Skip to navigation
REST RPC APICustomers

Retrieve

View as Markdown
Returns information about an individual customer account by its unique identifier.

Authentication

x-api-keystring

Application API Scope — server-to-server, sent in the x-api-key header. See Authentication.

OR
authorizationstring

Storefront API Scope — client-side, scoped to one customer, sent as a signature in the authorization header. See Authentication.

Path parameters

merchant_user_idstringRequired
Merchant User ID

Response

200
merchantstringOptional
merchant_user_idstringOptional
session_idstringOptional
user_token_idstringOptional
first_namestringOptional
last_namestringOptional
emailstringOptional
phone_numberstringOptional
phone_typeintegerOptionalDefaults to 0
livebooleanOptionalDefaults to true
createdstringOptional
last_updatedstringOptional
last_loginstring or nullOptional
extra_datastringOptional
localeinteger or nullOptional

The customer's locale as a numeric ID, for example 1 for en-us. Unlike the update endpoint, which returns the locale code, this endpoint returns the number.

price_codestringOptional

Errors

403
Forbidden Error
404
Not Found Error