The Label Printing section of the InvenTree API schema is documented below.

InvenTree API 196

API for InvenTree - the intuitive open source inventory management system

---

License: MIT

Servers

Description	URL
http://localhost:8000	http://localhost:8000

label

---

GET /api/label/buildline/

Description

API endpoint for viewing a list of BuildLineLabel objects.

Input parameters

Parameter	In	Type	Default	Nullable	Description
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
limit	query	integer		No	Number of results to return per page.
offset	query	integer		No	The initial index from which to return the results.
search	query	string		No	A search term.

Response 200 OK

application/json

{
    "count": 123,
    "next": "http://api.example.org/accounts/?offset=400&limit=100",
    "previous": "http://api.example.org/accounts/?offset=200&limit=100",
    "results": [
        {
            "description": "string",
            "enabled": true,
            "filters": "string",
            "height": 10.12,
            "label": "string",
            "name": "string",
            "pk": 0,
            "width": 10.12
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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/BuildLineLabel"
            },
            "type": "array"
        }
    },
    "type": "object"
}

---

POST /api/label/buildline/

Description

API endpoint for viewing a list of BuildLineLabel objects.

Input parameters

Parameter	In	Type	Default	Nullable	Description
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializes a BuildLineLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "required": [
        "label",
        "name",
        "pk"
    ],
    "type": "object"
}

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializes a BuildLineLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "required": [
        "label",
        "name",
        "pk"
    ],
    "type": "object"
}

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializes a BuildLineLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "required": [
        "label",
        "name",
        "pk"
    ],
    "type": "object"
}

Response 201 Created

application/json

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializes a BuildLineLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "required": [
        "label",
        "name",
        "pk"
    ],
    "type": "object"
}

---

DELETE /api/label/buildline/{id}/

Description

API endpoint for a single BuildLineLabel object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
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/buildline/{id}/

Description

API endpoint for a single BuildLineLabel object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
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

application/json

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializes a BuildLineLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "required": [
        "label",
        "name",
        "pk"
    ],
    "type": "object"
}

---

PATCH /api/label/buildline/{id}/

Description

API endpoint for a single BuildLineLabel object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializes a BuildLineLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "type": "object"
}

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializes a BuildLineLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "type": "object"
}

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializes a BuildLineLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "type": "object"
}

Response 200 OK

application/json

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializes a BuildLineLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "required": [
        "label",
        "name",
        "pk"
    ],
    "type": "object"
}

---

PUT /api/label/buildline/{id}/

Description

API endpoint for a single BuildLineLabel object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializes a BuildLineLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "required": [
        "label",
        "name",
        "pk"
    ],
    "type": "object"
}

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializes a BuildLineLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "required": [
        "label",
        "name",
        "pk"
    ],
    "type": "object"
}

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializes a BuildLineLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "required": [
        "label",
        "name",
        "pk"
    ],
    "type": "object"
}

Response 200 OK

application/json

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializes a BuildLineLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "required": [
        "label",
        "name",
        "pk"
    ],
    "type": "object"
}

---

GET /api/label/buildline/{id}/metadata/

Description

Generic API endpoint for reading and editing metadata for a model.

Input parameters

Parameter	In	Type	Default	Nullable	Description
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

application/json

{
    "metadata": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

---

PATCH /api/label/buildline/{id}/metadata/

Description

Generic API endpoint for reading and editing metadata for a model.

Input parameters

Parameter	In	Type	Default	Nullable	Description
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "metadata": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "type": "object"
}

{
    "metadata": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "type": "object"
}

{
    "metadata": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "type": "object"
}

Response 200 OK

application/json

{
    "metadata": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

---

PUT /api/label/buildline/{id}/metadata/

Description

Generic API endpoint for reading and editing metadata for a model.

Input parameters

Parameter	In	Type	Default	Nullable	Description
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "metadata": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

{
    "metadata": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

{
    "metadata": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

Response 200 OK

application/json

{
    "metadata": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

---

GET /api/label/buildline/{id}/print/

Description

Perform a GET request against this endpoint to print labels.

Input parameters

Parameter	In	Type	Default	Nullable	Description
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

---

POST /api/label/buildline/{id}/print/

Description

Perform a GET request against this endpoint to print labels.

Input parameters

Parameter	In	Type	Default	Nullable	Description
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

---

GET /api/label/location/

Description

API endpoint for viewiing list of StockLocationLabel objects.

Filterable by:

• enabled: Filter by enabled / disabled status
• location: Filter by a single stock location
• locations: Filter by list of stock locations

Input parameters

Parameter	In	Type	Default	Nullable	Description
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
limit	query	integer		No	Number of results to return per page.
offset	query	integer		No	The initial index from which to return the results.
search	query	string		No	A search term.

Response 200 OK

application/json

{
    "count": 123,
    "next": "http://api.example.org/accounts/?offset=400&limit=100",
    "previous": "http://api.example.org/accounts/?offset=200&limit=100",
    "results": [
        {
            "description": "string",
            "enabled": true,
            "filters": "string",
            "height": 10.12,
            "label": "string",
            "name": "string",
            "pk": 0,
            "width": 10.12
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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/StockLocationLabel"
            },
            "type": "array"
        }
    },
    "type": "object"
}

---

POST /api/label/location/

Description

API endpoint for viewiing list of StockLocationLabel objects.

Filterable by:

• enabled: Filter by enabled / disabled status
• location: Filter by a single stock location
• locations: Filter by list of stock locations

Input parameters

Parameter	In	Type	Default	Nullable	Description
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializes a StockLocationLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "required": [
        "label",
        "name",
        "pk"
    ],
    "type": "object"
}

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializes a StockLocationLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "required": [
        "label",
        "name",
        "pk"
    ],
    "type": "object"
}

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializes a StockLocationLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "required": [
        "label",
        "name",
        "pk"
    ],
    "type": "object"
}

Response 201 Created

application/json

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializes a StockLocationLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "required": [
        "label",
        "name",
        "pk"
    ],
    "type": "object"
}

---

DELETE /api/label/location/{id}/

Description

API endpoint for a single StockLocationLabel object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
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/location/{id}/

Description

API endpoint for a single StockLocationLabel object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
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

application/json

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializes a StockLocationLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "required": [
        "label",
        "name",
        "pk"
    ],
    "type": "object"
}

---

PATCH /api/label/location/{id}/

Description

API endpoint for a single StockLocationLabel object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializes a StockLocationLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "type": "object"
}

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializes a StockLocationLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "type": "object"
}

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializes a StockLocationLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "type": "object"
}

Response 200 OK

application/json

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializes a StockLocationLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "required": [
        "label",
        "name",
        "pk"
    ],
    "type": "object"
}

---

PUT /api/label/location/{id}/

Description

API endpoint for a single StockLocationLabel object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializes a StockLocationLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "required": [
        "label",
        "name",
        "pk"
    ],
    "type": "object"
}

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializes a StockLocationLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "required": [
        "label",
        "name",
        "pk"
    ],
    "type": "object"
}

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializes a StockLocationLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "required": [
        "label",
        "name",
        "pk"
    ],
    "type": "object"
}

Response 200 OK

application/json

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializes a StockLocationLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "required": [
        "label",
        "name",
        "pk"
    ],
    "type": "object"
}

---

GET /api/label/location/{id}/metadata/

Description

Generic API endpoint for reading and editing metadata for a model.

Input parameters

Parameter	In	Type	Default	Nullable	Description
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

application/json

{
    "metadata": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

---

PATCH /api/label/location/{id}/metadata/

Description

Generic API endpoint for reading and editing metadata for a model.

Input parameters

Parameter	In	Type	Default	Nullable	Description
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "metadata": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "type": "object"
}

{
    "metadata": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "type": "object"
}

{
    "metadata": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "type": "object"
}

Response 200 OK

application/json

{
    "metadata": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

---

PUT /api/label/location/{id}/metadata/

Description

Generic API endpoint for reading and editing metadata for a model.

Input parameters

Parameter	In	Type	Default	Nullable	Description
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "metadata": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

{
    "metadata": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

{
    "metadata": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

Response 200 OK

application/json

{
    "metadata": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

---

GET /api/label/location/{id}/print/

Description

Perform a GET request against this endpoint to print labels.

Input parameters

Parameter	In	Type	Default	Nullable	Description
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

---

POST /api/label/location/{id}/print/

Description

Perform a GET request against this endpoint to print labels.

Input parameters

Parameter	In	Type	Default	Nullable	Description
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

---

GET /api/label/part/

Description

API endpoint for viewing list of PartLabel objects.

Input parameters

Parameter	In	Type	Default	Nullable	Description
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
limit	query	integer		No	Number of results to return per page.
offset	query	integer		No	The initial index from which to return the results.
search	query	string		No	A search term.

Response 200 OK

application/json

{
    "count": 123,
    "next": "http://api.example.org/accounts/?offset=400&limit=100",
    "previous": "http://api.example.org/accounts/?offset=200&limit=100",
    "results": [
        {
            "description": "string",
            "enabled": true,
            "filters": "string",
            "height": 10.12,
            "label": "string",
            "name": "string",
            "pk": 0,
            "width": 10.12
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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/PartLabel"
            },
            "type": "array"
        }
    },
    "type": "object"
}

---

POST /api/label/part/

Description

API endpoint for viewing list of PartLabel objects.

Input parameters

Parameter	In	Type	Default	Nullable	Description
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializes a PartLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "required": [
        "label",
        "name",
        "pk"
    ],
    "type": "object"
}

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializes a PartLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "required": [
        "label",
        "name",
        "pk"
    ],
    "type": "object"
}

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializes a PartLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "required": [
        "label",
        "name",
        "pk"
    ],
    "type": "object"
}

Response 201 Created

application/json

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializes a PartLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "required": [
        "label",
        "name",
        "pk"
    ],
    "type": "object"
}

---

DELETE /api/label/part/{id}/

Description

API endpoint for a single PartLabel object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
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/part/{id}/

Description

API endpoint for a single PartLabel object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
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

application/json

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializes a PartLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "required": [
        "label",
        "name",
        "pk"
    ],
    "type": "object"
}

---

PATCH /api/label/part/{id}/

Description

API endpoint for a single PartLabel object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializes a PartLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "type": "object"
}

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializes a PartLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "type": "object"
}

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializes a PartLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "type": "object"
}

Response 200 OK

application/json

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializes a PartLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "required": [
        "label",
        "name",
        "pk"
    ],
    "type": "object"
}

---

PUT /api/label/part/{id}/

Description

API endpoint for a single PartLabel object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializes a PartLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "required": [
        "label",
        "name",
        "pk"
    ],
    "type": "object"
}

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializes a PartLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "required": [
        "label",
        "name",
        "pk"
    ],
    "type": "object"
}

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializes a PartLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "required": [
        "label",
        "name",
        "pk"
    ],
    "type": "object"
}

Response 200 OK

application/json

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializes a PartLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "required": [
        "label",
        "name",
        "pk"
    ],
    "type": "object"
}

---

GET /api/label/part/{id}/metadata/

Description

Generic API endpoint for reading and editing metadata for a model.

Input parameters

Parameter	In	Type	Default	Nullable	Description
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

application/json

{
    "metadata": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

---

PATCH /api/label/part/{id}/metadata/

Description

Generic API endpoint for reading and editing metadata for a model.

Input parameters

Parameter	In	Type	Default	Nullable	Description
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "metadata": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "type": "object"
}

{
    "metadata": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "type": "object"
}

{
    "metadata": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "type": "object"
}

Response 200 OK

application/json

{
    "metadata": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

---

PUT /api/label/part/{id}/metadata/

Description

Generic API endpoint for reading and editing metadata for a model.

Input parameters

Parameter	In	Type	Default	Nullable	Description
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "metadata": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

{
    "metadata": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

{
    "metadata": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

Response 200 OK

application/json

{
    "metadata": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

---

GET /api/label/part/{id}/print/

Description

Perform a GET request against this endpoint to print labels.

Input parameters

Parameter	In	Type	Default	Nullable	Description
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

---

POST /api/label/part/{id}/print/

Description

Perform a GET request against this endpoint to print labels.

Input parameters

Parameter	In	Type	Default	Nullable	Description
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

---

GET /api/label/stock/

Description

API endpoint for viewing list of StockItemLabel objects.

Filterable by:

• enabled: Filter by enabled / disabled status
• item: Filter by single stock item
• items: Filter by list of stock items

Input parameters

Parameter	In	Type	Default	Nullable	Description
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
limit	query	integer		No	Number of results to return per page.
offset	query	integer		No	The initial index from which to return the results.
search	query	string		No	A search term.

Response 200 OK

application/json

{
    "count": 123,
    "next": "http://api.example.org/accounts/?offset=400&limit=100",
    "previous": "http://api.example.org/accounts/?offset=200&limit=100",
    "results": [
        {
            "description": "string",
            "enabled": true,
            "filters": "string",
            "height": 10.12,
            "label": "string",
            "name": "string",
            "pk": 0,
            "width": 10.12
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

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/StockItemLabel"
            },
            "type": "array"
        }
    },
    "type": "object"
}

---

POST /api/label/stock/

Description

API endpoint for viewing list of StockItemLabel objects.

Filterable by:

• enabled: Filter by enabled / disabled status
• item: Filter by single stock item
• items: Filter by list of stock items

Input parameters

Parameter	In	Type	Default	Nullable	Description
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializes a StockItemLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "required": [
        "label",
        "name",
        "pk"
    ],
    "type": "object"
}

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializes a StockItemLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "required": [
        "label",
        "name",
        "pk"
    ],
    "type": "object"
}

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializes a StockItemLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "required": [
        "label",
        "name",
        "pk"
    ],
    "type": "object"
}

Response 201 Created

application/json

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializes a StockItemLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "required": [
        "label",
        "name",
        "pk"
    ],
    "type": "object"
}

---

DELETE /api/label/stock/{id}/

Description

API endpoint for a single StockItemLabel object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
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/stock/{id}/

Description

API endpoint for a single StockItemLabel object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
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

application/json

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializes a StockItemLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "required": [
        "label",
        "name",
        "pk"
    ],
    "type": "object"
}

---

PATCH /api/label/stock/{id}/

Description

API endpoint for a single StockItemLabel object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializes a StockItemLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "type": "object"
}

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializes a StockItemLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "type": "object"
}

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializes a StockItemLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "type": "object"
}

Response 200 OK

application/json

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializes a StockItemLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "required": [
        "label",
        "name",
        "pk"
    ],
    "type": "object"
}

---

PUT /api/label/stock/{id}/

Description

API endpoint for a single StockItemLabel object.

Input parameters

Parameter	In	Type	Default	Nullable	Description
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializes a StockItemLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "required": [
        "label",
        "name",
        "pk"
    ],
    "type": "object"
}

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializes a StockItemLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "required": [
        "label",
        "name",
        "pk"
    ],
    "type": "object"
}

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializes a StockItemLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "required": [
        "label",
        "name",
        "pk"
    ],
    "type": "object"
}

Response 200 OK

application/json

{
    "description": "string",
    "enabled": true,
    "filters": "string",
    "height": 10.12,
    "label": "string",
    "name": "string",
    "pk": 0,
    "width": 10.12
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializes a StockItemLabel object.",
    "properties": {
        "description": {
            "description": "Label description",
            "maxLength": 250,
            "nullable": true,
            "type": "string"
        },
        "enabled": {
            "description": "Label template is enabled",
            "type": "boolean"
        },
        "filters": {
            "description": "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"
        },
        "label": {
            "format": "uri",
            "type": "string"
        },
        "name": {
            "description": "Label name",
            "maxLength": 100,
            "type": "string"
        },
        "pk": {
            "readOnly": true,
            "title": "ID",
            "type": "integer"
        },
        "width": {
            "description": "Label width, specified in mm",
            "format": "double",
            "minimum": 2,
            "title": "Width [mm]",
            "type": "number"
        }
    },
    "required": [
        "label",
        "name",
        "pk"
    ],
    "type": "object"
}

---

GET /api/label/stock/{id}/metadata/

Description

Generic API endpoint for reading and editing metadata for a model.

Input parameters

Parameter	In	Type	Default	Nullable	Description
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

application/json

{
    "metadata": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

---

PATCH /api/label/stock/{id}/metadata/

Description

Generic API endpoint for reading and editing metadata for a model.

Input parameters

Parameter	In	Type	Default	Nullable	Description
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "metadata": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "type": "object"
}

{
    "metadata": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "type": "object"
}

{
    "metadata": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "type": "object"
}

Response 200 OK

application/json

{
    "metadata": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

---

PUT /api/label/stock/{id}/metadata/

Description

Generic API endpoint for reading and editing metadata for a model.

Input parameters

Parameter	In	Type	Default	Nullable	Description
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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
    "metadata": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

{
    "metadata": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

{
    "metadata": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

Response 200 OK

application/json

{
    "metadata": null
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "description": "Serializer class for model metadata API access.",
    "properties": {
        "metadata": {}
    },
    "required": [
        "metadata"
    ],
    "type": "object"
}

---

GET /api/label/stock/{id}/print/

Description

Perform a GET request against this endpoint to print labels.

Input parameters

Parameter	In	Type	Default	Nullable	Description
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

---

POST /api/label/stock/{id}/print/

Description

Perform a GET request against this endpoint to print labels.

Input parameters

Parameter	In	Type	Default	Nullable	Description
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

---

Schemas

BuildLineLabel

Name	Type
description	string| null
enabled	boolean
filters	string
height	number(double)
label	string(uri)
name	string
pk	integer
width	number(double)

Metadata

Name	Type
metadata

PaginatedBuildLineLabelList

Name	Type
count	integer
next	string(uri)| null
previous	string(uri)| null
results	Array<BuildLineLabel>

PaginatedPartLabelList

Name	Type
count	integer
next	string(uri)| null
previous	string(uri)| null
results	Array<PartLabel>

PaginatedStockItemLabelList

Name	Type
count	integer
next	string(uri)| null
previous	string(uri)| null
results	Array<StockItemLabel>

PaginatedStockLocationLabelList

Name	Type
count	integer
next	string(uri)| null
previous	string(uri)| null
results	Array<StockLocationLabel>

PartLabel

Name	Type
description	string| null
enabled	boolean
filters	string
height	number(double)
label	string(uri)
name	string
pk	integer
width	number(double)

PatchedBuildLineLabel

Name	Type
description	string| null
enabled	boolean
filters	string
height	number(double)
label	string(uri)
name	string
pk	integer
width	number(double)

PatchedMetadata

Name	Type
metadata

PatchedPartLabel

Name	Type
description	string| null
enabled	boolean
filters	string
height	number(double)
label	string(uri)
name	string
pk	integer
width	number(double)

PatchedStockItemLabel

Name	Type
description	string| null
enabled	boolean
filters	string
height	number(double)
label	string(uri)
name	string
pk	integer
width	number(double)

PatchedStockLocationLabel

Name	Type
description	string| null
enabled	boolean
filters	string
height	number(double)
label	string(uri)
name	string
pk	integer
width	number(double)

StockItemLabel

Name	Type
description	string| null
enabled	boolean
filters	string
height	number(double)
label	string(uri)
name	string
pk	integer
width	number(double)

StockLocationLabel

Name	Type
description	string| null
enabled	boolean
filters	string
height	number(double)
label	string(uri)
name	string
pk	integer
width	number(double)

Security schemes

Name	Type	Scheme	Description
basicAuth	http	basic
cookieAuth	apiKey
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