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

Order - Get By Base Order Number

cURL

curl --request GET \
  --url https://api.skulabs.com/order/get_by_base_order_number \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "_id": "507f1f77bcf86cd799439011",
    "order_number": "<string>",
    "status": "unstarted",
    "financial_status": "pending"
  }
]

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

base_order_number · string · required

Base order number to search for

Example:

"ORD-1234"

Response

200

application/json

Orders matching the base order number

_id · string · required

Unique order identifier

Example:

"507f1f77bcf86cd799439011"

order_number · string · required

Order number

status · enum<string> · required

Order status

Available options: unstarted, in_progress, shipped, cancelled, cleared, delayed, stopped, partially shipped, archived, awaiting fulfillment, pending, partially cleared

financial_status · enum<string>

Financial status

Available options: pending, paid