Skip to content

Customer ​

Type: schema

TypeScript Definition ​

typescript
Customer: {components["schemas"]["CustomerInfo"] & {
            /** @description Stored business fields are returned whenever a customer record exists, including when name is null or empty and when all optional fields are empty. business_type may contain a legacy/default customer group name
}

Component References ​

ReferenceResolves To
components["schemas"]["CustomerInfo"]CustomerInfo

OpenAPI Schema ​

json
{
  "title": "Customer",
  "allOf": [
    {
      "$ref": "#/components/schemas/CustomerInfo"
    },
    {
      "type": "object",
      "properties": {
        "business": {
          "description": "Stored business fields are returned whenever a customer record exists, including when name is null or empty and when all optional fields are empty. business_type may contain a legacy/default customer group name; this object does not imply business registration. null is retained for representations without a linked customer record.",
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/components/schemas/BusinessInfo"
            }
          ]
        },
        "segments": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/CustomerSegment"
          }
        },
        "address": {
          "description": "The customer's primary address. `null` when the customer has none.",
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/components/schemas/AdminCustomerAddress"
            }
          ]
        }
      }
    }
  ],
  "x-tags": [
    "Customers"
  ]
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: