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

item
string
required

Body

application/json

A barcode for an item, optionally for one of its units.

code
string
required

The code as scanned. GTINs are digits whose last is the check digit.

Maximum string length: 512
symbology
enum<string>
required

How a barcode is printed. GTINs are digits with a check digit; Code 128 is printable ASCII; QR holds any text.

Available options:
gtin8,
gtin12,
gtin13,
gtin14,
code128,
qr
unit
string | null

The unit the code counts in, such as a case; none for one of the base unit.

Maximum string length: 16
Pattern: ^[A-Za-z0-9][A-Za-z0-9._-]*$

Response

BarcodeResource

data
BarcodeResource · object
required