order

Order - Get By Base Order Number

Look up orders by their base order number, which groups split and combined orders.

get/order/get_by_base_order_number

Query parameters

base_order_numberstring required

Base order number to search for

Example:ORD-1234

Response

Orders matching the base order number

_idstring required

Unique order identifier

order_numberstring required

Order number

Order status

financial_status'pending' | 'paid'

Financial status

Example response

[
  {
    "_id": "507f1f77bcf86cd799439011"
  }
]

Changes

Changed in 3 of the 13 revisions of this API.216

Mar 2, 2026fa53dd949b8e17See the full diff
- ▲
  the query request parameter base_order_number became required
  request-parameter-became-required
- ○
  api operation id get_order_get_by_base_order_number was added
  api-operation-id-added
- ○
  added the media type application/json for the response with the status 200
  response-media-type-added
- ○
  added the media type application/json for the response with the status 400
  response-media-type-added
- ○
  added the media type application/json for the response with the status 401
  response-media-type-added
- ○
  added the non-success response with the status 403
  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
Apr 22, 202408cd9cfa14dd2See the full diff
- ○
  added the non-success response with the status 400
  response-non-success-status-added
- ○
  added the non-success response with the status 401
  response-non-success-status-added
Apr 19, 202446ceda52800017See the full diff
- ▲
  removed the media type application/json for the response with the status 200
  response-media-type-removed
- ○
  api operation id get_order_get_by_base_order_number removed and replaced with
  api-operation-id-removed
- ○
  the query request parameter base_order_number became optional
  request-parameter-became-optional
- ○
  removed the non-success response with the status 400
  response-non-success-status-removed
- ○
  removed the non-success response with the status 401
  response-non-success-status-removed
- ○
  removed the non-success response with the status 403
  response-non-success-status-removed
- ○
  removed the non-success response with the status 429
  response-non-success-status-removed
- ○
  removed the non-success response with the status 500
  response-non-success-status-removed
This revision also has 85 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history