Skip to main content
POST
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

A build to complete, with what its output is tracked by.

lot
string | null

The output's lot, needed for a lot-tracked item. A new lot is created.

Maximum string length: 255
lot_expires_on
string<date> | null

When the output's lot expires, as Y-m-d.

serials
string[]

The output's serial numbers, one per unit made, needed for a serial-tracked item.

Maximum array length: 1000
Maximum string length: 255
as_recorded
boolean

The steps recorded were the whole of it, so nothing more is issued. Each line that used less than its parts list then says why.

reasons
(string | null)[]

Why a line used less than its parts list, by the line's id, when completing as recorded.

Maximum string length: 255

With recorded consumption, which lots and serial numbers the build used went into which output units. What no link names is spread evenly over the output.

Maximum array length: 1000

Response

BuildResource

data
BuildResource · object
required