Render Label for Items
POST
/v1/label-templates/{id}/render
const url = 'https://example.com/api/v1/label-templates/example/render';const options = { method: 'POST', headers: {Authorization: '<Authorization>', 'Content-Type': 'application/json'}, body: '{"canvasData":"example","format":"example","itemIds":["example"],"pageSize":"example","showCutGuides":true,"skipLabels":1}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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 }'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”id
required
string
Template ID
Request Bodyrequired
Section titled “Request Bodyrequired”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>
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}Responses
Section titled “Responses”OK
string format: binary
string format: binary