Skip to content
Developersskuflo.iov1Changelog

One order with every piece and its scan history

GET/v1/orders/{id}Factory API keyBase URL api.skuflo.io
Try it now

Path parameters#

NameTypeDescription
idrequiredstring (uuid)·

Responses#

StatusMeaning
200Success. An example body is in the column on the right.

Response fields

NameTypeDescription
idstring·
order_nostring·
po_numberstring, nullablethe retailer's purchase order number, when they gave one
statusstringpending_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_atstring (date-time), nullablewhen the factory marked the order as processed (sent into production)
rejection_reasonstring, nullable·
production_datestring (date), nullable·
needed_bystring (date), nullable·
sourcestring·
One of "upload", "api", "portal", "manual"
created_atstring (date-time)·
produced_atstring (date-time), nullable·
in_stock_atstring (date-time), nullable·
dispatched_atstring (date-time), nullable·
retailer_idstring·
retailer_namestring·
retailer_codestring·
stuckbooleanproduced/in_stock for longer than the factory's stuck_after_days, or partially dispatched
pieces_totalinteger·
pieces_scannedinteger·
pieces_in_stockinteger·
pieces_dispatchedinteger·
piece_statesstring[]·
itemsstringSKU + colour of every line, comma separated
piecesobject[]·
idstring·
barcodestringThe label barcode as your scanner reads it. Send it raw: control characters, symbology prefixes and our QR link are cleaned up for you.
unit_nointeger·
piece_nointeger·
piece_namestring, nullable·
statusstring·
locationstring, nullable·
produced_atstring (date-time), nullable·
in_stock_atstring (date-time), nullable·
dispatched_atstring (date-time), nullable·
label_printed_atstring (date-time), nullable·
skustring·
colourstring, nullable·
qtyinteger·
pieces_per_unitinteger·
descriptionstring, nullable·
product_typestring, nullable·
scansobject[]·
eventstring·
acceptedboolean·
reasonstring, nullable·
locationstring, nullable·
stationstring·
atstring (date-time)·

Other errors#

StatusMeaning
401No key, or the key is not recognised.
404Nothing with that id in your factory.
429More than 600 requests a minute. Wait retry-after seconds.