Developers

Customers

Markdown

Get a customer

A single customer by ID.

GET/stores/{storeId}/v1/customers/{id}

Path parameters

idstringrequired

Response

dataobjectrequired
idstringrequired
namestringrequired
first_namestring
last_namestring
phonestring | nullrequired
Phone number in E.164 format, such as +966512345678, or null if it is not a valid number.
emailstring | null (email)required
orders_countintegerrequired
Delivered orders that were not refunded.
total_spentstringrequired
The total of those orders in SAR.
last_order_atstring | null (date-time)
created_atstring (date-time)required
executionobject
Who executed the request: the app, version, installation and store. Field names here are camelCase.
appIdstring (uuid)
versionIdstring (uuid)
installationIdstring (uuid)
storeIdstring (uuid)
requestIdstring (uuid)
generationinteger
routeEpochinteger
appAuthEpochinteger
grantRevisioninteger
metaobjectrequired
request_idstring (uuid)
The request ID; include it in any support request.

Errors

HTTPCodeMeaning
404RESOURCE_NOT_FOUNDThe ID does not exist in this store.
403SCOPE_REQUIREDThe token does not carry the required scope.
503APPS_SCOPE_RUNTIME_NOT_READYThe resource is not enabled on this merchant's store yet.

Shared codes are listed in Errors.

    ↑↓ moveEnter openEsc close