Class CompanyResource

Company (B2B) endpoints.

A customer may belong to several companies (e.g. a buyer purchasing on behalf of multiple clients). Every method takes an optional companyId to say which company to act on. When omitted, the API falls back to the sole membership; if the customer belongs to several and none is given, the API responds 400 (COMPANY_SELECTION_REQUIRED). Read the full list from auth.getMe().companies.

Index

Constructors

constructor

Methods

addShippingAddress get getMembers listInvites removeMember removeShippingAddress revokeInvite sendInvite updateAddress updateMemberRole updateShippingAddress

Constructors

constructor

new CompanyResource(http: HttpClient): CompanyResource
Parameters
- http: HttpClient
Returns CompanyResource
- Defined in services/api/packages/storefront-sdk/src/resources/company.ts:14

Methods

addShippingAddress

addShippingAddress(address: Address, companyId?: string): Promise<Address>
Add a shipping address
Parameters
- address: Address
- OptionalcompanyId: string
Returns Promise<Address>
- Defined in services/api/packages/storefront-sdk/src/resources/company.ts:75

get

get(companyId?: string): Promise<Company>
Get the company the customer is acting for.
Parameters
- OptionalcompanyId: string
Returns Promise<Company>
- Defined in services/api/packages/storefront-sdk/src/resources/company.ts:17

getMembers

getMembers(companyId?: string): Promise<CompanyMember[]>
Get all members of the company. Owner or admin only.
Parameters
- OptionalcompanyId: string
Returns Promise<CompanyMember[]>
- Defined in services/api/packages/storefront-sdk/src/resources/company.ts:22

listInvites

listInvites(companyId?: string): Promise<CompanyInvite[]>
List pending invites. Owner or admin only.
Parameters
- OptionalcompanyId: string
Returns Promise<CompanyInvite[]>
- Defined in services/api/packages/storefront-sdk/src/resources/company.ts:44

removeMember

removeMember(
memberId: string,
companyId?: string,
): Promise<{ success: boolean }>
Remove a member from the company. Owner or admin.
Parameters
- memberId: string
- OptionalcompanyId: string
Returns Promise<{ success: boolean }>
- Defined in services/api/packages/storefront-sdk/src/resources/company.ts:36

removeShippingAddress

removeShippingAddress(
addressId: string,
companyId?: string,
): Promise<{ success: boolean }>
Remove a shipping address
Parameters
- addressId: string
- OptionalcompanyId: string
Returns Promise<{ success: boolean }>
- Defined in services/api/packages/storefront-sdk/src/resources/company.ts:93

revokeInvite

revokeInvite(
inviteId: string,
companyId?: string,
): Promise<{ success: boolean }>
Revoke a pending invite. Owner or admin.
Parameters
- inviteId: string
- OptionalcompanyId: string
Returns Promise<{ success: boolean }>
- Defined in services/api/packages/storefront-sdk/src/resources/company.ts:58

sendInvite

sendInvite(
params: SendInviteParams,
companyId?: string,
): Promise<{ inviteId: string; success: boolean }>
Send a company membership invite. Owner or admin.
Parameters
- params: SendInviteParams
- OptionalcompanyId: string
Returns Promise<{ inviteId: string; success: boolean }>
- Defined in services/api/packages/storefront-sdk/src/resources/company.ts:49

updateAddress

updateAddress(billingAddress: Address, companyId?: string): Promise<Company>
Update the company's billing address
Parameters
- billingAddress: Address
- OptionalcompanyId: string
Returns Promise<Company>
- Defined in services/api/packages/storefront-sdk/src/resources/company.ts:66

updateMemberRole

updateMemberRole(
    memberId: string,
    role: string,
    companyId?: string,
): Promise<{ memberId: string; role: string; success: boolean }>
Update a member's role. Owner only.
Parameters
- memberId: string
- role: string
- OptionalcompanyId: string
Returns Promise<{ memberId: string; role: string; success: boolean }>
- Defined in services/api/packages/storefront-sdk/src/resources/company.ts:27

updateShippingAddress

updateShippingAddress(
    addressId: string,
    address: Partial<Address>,
    companyId?: string,
): Promise<Address>
Update a shipping address in place. Returns the updated address.
Parameters
- addressId: string
- address: Partial<Address>
- OptionalcompanyId: string
Returns Promise<Address>
- Defined in services/api/packages/storefront-sdk/src/resources/company.ts:84

Class CompanyResource

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CompanyResource

Methods

addShippingAddress

Parameters

Returns Promise<Address>

get

Parameters

Returns Promise<Company>

getMembers

Parameters

Returns Promise<CompanyMember[]>

listInvites

Parameters

Returns Promise<CompanyInvite[]>

removeMember

Parameters

Returns Promise<{ success: boolean }>

removeShippingAddress

Parameters

Returns Promise<{ success: boolean }>

revokeInvite

Parameters

Returns Promise<{ success: boolean }>

sendInvite

Parameters

Returns Promise<{ inviteId: string; success: boolean }>

updateAddress

Parameters

Returns Promise<Company>

updateMemberRole

Parameters

Returns Promise<{ memberId: string; role: string; success: boolean }>

updateShippingAddress

Parameters

Returns Promise<Address>

Settings

On This Page