Skip to main content
POST
Enqueue a print job

Authorizations

Authorization
string
header
required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Path Parameters

stationId
string
required

ID of the target print station.

Body

application/json
format
enum<string>
required

Payload format.

Available options:
zpl,
pdf
kind
enum<string> | null

Job kind. Defaults to raw.

Available options:
shipping_label,
packing_slip,
raw
printer_name
string | null

Target printer name. Must match a printer available on the station; omit to use the station default.

payload_base64
string | null

Base64-encoded payload (binary/PDF bytes). Required when payload_text is not provided.

payload_text
string | null

Raw text payload (e.g. a ZPL command stream). Required when payload_base64 is not provided.

copies
integer | null

Number of copies to print. Defaults to 1.

Required range: 1 <= x <= 10
metadata
object | null

Arbitrary metadata echoed back on the job.

Response

Print job enqueued

data
object