v1

latestOpenAPI 3.0.12026-07-26381328555.2 KB
B2BAccount

Get B2B Account

Retrieves the details of a B2B account specified by its unique identifier.

get/commerce/customer/b2baccounts/{accountId}

Path parameters

accountIdinteger required

Unique identifier of the B2B account whose details you want to retrieve.

Query parameters

responseGroupsstring

Used to refine the default information returned from a request. To reduce amount of customer account information returned, use the valid response groups: Contacts, CustomerAccountNotes, and OrderSummary. Optional.

responseFieldsstring

limits which fields are returned in the response body

Response

OK

accountTypestring nullable

Type of account.

approvalStatusstring nullable

Status on B2B account.

companyOrOrganizationstring nullable

The company or organization name for an account.

customerSetstring nullable
customerSinceDatestring date-time nullable

Date when the customer account is created.

externalIdstring nullable
idinteger

Unique identifier of the account, also known as a customer number.

isActiveboolean nullable

Is the B2B account active?

migrationRequiredboolean

Indicates Subscription migration is required or not.

parentAccountIdinteger nullable

Parent account Id in B2B hierarchy

priceListstring nullable

Price list on B2B account.

priorityinteger nullable

Priority of the b2b account for order release

rootAccountIdinteger nullable

Root account Id in B2B hierarchy

taxExemptboolean
taxIdstring nullable