Skip to content

Render Labels for an Asset ID Range

POST
/v1/label-templates/{id}/render-assets
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.

id
required
string

Template ID

Asset range to render

Media typeapplication/json
object
endAssetId
integer
>= 1
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
<= 1000
startAssetId
integer
>= 1
Examplegenerated
{
"endAssetId": 1,
"format": "example",
"pageSize": "example",
"showCutGuides": true,
"skipLabels": 1,
"startAssetId": 1
}

OK

string format: binary