Skip to main content

What is Order?

An order is a customer request that moves through the steps of its order type, for example receive, pick, deliver. Each step can create tasks, wait for a status, or call another system. These endpoints are served under /api/v4 and need the Order Management add-on.

Key Features

Read orders

GET /orders

Create order

POST /order

Read order by ID

GET /order/

Update order

PUT /order/

Delete order

DELETE /order/

Cancel order

PUT /order//cancel

Change order status

PUT /order//status

Read order history

GET /order//history

Read order step log

GET /order//step-log

Resolve order attention

POST /order//attention/resolve

Retry order attention

POST /order//attention/retry

Create orders in bulk

POST /orders/bulk

Export orders

POST /orders/export

Read order export

GET /orders/export/

Validate order import

POST /orders/import/validate

Commit order import

POST /orders/import/commit

Read order import

GET /orders/import/

Read active step options

GET /order-type//active-step-options