fulfillment-orders

Get a fulfillment order by id

Returns the fulfillment order detail scoped to the caller account: the fulfillment order header, its items and its status timeline (tracking events ordered chronologically by occurrence — creation, status changes, cancellation/rejection, each with actor, moment and any reason captured in metadata). Shipments and their tracking live on the nested shipments resource. accountCode comes from the JWT.

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

Path parameters

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

Fulfillment order identifier (UUID v4).

Response

The fulfillment order detail.

metadataobject nullable required
idstring required
order_idstring required
strategy_idstring nullable required
statusstring required
created_atstring required
updated_atstring required

Changes

Changed in 2 of the 9 revisions of this API.33

    • added the required property created_at to the response with the 200 status

      response-required-property-added

    • added the required property id to the response with the 200 status

      response-required-property-added

    • added the required property items/items/category to the response with the 200 status

      response-required-property-added

    • added the required property items/items/discount to the response with the 200 status

      response-required-property-added

    • added the required property items/items/name to the response with the 200 status

      response-required-property-added

    • added the required property items/items/quantity to the response with the 200 status

      response-required-property-added

    • added the required property items/items/sku to the response with the 200 status

      response-required-property-added

    • added the required property items/items/total_price to the response with the 200 status

      response-required-property-added

    • added the required property items/items/unit_price to the response with the 200 status

      response-required-property-added

    • added the required property order_id to the response with the 200 status

      response-required-property-added

    • added the required property shipments/items/carrier_id to the response with the 200 status

      response-required-property-added

    • added the required property shipments/items/created_at to the response with the 200 status

      response-required-property-added

    • added the required property shipments/items/delivered_at to the response with the 200 status

      response-required-property-added

    • added the required property shipments/items/dispatched_at to the response with the 200 status

      response-required-property-added

    • added the required property shipments/items/fulfillment_order_id to the response with the 200 status

      response-required-property-added

    • added the required property shipments/items/id to the response with the 200 status

      response-required-property-added

    • added the required property shipments/items/label to the response with the 200 status

      response-required-property-added

    • added the required property shipments/items/order_id to the response with the 200 status

      response-required-property-added

    • added the required property shipments/items/packages/items/label_url to the response with the 200 status

      response-required-property-added

    • added the required property shipments/items/packages/items/weight_kg to the response with the 200 status

      response-required-property-added

    • added the required property shipments/items/status to the response with the 200 status

      response-required-property-added

    • added the required property shipments/items/tracking_code to the response with the 200 status

      response-required-property-added

    • added the required property shipments/items/updated_at to the response with the 200 status

      response-required-property-added

    • added the required property status to the response with the 200 status

      response-required-property-added

    • added the required property strategy_id to the response with the 200 status

      response-required-property-added

    • added the required property timeline/items/id to the response with the 200 status

      response-required-property-added

    • added the required property timeline/items/new_status to the response with the 200 status

      response-required-property-added

    • added the required property timeline/items/occurred_at to the response with the 200 status

      response-required-property-added

    • added the required property timeline/items/previous_status to the response with the 200 status

      response-required-property-added

    • added the required property timeline/items/service_account_id to the response with the 200 status

      response-required-property-added

    • added the required property timeline/items/user_id to the response with the 200 status

      response-required-property-added

    • added the required property updated_at to the response with the 200 status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • endpoint added

      endpoint-added

    This revision also has 36 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog