Retrieve a list of shipments.
This is for detailed shipment objects.
"DO NOT include cancelled shipments in response unless user explicitly asks"
** USE THIS TOOL FOR:**
- Retrieving detailed shipment information for specific shipments (by ID, tracking number, etc.)
- Getting full shipment objects with all details
- Filtering shipments by specific criteria (state, courier, etc.) when you need the full shipment objects
- When you need individual shipment details, not aggregated analytics
** DO NOT USE THIS TOOL FOR:**
- Analytics queries -> Use analytics tools instead
Required authorization scope: `public.shipment:read`
Args:
page: Page number to fetch, default: `1`
per_page: Number of records per page to fetch, default: `20`
label_state: Filter by label status. Valid values: "not_created", "pending", "generating", "generated", "printed", "failed", "technical_failed", "reported".
pickup_state: Filter by pickup status. Valid values: "not_requested", "pending_confirmation", "pending_drop_off", "request_failed", "requested", "completed", "cancelled".
created_at_to: Search for shipments created before this date: ISO8601 date format.
updated_at_to: Search for shipments updated before this date: ISO8601 date format.
delivery_state: Filter by delivery status. Valid values: "not_created", "pending", "info_received", "in_transit_to_customer", "out_for_delivery", "delivered", "failed_attempt", "exception", "expired", "lost_by_courier", "returned_to_shipper".
shipment_state: Filter by shipment status. Valid values: "created", "cancelled".
created_at_from: Search for shipments created since this date: ISO8601 date format.
updated_at_from: Search for shipments updated since this date: ISO8601 date format.
warehouse_state: For eFulfilment only. Valid values: "pending", "created", "packed", "shipped".
label_paid_at_to: Search for shipments where the labels were paid for before this date: ISO8601 date format.
label_paid_at_from: Search for shipments where the labels were paid for since this date: ISO8601 date format.
easyship_shipment_id: Easyship Shipment ID provided when creating the shipment.
label_generated_at_to: Search for labels generated before this date: ISO8601 date format.
origin_country_alpha2: Search by the shipment origin country code: Alpha-2 format (ISO 3166-1).
platform_order_number: Order number on the sales platform.
label_generated_at_from: Search for labels generated since this date: ISO8601 date format.
destination_country_alpha2: Search by shipment destination country code: Alpha-2 format (ISO 3166-1).
return_shipment: Search by shipment whether the shipment is return shipment or not.
Returns:
A paginated list of shipment objects matching the filter criteria.