Skip to content

Render Label for Items

POST
/v1/label-templates/{id}/render
curl --request POST \
--url https://example.com/api/v1/label-templates/example/render \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "canvasData": "example", "format": "example", "itemIds": [ "example" ], "pageSize": "example", "showCutGuides": true, "skipLabels": 1 }'
id
required
string

Template ID

Items to render

Media typeapplication/json
object
canvasData

Optional: canvas data for live preview (overrides saved template)

string
format

“png” or “pdf”, defaults to “png”

string
itemIds
required
Array<string>
>= 1 items
pageSize

“Letter”, “A4”, or “Custom” for PDF

string
showCutGuides

Draw light borders around labels for cutting

boolean
skipLabels

Leave this many positions empty on the first sheet

integer
Examplegenerated
{
"canvasData": "example",
"format": "example",
"itemIds": [
"example"
],
"pageSize": "example",
"showCutGuides": true,
"skipLabels": 1
}

OK

string format: binary