ShipStation API MCP Server

list_customers

Retrieve and filter customer data from ShipStation API by country code, marketplace ID, name, or state code, with options to sort, paginate, and control page size for efficient customer management.

Input Schema

NameRequiredDescriptionDefault
countryCodeNoFilter by country code
marketplaceIdNoFilter by marketplace ID
nameNoFilter by customer name
pageNoPage number
pageSizeNoNumber of customers per page (max 500)
sortByNoSort customers by a specific field
sortDirNoSort direction
stateCodeNoFilter 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" }
ID: gf5s1mfe76