Customer API

Create customer

Create a customer, optionally with its locations and their addresses. The response is the full customer record, including the resourceId of the customer and of each location: store them to update the customer later.

Usage notes:

carrier.resourceId must be the carrier in the carrierId query parameter.
Customer names and SCACs are unique per carrier, and location names are unique per customer: a duplicate returns 400. Create does not match on externalLocationId. To find an existing customer, look its name up with List customers, then change it with Update customer.
printedName defaults to name. Customer and location names cannot contain / (412).
ediId must be unique across every customer in Cedar; scac must be a SCAC Cedar already knows.
An address missing streetLine1, city, state or zipCode (and not AT_PARTIAL) is rejected with a 500 error. Fix the request rather than retrying it.
Set usedForBilling: true on each location you invoice. The first location becomes the default location unless another one has isDefault: true.
Cedar also creates two user groups for each new customer, <name> Admin and <name> Operator, shortly after the call returns. Renaming the customer renames them.
A missing permission returns 401.

POST

ims

customers

create

curl --request POST \
  --url https://api-lg.arms.cedarai.com/ims/customers/create \
  --header 'Content-Type: application/json' \
  --header 'x-arms-api-key: <api-key>' \
  --header 'x-arms-assume-user: <api-key>' \
  --data '
{
  "carrier": {
    "resourceId": 1234
  },
  "name": "Acme Chemical",
  "ediId": "ACMECHEM",
  "isTaxExempt": false,
  "locations": [
    {
      "name": "Acme Chemical - Odessa",
      "isDefault": true,
      "usedForBilling": true,
      "currencyCode": "USD",
      "email": "ap@acme-chemical.example",
      "phoneNumber": "4325550100",
      "externalLocationId": "NS-CUST-1001",
      "address": {
        "streetLine1": "1600 Rail Spur Rd",
        "city": "Odessa",
        "state": "TX",
        "zipCode": "79761",
        "country": "US"
      }
    }
  ]
}
'

{
  "customer": {
    "resourceId": 123,
    "uuid": "<string>",
    "name": "<string>",
    "printedName": "<string>",
    "scac": "<string>",
    "ediId": "<string>",
    "isTaxExempt": true,
    "carrier": {
      "resourceType": "Carrier",
      "resourceId": 123,
      "uuid": "<string>",
      "carrierCode": "<string>",
      "name": "<string>"
    },
    "locations": [
      {
        "resourceId": 123,
        "uuid": "<string>",
        "name": "<string>",
        "abbreviatedName": "<string>",
        "customer": {
          "resourceType": "Customer",
          "resourceId": 123,
          "uuid": "<string>",
          "name": "<string>"
        },
        "address": {
          "resourceId": 123,
          "name": "<string>",
          "streetLine1": "<string>",
          "streetLine2": "<string>",
          "streetLine3": "<string>",
          "streetLine4": "<string>",
          "city": "<string>",
          "state": "<string>",
          "zipCode": "<string>",
          "country": "<string>",
          "addressType": "<string>"
        },
        "isDefault": true,
        "usedForBilling": true,
        "currencyCode": "<string>",
        "email": "<string>",
        "phoneNumber": "<string>",
        "externalLocationId": "<string>",
        "generalLedgerNumber": "<string>",
        "customerIdentificationNumbers": [
          "<string>"
        ]
      }
    ]
  },
  "contract": {
    "effect": "append",
    "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

Body

application/json

carrier

object

required

Show child attributes

name

string

required

Customer name. Cannot contain /.

printedName

string

Name printed on documents such as invoices (Printed Name in ARMS). Defaults to name.

scac

string

The customer's SCAC. Must be a SCAC Cedar already knows; an unknown SCAC returns 404.

ediId

string

EDI ID. Must be unique across every customer in Cedar, including deleted customers; a duplicate returns 400.

isTaxExempt

boolean

Tax exempt in ARMS.

locations

object[]

Show child attributes

Response

customer

object

The full customer record. Fields without a value are left out.

Show child attributes

contract

object

Show child attributes

⌘I

curl --request POST \
  --url https://api-lg.arms.cedarai.com/ims/customers/create \
  --header 'Content-Type: application/json' \
  --header 'x-arms-api-key: <api-key>' \
  --header 'x-arms-assume-user: <api-key>' \
  --data '
{
  "carrier": {
    "resourceId": 1234
  },
  "name": "Acme Chemical",
  "ediId": "ACMECHEM",
  "isTaxExempt": false,
  "locations": [
    {
      "name": "Acme Chemical - Odessa",
      "isDefault": true,
      "usedForBilling": true,
      "currencyCode": "USD",
      "email": "ap@acme-chemical.example",
      "phoneNumber": "4325550100",
      "externalLocationId": "NS-CUST-1001",
      "address": {
        "streetLine1": "1600 Rail Spur Rd",
        "city": "Odessa",
        "state": "TX",
        "zipCode": "79761",
        "country": "US"
      }
    }
  ]
}
'

{
  "customer": {
    "resourceId": 123,
    "uuid": "<string>",
    "name": "<string>",
    "printedName": "<string>",
    "scac": "<string>",
    "ediId": "<string>",
    "isTaxExempt": true,
    "carrier": {
      "resourceType": "Carrier",
      "resourceId": 123,
      "uuid": "<string>",
      "carrierCode": "<string>",
      "name": "<string>"
    },
    "locations": [
      {
        "resourceId": 123,
        "uuid": "<string>",
        "name": "<string>",
        "abbreviatedName": "<string>",
        "customer": {
          "resourceType": "Customer",
          "resourceId": 123,
          "uuid": "<string>",
          "name": "<string>"
        },
        "address": {
          "resourceId": 123,
          "name": "<string>",
          "streetLine1": "<string>",
          "streetLine2": "<string>",
          "streetLine3": "<string>",
          "streetLine4": "<string>",
          "city": "<string>",
          "state": "<string>",
          "zipCode": "<string>",
          "country": "<string>",
          "addressType": "<string>"
        },
        "isDefault": true,
        "usedForBilling": true,
        "currencyCode": "<string>",
        "email": "<string>",
        "phoneNumber": "<string>",
        "externalLocationId": "<string>",
        "generalLedgerNumber": "<string>",
        "customerIdentificationNumbers": [
          "<string>"
        ]
      }
    ]
  },
  "contract": {
    "effect": "append",
    "resourceType": "Customer"
  }
}

{
  "message": "<string>"
}