Retrieve Customer
Retrieve a customer. A customer can be retrieved by referencing a customer ID, their email address, their order reference, the barcode from an order item, or an NFC tag they have been assigned.
Authorizations
The 'Bearer' token can be obtained from the token management interface or via the login endpoint using your admin user credentials.
Query Parameters
The customer's ID. This is required if the email, reference, nfcId or barcode fields are empty.
The customer's email address. This is required if the id, reference, nfcId or barcode fields are empty.
A barcode from one of the customer's order items. This is required if the id, reference, nfcId or email fields are empty.
A customer order reference. This is required if the id, barcode, nfcId or email fields are empty.
an NFC tag ID. This is required if the id, barcode, reference or email fields are empty.
A list of related resources you wish to include in the response. Values can be a url encoded array, or comma separated string.
The dataCaptureResponses return both the responses to the marketing preferences and the responses to the general data capture questions in the checkout. You can filter these by referring to the questionGroup field in each of the data capture responses (marketing for marketing preference responses, and shop for the customer data capture in the checkout).
The answer value returned in the data capture responses can be a string (generally from responses to free text, checkboxes or select fields), or an array of option ID's selected (generally from, multicheckbox fields and radio buttons).
companies, dataCaptureResponses, cities, currencies, wallets, authenticationProviders Controls records returned depending on their deletedAt status. This is a global flag, so will apply to all resources, including relationships such as resources returned under the included attribute.
trueto include deleted recordsfalseto exclude deleted records (or leave blank)
true, false A list of attributes that you wish to be returned in the payload. When empty or omitted, all fields will be included by default. Use dot-notation for both top-level resources and child resources, i.e. customers.name,dataCaptureResponses.answer. Can be used in conjunction with except providing both parameters don't reference the same resource.
A list of attributes that you wish to exclude from the payload. When empty or omitted, all fields will be included by default. Use dot-notation for both top-level resources and child resources, i.e. customers.name,dataCaptureResponses.answer. Can be used in conjunction with only providing both parameters don't reference the same resource.