order

Order - Get By Base Order Number

Changed on

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

get/order/get_by_base_order_number

Request

  • Base URL
    https://api.skulabs.com
  • URL
    https://api.skulabs.com/order/get_by_base_order_number
  • Auth
    HTTP bearer

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"
  }
]

Changes

  • fa53dd949b8eRevision changes
    • breaking

      the query request parameter base_order_number became required

    • info

      api operation id get_order_get_by_base_order_number was added

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 08cd9cfa14ddRevision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status