Orders, filterable by scan state and retailer
GET
/v1/ordersAuth: Factory API key
Filter values: not_scanned, made (produced but not yet in stock), in_stock, dispatched, stuck (sitting produced/in stock past the factory's stuck_after_days, or partially dispatched), or all (default). q matches order number.
Query parameters
| Name | Type | Description |
|---|---|---|
retailer_id | string | · |
filter | string | · one of: "all", "not_scanned", "made", "in_stock", "dispatched", "stuck"default: "all" |
q | string | · |
limit | integer | · default: 100 |
offset | integer | · default: 0 |
Response
200
| Field | Type | Description |
|---|---|---|
orders | object[] | · |
id | string | · |
order_no | string | · |
status | string | · one of: "awaiting_production", "in_production", "produced", "in_stock", "partially_dispatched", "dispatched", "cancelled" |
production_date | string (date), nullable | · |
needed_by | string (date), nullable | · |
source | string | · one of: "upload", "api" |
created_at | string (date-time) | · |
produced_at | string (date-time), nullable | · |
in_stock_at | string (date-time), nullable | · |
dispatched_at | string (date-time), nullable | · |
retailer_id | string | · |
retailer_name | string | · |
retailer_code | string | · |
stuck | boolean | produced/in_stock for longer than the factory's stuck_after_days, or partially dispatched |
pieces_total | integer | · |
pieces_scanned | integer | · |
pieces_in_stock | integer | · |
pieces_dispatched | integer | · |
piece_states | string[] | · |
items | string | SKU + colour of every line, comma separated |
counts | object | · |
all | integer | · |
not_scanned | integer | · |
made | integer | · |
in_stock | integer | · |
dispatched | integer | · |
stuck | integer | · |
Code samples
curl "https://api.skuflo.io/v1/orders?retailer_id=ret_9c1a4e&filter=all" \
-H "Authorization: Bearer sk_live_..."