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"
}