2
0
mirror of https://github.com/inventree/inventree-docs.git synced 2025-04-27 21:26:43 +00:00
Oliver 48baf7e051
API docs (#379)
* Move API documentation into separate directory

* Rearrange main docs bar

* Split python examples into separate page

* Fix broken links

* Adds page for browseable API

* Fix image links

* Add entrypoint page for barcodes

* Update barcode docs

* Add (empty) pages for internal and external barcods

* Add documentation on "internal" barcode format

* Documentation for external barcode functionality

* Skeleton page for custom barcode information

* Extend docs for custom barcodesplugins

* Add stubs for new API docs

* Add documentation for downloading data via the AP

* API metadata information

* docs for pythonic metadata access

* docs for bulk delete
2022-10-29 14:46:06 +11:00

1.9 KiB

title
title
Barcodes

Barcode Support

InvenTree has native support for barcodes, which provides powerful functionality "out of the box", and can be easily extended:

Barcode Data Types

Barcodes can be linked with the following data model types:

Web Integration

Barcode scanning can be enabled within the web interface. Barcode scanning in the web interface supports scanning via:

  • Keyboard style scanners (e.g. USB connected)
  • Webcam (image processing)

Configuration

Barcode scanning may need to be enabled for the web interface:

{% with id="barcode_config", url="barcode/barcode_settings.png", description="Barcode settings" %} {% include 'img.html' %} {% endwith %}

Scanning

When enabled, select the barcode icon in the top-right of the menu bar to scan a barcode. If the barcode is recognized by the system, the web browser will automatically navigate to the correct item:

{% with id="barcode_scan", url="barcode/barcode_scan.png", description="Barcode scan" %} {% include 'img.html' %} {% endwith %}

No Match Found

If no match is found for the scanned barcode, the following error message is displayed:

{% with id="barcode_no_match", url="barcode/barcode_no_match.png", description="No match for barcode" %} {% include 'img.html' %} {% endwith %}

App Integration

Barcode scanning is a key feature of the companion mobile app.