Skip to main content
PUT
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Path Parameters

build
string
required

Body

application/json

What a build makes, how many, where and by when, and how urgent it is.

item
string
required

The item to build: its id or SKU. Releasing the build needs a released BOM for it.

Maximum string length: 64
quantity
string
required

How many to build, in the item's base unit: an exact decimal above zero.

Pattern: ^(?!0+(\.0+)?$)\d{1,20}(\.\d{1,20})?$
location
string
required

The id of the active stock location it is built at.

Maximum string length: 64
due_on
string<date> | null

When it is due, as Y-m-d.

note
string | null
Maximum string length: 2000
priority
enum<string> | null

Which build goes first when builds due the same day share a work center: high, normal (the default) or low.

Available options:
high,
normal,
low

Response

BuildResource

data
BuildResource · object
required