CustomerDetail
Type: schema
TypeScript Definition
typescript
CustomerDetail: {components["schemas"]["Customer"] & {
addresses?: components["schemas"]["AdminCustomerAddress"][]
}Component References
| Reference | Resolves To |
|---|---|
components["schemas"]["Customer"] | Customer |
components["schemas"]["AdminCustomerAddress"] | AdminCustomerAddress |
OpenAPI Schema
json
{
"allOf": [
{
"$ref": "#/components/schemas/Customer"
},
{
"type": "object",
"properties": {
"addresses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdminCustomerAddress"
}
},
"banking": {
"description": "Bank accounts saved against the customer, used for refunds and payouts.",
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomerBankAccount"
}
},
"loyalty": {
"description": "`null` when the customer is not enrolled in a loyalty program.",
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/LoyaltyMember"
}
]
},
"notification_preferences": {
"$ref": "#/components/schemas/NotificationPreferences"
},
"attributes": {
"description": "The customer's values of the store's active `custom` attributes, read-only ones included, each typed by its `attribute_type`; `value` is `null` when none is set. `GET /customers/{id}/attributes` lists every kind.",
"type": "array",
"items": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/StringAttribute"
},
{
"$ref": "#/components/schemas/IntegerAttribute"
},
{
"$ref": "#/components/schemas/AdminNumberAttribute"
},
{
"$ref": "#/components/schemas/AdminBooleanAttribute"
},
{
"$ref": "#/components/schemas/ListAttribute"
},
{
"$ref": "#/components/schemas/ObjectAttribute"
},
{
"$ref": "#/components/schemas/DateTimeAttribute"
}
]
}
},
"metadata": {
"description": "The customer's own data as key-value pairs; `null` when none was ever set.",
"type": [
"object",
"null"
],
"additionalProperties": true
}
}
}
],
"title": "CustomerDetail",
"x-tags": [
"Customers"
]
}Auto-generated from OpenAPI spec and TypeScript definitions