KRkruzer-corp
orders

Get an order by id

Changed on

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}

Request

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

  • a3b4750a505fRevision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 84194c31ab85Revision changes
    • info

      endpoint added