Customer API

Update customer

Update a customer and add, change, or delete its locations. Identify the customer by resourceId, as returned by Create customer or List customers.

Usage notes:

Customer fields you leave out keep their values. Send an empty string to clear scac or ediId.
locations lists only the locations to add, change, or delete; locations you leave out are not changed. A location with a resourceId is changed, or deleted with requestAction: "delete". A location without a resourceId is added; set its customerId to the customer’s resourceId.
When you change a location, send all of it, including isDefault and its address (with the address resourceId to change that address in place). Location fields you leave out are reset or cleared; see the locations schema. A changed location without an address is rejected with a 500 error.
List customers returns only part of a customer: not ediId, isTaxExempt, or a location’s isDefault, usedForBilling, externalLocationId, contact details or address. Keep the full record that Create customer and Update customer return, including address resourceIds, and treat your system as the source of truth for those fields. An address sent without a resourceId replaces the location’s address.
At most one location is the default. To move the default, list the current default with isDefault: false before the new default.
Renaming the customer or a location also updates clear references to the old name in revenue agreements, invoice settings, and workflows: the same updates the ARMS customer form makes without asking. Ambiguous references are left unchanged.
Renaming the customer also renames its <name> Admin and <name> Operator user groups, acting as the user in x-arms-assume-user. If that user cannot update user groups, the rename can fail; rename the customer in ARMS instead.
There is no upsert: updating a customer ID that does not exist returns 404.
A missing permission returns 401.

POST

ims

customers

update

curl --request POST \
  --url https://api-lg.arms.cedarai.com/ims/customers/update \
  --header 'Content-Type: application/json' \
  --header 'x-arms-api-key: <api-key>' \
  --header 'x-arms-assume-user: <api-key>' \
  --data '
{
  "carrier": {
    "resourceId": 1234
  },
  "resourceId": 5678,
  "printedName": "Acme Chemical Co.",
  "locations": [
    {
      "resourceId": 9012,
      "name": "Acme Chemical - Odessa",
      "isDefault": true,
      "usedForBilling": true,
      "currencyCode": "USD",
      "email": "billing@acme-chemical.example",
      "externalLocationId": "NS-CUST-1001",
      "address": {
        "resourceId": 3456,
        "streetLine1": "1650 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": "overwriteItem",
    "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

Customer fields you leave out (or send as null) keep their current values.

carrier

object

required

Show child attributes

resourceId

integer

required

ID of the customer to update, as returned by Create customer or List customers.

name

string

New customer name. Cannot contain /. Renaming also renames the customer's <name> Admin and <name> Operator user groups.

printedName

string

scac

string

Must be a SCAC Cedar already knows. Send an empty string to clear it.

ediId

string

Must be unique across every customer in Cedar. Send an empty string to clear it.

isTaxExempt

boolean

locations

object[]

Only the locations to add, change or delete. Locations you leave out are not changed.

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/update \
  --header 'Content-Type: application/json' \
  --header 'x-arms-api-key: <api-key>' \
  --header 'x-arms-assume-user: <api-key>' \
  --data '
{
  "carrier": {
    "resourceId": 1234
  },
  "resourceId": 5678,
  "printedName": "Acme Chemical Co.",
  "locations": [
    {
      "resourceId": 9012,
      "name": "Acme Chemical - Odessa",
      "isDefault": true,
      "usedForBilling": true,
      "currencyCode": "USD",
      "email": "billing@acme-chemical.example",
      "externalLocationId": "NS-CUST-1001",
      "address": {
        "resourceId": 3456,
        "streetLine1": "1650 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": "overwriteItem",
    "resourceType": "Customer"
  }
}

{
  "message": "<string>"
}