Sign in

v9

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-071292691.1 MB
fulfillment-order-shipments

Get a fulfillment order shipment by id

Returns the shipment detail scoped to the caller account and parent fulfillment order: header, packages and its tracking timeline (events ordered chronologically by occurrence).

get/api/v1/fulfillment-orders/{fulfillmentOrderId}/shipments/{id}

Path parameters

fulfillmentOrderIdstring uuid required
Example:01920000-0000-7000-8000-000000000000

Parent fulfillment order identifier (UUID v4).

idstring uuid required
Example:01920000-0000-7000-8000-000000000000

Fulfillment order shipment identifier (UUID v4).

Response

The fulfillment order shipment detail.

metadataobject nullable required
idstring required
fulfillment_order_idstring required
order_idstring required
carrier_idstring required
status'SHIPMENT_CREATED' | 'DISPATCHED' | 'IN_TRANSIT' | 'OUT_FOR_DELIVERY' | 'DELIVERED' | 'DELIVERY_FAILED' | 'RETURNED' | 'LOST' | 'LABEL_CREATED' | 'AWAITING_PICKUP' | 'IN_TRANSFER' required
tracking_codestring nullable required
labelstring nullable required
dispatched_atstring nullable required
delivered_atstring nullable required
created_atstring required
updated_atstring required