list_shipments
Retrieve and filter shipment data by creation date, order ID, or status. Manage pagination with limit and page options to efficiently access shipment details.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| created_after | No | Filter by creation date (YYYY-MM-DD) | |
| limit | No | Number of results per page | |
| order_id | No | Filter by order ID | |
| page | No | Page number for pagination | |
| status | No | Filter by shipment status |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"created_after": {
"description": "Filter by creation date (YYYY-MM-DD)",
"type": "string"
},
"limit": {
"description": "Number of results per page",
"type": "number"
},
"order_id": {
"description": "Filter by order ID",
"type": "string"
},
"page": {
"description": "Page number for pagination",
"type": "number"
},
"status": {
"description": "Filter by shipment status",
"type": "string"
}
},
"type": "object"
}