Search for customers
GET/customer/customers/search
Retrieves customers from the account by matching the search value against most customer fields. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination. This search also goes against the cache so updates should not be performed with these result objects. Always re-query the individual customer profile if you are going to make updates.
This call serves interactive customer search. Results come from a cache, so do not update customers from them: fetch the customer profile again first. For exports or bulk reads, use Retrieve customers by query or the BigQuery SDK.
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