list_customers
Retrieve and filter customer data from ShipStation API by page, size, name, location, or marketplace ID. Sort results by specific fields and directions for efficient customer management.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| countryCode | No | Filter by country code | |
| marketplaceId | No | Filter by marketplace ID | |
| name | No | Filter by customer name | |
| page | No | Page number | |
| pageSize | No | Number of customers per page (max 500) | |
| sortBy | No | Sort customers by a specific field | |
| sortDir | No | Sort direction | |
| stateCode | No | Filter by state code |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"countryCode": {
"description": "Filter by country code",
"type": "string"
},
"marketplaceId": {
"description": "Filter by marketplace ID",
"type": "number"
},
"name": {
"description": "Filter by customer name",
"type": "string"
},
"page": {
"description": "Page number",
"type": "number"
},
"pageSize": {
"description": "Number of customers per page (max 500)",
"type": "number"
},
"sortBy": {
"description": "Sort customers by a specific field",
"type": "string"
},
"sortDir": {
"description": "Sort direction",
"enum": [
"ASC",
"DESC"
],
"type": "string"
},
"stateCode": {
"description": "Filter by state code",
"type": "string"
}
},
"type": "object"
}