Skip to main content
GET
/
commerce
/
customer
/
b2baccounts
/
{accountId}
/
hierarchy
Error
A valid request URL is required to generate request examples
{
  "accounts": [
    {
      "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
    }
  ],
  "hierarchy": {
    "id": 123,
    "children": [
      {}
    ]
  }
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

accountId
integer<int32>
required

Unique identifier of the B2B account whose account hierarchy you want to retrieve. This can be any account belonging to the same hierarchy.

Query Parameters

responseGroups
string

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.

responseFields
string

limits which fields are returned in the response body

Response

Success

accounts
object[] | null

All accounts belonging to this account hierarchy.

hierarchy
object