Search for customers

Retrieve customer information by the given parameter(s). See customer object definition for parameter details. The results are ordered by lastName then firstName. Each customer object will contain an additional property, customerCount, which can be used in combination with the pageNumber and pageSize query params to paginate results.

📘

This endpoint requires a POST request despite the fact that it does not modify or create any data. This is to prevent sensitive data (such as taxId) from possibly being stored in any HTTP logs.

Error Codes

Click to expand

Code

Message (en-US)

Notes

1-60000

Any "Common Error Code" may occur.

See Common Error Codes

60401

At least one field must be specified when performing a search.

Language
Authentication
Basic
base64
:
URL
Click Try It! to start a request and see the response here!