2
0
mirror of https://github.com/inventree/InvenTree.git synced 2025-05-07 15:58:49 +00:00
InvenTree/docs/docs/barcodes/internal.md
Oliver 2ffd2354eb
Documentation integration (#4653)
* Add documentation under docs/ directory

* Add CI workflow for mkdocs configuration checking

* Add documentation issue template

* update pip-tools?

* Update .gitignore files

* Fix .gitignore rules

* Improve release notes page

* remove references to old repo
2023-04-22 22:40:29 +10:00

1.2 KiB

title
title
Internal Barcodes

Internal Barcodes

InvenTree defines an internal format for generating barcodes for various items. This format uses a simple JSON-style string to uniquely identify an item in the database.

Some simple examples of this format are shown below:

Model Type Example Barcode
Part {% raw %}{"part": 10}{% endraw %}
Stock Item {% raw %}{"stockitem": 123}{% endraw %}
Supplier Part {% raw %}{"supplierpart": 99}{% endraw %}

The numerical ID value used is the Primary Key (PK) of the particular object in the database.

Report Integration

This barcode format can be used to generate 1D or 2D barcodes (e.g. for labels and reports)

To access the raw barcode information string within a template, use the .barcode attribute, and pass it into a barcode generation method.

Example: QR Code

For example, to render a QR-Code image for a part instance:

{% raw %}
<img src='{% qrcode part.barcode %}'>
{% endraw %}

!!! info "Barcode Formatting" Refer to the report documentation for further information on formatting barcode data