API reference
- Getting Started with Your API
- SDKs and Toolkits
- Customer Overview
- GETGet B2B Account Attributes
- POSTAdd B2B Account tAttribute
- GETGet B2B Account Attribute
- PUTUpdate B2B Account Attribute
- DELDelete B2B Account Attribute
- GETGet B2B Accounts
- POSTAdd Account
- GETGet B2B Account
- PUTUpdate Account
- GETGet B2B Account Hierarchy
- POSTChange Parent Account
- POSTAdd Sales Rep To B2B Account
- DELRemove Sales Rep From B2B Account
- POSTAdd Sales Reps To B2B Account
- PUTUpdate Sales Reps On B2B Account
- PUTUpdate B2B Account Status
- GETGet Accounts For Sales Rep
- PUTUpgrade B2C Accounts To B2B
- GETGet Accounts by User
- PUTUpdate Account Priorities
- GETGet Account Priorities
- PUTDelete Account Priorities
- POSTAdd User
- GETGet Users Async
- PUTUpdate User
- PUTRemove User
- GETGet User Roles Async
- POSTAdd User Role Async
- DELRemove User Role Async
- GET
A valid request URL is required to generate request examples{
"id": 123,
"customerSet": "<string>",
"commerceSummary": {
"totalOrderAmount": {
"currencyCode": "<string>",
"amount": 123
},
"orderCount": 123,
"lastOrderDate": "2023-11-07T05:31:56Z",
"wishlistCount": 123,
"visitsCount": 123
},
"contacts": [
{
"accountId": 123,
"types": [
{
"name": "<string>",
"isPrimary": true
}
],
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
},
"faxNumber": "<string>",
"label": "<string>",
"id": 123,
"email": "<string>",
"firstName": "<string>",
"middleNameOrInitial": "<string>",
"lastNameOrSurname": "<string>",
"companyOrOrganization": "<string>",
"phoneNumbers": {
"home": "<string>",
"mobile": "<string>",
"work": "<string>"
},
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"address4": "<string>",
"cityOrTown": "<string>",
"stateOrProvince": "<string>",
"postalOrZipCode": "<string>",
"countryCode": "<string>",
"addressType": "<string>",
"isValidated": true
}
}
],
"companyOrOrganization": "<string>",
"notes": [
{
"id": 123,
"content": "<string>",
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
}
}
],
"attributes": [
{
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
},
"fullyQualifiedName": "<string>",
"attributeDefinitionId": 123,
"values": [
"<unknown>"
]
}
],
"segments": [
{
"id": 123,
"code": "<string>",
"name": "<string>",
"description": "<string>",
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
}
}
],
"taxExempt": true,
"taxId": "<string>",
"externalId": "<string>",
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
},
"customerSinceDate": "2023-11-07T05:31:56Z",
"accountType": "<string>",
"migrationRequired": true,
"users": [
{
"emailAddress": "<string>",
"userName": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"localeCode": "<string>",
"userId": "<string>",
"roles": [
{
"userId": "<string>",
"assignedInScope": {
"type": "<string>",
"id": 123,
"name": "<string>"
},
"roleId": 123,
"roleName": "<string>",
"roleResources": [
{
"type": "<string>",
"id": "<string>"
}
],
"roleTags": [
"<string>"
],
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
}
}
],
"isLocked": true,
"isActive": true,
"isRemoved": true,
"acceptsMarketing": true,
"hasExternalPassword": true,
"last2FaDate": "2023-11-07T05:31:56Z"
}
],
"isActive": true,
"priceList": "<string>",
"salesReps": [
{
"accountId": 123,
"adminUserId": "<string>"
}
],
"rootAccountId": 123,
"parentAccountId": 123,
"approvalStatus": "<string>",
"priority": 123
}Add Account
Creates a new B2B account in the Pending Approval state. This account will not yet be active, as it requires a sales representative to be assigned (with …/b2baccounts//salesrep/) before it is approved (with …/b2baccounts//status/).
A valid request URL is required to generate request examples{
"id": 123,
"customerSet": "<string>",
"commerceSummary": {
"totalOrderAmount": {
"currencyCode": "<string>",
"amount": 123
},
"orderCount": 123,
"lastOrderDate": "2023-11-07T05:31:56Z",
"wishlistCount": 123,
"visitsCount": 123
},
"contacts": [
{
"accountId": 123,
"types": [
{
"name": "<string>",
"isPrimary": true
}
],
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
},
"faxNumber": "<string>",
"label": "<string>",
"id": 123,
"email": "<string>",
"firstName": "<string>",
"middleNameOrInitial": "<string>",
"lastNameOrSurname": "<string>",
"companyOrOrganization": "<string>",
"phoneNumbers": {
"home": "<string>",
"mobile": "<string>",
"work": "<string>"
},
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"address4": "<string>",
"cityOrTown": "<string>",
"stateOrProvince": "<string>",
"postalOrZipCode": "<string>",
"countryCode": "<string>",
"addressType": "<string>",
"isValidated": true
}
}
],
"companyOrOrganization": "<string>",
"notes": [
{
"id": 123,
"content": "<string>",
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
}
}
],
"attributes": [
{
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
},
"fullyQualifiedName": "<string>",
"attributeDefinitionId": 123,
"values": [
"<unknown>"
]
}
],
"segments": [
{
"id": 123,
"code": "<string>",
"name": "<string>",
"description": "<string>",
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
}
}
],
"taxExempt": true,
"taxId": "<string>",
"externalId": "<string>",
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
},
"customerSinceDate": "2023-11-07T05:31:56Z",
"accountType": "<string>",
"migrationRequired": true,
"users": [
{
"emailAddress": "<string>",
"userName": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"localeCode": "<string>",
"userId": "<string>",
"roles": [
{
"userId": "<string>",
"assignedInScope": {
"type": "<string>",
"id": 123,
"name": "<string>"
},
"roleId": 123,
"roleName": "<string>",
"roleResources": [
{
"type": "<string>",
"id": "<string>"
}
],
"roleTags": [
"<string>"
],
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
}
}
],
"isLocked": true,
"isActive": true,
"isRemoved": true,
"acceptsMarketing": true,
"hasExternalPassword": true,
"last2FaDate": "2023-11-07T05:31:56Z"
}
],
"isActive": true,
"priceList": "<string>",
"salesReps": [
{
"accountId": 123,
"adminUserId": "<string>"
}
],
"rootAccountId": 123,
"parentAccountId": 123,
"approvalStatus": "<string>",
"priority": 123
}Authorizations
JWT Authorization header using the Bearer scheme.
Query Parameters
limits which fields are returned in the response body
Body
Properties of the new B2B account to create.
Customer account. Customers provide contact information, view order history, and set email preferences on their account. Merchants can edit accounts to add internal notes or assign them to segments.
Unique identifier of the account, also known as a customer number.
Commerce (orders and wishlists) on a customer account which lists all the orders the customer has made with the order date, order amount, and status. Includes cancellations and returns. Also includes wishlist information.
Show child attributes
Show child attributes
List of contacts for this account. A customer account can have multiple contacts for billing and shipping addresses.
Show child attributes
Show child attributes
The company or organization name for an account.
List of notes for the account. Merchants use these internal notes, for example, to make a note of a customer's interests or complaints. Notes are available only from the merchant's view, customers cannot view these notes.
Show child attributes
Show child attributes
List of attributes for the account.
Show child attributes
Show child attributes
List of segments assigned to account. Merchants create segments, for example, to manage discounts or assign VIP status. Then they assign the account to the segment. An account can belong to several segments or none at all.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Date when the customer account is created.
Type of account.
Indicates Subscription migration is required or not.
List of B2B users on the account.
Show child attributes
Show child attributes
Is the B2B account active?
Price list on B2B account.
List of sales rep on B2B account.
Show child attributes
Show child attributes
Root account Id in B2B hierarchy
Parent account Id in B2B hierarchy
Status on B2B account.
Priority of the b2b account for order release
Response
Success
Customer account. Customers provide contact information, view order history, and set email preferences on their account. Merchants can edit accounts to add internal notes or assign them to segments.
Unique identifier of the account, also known as a customer number.
Commerce (orders and wishlists) on a customer account which lists all the orders the customer has made with the order date, order amount, and status. Includes cancellations and returns. Also includes wishlist information.
Show child attributes
Show child attributes
List of contacts for this account. A customer account can have multiple contacts for billing and shipping addresses.
Show child attributes
Show child attributes
The company or organization name for an account.
List of notes for the account. Merchants use these internal notes, for example, to make a note of a customer's interests or complaints. Notes are available only from the merchant's view, customers cannot view these notes.
Show child attributes
Show child attributes
List of attributes for the account.
Show child attributes
Show child attributes
List of segments assigned to account. Merchants create segments, for example, to manage discounts or assign VIP status. Then they assign the account to the segment. An account can belong to several segments or none at all.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Date when the customer account is created.
Type of account.
Indicates Subscription migration is required or not.
List of B2B users on the account.
Show child attributes
Show child attributes
Is the B2B account active?
Price list on B2B account.
List of sales rep on B2B account.
Show child attributes
Show child attributes
Root account Id in B2B hierarchy
Parent account Id in B2B hierarchy
Status on B2B account.
Priority of the b2b account for order release