list_shipments

list_shipments

Retrieve and filter shipment data from ShipStation API by creation date, ship date, order ID, recipient name, or page size. Sort results by specific fields for efficient order management.

Input Schema

Name	Required	Description
`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"
}

ShipStation API MCP Server

Input Schema

Input Schema (JSON Schema)

Other Tools from ShipStation API MCP Server

Related Tools