Retrieve customers
GET/customer/customers
Retrieves customers from the account. If no parameters are specified, all customers will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
For backfills, exports and reporting, the BigQuery SDK (JavaScript) reads customers from your UltraCart data warehouse in one query and returns the same Customer objects as this API, fully expanded, without REST rate limits. Its change log also keeps every version of each customer, including deletes, so you can sync only what changed: the REST API returns only the current version. See BigQuery SDK Quickstart.
Request
Responses
- 200
- 400
- 401
- 410
- 429
- 500
Successful response
Status Code 400: bad request input such as invalid json
Response Headers
Contains human readable error message
Status Code 401: invalid credentials supplied
Response Headers
Contains human readable error message
Status Code 410: Your authorized application has been disabled by UltraCart
Response Headers
Contains human readable error message
Status Code 429: you have exceeded the allowed API call rate limit for your application.
Response Headers
Contains human readable error message
Status Code 500: any server side error. the body will contain a generic server error message
Response Headers
Contains human readable error message