Skip to main content
GET
Get label

Authorizations

api-key
string
header
required

Path Parameters

orderId
string
required

Query Parameters

format
enum<string>
default:pdf

Output format. ZPL is available for Sparqle-generated labels only, always A6 at 203 DPI. Use orientation=landscape|portrait; when omitted, ZPL follows the company ORIENTATION setting (same as PDF), not landscape by default. printSize is not supported for ZPL.

Available options:
pdf,
zpl
orientation
enum<string>

Label orientation for PDF and ZPL. When omitted, uses the company ORIENTATION setting, then landscape. For ZPL: merchants with portrait configured for PDF receive portrait ZPL unless orientation=landscape is passed explicitly.

Available options:
landscape,
portrait
printSize
enum<string>

PDF print size only. Not supported with format=zpl.

Available options:
A6,
A4

Response

Base64-encoded label document

label
string

Base64-encoded PDF or ZPL label document.

Example:

"JVBERi0xLjQKJ..."