customers
List customers
Obtains a list of customers that match the specified criteria
get/customers
Query parameters
stateCodestring
Returns customers that reside in the specified stateCode
countryCodestring
Returns customers that reside in the specified countryCode (two-letter ISO)
marketplaceIdinteger
Returns customers that purchased from the specified marketplaceId
tagIdinteger
Returns customers that have been tagged with the specified tagId
sortBy'Name' | 'ModifyDate' | 'CreateDate'
Sorts the order of the response
sortDir'ASC' | 'DESC'
Sort direction
pageinteger
Page number
pageSizeinteger
Number of results per page. Maximum 500.
Response
List of customers retrieved successfully
Example response
{
"customers": [
{
"customerId": 12345678,
"name": "Cam Newton",
"company": "Test Company",
"email": "supermancam@example.com",
"phone": "555-555-5555",
"city": "Auburn",
"state": "AL",
"countryCode": "US"
}
]
}