The Label Printing section of the InvenTree API schema is documented below.
InvenTree API 435¶
API for InvenTree - the intuitive open source inventory management system
License: MIT
Servers¶
| Description | URL |
|---|---|
| http://localhost:8000 | http://localhost:8000 |
label¶
POST /api/label/print/¶
Description
POST action for printing labels.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"items": [
0
],
"plugin": "string",
"template": 0
}
Schema of the request body
{
"description": "Serializer class for printing a label.",
"properties": {
"items": {
"description": "List of item primary keys to include in the report",
"items": {
"type": "integer"
},
"type": "array"
},
"plugin": {
"description": "Select plugin to use for label printing",
"title": "Printing Plugin",
"type": "string"
},
"template": {
"description": "Select label template",
"type": "integer"
}
},
"required": [
"items",
"template"
],
"type": "object"
}
{
"items": [
0
],
"plugin": "string",
"template": 0
}
Schema of the request body
{
"description": "Serializer class for printing a label.",
"properties": {
"items": {
"description": "List of item primary keys to include in the report",
"items": {
"type": "integer"
},
"type": "array"
},
"plugin": {
"description": "Select plugin to use for label printing",
"title": "Printing Plugin",
"type": "string"
},
"template": {
"description": "Select label template",
"type": "integer"
}
},
"required": [
"items",
"template"
],
"type": "object"
}
{
"items": [
0
],
"plugin": "string",
"template": 0
}
Schema of the request body
{
"description": "Serializer class for printing a label.",
"properties": {
"items": {
"description": "List of item primary keys to include in the report",
"items": {
"type": "integer"
},
"type": "array"
},
"plugin": {
"description": "Select plugin to use for label printing",
"title": "Printing Plugin",
"type": "string"
},
"template": {
"description": "Select label template",
"type": "integer"
}
},
"required": [
"items",
"template"
],
"type": "object"
}
Response 200 OK
{
"items": [
0
],
"plugin": "string",
"template": 0
}
Schema of the response body
{
"description": "Serializer class for printing a label.",
"properties": {
"items": {
"description": "List of item primary keys to include in the report",
"items": {
"type": "integer"
},
"type": "array"
},
"plugin": {
"description": "Select plugin to use for label printing",
"title": "Printing Plugin",
"type": "string"
},
"template": {
"description": "Select label template",
"type": "integer"
}
},
"required": [
"items",
"template"
],
"type": "object"
}
GET /api/label/template/¶
Description
API endpoint for viewing list of LabelTemplate objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
enabled |
query | boolean | No | ||
items |
query | string | No | Items | |
limit |
query | integer | No | Number of results to return per page. | |
model_type |
query | string | No | Model Type * `part` - Part * `build` - Build Order * `buildline` - Build Order Line Item * `company` - Company * `purchaseorder` - Purchase Order * `salesorder` - Sales Order * `salesordershipment` - Sales Order Shipment * `returnorder` - Return Order * `stockitem` - Stock Item * `stocklocation` - Stock Location | |
offset |
query | integer | No | The initial index from which to return the results. | |
search |
query | string | No | A search term. Searched fields: description, name. |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"attach_to_model": true,
"description": "string",
"enabled": true,
"filename_pattern": "string",
"filters": "string",
"height": 10.12,
"model_type": "part",
"name": "string",
"pk": 0,
"revision": 0,
"template": "string",
"width": 10.12
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/LabelTemplate"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
POST /api/label/template/¶
Description
API endpoint for viewing list of LabelTemplate objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"attach_to_model": true,
"description": "string",
"enabled": true,
"filename_pattern": "string",
"filters": "string",
"height": 10.12,
"model_type": "part",
"name": "string",
"pk": 0,
"revision": 0,
"template": "string",
"width": 10.12
}
Schema of the request body
{
"description": "Serializer class for label template model.",
"properties": {
"attach_to_model": {
"description": "Save report output as an attachment against linked model instance when printing",
"title": "Attach to Model on Print",
"type": "boolean"
},
"description": {
"description": "Template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Template is enabled",
"type": "boolean"
},
"filename_pattern": {
"description": "Pattern for generating filenames",
"maxLength": 100,
"type": "string"
},
"filters": {
"description": "Template query filters (comma-separated list of key=value pairs)",
"maxLength": 250,
"type": "string"
},
"height": {
"description": "Label height, specified in mm",
"format": "double",
"minimum": 2,
"title": "Height [mm]",
"type": "number"
},
"model_type": {
"$ref": "#/components/schemas/TemplateModelTypeEnum"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"revision": {
"readOnly": true,
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
},
"width": {
"description": "Label width, specified in mm",
"format": "double",
"minimum": 2,
"title": "Width [mm]",
"type": "number"
}
},
"required": [
"description",
"model_type",
"name",
"pk",
"revision",
"template"
],
"type": "object"
}
{
"attach_to_model": true,
"description": "string",
"enabled": true,
"filename_pattern": "string",
"filters": "string",
"height": 10.12,
"model_type": "part",
"name": "string",
"pk": 0,
"revision": 0,
"template": "string",
"width": 10.12
}
Schema of the request body
{
"description": "Serializer class for label template model.",
"properties": {
"attach_to_model": {
"description": "Save report output as an attachment against linked model instance when printing",
"title": "Attach to Model on Print",
"type": "boolean"
},
"description": {
"description": "Template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Template is enabled",
"type": "boolean"
},
"filename_pattern": {
"description": "Pattern for generating filenames",
"maxLength": 100,
"type": "string"
},
"filters": {
"description": "Template query filters (comma-separated list of key=value pairs)",
"maxLength": 250,
"type": "string"
},
"height": {
"description": "Label height, specified in mm",
"format": "double",
"minimum": 2,
"title": "Height [mm]",
"type": "number"
},
"model_type": {
"$ref": "#/components/schemas/TemplateModelTypeEnum"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"revision": {
"readOnly": true,
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
},
"width": {
"description": "Label width, specified in mm",
"format": "double",
"minimum": 2,
"title": "Width [mm]",
"type": "number"
}
},
"required": [
"description",
"model_type",
"name",
"pk",
"revision",
"template"
],
"type": "object"
}
{
"attach_to_model": true,
"description": "string",
"enabled": true,
"filename_pattern": "string",
"filters": "string",
"height": 10.12,
"model_type": "part",
"name": "string",
"pk": 0,
"revision": 0,
"template": "string",
"width": 10.12
}
Schema of the request body
{
"description": "Serializer class for label template model.",
"properties": {
"attach_to_model": {
"description": "Save report output as an attachment against linked model instance when printing",
"title": "Attach to Model on Print",
"type": "boolean"
},
"description": {
"description": "Template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Template is enabled",
"type": "boolean"
},
"filename_pattern": {
"description": "Pattern for generating filenames",
"maxLength": 100,
"type": "string"
},
"filters": {
"description": "Template query filters (comma-separated list of key=value pairs)",
"maxLength": 250,
"type": "string"
},
"height": {
"description": "Label height, specified in mm",
"format": "double",
"minimum": 2,
"title": "Height [mm]",
"type": "number"
},
"model_type": {
"$ref": "#/components/schemas/TemplateModelTypeEnum"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"revision": {
"readOnly": true,
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
},
"width": {
"description": "Label width, specified in mm",
"format": "double",
"minimum": 2,
"title": "Width [mm]",
"type": "number"
}
},
"required": [
"description",
"model_type",
"name",
"pk",
"revision",
"template"
],
"type": "object"
}
Response 201 Created
{
"attach_to_model": true,
"description": "string",
"enabled": true,
"filename_pattern": "string",
"filters": "string",
"height": 10.12,
"model_type": "part",
"name": "string",
"pk": 0,
"revision": 0,
"template": "string",
"width": 10.12
}
Schema of the response body
{
"description": "Serializer class for label template model.",
"properties": {
"attach_to_model": {
"description": "Save report output as an attachment against linked model instance when printing",
"title": "Attach to Model on Print",
"type": "boolean"
},
"description": {
"description": "Template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Template is enabled",
"type": "boolean"
},
"filename_pattern": {
"description": "Pattern for generating filenames",
"maxLength": 100,
"type": "string"
},
"filters": {
"description": "Template query filters (comma-separated list of key=value pairs)",
"maxLength": 250,
"type": "string"
},
"height": {
"description": "Label height, specified in mm",
"format": "double",
"minimum": 2,
"title": "Height [mm]",
"type": "number"
},
"model_type": {
"$ref": "#/components/schemas/TemplateModelTypeEnum"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"revision": {
"readOnly": true,
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
},
"width": {
"description": "Label width, specified in mm",
"format": "double",
"minimum": 2,
"title": "Width [mm]",
"type": "number"
}
},
"required": [
"description",
"model_type",
"name",
"pk",
"revision",
"template"
],
"type": "object"
}
DELETE /api/label/template/{id}/¶
Description
Detail API endpoint for label template model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 204 No Content
GET /api/label/template/{id}/¶
Description
Detail API endpoint for label template model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"attach_to_model": true,
"description": "string",
"enabled": true,
"filename_pattern": "string",
"filters": "string",
"height": 10.12,
"model_type": "part",
"name": "string",
"pk": 0,
"revision": 0,
"template": "string",
"width": 10.12
}
Schema of the response body
{
"description": "Serializer class for label template model.",
"properties": {
"attach_to_model": {
"description": "Save report output as an attachment against linked model instance when printing",
"title": "Attach to Model on Print",
"type": "boolean"
},
"description": {
"description": "Template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Template is enabled",
"type": "boolean"
},
"filename_pattern": {
"description": "Pattern for generating filenames",
"maxLength": 100,
"type": "string"
},
"filters": {
"description": "Template query filters (comma-separated list of key=value pairs)",
"maxLength": 250,
"type": "string"
},
"height": {
"description": "Label height, specified in mm",
"format": "double",
"minimum": 2,
"title": "Height [mm]",
"type": "number"
},
"model_type": {
"$ref": "#/components/schemas/TemplateModelTypeEnum"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"revision": {
"readOnly": true,
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
},
"width": {
"description": "Label width, specified in mm",
"format": "double",
"minimum": 2,
"title": "Width [mm]",
"type": "number"
}
},
"required": [
"description",
"model_type",
"name",
"pk",
"revision",
"template"
],
"type": "object"
}
PATCH /api/label/template/{id}/¶
Description
Detail API endpoint for label template model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"attach_to_model": true,
"description": "string",
"enabled": true,
"filename_pattern": "string",
"filters": "string",
"height": 10.12,
"model_type": "part",
"name": "string",
"pk": 0,
"revision": 0,
"template": "string",
"width": 10.12
}
Schema of the request body
{
"description": "Serializer class for label template model.",
"properties": {
"attach_to_model": {
"description": "Save report output as an attachment against linked model instance when printing",
"title": "Attach to Model on Print",
"type": "boolean"
},
"description": {
"description": "Template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Template is enabled",
"type": "boolean"
},
"filename_pattern": {
"description": "Pattern for generating filenames",
"maxLength": 100,
"type": "string"
},
"filters": {
"description": "Template query filters (comma-separated list of key=value pairs)",
"maxLength": 250,
"type": "string"
},
"height": {
"description": "Label height, specified in mm",
"format": "double",
"minimum": 2,
"title": "Height [mm]",
"type": "number"
},
"model_type": {
"$ref": "#/components/schemas/TemplateModelTypeEnum"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"revision": {
"readOnly": true,
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
},
"width": {
"description": "Label width, specified in mm",
"format": "double",
"minimum": 2,
"title": "Width [mm]",
"type": "number"
}
},
"type": "object"
}
{
"attach_to_model": true,
"description": "string",
"enabled": true,
"filename_pattern": "string",
"filters": "string",
"height": 10.12,
"model_type": "part",
"name": "string",
"pk": 0,
"revision": 0,
"template": "string",
"width": 10.12
}
Schema of the request body
{
"description": "Serializer class for label template model.",
"properties": {
"attach_to_model": {
"description": "Save report output as an attachment against linked model instance when printing",
"title": "Attach to Model on Print",
"type": "boolean"
},
"description": {
"description": "Template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Template is enabled",
"type": "boolean"
},
"filename_pattern": {
"description": "Pattern for generating filenames",
"maxLength": 100,
"type": "string"
},
"filters": {
"description": "Template query filters (comma-separated list of key=value pairs)",
"maxLength": 250,
"type": "string"
},
"height": {
"description": "Label height, specified in mm",
"format": "double",
"minimum": 2,
"title": "Height [mm]",
"type": "number"
},
"model_type": {
"$ref": "#/components/schemas/TemplateModelTypeEnum"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"revision": {
"readOnly": true,
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
},
"width": {
"description": "Label width, specified in mm",
"format": "double",
"minimum": 2,
"title": "Width [mm]",
"type": "number"
}
},
"type": "object"
}
{
"attach_to_model": true,
"description": "string",
"enabled": true,
"filename_pattern": "string",
"filters": "string",
"height": 10.12,
"model_type": "part",
"name": "string",
"pk": 0,
"revision": 0,
"template": "string",
"width": 10.12
}
Schema of the request body
{
"description": "Serializer class for label template model.",
"properties": {
"attach_to_model": {
"description": "Save report output as an attachment against linked model instance when printing",
"title": "Attach to Model on Print",
"type": "boolean"
},
"description": {
"description": "Template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Template is enabled",
"type": "boolean"
},
"filename_pattern": {
"description": "Pattern for generating filenames",
"maxLength": 100,
"type": "string"
},
"filters": {
"description": "Template query filters (comma-separated list of key=value pairs)",
"maxLength": 250,
"type": "string"
},
"height": {
"description": "Label height, specified in mm",
"format": "double",
"minimum": 2,
"title": "Height [mm]",
"type": "number"
},
"model_type": {
"$ref": "#/components/schemas/TemplateModelTypeEnum"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"revision": {
"readOnly": true,
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
},
"width": {
"description": "Label width, specified in mm",
"format": "double",
"minimum": 2,
"title": "Width [mm]",
"type": "number"
}
},
"type": "object"
}
Response 200 OK
{
"attach_to_model": true,
"description": "string",
"enabled": true,
"filename_pattern": "string",
"filters": "string",
"height": 10.12,
"model_type": "part",
"name": "string",
"pk": 0,
"revision": 0,
"template": "string",
"width": 10.12
}
Schema of the response body
{
"description": "Serializer class for label template model.",
"properties": {
"attach_to_model": {
"description": "Save report output as an attachment against linked model instance when printing",
"title": "Attach to Model on Print",
"type": "boolean"
},
"description": {
"description": "Template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Template is enabled",
"type": "boolean"
},
"filename_pattern": {
"description": "Pattern for generating filenames",
"maxLength": 100,
"type": "string"
},
"filters": {
"description": "Template query filters (comma-separated list of key=value pairs)",
"maxLength": 250,
"type": "string"
},
"height": {
"description": "Label height, specified in mm",
"format": "double",
"minimum": 2,
"title": "Height [mm]",
"type": "number"
},
"model_type": {
"$ref": "#/components/schemas/TemplateModelTypeEnum"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"revision": {
"readOnly": true,
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
},
"width": {
"description": "Label width, specified in mm",
"format": "double",
"minimum": 2,
"title": "Width [mm]",
"type": "number"
}
},
"required": [
"description",
"model_type",
"name",
"pk",
"revision",
"template"
],
"type": "object"
}
PUT /api/label/template/{id}/¶
Description
Detail API endpoint for label template model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"attach_to_model": true,
"description": "string",
"enabled": true,
"filename_pattern": "string",
"filters": "string",
"height": 10.12,
"model_type": "part",
"name": "string",
"pk": 0,
"revision": 0,
"template": "string",
"width": 10.12
}
Schema of the request body
{
"description": "Serializer class for label template model.",
"properties": {
"attach_to_model": {
"description": "Save report output as an attachment against linked model instance when printing",
"title": "Attach to Model on Print",
"type": "boolean"
},
"description": {
"description": "Template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Template is enabled",
"type": "boolean"
},
"filename_pattern": {
"description": "Pattern for generating filenames",
"maxLength": 100,
"type": "string"
},
"filters": {
"description": "Template query filters (comma-separated list of key=value pairs)",
"maxLength": 250,
"type": "string"
},
"height": {
"description": "Label height, specified in mm",
"format": "double",
"minimum": 2,
"title": "Height [mm]",
"type": "number"
},
"model_type": {
"$ref": "#/components/schemas/TemplateModelTypeEnum"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"revision": {
"readOnly": true,
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
},
"width": {
"description": "Label width, specified in mm",
"format": "double",
"minimum": 2,
"title": "Width [mm]",
"type": "number"
}
},
"required": [
"description",
"model_type",
"name",
"pk",
"revision",
"template"
],
"type": "object"
}
{
"attach_to_model": true,
"description": "string",
"enabled": true,
"filename_pattern": "string",
"filters": "string",
"height": 10.12,
"model_type": "part",
"name": "string",
"pk": 0,
"revision": 0,
"template": "string",
"width": 10.12
}
Schema of the request body
{
"description": "Serializer class for label template model.",
"properties": {
"attach_to_model": {
"description": "Save report output as an attachment against linked model instance when printing",
"title": "Attach to Model on Print",
"type": "boolean"
},
"description": {
"description": "Template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Template is enabled",
"type": "boolean"
},
"filename_pattern": {
"description": "Pattern for generating filenames",
"maxLength": 100,
"type": "string"
},
"filters": {
"description": "Template query filters (comma-separated list of key=value pairs)",
"maxLength": 250,
"type": "string"
},
"height": {
"description": "Label height, specified in mm",
"format": "double",
"minimum": 2,
"title": "Height [mm]",
"type": "number"
},
"model_type": {
"$ref": "#/components/schemas/TemplateModelTypeEnum"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"revision": {
"readOnly": true,
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
},
"width": {
"description": "Label width, specified in mm",
"format": "double",
"minimum": 2,
"title": "Width [mm]",
"type": "number"
}
},
"required": [
"description",
"model_type",
"name",
"pk",
"revision",
"template"
],
"type": "object"
}
{
"attach_to_model": true,
"description": "string",
"enabled": true,
"filename_pattern": "string",
"filters": "string",
"height": 10.12,
"model_type": "part",
"name": "string",
"pk": 0,
"revision": 0,
"template": "string",
"width": 10.12
}
Schema of the request body
{
"description": "Serializer class for label template model.",
"properties": {
"attach_to_model": {
"description": "Save report output as an attachment against linked model instance when printing",
"title": "Attach to Model on Print",
"type": "boolean"
},
"description": {
"description": "Template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Template is enabled",
"type": "boolean"
},
"filename_pattern": {
"description": "Pattern for generating filenames",
"maxLength": 100,
"type": "string"
},
"filters": {
"description": "Template query filters (comma-separated list of key=value pairs)",
"maxLength": 250,
"type": "string"
},
"height": {
"description": "Label height, specified in mm",
"format": "double",
"minimum": 2,
"title": "Height [mm]",
"type": "number"
},
"model_type": {
"$ref": "#/components/schemas/TemplateModelTypeEnum"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"revision": {
"readOnly": true,
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
},
"width": {
"description": "Label width, specified in mm",
"format": "double",
"minimum": 2,
"title": "Width [mm]",
"type": "number"
}
},
"required": [
"description",
"model_type",
"name",
"pk",
"revision",
"template"
],
"type": "object"
}
Response 200 OK
{
"attach_to_model": true,
"description": "string",
"enabled": true,
"filename_pattern": "string",
"filters": "string",
"height": 10.12,
"model_type": "part",
"name": "string",
"pk": 0,
"revision": 0,
"template": "string",
"width": 10.12
}
Schema of the response body
{
"description": "Serializer class for label template model.",
"properties": {
"attach_to_model": {
"description": "Save report output as an attachment against linked model instance when printing",
"title": "Attach to Model on Print",
"type": "boolean"
},
"description": {
"description": "Template description",
"maxLength": 250,
"type": "string"
},
"enabled": {
"description": "Template is enabled",
"type": "boolean"
},
"filename_pattern": {
"description": "Pattern for generating filenames",
"maxLength": 100,
"type": "string"
},
"filters": {
"description": "Template query filters (comma-separated list of key=value pairs)",
"maxLength": 250,
"type": "string"
},
"height": {
"description": "Label height, specified in mm",
"format": "double",
"minimum": 2,
"title": "Height [mm]",
"type": "number"
},
"model_type": {
"$ref": "#/components/schemas/TemplateModelTypeEnum"
},
"name": {
"description": "Template name",
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"revision": {
"readOnly": true,
"type": "integer"
},
"template": {
"format": "uri",
"type": "string"
},
"width": {
"description": "Label width, specified in mm",
"format": "double",
"minimum": 2,
"title": "Width [mm]",
"type": "number"
}
},
"required": [
"description",
"model_type",
"name",
"pk",
"revision",
"template"
],
"type": "object"
}
GET /api/label/template/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PATCH /api/label/template/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PUT /api/label/template/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
Schemas¶
LabelPrint¶
| Name | Type |
|---|---|
items |
Array<integer> |
plugin |
string |
template |
integer |
LabelTemplate¶
| Name | Type |
|---|---|
attach_to_model |
boolean |
description |
string |
enabled |
boolean |
filename_pattern |
string |
filters |
string |
height |
number(double) |
model_type |
TemplateModelTypeEnum |
name |
string |
pk |
integer |
revision |
integer |
template |
string(uri) |
width |
number(double) |
Metadata¶
| Name | Type |
|---|---|
metadata |
PaginatedLabelTemplateList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<LabelTemplate> |
PatchedLabelTemplate¶
| Name | Type |
|---|---|
attach_to_model |
boolean |
description |
string |
enabled |
boolean |
filename_pattern |
string |
filters |
string |
height |
number(double) |
model_type |
TemplateModelTypeEnum |
name |
string |
pk |
integer |
revision |
integer |
template |
string(uri) |
width |
number(double) |
PatchedMetadata¶
| Name | Type |
|---|---|
metadata |
TemplateModelTypeEnum¶
Type: string
Common responses¶
This section describes common responses that are reused across operations.
allauth.AddAuthenticatorConflict¶
The account prohibits adding an authenticator, e.g. because of an unverified email address.
Schema of the response body
null
allauth.AddWebAuthnAuthenticator¶
A WebAuthn authenticator.
{
"data": null,
"meta": {
"recovery_codes_generated": true
},
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.WebAuthnAuthenticator"
},
"meta": {
"properties": {
"recovery_codes_generated": {
"description": "Whether or not recovery codes where generated automatically.\n",
"type": "boolean"
}
},
"type": "object"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data",
"meta"
],
"type": "object"
}
allauth.Authenticated¶
The user is authenticated.
Schema of the response body
null
allauth.AuthenticatedByCode¶
Authenticated by code.
{
"summary": "Authenticated by code.\n",
"value": {
"data": {
"methods": [
{
"at": 1711555057.065702,
"email": "email@domain.org",
"method": "code"
}
],
"user": {
"display": "Magic Wizard",
"email": "email@domain.org",
"has_usable_password": true,
"id": 123,
"username": "wizard"
}
},
"meta": {
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdW",
"is_authenticated": true,
"session_token": "ufwcig0zen9skyd545jc0fkq813ghar2"
},
"status": 200
}
}
Schema of the response body
null
allauth.AuthenticatedByPassword¶
Authenticated by password.
{
"summary": "Authenticated by password.\n",
"value": {
"data": {
"methods": [
{
"at": 1711555057.065702,
"email": "email@domain.org",
"method": "password"
}
],
"user": {
"display": "Magic Wizard",
"email": "email@domain.org",
"has_usable_password": true,
"id": 123,
"username": "wizard"
}
},
"meta": {
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdW",
"is_authenticated": true,
"session_token": "ufwcig0zen9skyd545jc0fkq813ghar2"
},
"status": 200
}
}
Schema of the response body
null
allauth.AuthenticatedByPasswordAnd2FA¶
Authenticated by password and 2FA.
{
"summary": "Fully authenticated using by password and 2FA.\n",
"value": {
"data": {
"methods": [
{
"at": 1711555057.065702,
"email": "email@domain.org",
"method": "password"
},
{
"at": 1711555060.9375854,
"id": 66,
"method": "mfa",
"type": "totp"
}
],
"user": {
"display": "Magic Wizard",
"email": "email@domain.org",
"has_usable_password": true,
"id": 123,
"username": "wizard"
}
},
"meta": {
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdW",
"is_authenticated": true,
"session_token": "ufwcig0zen9skyd545jc0fkq813ghar2"
},
"status": 200
}
}
Schema of the response body
null
allauth.Authentication¶
Not authenticated.
{
"summary": "Reauthentication required\n",
"value": {
"data": {
"flows": [
{
"id": "reauthenticate"
},
{
"id": "mfa_reauthenticate"
}
],
"methods": [
{
"at": 1711555057.065702,
"email": "email@domain.org",
"method": "password"
},
{
"at": 1711555060.9375854,
"id": 66,
"method": "mfa",
"type": "totp"
}
],
"user": {
"display": "Magic Wizard",
"email": "email@domain.org",
"has_usable_password": true,
"id": 123,
"username": "wizard"
}
},
"meta": {
"is_authenticated": true
},
"status": 401
}
}
{
"summary": "Unauthenticated: Initial\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
{
"summary": "Unauthenticated: pending 2FA\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
},
{
"id": "mfa_authenticate",
"is_pending": true
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
{
"summary": "Unauthenticated: pending email verification\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
},
{
"id": "verify_email",
"is_pending": true
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
{
"summary": "Unauthenticated: pending provider signup\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
},
{
"id": "provider_signup",
"is_pending": true,
"provider": {
"client_id": "123.apps.googleusercontent.com",
"flows": [
"provider_redirect",
"provider_token"
],
"id": "google",
"name": "Google"
}
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
Schema of the response body
null
allauth.AuthenticationOrReauthentication¶
The response indicates authentication or re-authentication is required.
Schema of the response body
{
"oneOf": [
{
"$ref": "#/components/schemas/allauth.AuthenticationResponse"
},
{
"$ref": "#/components/schemas/allauth.ReauthenticationResponse"
}
]
}
allauth.Authenticators¶
List of authenticators.
{
"data": null,
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.AuthenticatorList"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.Configuration¶
The django-allauth configuration.
Schema of the response body
null
allauth.EmailAddresses¶
List of email addresses.
{
"data": [
null
],
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/allauth.EmailAddress"
},
"type": "array"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.EmailVerificationInfo¶
Email verification information.
Schema of the response body
null
allauth.Error¶
An input error occurred.
Schema of the response body
null
allauth.Forbidden¶
A forbidden response.
Schema of the response body
null
allauth.NotFound¶
Not found.
{
"status": 0
}
Schema of the response body
{
"properties": {
"status": {
"enum": [
404
],
"type": "integer"
}
},
"required": [
"status"
],
"type": "object"
}
allauth.PasswordResetInfo¶
Information about the password reset key.
{
"data": {
"user": null
},
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"properties": {
"user": {
"$ref": "#/components/schemas/allauth.User"
}
},
"type": "object"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.PhoneNumbers¶
List of phone numbers.
Schema of the response body
null
allauth.ProviderAccounts¶
List of third-party provider accounts.
{
"data": [
null
],
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/allauth.ProviderAccount"
},
"type": "array"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.ProviderSignup¶
Information relating to the pending provider signup.
{
"data": {
"account": null,
"email": [
null
],
"user": null
},
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"properties": {
"account": {
"$ref": "#/components/schemas/allauth.ProviderAccount"
},
"email": {
"items": {
"$ref": "#/components/schemas/allauth.EmailAddress"
},
"type": "array"
},
"user": {
"$ref": "#/components/schemas/allauth.User"
}
},
"required": [
"email",
"account",
"user"
],
"type": "object"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.ReauthenticationRequired¶
The response indicates reauthentication is required.
{
"data": {
"flows": [
{
"id": "reauthenticate"
},
{
"id": "mfa_reauthenticate"
}
],
"methods": [
{
"at": 1711555057.065702,
"email": "email@domain.org",
"method": "password"
},
{
"at": 1711555060.9375854,
"id": 66,
"method": "mfa",
"type": "totp"
}
],
"user": {
"display": "Magic Wizard",
"email": "email@domain.org",
"has_usable_password": true,
"id": 123,
"username": "wizard"
}
},
"meta": {
"is_authenticated": true
},
"status": 401
}
Schema of the response body
null
allauth.RecoveryCodes¶
Information on the recovery codes.
{
"data": null,
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.SensitiveRecoveryCodesAuthenticator"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.RefreshToken¶
A new access token (and optionally new refresh token).
{
"data": {
"access_token": null,
"refresh_token": null
},
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"properties": {
"access_token": {
"$ref": "#/components/schemas/allauth.AccessToken"
},
"refresh_token": {
"$ref": "#/components/schemas/allauth.RefreshToken"
}
},
"required": [
"access_token"
],
"type": "object"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"data",
"status"
],
"type": "object"
}
allauth.SessionGone¶
The response indicates session is invalid or no longer exists.
{
"summary": "Unauthenticated: Initial\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
Schema of the response body
null
allauth.Sessions¶
List of sessions.
{
"data": [
null
],
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/allauth.Session"
},
"type": "array"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.StatusOK¶
A success response.
{
"status": null
}
Schema of the response body
{
"properties": {
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status"
],
"type": "object"
}
allauth.TOTPAuthenticator¶
Information on the TOTP authenticator.
{
"data": null,
"meta": {
"recovery_codes_generated": true
},
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.TOTPAuthenticator"
},
"meta": {
"properties": {
"recovery_codes_generated": {
"description": "Whether or not recovery codes where generated automatically.",
"type": "boolean"
}
},
"type": "object"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.TOTPAuthenticatorNotFound¶
No TOTP authenticator has been set up.
{
"meta": {
"secret": "J4ZKKXTK7NOVU7EPUVY23LCDV4T2QZYM",
"totp_url": "otpauth://totp/Example:alice@fsf.org?secret=JBSWY3DPEHPK3PXP&issuer=Example"
},
"status": 0
}
Schema of the response body
{
"properties": {
"meta": {
"properties": {
"secret": {
"description": "A TOTP secret that can be used to setup a new authenticator.\n",
"example": "J4ZKKXTK7NOVU7EPUVY23LCDV4T2QZYM",
"type": "string"
},
"totp_url": {
"description": "otpauth URI from which a QR code can be generated and scanned by OTP clients.\n",
"example": "otpauth://totp/Example:alice@fsf.org?secret=JBSWY3DPEHPK3PXP&issuer=Example",
"type": "string"
}
},
"required": [
"secret",
"totp_url"
],
"type": "object"
},
"status": {
"enum": [
404
],
"type": "integer"
}
},
"required": [
"status",
"meta"
],
"type": "object"
}
allauth.TooManyRequests¶
Too many requests.
{
"status": 0
}
Schema of the response body
{
"properties": {
"status": {
"enum": [
429
],
"type": "integer"
}
},
"required": [
"status"
],
"type": "object"
}
allauth.Unauthenticated¶
There is no authenticated session.
{
"summary": "Unauthenticated: Initial\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
Schema of the response body
null
allauth.WebAuthnAuthenticator¶
A WebAuthn authenticator.
{
"data": null,
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.WebAuthnAuthenticator"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.WebAuthnCreationOptionsResponse¶
WebAuthn credential creation options.
{
"data": null,
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.WebAuthnCredentialCreationOptions"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.WebAuthnRequestOptionsResponse¶
WebAuthn credential request options.
{
"data": null,
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.WebAuthnCredentialRequestOptions"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
Common parameters¶
This section describes common parameters that are reused across operations.
allauth.EmailVerificationKey¶
| Name | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
X-Email-Verification-Key |
header | string | No |
allauth.PasswordLess¶
| Name | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
passwordless |
query | boolean | No |
allauth.PasswordResetKey¶
| Name | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
X-Password-Reset-Key |
header | string | No |
Security schemes¶
| Name | Type | Scheme | Description |
|---|---|---|---|
| basicAuth | http | basic | |
| cookieAuth | apiKey | ||
| oauth2 | oauth2 | ||
| tokenAuth | apiKey | Token-based authentication with required prefix "Token" |
More documentation¶
More information about InvenTree in the official docs
For more information: https://docs.inventree.org