Docs
Open Revolution St
Orders
POST/api/v3/orders

Create an order

Creates one order with its lines. Client and location are referenced by code. status is planned for orders that are known but not yet actionable (tomorrow's work), pending for orders to wave now. Lines are the SKUs on the order; when present they set the unit and line counts. Fails if the order number already exists; use POST /orders/batch for idempotent re-sends. Wave business rules run on every API create and may override status or priority or mark the order to skip automatic waving.

Request body (optional)

orderNumberstringrequired
clientIdstring (uuid)nullable
clientCodestring
locationIdstring (uuid)nullable
locationCodestring
customerNamestring
customerEmailstringnullable
statusenum

plannedpending

priorityenum

lownormalhighurgent

orderDatestringnullable
shipBystringnullable
releaseAtstringnullable
carrierstringnullable
servicestringnullable
externalRefstringnullable
notesstringnullable
linesobject[]
lineNointeger
skustringrequired
qtyinteger
totalItemsinteger

Responses

201Created order
idstring (uuid)required
orderNumberstringrequired
clientIdstring (uuid)required
locationIdstring (uuid)required
statusenumrequired

plannedpendingprocessingpickingpackingshippeddeliveredcancelled

priorityenumrequired

lownormalhighurgent

customerNamestringrequired
customerEmailstringrequired
totalItemsnumberrequired
pickedItemsnumberrequired
lineCountnumberrequired
waveIdstring (uuid)required
containerIdstring (uuid)required
orderDatestringrequired
shipBystringrequired
releaseAtstringrequired
carrierstringrequired
servicestringrequired
externalRefstringrequired
skipWavebooleanrequired
prioritySwapCountnumberrequired
notesstringrequired
createdAtstringrequired
updatedAtstringrequired
shippedAtstringrequired
400Invalid order
errorstringrequired

Sending requests from a browser

Open https://v3.revolutionstreetwxs.io/api/v3/docs to send requests to this endpoint with your API key.

esc