list_orders

Implementation Reference

• src/tools/order-tools.js:20-32 (handler)

  Handler function that executes the list_orders tool by calling shipStationClient.getOrders and formatting the response.

  handler: async (params) => {
    try {
      const orders = await shipStationClient.getOrders(params);
      return {
        content: [{ type: "text", text: JSON.stringify(orders, null, 2) }]
      };
    } catch (error) {
      return {
        content: [{ type: "text", text: error.message }],
        isError: true
      };
    }
  }

• src/tools/order-tools.js:8-19 (schema)

  Zod schema defining the input parameters for filtering, sorting, and paginating the list_orders tool.

  schema: {
    page: z.number().optional().describe("Page number"),
    pageSize: z.number().optional().describe("Number of orders per page (max 500)"),
    sortBy: z.string().optional().describe("Sort orders by a specific field"),
    sortDir: z.enum(["ASC", "DESC"]).optional().describe("Sort direction"),
    orderStatus: z.string().optional().describe("Filter by order status"),
    storeId: z.number().optional().describe("Filter by store ID"),
    createDateStart: z.string().optional().describe("Filter by creation date (start)"),
    createDateEnd: z.string().optional().describe("Filter by creation date (end)"),
    modifyDateStart: z.string().optional().describe("Filter by modification date (start)"),
    modifyDateEnd: z.string().optional().describe("Filter by modification date (end)")
  },

• src/server.js:174-191 (registration)

  Bulk registration of all tools including list_orders (from orderTools) to the MCP server via server.tool().

  [
    ...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:48-50 (helper)

  ShipStationClient.getOrders method used by the handler to make the actual API request to list orders.

  async getOrders(params) {
    return this.request('GET', '/orders', null, params);
  }