Skip to content
Developersskuflo.iov1Changelog

Import order lines as JSON

POST/v1/orders/importFactory API keyBase URL api.skuflo.io

The main integration point: push a retailer's order as lines and Skuflo creates the order, its pieces and their labels. Lines are grouped into orders by order_no. A line with no order_no but a po_number joins every other line with that PO number, and all of them become ONE order with an automatic number (your label prefix and a running number, for example OAK 1043) carrying the PO. Leave retailer_id out for your own stock and trade orders. on_duplicate controls a repeated (order_no, sku, colour): error (default) reports it and saves nothing, skip ignores just that line, allow adds it as extra units. pieces per line falls back to the SKU's configured piece count (Settings, SKU pieces), then 1; a line with neither comes back in unknown_skus. Every line needs a product_type from your list (Settings, Product types); a line that leaves it out takes its SKU's product type. Orders go into To schedule unless you give production_date. Responds 422 with { error, errors: [...] } and saves nothing if any line fails validation.

Try it now

Body parameters#

NameTypeDescription
retailer_idoptionalstring·
production_dateoptionalstring·
on_duplicateoptionalstring·
One of "error", "skip", "allow"
Default "error"
linesrequiredobject[]·
order_nooptionalstring, nullable·
po_numberoptionalstring, nullable·
postcodeoptionalstring, nullabledelivery postcode of the order
skurequiredstring·
colouroptionalstring, nullable·
descriptionoptionalstring, nullable·
product_typeoptionalstring, nullable·
qtyrequiredinteger·
piecesoptionalinteger, nullable·

Responses#

StatusMeaning
201Created. The new record is in the body.
422The request body failed validation. Nothing was saved.

Other errors#

StatusMeaning
401No key, or the key is not recognised.
402billing_required. Reading always works, but this is a write and stops once a trial ends or a plan is cancelled.
403The key is valid but its role cannot do this.
422The body failed validation. The response lists every problem at once.
429More than 600 requests a minute. Wait retry-after seconds.