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 |