Label Compile
Compile a label to printer commands (tsc, zpl, epl, …). POST width, language, and elements. Text uses content and size (1-10), not text or fontSize. No barcode element. Example: {"width":40,"height":30,"unit":"mm","language":"zpl","elements":[{"type":"text","content":"ACME","x":10,"y":10,"size":2},{"type":"text","content":"SKU: BOX-12","x":10,"y":35,"size":2}]}
Credit cost: 3 credits per call
fields?stringComma-separated list of response fields to return, with dot notation for nested fields (e.g. name,location.city).
is_async?booleanRun the request as a background job: the API answers 202 with a job_id to poll on GET /v1/jobs/{id}.
falsesoft_fail?booleanReturn HTTP 200 even when the request fails; the error is in the error field of the body.
falseapplication/json- body
width*numberLabel width. Required. Default unit is mm. Example: 40. Do not send query instead of width.
height?numberLabel height in the same unit. Example: 30. Omit for receipt / continuous mode.
unit?stringMeasurement unit for width and height. Default mm. Use mm unless you are working in printer dots.
"mm""mm""inch""dot"dpi?numberPrinter DPI. Default 203.
gap?numberGap between labels in mm. Ignored for receipts.
speed?numberPrint speed, 1-18.
density?numberPrint darkness, 0-15.
direction?numberPrint direction. 0 = normal, 1 = reversed.
101copies?numberNumber of copies. Minimum 1.
printer?stringPrinter profile id (tsc-te210, zebra-zd420, …).
elements*array<>Required array. Text items need type=text, content, and size (1-10 magnification). Do not use text, fontSize, or type=barcode. Positions x/y are in dots. Example item: {"type":"text","content":"Order: 1042","x":10,"y":10,"size":2}.
1 <= itemslanguage*stringRequired printer language. Example: zpl or tsc. Do not omit.
"tsc""tsc""zpl""epl""cpcl""dpl""sbpl""escpos""starprnt""ipl"Successful response
response?stringapplication/jsoncurl -X POST 'https://api.chartquery.com/v1/label/compile' \ -H 'Content-Type: application/json' \ -d '{ "width": 0, "elements": [ { "type": "text" } ], "language": "tsc"}'"SIZE 40 mm, 30 mm\nGAP 3 mm, 0\nSPEED 4\nDENSITY 8\nDIRECTION 1\nCLS\nTEXT 10,10,\"2\",0,1,1,\"ACME Corp\"\nTEXT 10,35,\"1\",0,1,1,\"SKU: PRD-00123\"\nBAR 5,55,305,1\nBOX 5,5,315,235,2\nPRINT 1"