list_customers
Retrieve customer data from ShipStation with pagination, sorting, and filtering options to manage and analyze customer information.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| 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 | |
| name | No | Filter by customer name | |
| stateCode | No | Filter by state code | |
| countryCode | No | Filter by country code | |
| marketplaceId | No | Filter by marketplace ID |
Implementation Reference
- src/tools/customer-tools.js:18-30 (handler)The handler function for the 'list_customers' tool. It calls shipStationClient.getCustomers(params), stringifies the result as JSON, or returns an error message.handler: async (params) => { try { const customers = await shipStationClient.getCustomers(params); return { content: [{ type: "text", text: JSON.stringify(customers, null, 2) }] }; } catch (error) { return { content: [{ type: "text", text: error.message }], isError: true }; } }
- src/tools/customer-tools.js:8-17 (schema)Zod input schema defining optional parameters for filtering, sorting, and pagination of customers.schema: { page: z.number().optional().describe("Page number"), pageSize: z.number().optional().describe("Number of customers per page (max 500)"), sortBy: z.string().optional().describe("Sort customers by a specific field"), sortDir: z.enum(["ASC", "DESC"]).optional().describe("Sort direction"), name: z.string().optional().describe("Filter by customer name"), stateCode: z.string().optional().describe("Filter by state code"), countryCode: z.string().optional().describe("Filter by country code"), marketplaceId: z.number().optional().describe("Filter by marketplace ID") },
- src/server.js:174-191 (registration)Registration of all tools, including 'list_customers' from customerTools, using server.tool() in a loop.[ ...orderTools, ...shipmentTools, ...carrierTools, ...warehouseTools, ...productTools, ...customerTools, ...storeTools, ...webhookTools, ...fulfillmentTools ].forEach(tool => { server.tool( tool.name, tool.schema, tool.handler, { description: tool.description } ); });