Orders
POST
/api/v3/ordersCreate 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)
orderNumberstringrequiredclientIdstring (uuid)nullableclientCodestringlocationIdstring (uuid)nullablelocationCodestringcustomerNamestringcustomerEmailstringnullablestatusenumplannedpending
priorityenumlownormalhighurgent
orderDatestringnullableshipBystringnullablereleaseAtstringnullablecarrierstringnullableservicestringnullableexternalRefstringnullablenotesstringnullablelinesobject[]
linesobject[]lineNointegerskustringrequiredqtyintegertotalItemsintegerResponses
201Created order
idstring (uuid)requiredorderNumberstringrequiredclientIdstring (uuid)requiredlocationIdstring (uuid)requiredstatusenumrequiredplannedpendingprocessingpickingpackingshippeddeliveredcancelled
priorityenumrequiredlownormalhighurgent
customerNamestringrequiredcustomerEmailstringrequiredtotalItemsnumberrequiredpickedItemsnumberrequiredlineCountnumberrequiredwaveIdstring (uuid)requiredcontainerIdstring (uuid)requiredorderDatestringrequiredshipBystringrequiredreleaseAtstringrequiredcarrierstringrequiredservicestringrequiredexternalRefstringrequiredskipWavebooleanrequiredprioritySwapCountnumberrequirednotesstringrequiredcreatedAtstringrequiredupdatedAtstringrequiredshippedAtstringrequired400Invalid order
errorstringrequiredSending requests from a browser
Open https://v3.revolutionstreetwxs.io/api/v3/docs to send requests to this endpoint with your API key.