Get an order by id

Returns the full order detail scoped to the caller account: header (id, external order id, channel, status, currency, creation), resolved customer, shipping/billing addresses, items (with metadata), mirrored payments, totals, the resolved state machine (id/code/name/version + transitions of the pinned version), the fulfillment orders block, and a unified chronological timeline that merges order status events, fulfillment order status events and shipment tracking events (each shipment event carries the resolved carrier and tracking code). An order that does not exist, is soft-deleted, or belongs to another account returns 404.

get/api/v1/orders/{id}

Path parameters

idstring uuid required

Example:01920000-0000-7000-8000-000000000000

Order identifier (UUID).

Response

The order detail.

metadataobject nullable required

idstring required

external_order_idstring required

requested_strategy_codestring nullable required

source_storestring nullable required

shipping_methodstring nullable required

currency'BRL' | 'USD' required

created_atstring required

updated_atstring required

Changes

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

Jul 7, 2026a3b4750a505f13See the full diff
- ○
  added the required property billing_address to the response with the 200 status
  response-required-property-added
- ○
  added the required property created_at to the response with the 200 status
  response-required-property-added
- ○
  added the required property currency to the response with the 200 status
  response-required-property-added
- ○
  added the required property external_order_id 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 to the response with the 200 status
  response-required-property-added
- ○
  added the required property payments to the response with the 200 status
  response-required-property-added
- ○
  added the required property requested_strategy_code to the response with the 200 status
  response-required-property-added
- ○
  added the required property shipping_address to the response with the 200 status
  response-required-property-added
- ○
  added the required property shipping_method to the response with the 200 status
  response-required-property-added
- ○
  added the required property source_store to the response with the 200 status
  response-required-property-added
- ○
  added the required property totals 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
Jul 7, 202684194c31ab851See the full diff
- ○
  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

Full history