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

Order - Get

cURL

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

200

[
  {
    "_id": "507f1f77bcf86cd799439011",
    "store_id": "507f1f77bcf86cd799439011",
    "order_number": "<string>",
    "status": "unstarted",
    "type": "manual",
    "items": [
      {}
    ],
    "log": [
      {
        "user_id": "507f1f77bcf86cd799439011",
        "action": "<string>",
        "time": "2025-01-15T12:00:00.000Z",
        "details": "<unknown>"
      }
    ],
    "scans": [
      {
        "_id": "507f1f77bcf86cd799439011",
        "user_id": "507f1f77bcf86cd799439011",
        "barcode_id": "<string>",
        "item_id": "<string>",
        "variant_id": "<string>",
        "time": "2025-01-15T12:00:00.000Z",
        "skipped": true,
        "out_of_stock": true,
        "note": "<string>",
        "quantity": 123,
        "deducted": true,
        "location_id": "<string>",
        "line_id": "<string>"
      }
    ],
    "fulfillments": [
      {
        "_id": "507f1f77bcf86cd799439011",
        "status": "<string>",
        "tracking_number": "<string>",
        "tracking_url": "<string>"
      }
    ],
    "transactions": [
      {
        "_id": "507f1f77bcf86cd799439011",
        "amount": 123,
        "kind": "<string>",
        "status": "<string>"
      }
    ],
    "returns": [
      {
        "_id": "507f1f77bcf86cd799439011",
        "rma_number": "<string>",
        "status": "<string>",
        "items": [
          {}
        ]
      }
    ],
    "notes": [
      {
        "_id": "507f1f77bcf86cd799439011",
        "user_id": "507f1f77bcf86cd799439011",
        "time": "2025-01-15T12:00:00.000Z",
        "note": "<string>",
        "type": "internal"
      }
    ],
    "tags": [
      "507f1f77bcf86cd799439011",
      "507f1f77bcf86cd799439012"
    ],
    "stash": {
      "store_id": "507f1f77bcf86cd799439011",
      "id": "<string>",
      "date": "2025-01-15",
      "items": [
        {
          "id": "<string>",
          "variant_id": "<string>",
          "lineName": "<string>",
          "quantity": 123,
          "price": 123,
          "sku": "<string>",
          "line_id": "<string>",
          "metadata": "<unknown>",
          "dropshipped": true
        }
      ],
      "shipping_information": {
        "name": "<string>",
        "email": "<string>",
        "address": "<string>",
        "street2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zip": "<string>",
        "country": "<string>",
        "phone": "<string>",
        "company": "<string>",
        "method": "<string>",
        "is_residential": true,
        "is_valid": true,
        "hash": "<string>",
        "address_type": "<string>",
        "address_validation_data": {}
      },
      "total": 123,
      "tax": 123,
      "shipping": 123,
      "discount": 123,
      "notes": "<string>",
      "alternate_order_id": "<string>",
      "order_id": "<string>",
      "currency": "<string>"
    },
    "location": "<string>",
    "batch_number": 123,
    "channel_status": "<string>"
  }
]

Authorizations

Authorization · string · header · required

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

Query Parameters

selector · object · required

Query selector object for filtering results

limit · number

Max results to return

Example:

50

skip · number

Number of results to skip

Example:

0

sort · object

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

fields · object

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

Response

200

application/json

Array of orders matching the query

_id · string

Unique order identifier

Example:

"507f1f77bcf86cd799439011"

store_id · string

Store identifier

Example:

"507f1f77bcf86cd799439011"

order_number · string

Order number

status · enum<string>

Order status

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

type · enum<string>

Order type

Available options: manual, combined, split, combined_child, split_parent

items · object[]

Cleared/scanned items array

log · object[]

Order log entries

Show child attributes

scans · object[]

Scan records

Show child attributes

fulfillments · object[]

Fulfillment records

Show child attributes

transactions · object[]

Transaction records

Show child attributes

returns · object[]

Returns

Show child attributes

notes · object[]

Order notes

Show child attributes

tags · string[]

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

Example:

[
  "507f1f77bcf86cd799439011",
  "507f1f77bcf86cd799439012"
]

stash · object

Channel data stash

Show child attributes

location · string

Assigned location name

batch_number · number | null

Batch number

channel_status · string | null

Channel-reported status