list_shipments
Retrieve shipment data from ShipBob's fulfillment API by filtering with order ID, date range, or pagination parameters for efficient tracking and management.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| endDate | No | End date for filtering (YYYY-MM-DD) | |
| limit | No | Number of shipments per page | |
| orderId | No | Filter by order ID | |
| page | No | Page number for pagination | |
| startDate | No | Start date for filtering (YYYY-MM-DD) |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"endDate": {
"description": "End date for filtering (YYYY-MM-DD)",
"type": "string"
},
"limit": {
"description": "Number of shipments per page",
"type": "number"
},
"orderId": {
"description": "Filter by order ID",
"type": "string"
},
"page": {
"description": "Page number for pagination",
"type": "number"
},
"startDate": {
"description": "Start date for filtering (YYYY-MM-DD)",
"type": "string"
}
},
"type": "object"
}