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

The labels to print for a build.

serials
string[]

The output's serial numbers, one per unit made. A completed build's own are used when this and the lot are left out.

Maximum array length: 250
Maximum string length: 64
lot
string | null

The output's lot, for a lot-tracked item.

Maximum string length: 64
carton_quantity
string | null

What a carton of the lot holds, in the item's base unit. The whole output is one carton when left out.

Pattern: ^(?!0+(\.0+)?$)\d{1,20}(\.\d{1,20})?$
orientation
enum<string> | null

portrait or landscape.

Available options:
portrait,
landscape

Response

The labels as a PDF, a page a piece.

The response is of type file.