Order

Get order

Get the order with the given ID.

get/order/{id}

Path parameters

idstring required

ID of the order to get.

Example:ord_XXXXXXXXXXXXXXXXXXXXXXXXX

Response

Order information.

Example response

{
  "data": {
    "id": "ord_XXXXXXXXXXXXXXXXXXXXXXXXX",
    "index": 0,
    "shipping": {
      "name": "John Doe",
      "street1": "123 Main St",
      "street2": "Apt 1",
      "city": "Anytown",
      "province": "CA",
      "zip": "12345",
      "country": "US",
      "phone": "5555555555"
    },
    "amount": {
      "subtotal": 4400,
      "shipping": 800
    },
    "created": "2024-06-29T19:36:19.000Z",
    "tracking": {
      "service": "USPS Ground Advantage",
      "number": "92346903470167000000000019",
      "url": "https://tools.usps.com/go/TrackConfirmAction_input?origTrackNum=92346903470167000000000019",
      "status": "DELIVERED",
      "statusDetails": "Your shipment has been delivered.",
      "statusUpdatedAt": "2025-04-08T12:00:00.000Z"
    },
    "items": [
      {
        "id": "itm_XXXXXXXXXXXXXXXXXXXXXXXXX",
        "amount": 4400,
        "quantity": 2,
        "productVariantID": "var_XXXXXXXXXXXXXXXXXXXXXXXXX"
      }
    ]
  }
}

Changes

Changed in 9 of the 41 revisions of this API.10645

Apr 24, 2025128873249a646See the full diff
- ●
  added the new DELIVERED enum value to the data/allOf[Order]/tracking/status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new FAILURE enum value to the data/allOf[Order]/tracking/status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new PRE_TRANSIT enum value to the data/allOf[Order]/tracking/status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new RETURNED enum value to the data/allOf[Order]/tracking/status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new TRANSIT enum value to the data/allOf[Order]/tracking/status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new UNKNOWN enum value to the data/allOf[Order]/tracking/status response property for the response status 200
  response-property-enum-value-added
Apr 14, 202558fa4af8e3251See the full diff
- ○
  added the required property data/allOf[Order]/created to the response with the 200 status
  response-required-property-added
Apr 9, 2025d02e3d898e583See the full diff
- ○
  added the optional property data/allOf[Order]/tracking/status to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property data/allOf[Order]/tracking/statusDetails to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property data/allOf[Order]/tracking/statusUpdatedAt to the response with the 200 status
  response-optional-property-added
Mar 19, 20251c6726b12e29424See the full diff
- ▲
  the response's body type/format changed from / to object/ for status 401
  response-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 404
  response-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 429
  response-body-type-changed
- ▲
  the response's body type/format changed from / to object/ for status 500
  response-body-type-changed
- ○
  removed ErrorResponse from the response body allOf list for the response status 401
  response-body-all-of-removed
- ○
  removed ErrorResponse from the response body allOf list for the response status 404
  response-body-all-of-removed
- ○
  removed ErrorResponse from the response body allOf list for the response status 429
  response-body-all-of-removed
- ○
  removed ErrorResponse from the response body allOf list for the response status 500
  response-body-all-of-removed
- ○
  added the optional property details to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property details to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property details to the response with the 429 status
  response-optional-property-added
- ○
  added the optional property details to the response with the 500 status
  response-optional-property-added
- ○
  added the optional property param to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property param to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property param to the response with the 429 status
  response-optional-property-added
- ○
  added the optional property param to the response with the 500 status
  response-optional-property-added
- ○
  added the required property code to the response with the 401 status
  response-required-property-added
- ○
  added the required property code to the response with the 404 status
  response-required-property-added
- ○
  added the required property code to the response with the 429 status
  response-required-property-added
- ○
  added the required property code to the response with the 500 status
  response-required-property-added
- ○
  added the required property message to the response with the 401 status
  response-required-property-added
- ○
  added the required property message to the response with the 404 status
  response-required-property-added
- ○
  added the required property message to the response with the 429 status
  response-required-property-added
- ○
  added the required property message to the response with the 500 status
  response-required-property-added
- ○
  added the required property type to the response with the 401 status
  response-required-property-added
- ○
  added the required property type to the response with the 404 status
  response-required-property-added
- ○
  added the required property type to the response with the 429 status
  response-required-property-added
- ○
  added the required property type to the response with the 500 status
  response-required-property-added
Mar 7, 2025979a6c40552c24See the full diff
- ▲
  the response's body type/format changed from object/ to / for status 404
  response-body-type-changed
- ▲
  removed the required property error from the response with the 404 status
  response-required-property-removed
- ○
  added ErrorResponse to the response body allOf list for the response status 404
  response-body-all-of-added
- ○
  added the non-success response with the status 401
  response-non-success-status-added
- ○
  added the non-success response with the status 429
  response-non-success-status-added
- ○
  added the non-success response with the status 500
  response-non-success-status-added
Dec 16, 202456a8a6f18e6c1See the full diff
- ○
  endpoint added
  endpoint-added
Dec 16, 2024021e5a9aa9e21See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
Dec 13, 2024916cf9100f6819See the full diff
- ▲
  the data/allOf[Order]/shipping response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ○
  added the optional property data/allOf[Order]/shipping/phone to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property data/allOf[Order]/shipping/province to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property data/allOf[Order]/shipping/street2 to the response with the 200 status
  response-optional-property-added
- ○
  removed Address from the data/allOf[Order]/shipping response property allOf list for the response status 200
  response-property-all-of-removed
- ○
  added the required property data/allOf[Order]/shipping/city to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/allOf[Order]/shipping/country to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/allOf[Order]/shipping/name to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/allOf[Order]/shipping/street1 to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/allOf[Order]/shipping/zip to the response with the 200 status
  response-required-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Dec 13, 202443ff7af31b1e23See the full diff
- ▲
  added the new path request parameter id
  new-request-path-parameter
- ▲
  removed the required property result from the response with the 200 status
  response-required-property-removed
- ○
  api operation id getOrderById was added
  api-operation-id-added
- ○
  api tag Orders added
  api-tag-added
- ○
  added the required property data to the response with the 200 status
  response-required-property-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history