API reference
8 operations in labels. Raw spec: openapi.json.
GET
/api/v1/label-templatesGET /api/label-templates — org templates, optionally per purpose.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
purpose | query | string | No | Filter to one print purpose |
active_only | query | boolean | No | Defaults to true |
Responses
| Status | Description |
|---|---|
200 |
Security: bearer
POST
/api/v1/label-templatesPOST /api/label-templates — create a template (Admin:edit).
Request body
CreateLabelTemplateRequest
Responses
| Status | Description |
|---|---|
200 | |
409 | |
422 |
Security: bearer
POST
/api/v1/label-templates/previewPOST /api/label-templates/preview — render a DRAFT template against deterministic sample values (the designer's live preview).
Request body
PreviewLabelRequest
Responses
| Status | Description |
|---|---|
200 | |
422 |
Security: bearer
GET
/api/v1/label-templates/{id}GET /api/label-templates/{id}.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | Template id |
Responses
| Status | Description |
|---|---|
200 | |
404 |
Security: bearer
PATCH
/api/v1/label-templates/{id}PATCH /api/label-templates/{id} — absent fields keep their value (Admin:edit).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | Template id |
Request body
UpdateLabelTemplateRequest
Responses
| Status | Description |
|---|---|
200 | |
404 | |
409 | |
422 |
Security: bearer
POST
/api/v1/label-templates/{id}/archivePOST /api/label-templates/{id}/archive — archival is a flag; the archived template frees the purpose's default slot.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | Template id |
Responses
| Status | Description |
|---|---|
200 | |
404 |
Security: bearer
POST
/api/v1/labels/renderPOST /api/labels/render — resolve a real entity and render its label: browser-print geometry + the exact ZPL the desktop shell transports.
Request body
RenderLabelRequest
Responses
| Status | Description |
|---|---|
200 | |
404 | |
422 |
Security: bearer
POST
/api/v1/scan/resolvePOST /api/scan/resolve — resolve scanned text into a typed entity.
Request body
ScanResolveRequest
Responses
| Status | Description |
|---|---|
200 | |
422 |
Security: bearer