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

source
string
required

Body

application/json

What an organization sets in a label template. The zones, their order and meaning, the sigil, the date format and the piece ID are not settings.

header
enum<string>
required

organization for the organization's name, or organization_site to add the site the labels are printed for.

Available options:
organization,
organization_site
tile_fallback
enum<string>
required

What the family tile shows for an item with no family. sku shows the first segment of its SKU, name the first letters of its name and text the tile_text.

Available options:
sku,
name,
text
source_detail
enum<string>
required

What the source zone shows under the supplier or line: record for what the record gives, supplier_lot, routing_revision or custom_field.

Available options:
record,
supplier_lot,
routing_revision,
custom_field
dpi
enum<integer>
required

The printer's resolution in dots per inch: 203 or 300.

Available options:
203,
300
tile_text
string | null

The tile's text, up to 6 characters. Required when tile_fallback is text.

Maximum string length: 6
date_kind
enum<string> | null

The fixed date that fills the date strip: expires, use_by, made, received or released. Null prints the date the record gives. When the record lacks it, the record's own date prints.

Available options:
expires,
use_by,
made,
received,
released
source_detail_field
string | null

The custom field to show, up to 64 characters. Required when source_detail is custom_field.

Maximum string length: 64
orientation
enum<string>

Previews only: portrait (the default) or landscape.

Available options:
portrait,
landscape

Response

LabelTemplateResource

data
LabelTemplateResource · object
required