list_shipments
Retrieve filtered and sorted shipment data from ShipStation API, including pagination options, recipient details, and date ranges for creation or shipping.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| createDateEnd | No | Filter by creation date (end) | |
| createDateStart | No | Filter by creation date (start) | |
| orderId | No | Filter by order ID | |
| page | No | Page number | |
| pageSize | No | Number of shipments per page (max 500) | |
| recipientName | No | Filter by recipient name | |
| shipDateEnd | No | Filter by ship date (end) | |
| shipDateStart | No | Filter by ship date (start) | |
| sortBy | No | Sort shipments by a specific field | |
| sortDir | No | Sort direction |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"createDateEnd": {
"description": "Filter by creation date (end)",
"type": "string"
},
"createDateStart": {
"description": "Filter by creation date (start)",
"type": "string"
},
"orderId": {
"description": "Filter by order ID",
"type": "number"
},
"page": {
"description": "Page number",
"type": "number"
},
"pageSize": {
"description": "Number of shipments per page (max 500)",
"type": "number"
},
"recipientName": {
"description": "Filter by recipient name",
"type": "string"
},
"shipDateEnd": {
"description": "Filter by ship date (end)",
"type": "string"
},
"shipDateStart": {
"description": "Filter by ship date (start)",
"type": "string"
},
"sortBy": {
"description": "Sort shipments by a specific field",
"type": "string"
},
"sortDir": {
"description": "Sort direction",
"enum": [
"ASC",
"DESC"
],
"type": "string"
}
},
"type": "object"
}
Implementation Reference
- src/tools/shipment-tools.js:20-32 (handler)The handler function for the 'list_shipments' MCP tool. It invokes the ShipStation API client to fetch shipments based on provided parameters and returns formatted JSON response or error.handler: async (params) => { try { const shipments = await shipStationClient.getShipments(params); return { content: [{ type: "text", text: JSON.stringify(shipments, null, 2) }] }; } catch (error) { return { content: [{ type: "text", text: error.message }], isError: true }; } }
- src/tools/shipment-tools.js:8-19 (schema)Input schema using Zod for validating parameters to the 'list_shipments' tool, including pagination, sorting, and filtering options.schema: { page: z.number().optional().describe("Page number"), pageSize: z.number().optional().describe("Number of shipments per page (max 500)"), sortBy: z.string().optional().describe("Sort shipments by a specific field"), sortDir: z.enum(["ASC", "DESC"]).optional().describe("Sort direction"), recipientName: z.string().optional().describe("Filter by recipient name"), createDateStart: z.string().optional().describe("Filter by creation date (start)"), createDateEnd: z.string().optional().describe("Filter by creation date (end)"), shipDateStart: z.string().optional().describe("Filter by ship date (start)"), shipDateEnd: z.string().optional().describe("Filter by ship date (end)"), orderId: z.number().optional().describe("Filter by order ID") },
- src/server.js:173-191 (registration)Bulk registration of all ShipStation tools, including 'list_shipments' from shipmentTools array, using the MCP server's tool() method.// Register all tools [ ...orderTools, ...shipmentTools, ...carrierTools, ...warehouseTools, ...productTools, ...customerTools, ...storeTools, ...webhookTools, ...fulfillmentTools ].forEach(tool => { server.tool( tool.name, tool.schema, tool.handler, { description: tool.description } ); });
- src/api-client.js:85-87 (helper)ShipStationClient helper method that makes the API GET request to /shipments endpoint with query parameters, used by the tool handler.async getShipments(params) { return this.request('GET', '/shipments', null, params); }