Skip to main content

What is Order Type?

An order type is the blueprint for orders: the list of steps, which task type each step uses, and how an order moves from one step to the next. Order types are versioned: you edit a draft, validate or simulate it, then publish it. These endpoints are served under /api/v4.

Key Features

Read order types

GET /order-types

Create order type

POST /order-type

Read order type by ID

GET /order-type/

Update order type

PUT /order-type/

Delete order type

DELETE /order-type/

Publish order type

PATCH /order-type//publish

Restore order type version

PUT /order-type//restore/

Simulate order type

POST /order-type//simulate

Read order type versions

GET /order-type-logs

Validate order type draft

POST /order-type-validate