customer

Requires permission customers:customer:read.

Returns one customer by ID, if the signed-in user may see it. Needs the customers read permission.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query Customer($id: ID!) {
  customer(id: $id) {
    id
    code
    registrationNumber
    name
    customerTierName
    displayName
    addresses {
      id
      postalCode
      contactName
      type
      createdAt
      addressLine1
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query Customer($id: ID!) {\n  customer(id: $id) {\n    id\n    code\n    registrationNumber\n    name\n    customerTierName\n    displayName\n    addresses {\n      id\n      postalCode\n      contactName\n      type\n      createdAt\n      addressLine1\n    }\n  }\n}",
  "variables": {
    "id": "id"
  }
}
EOF

Variables:

{
  "id": "id"
}

Response:

{
  "data": {
    "customer": {
      "id": "id",
      "code": "string",
      "registrationNumber": "string",
      "name": "string",
      "customerTierName": "string",
      "displayName": "string",
      "addresses": [
        {
          "id": "id",
          "postalCode": "string",
          "contactName": "string",
          "type": "string",
          "createdAt": "2025-01-15T00:00:00Z",
          "addressLine1": "string"
        }
      ]
    }
  }
}

customer(
  id: ID!
): Customer!

Arguments

customer.id ● ID! non-null scalar

The ID of the customer.

Type

Customer object

A customer: a partner with the customer role.