Skip to main content
POST
Create an order from a route

Authorizations

X-API-Key
string
header
required

Organization-scoped API key. Create one in the BuildingSwell app under Organization settings, API keys.

Body

application/json
routeId
string<uuid>
required

Route to instantiate.

projectId
string<uuid>
required

Project the order belongs to.

name
string
required

Name for the new order.

identifier
string

Your own identifier. Generated as ORD- when you leave it out.

quantity
integer
default:1

How many the order covers.

dueDate
string<date-time>

When the order is due.

Response

The new order's context.

orderId
string<uuid>

The new order.

order
object

A deliverable as the concepts layer returns it: the node's own fields plus its resolved concept context.

rollup
object

Counts and flags rolled up across a whole tree.