Customer
| Field | Type | Required | Description |
|---|---|---|---|
id |
string |
||
internalCustomerNumber |
number |
Internal Customer number, set automatically upon creation | |
externalCustomerNumber |
string |
External Customer number | |
firstName |
string |
First name of the customer | |
middleName |
`string | null` | |
lastName |
string |
Last name of the customer | |
emailAddress |
string |
format: email |
|
status |
Status | one of: active, inactive, deleted · default: "active" |
|
isAnonymous |
boolean |
Indicates anonymous/guest customer. default: false |
|
externalUpdateDate |
string |
format: date-time |
|
taxExempt |
boolean |
default: false |
|
taxClass |
string |
Tax class of the customer. | |
contacts |
array[ContactFull] | ||
attributes |
array[CustomerAttribute] | ||
settings |
CustomerSettings | All customer settings which are defined by Shopgate | |
associatedShops |
array[AssociatedShop] |
Example
Section titled “Example”{ "id": "d162439c-e2f9-4050-8b94-6bff33e8163b", "internalCustomerNumber": 2, "externalCustomerNumber": "10001", "firstName": "John", "middleName": "Doug", "lastName": "Doe", "emailAddress": "john.doe@shopgate.com", "status": "active", "isAnonymous": true, "externalUpdateDate": "2026-01-01T00:00:00Z", "taxExempt": true, "taxClass": "string", "contacts": [ {} ], "attributes": [ { "code": "tshirtSize", "name": "T-Shirt Size", "value": { "code": "l", "name": "L" } }, { "code": "nameOfCat", "name": "Name of your cat", "value": "Some Cat Name" } ], "settings": { "defaultLocale": "en-us", "defaultCurrency": "USD", "communicationPreferences": [ "email", "push", "sms" ], "defaultLocationCode": "DERetail001", "marketingOptIn": true }, "associatedShops": [ "shop_10000" ]}
