Sign in

v1

latestOpenAPI 3.0.32026-07-13149852.3 MB
order

Order - Get

Retrieve a paginated list of orders with optional filtering by status, store, tags, and date ranges. Maximum page size: 100 (Standard), 250 (Pro), 500 (Enterprise).

get/order/get

Query parameters

selectorobject required

Query selector object for filtering results

limitnumber

Max results to return

Example:50
skipnumber

Number of results to skip

sortobject

Sort fields object, e.g. { "name": 1 }

fieldsobject

Projection fields object, e.g. { "name": 1 }

Response

Array of orders matching the query

_idstring

Unique order identifier

store_idstring

Store identifier

order_numberstring

Order number

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

Order status

type'manual' | 'combined' | 'split' | 'combined_child' | 'split_parent'

Order type

itemsobject[]

Cleared/scanned items array

tagsstring[]

Array of tag IDs (ObjectId strings referencing the tag collection)

locationstring

Assigned location name

batch_numbernumber nullable

Batch number

channel_statusstring nullable

Channel-reported status

Example response

[
  {
    "_id": "507f1f77bcf86cd799439011",
    "store_id": "507f1f77bcf86cd799439011",
    "log": [
      {
        "user_id": "507f1f77bcf86cd799439011",
        "time": "2025-01-15T12:00:00.000Z"
      }
    ],
    "scans": [
      {
        "_id": "507f1f77bcf86cd799439011",
        "user_id": "507f1f77bcf86cd799439011",
        "time": "2025-01-15T12:00:00.000Z"
      }
    ],
    "fulfillments": [
      {
        "_id": "507f1f77bcf86cd799439011"
      }
    ],
    "transactions": [
      {
        "_id": "507f1f77bcf86cd799439011"
      }
    ],
    "returns": [
      {
        "_id": "507f1f77bcf86cd799439011"
      }
    ],
    "notes": [
      {
        "_id": "507f1f77bcf86cd799439011",
        "user_id": "507f1f77bcf86cd799439011",
        "time": "2025-01-15T12:00:00.000Z"
      }
    ],
    "tags": [
      "507f1f77bcf86cd799439011",
      "507f1f77bcf86cd799439012"
    ],
    "stash": {
      "store_id": "507f1f77bcf86cd799439011",
      "date": "2025-01-15"
    }
  }
]