v1

latestSwagger 2.02026-07-134272111.8 KB
customers

Find customers in the eCommerce system, using the provided CEQL search expression. If no search expression is provided, all records will be retrieved

get/customers

Query parameters

wherestring

The CEQL search expression, or the where clause, without the WHERE keyword, in a typical SQL query (i.e. field='value'). <p>Supported search terms: customer_id and customer_email. All other search criteria are ignored. NOTE: When searching by customer_id, do not quote the value (ex: customer_id=15693430), as the ID is a number rather than a string. When searching by email, quote the value (ex: customer_email='a@b.c'), as the email parameter is a string

pageSizeinteger

The number of results to fetch in a given page. When this parameter is omitted, a maximum of 200 results are returned

nextPagestring

The next page cursor, taken from the response header: elements-next-page-token

fieldsstring

The fields to return on the response. Can be a single field or a comma-separated list of fields

Headers

Authorizationstring required

The authorization tokens. The format for the header value is 'Element <token>, User <user secret>'

Response

OK - Everything worked as expected