Orders, filterable by scan state and retailer
GET
/v1/ordersFactory API keyBase URL api.skuflo.ioFilter 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_idoptional | string | · |
filteroptional | string | · One of "all", "not_scanned", "made", "in_stock", "dispatched", "stuck", "review", "rejected"Default "all" |
qoptional | string | · |
limitoptional | integer | · Default 100 |
offsetoptional | integer | · Default 0 |
sortoptional | string | Column to sort by (newest first when left out) One of "created_at", "order_no", "po_number", "retailer", "production_date", "needed_by", "status", "pieces", "units", "last_scan_at", "first_scan_at", "produced_at", "in_stock_at", "dispatched_at", "processed_at", "labels_printed" |
diroptional | string | · One of "asc", "desc"Default "desc" |
Responses#
| Status | Meaning |
|---|---|
| 200 | Success. An example body is in the column on the right. |
Response fields
| Name | Type | Description |
|---|---|---|
orders | object[] | · |
id | string | · |
order_no | string | · |
po_number | string, nullable | the retailer's purchase order number, when they gave one |
status | string | pending_review is an order a retailer sent that you have not accepted yet: it is not on the production list. rejected was turned down (see rejection_reason).One of "pending_review", "rejected", "awaiting_production", "in_production", "produced", "in_stock", "partially_dispatched", "dispatched", "cancelled" |
processed_at | string (date-time), nullable | when the factory marked the order as processed (sent into production) |
rejection_reason | string, nullable | · |
production_date | string (date), nullable | · |
needed_by | string (date), nullable | · |
source | string | · One of "upload", "api", "portal", "manual" |
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 | · |
review | integer | · |
rejected | integer | · |
total | integer | Orders matching the filter, retailer and search, over every page |