Retailer orders

Called with warehouse account keys. A key only sees its own account's data. Every example uses the same sample brand, order and item, so you can follow one item from call to call.

Base URL http://62.169.23.239:8001/api/v1Auth Bearer token1 endpoints

Endpoints

GET/warehouse/backordersList retailer orders

List retailer orders#

GET/warehouse/backorders

Requires scope warehouse_orders:read

Retailer orders waiting on stock, in the order they will be filled.

Watch for unpack_suggested: those orders are waiting on a sealed box that is already here, so opening it settles them straight away.

Parameters

limitintegerquery
Defaults to 100
offsetintegerquery
Defaults to 0

Returns

HTTP 200

itemsarray of objects
The objects on this page.
+Show 26 child attributesHide child attributes
- backorder_idstringRequired
- retail_idstringRequired
  The shop (retail account) id.
- brand_idstringRequired
  The brand that owns the product.
- warehouse_idstring | null
  The warehouse account id.
- product_idstringRequired
  Skannit's id for the product.
- product_namestring
  Defaults to —
- skustringRequired
  Stock-keeping unit of the variant.
- colorstring | null
  Colour name, exactly as on the product's variants.
- sizestring | null
  Size name, exactly as on the product's variants.
- quantityinteger
  Number of units.
  Defaults to 0
- statusstringRequired
  Current state of the object. See the allowed values.
  One ofpendingallocatedfulfilledcancelledexpired
- shortage_kindstring | null
  Why the order waits: stock is ready elsewhere, in production, or must be produced.
  One ofreadysealed_onlyin_transit_airin_transit_seain_factory_queuenot_in_pipeline
- pipeline_sourcestring | null
  One ofin_transit_airin_transit_seain_factory_queue
- pipeline_order_idstring | null
- eta_datedate | null
- brand_notified_attimestamp | null
- placed_attimestamp | null
- fulfilled_attimestamp | null
- cancelled_attimestamp | null
- cancel_reasonstring | null
- retail_namestring
  Defaults to —
- display_skustring
  Defaults to —
- unpack_suggestedboolean
  Defaults to false
- candidate_box_idsarray of strings
- loose_availableinteger
  Loose units left for this order after older orders are served.
  Defaults to 0
- sealed_availableinteger
  Sealed-box units left for this order after older orders are served.
  Defaults to 0
totalinteger
Total count.
Defaults to 0

GET /warehouse/backorders

curl

curl http://62.169.23.239:8001/api/v1/warehouse/backorders \
  -H "Authorization: Bearer $SKANNIT_TOKEN"

200Response

json

{
  "items": [
    {
      "backorder_id": "aae4bc0a-57f9-5c01-bc81-d47bdbd8232a",
      "retail_id": "4974bf7c-8314-5bb9-9f74-8c1497523eb5",
      "brand_id": "8ea3462c-426c-5cc1-84d7-db99868bca1c",
      "warehouse_id": "8bf28967-062b-532f-868c-afdf343630c2",
      "product_id": "f6abe715-90aa-5908-a0a6-12951a3a21cc",
      "product_name": "Trail Tee",
      "sku": "TT-100-WHT-M",
      "color": "White",
      "size": "M",
      "quantity": 1,
      "status": "pending",
      "shortage_kind": "ready",
      "pipeline_source": "in_transit_air",
      "pipeline_order_id": "1240b15f-cc3f-5bc4-8437-1c94c2d720c5",
      "eta_date": "2026-11-20",
      "brand_notified_at": null,
      "placed_at": null,
      "fulfilled_at": null,
      "cancelled_at": null,
      "cancel_reason": null,
      "retail_name": "Northwind Amsterdam",
      "display_sku": "TT-100-WHT-M",
      "unpack_suggested": false,
      "candidate_box_ids": [
        "77ac7ecf-0cda-5b6f-b35c-c399cc2e8641"
      ],
      "loose_available": 1,
      "sealed_available": 1
    }
  ],
  "total": 1
}

NextShipping to shops→