v1

latestOpenAPI 3.1.02026-07-134488210.8 KB

Orders

Get Order

Retrieve an existing order from the system, including all fulfillments. The orderId parameter can be either the external order ID you provided when creating the order, or the internal Redo order ID returned from the create order response. Requires the orders_read scope.

get/stores/{storeId}/orders/{orderId}

Response

Success

orderIdstring required

Unique identifier for the order.

createdAtstring date-time required

ISO 8601 date string for when the order was created.

totalPricenumber nullable

Total order price including tax and shipping, as a decimal amount in the order's currency (e.g. $79.99, not 7999 cents).

subtotalPricenumber nullable

Subtotal price excluding tax and shipping, as a decimal amount in the order's currency (e.g. $79.99, not 7999 cents).

totalTaxnumber nullable

Total tax amount, as a decimal amount in the order's currency (e.g. $79.99, not 7999 cents).

totalDiscountnumber nullable

Total discount amount applied to the order (e.g. coupon codes, promotions), as a decimal amount in the order's currency (e.g. $79.99, not 7999 cents).

tagsstring[] nullable

Optional tags associated with the order.

currencyCodestring nullable

Currency code from the ISO 4217 standard (e.g., USD, EUR, GBP).

locationIdstring nullable

Optional. Pin this order to a specific fulfillment location. Must be a location id (loc_...) returned by GET /inventory-levels — either one of your own warehouses or a location at a linked 3PL fulfillment service. When provided, the fulfillment group's origin address is sourced from the location row. Omit to use your team's default origin address.

Example response

{
  "locationId": "loc_4d8e1a2b3c"
}