List customers - Cedar.AI Documentation

POST

ims

customers

curl --request POST \
  --url https://api-lg.arms.cedarai.com/ims/customers \
  --header 'Content-Type: application/json' \
  --header 'x-arms-api-key: <api-key>' \
  --header 'x-arms-assume-user: <api-key>' \
  --data '
{
  "carrierId": 1234
}
'

{
  "customers": [
    {
      "resourceId": 123,
      "uuid": "<string>",
      "name": "<string>",
      "carrierId": 123,
      "carrier": {
        "resourceType": "Carrier",
        "resourceId": 123,
        "uuid": "<string>",
        "carrierCode": "<string>",
        "name": "<string>"
      },
      "blockCodePrefix": "<string>",
      "locations": [
        {
          "resourceId": 123,
          "uuid": "<string>",
          "name": "<string>",
          "blockCode": "<string>",
          "customerBlock": {
            "resourceType": "Grouping",
            "resourceId": 123,
            "uuid": "<string>",
            "name": "<string>",
            "groupingType": "<string>",
            "sortOrder": 123,
            "colorToken": "<string>"
          },
          "customer": {
            "resourceType": "Customer",
            "resourceId": 123,
            "uuid": "<string>",
            "name": "<string>"
          },
          "carrier": {
            "resourceType": "Carrier",
            "resourceId": 123,
            "uuid": "<string>",
            "carrierCode": "<string>",
            "name": "<string>"
          },
          "groupings": [
            {
              "resourceType": "Grouping",
              "resourceId": 123,
              "uuid": "<string>",
              "name": "<string>",
              "groupingType": "<string>",
              "sortOrder": 123,
              "colorToken": "<string>"
            }
          ],
          "abbreviatedName": "<string>",
          "currencyCode": "<string>"
        }
      ],
      "scac": "<string>",
      "printedName": "<string>"
    }
  ],
  "contract": {
    "effect": "overwrite",
    "resourceType": "Customer"
  }
}

{
  "message": "<string>"
}

Authorizations

x-arms-api-key

string

header

required

Your ARMS API key

x-arms-assume-user

string

header

required

Email of a user assigned to the appropriate user group

Query Parameters

carrierId

integer

required

Carrier identifier; required for all endpoints

viewAsUserGroup

string

Optional user group context

Body

application/json

carrierId

integer

required

Carrier identifier. May also be supplied via query parameter.

customerIds

integer[]

Optional filter by specific customer IDs

customerUuids

string[]

Optional filter by specific customer UUIDs

includeShipperCustomers

boolean

default:false

Whether to include shipper customers

Response

customers

object[]

Show child attributes

contract

object

Show child attributes

⌘I

curl --request POST \
  --url https://api-lg.arms.cedarai.com/ims/customers \
  --header 'Content-Type: application/json' \
  --header 'x-arms-api-key: <api-key>' \
  --header 'x-arms-assume-user: <api-key>' \
  --data '
{
  "carrierId": 1234
}
'

{
  "customers": [
    {
      "resourceId": 123,
      "uuid": "<string>",
      "name": "<string>",
      "carrierId": 123,
      "carrier": {
        "resourceType": "Carrier",
        "resourceId": 123,
        "uuid": "<string>",
        "carrierCode": "<string>",
        "name": "<string>"
      },
      "blockCodePrefix": "<string>",
      "locations": [
        {
          "resourceId": 123,
          "uuid": "<string>",
          "name": "<string>",
          "blockCode": "<string>",
          "customerBlock": {
            "resourceType": "Grouping",
            "resourceId": 123,
            "uuid": "<string>",
            "name": "<string>",
            "groupingType": "<string>",
            "sortOrder": 123,
            "colorToken": "<string>"
          },
          "customer": {
            "resourceType": "Customer",
            "resourceId": 123,
            "uuid": "<string>",
            "name": "<string>"
          },
          "carrier": {
            "resourceType": "Carrier",
            "resourceId": 123,
            "uuid": "<string>",
            "carrierCode": "<string>",
            "name": "<string>"
          },
          "groupings": [
            {
              "resourceType": "Grouping",
              "resourceId": 123,
              "uuid": "<string>",
              "name": "<string>",
              "groupingType": "<string>",
              "sortOrder": 123,
              "colorToken": "<string>"
            }
          ],
          "abbreviatedName": "<string>",
          "currencyCode": "<string>"
        }
      ],
      "scac": "<string>",
      "printedName": "<string>"
    }
  ],
  "contract": {
    "effect": "overwrite",
    "resourceType": "Customer"
  }
}

{
  "message": "<string>"
}