Labels API
Inventory label and barcode API for label templates, single-item labels, bulk label sheets, and printable PDFs.
Generated from the Celerp 2.8.0 OpenAPI schema, 2 November 2026.
POST /api/labels/bulk-print
Generate Bulk Inventory Labels
Generate a PDF label sheet for multiple items.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
entity_ids | array of string | yes | Identifiers of the business records included in the operation. |
template_id | string, optional | -- | Identifier of the label template to use. |
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns the label sheet as a PDF file. | -- |
422 | The request failed validation. The response lists each invalid field and why. | HTTPValidationError |
Example
curl -X POST http://localhost:8000/api/labels/bulk-print \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'POST /api/labels/print-source
Print Source
A PDF label sheet for records of a registered kind, on the chosen template, else the first of the company's that the rows can fill.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
source | string | yes | Source |
ids | array of string | yes | Ids |
template_id | string, optional | -- | Template Id |
Responses
| Status | Description | Body |
|---|---|---|
200 | Successful Response | -- |
422 | Validation Error | HTTPValidationError |
Example
curl -X POST http://localhost:8000/api/labels/print-source \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'POST /api/labels/print/{entity_id}
Generate Inventory Item Label
Generate a PDF label for a single item.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
entity_id | path | yes | string | Identifier of the requested Celerp record. |
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns the label as a PDF file. | -- |
422 | The request failed validation. The response lists each invalid field and why. | HTTPValidationError |
Example
curl -X POST http://localhost:8000/api/labels/print/:entity_id \
-H "Authorization: Bearer $TOKEN"GET /api/labels/source-rows
Source Rows
The label rows of the records ``ids`` (comma separated), in the order asked.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
source | query | yes | string | Kind of record that another module registers for labels. An unregistered kind is refused. |
ids | query | yes | string | Comma-separated identifiers of the records to print labels for. Rows come back in the order given. |
Responses
| Status | Description | Body |
|---|---|---|
200 | Successful Response | object |
422 | Validation Error | HTTPValidationError |
Example
curl -X GET http://localhost:8000/api/labels/source-rows \
-H "Authorization: Bearer $TOKEN"GET /api/labels/sources/{source}
Get Source
A kind of record labels print for: the fields its rows carry and the company's templates its rows can fill.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
source | path | yes | string | Kind of record that another module registers for labels. An unregistered kind is refused. |
Responses
| Status | Description | Body |
|---|---|---|
200 | Successful Response | object |
422 | Validation Error | HTTPValidationError |
Example
curl -X GET http://localhost:8000/api/labels/sources/:source \
-H "Authorization: Bearer $TOKEN"GET /api/labels/templates
List Label Templates
Return the available label templates.
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns the requested label templates. | object |
Example
curl -X GET http://localhost:8000/api/labels/templates \
-H "Authorization: Bearer $TOKEN"POST /api/labels/templates
Create Label Template
Create a label template from the supplied request data.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
name | string | yes | Human-readable name of the label template. |
format | string | -- | Output or label format selected for the template. |
orientation | string | -- | Page or label orientation used when rendering the template. |
width_mm | number, optional | -- | Template or label width in millimeters. |
height_mm | number, optional | -- | Template or label height in millimeters. |
fields | array of object | -- | Field definitions or field updates included in the request. |
copies | integer | -- | Number of label copies to generate. |
notes | string, optional | -- | Optional notes associated with the record or operation. |
Responses
| Status | Description | Body |
|---|---|---|
201 | Returns the created label template or creation result. | object |
422 | The request failed validation. The response lists each invalid field and why. | HTTPValidationError |
Example
curl -X POST http://localhost:8000/api/labels/templates \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'GET /api/labels/templates/{template_id}
Get Label Template
Return label template.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
template_id | path | yes | string | Identifier of the requested template. |
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns the requested label template result. | object |
422 | The request failed validation. The response lists each invalid field and why. | HTTPValidationError |
Example
curl -X GET http://localhost:8000/api/labels/templates/:template_id \
-H "Authorization: Bearer $TOKEN"PUT /api/labels/templates/{template_id}
Update Label Template
Update label template with the supplied fields.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
template_id | path | yes | string | Identifier of the requested template. |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
name | string, optional | -- | Updated human-readable name of the label template. |
format | string, optional | -- | Output or label format selected for the template. |
orientation | string, optional | -- | Page or label orientation used when rendering the template. |
width_mm | number, optional | -- | Template or label width in millimeters. |
height_mm | number, optional | -- | Template or label height in millimeters. |
fields | array of object, optional | -- | Field definitions or field updates included in the request. |
copies | integer, optional | -- | Number of label copies to generate. |
notes | string, optional | -- | Optional notes associated with the record or operation. |
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns the updated label template or update result. | object |
422 | The request failed validation. The response lists each invalid field and why. | HTTPValidationError |
Example
curl -X PUT http://localhost:8000/api/labels/templates/:template_id \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'DELETE /api/labels/templates/{template_id}
Delete Label Template
Delete a saved label template.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
template_id | path | yes | string | Identifier of the requested template. |
Responses
| Status | Description | Body |
|---|---|---|
204 | Success. No response body is returned. | -- |
422 | The request failed validation. The response lists each invalid field and why. | HTTPValidationError |
Example
curl -X DELETE http://localhost:8000/api/labels/templates/:template_id \
-H "Authorization: Bearer $TOKEN"