List shipments
cratejoy_list_shipmentsList shipments (id, customer_id, status, created_at, target_at, shipped_at, tracking_number, is_gift). Filter by status and creation range, or with filters. Relationships: customer, fulfillments, labels, ship_address, subscriptions. GET /v1/shipments/.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number, counting from 0 (default 0). Pass the previous reply's next_page. | |
| with | No | Relationships to embed: comma-separated names (e.g. 'customer,orders'), 'all', or an empty string for none. Omit it for the vendor default. | |
| limit | No | Results per page, 1-100 (default 25). | |
| status | No | Shipment status. | |
| filters | No | Extra Cratejoy filters as { '[relation.]property[__comparison]': value }. Comparisons: eq (default), ne, lt, le, gt, ge, like, ilike (% is the wildcard), in, nin (comma-separated), is_null. Status columns take integers. Example: { 'customer.email__like': '%@example.com' }. | |
| created_after | No | Only shipments created on or after this date/date-time. | |
| created_before | No | Only shipments created on or before this date/date-time. |