Skip to main content
GET
/
commerce
/
customer
/
b2baccounts
/
{accountId}
/
hierarchy
Error
A valid request URL is required to generate request examples
{
  "accounts": [
    {
      "accountType": "<string>",
      "attributes": [
        {
          "attributeDefinitionId": 123,
          "auditInfo": {
            "createBy": "<string>",
            "createDate": "2023-11-07T05:31:56Z",
            "updateBy": "<string>",
            "updateDate": "2023-11-07T05:31:56Z"
          },
          "fullyQualifiedName": "<string>",
          "values": [
            "<unknown>"
          ]
        }
      ],
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "commerceSummary": {
        "lastOrderDate": "2023-11-07T05:31:56Z",
        "orderCount": 123,
        "totalOrderAmount": {
          "amount": 123,
          "currencyCode": "<string>"
        },
        "visitsCount": 123,
        "wishlistCount": 123
      },
      "companyOrOrganization": "<string>",
      "contacts": [
        {
          "accountId": 123,
          "address": {
            "address1": "<string>",
            "address2": "<string>",
            "address3": "<string>",
            "address4": "<string>",
            "addressType": "<string>",
            "cityOrTown": "<string>",
            "countryCode": "<string>",
            "isValidated": true,
            "postalOrZipCode": "<string>",
            "stateOrProvince": "<string>"
          },
          "auditInfo": {
            "createBy": "<string>",
            "createDate": "2023-11-07T05:31:56Z",
            "updateBy": "<string>",
            "updateDate": "2023-11-07T05:31:56Z"
          },
          "companyOrOrganization": "<string>",
          "email": "<string>",
          "faxNumber": "<string>",
          "firstName": "<string>",
          "id": 123,
          "label": "<string>",
          "lastNameOrSurname": "<string>",
          "middleNameOrInitial": "<string>",
          "phoneNumbers": {
            "home": "<string>",
            "mobile": "<string>",
            "work": "<string>"
          },
          "types": [
            {
              "isPrimary": true,
              "name": "<string>"
            }
          ]
        }
      ],
      "customerSet": "<string>",
      "customerSinceDate": "2023-11-07T05:31:56Z",
      "externalId": "<string>",
      "id": 123,
      "migrationRequired": true,
      "notes": [
        {
          "auditInfo": {
            "createBy": "<string>",
            "createDate": "2023-11-07T05:31:56Z",
            "updateBy": "<string>",
            "updateDate": "2023-11-07T05:31:56Z"
          },
          "content": "<string>",
          "id": 123
        }
      ],
      "segments": [
        {
          "auditInfo": {
            "createBy": "<string>",
            "createDate": "2023-11-07T05:31:56Z",
            "updateBy": "<string>",
            "updateDate": "2023-11-07T05:31:56Z"
          },
          "code": "<string>",
          "description": "<string>",
          "id": 123,
          "name": "<string>"
        }
      ],
      "taxExempt": true,
      "taxId": "<string>",
      "approvalStatus": "<string>",
      "isActive": true,
      "parentAccountId": 123,
      "priceList": "<string>",
      "priority": 123,
      "rootAccountId": 123,
      "salesReps": [
        {
          "accountId": 123,
          "adminUserId": "<string>"
        }
      ],
      "users": [
        {
          "acceptsMarketing": true,
          "emailAddress": "<string>",
          "firstName": "<string>",
          "hasExternalPassword": true,
          "isActive": true,
          "isLocked": true,
          "isRemoved": true,
          "last2FaDate": "2023-11-07T05:31:56Z",
          "lastName": "<string>",
          "localeCode": "<string>",
          "roles": [
            {
              "assignedInScope": {
                "id": 123,
                "name": "<string>",
                "type": "<string>"
              },
              "auditInfo": {
                "createBy": "<string>",
                "createDate": "2023-11-07T05:31:56Z",
                "updateBy": "<string>",
                "updateDate": "2023-11-07T05:31:56Z"
              },
              "roleId": 123,
              "roleName": "<string>",
              "roleResources": [
                {
                  "id": "<string>",
                  "type": "<string>"
                }
              ],
              "roleTags": [
                "<string>"
              ],
              "userId": "<string>"
            }
          ],
          "userId": "<string>",
          "userName": "<string>"
        }
      ]
    }
  ],
  "hierarchy": {
    "children": [
      {}
    ],
    "id": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.kibocommerce.com/llms.txt

Use this file to discover all available pages before exploring further.

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