Sign in

v1

latestOpenAPI 3.0.32026-07-13149852.3 MB
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

status'unstarted' | 'in_progress' | 'shipped' | 'cancelled' | 'cleared' | 'delayed' | 'stopped' | 'partially shipped' | 'archived' | 'awaiting fulfillment' | 'pending' | 'partially cleared' required

Order status

financial_status'pending' | 'paid'

Financial status

Example response

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