Render Labels for an Asset ID Range
POST
/v1/label-templates/{id}/render-assets
const url = 'https://example.com/api/v1/label-templates/example/render-assets';const options = { method: 'POST', headers: {Authorization: '<Authorization>', 'Content-Type': 'application/json'}, body: '{"endAssetId":1,"format":"example","pageSize":"example","showCutGuides":true,"skipLabels":1,"startAssetId":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-assets \ --header 'Authorization: <Authorization>' \ --header 'Content-Type: application/json' \ --data '{ "endAssetId": 1, "format": "example", "pageSize": "example", "showCutGuides": true, "skipLabels": 1, "startAssetId": 1 }'Renders one label per asset ID in the range. Asset IDs that no entity has yet get a label with only the asset ID and asset URL, for pre-printing tags.
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”Asset range to render
Media typeapplication/json
object
endAssetId
integer
format
“png” or “pdf”, defaults to “pdf”
string
pageSize
“Letter” or “A4” for PDF
string
showCutGuides
Draw light borders around labels for cutting
boolean
skipLabels
Empty slots before the first label, for partly used sheets
integer
startAssetId
integer
Examplegenerated
{ "endAssetId": 1, "format": "example", "pageSize": "example", "showCutGuides": true, "skipLabels": 1, "startAssetId": 1}Responses
Section titled “Responses”OK
string format: binary
string format: binary