mirror of
https://github.com/inventree/inventree-docs.git
synced 2025-04-28 13:46:54 +00:00
48baf7e051
* 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
46 lines
1.9 KiB
Markdown
46 lines
1.9 KiB
Markdown
---
|
|
title: External Barcodes
|
|
---
|
|
|
|
## External Barcodes
|
|
|
|
In addition to defining an [internal barcode format](./internal.md), models which have associated barcode information also allow arbitrary external (third party) barcodes to be assigned or "linked" to items in the database.
|
|
|
|
For example, you have just purchased a reel of capacitors from a supplier, which comes provided with a sufficiently unique barcode or qr-code. Instead of printing an *internal* barcode, the existing barcode can be scanned and *linked* to the specific reel (which is a [Stock Item](../stock/stock.md#stock-item)).
|
|
|
|
Linking to external barcodes allows an alternative barcode workflow, which may be especially useful when dealing with in-feed components which are received from external suppliers.
|
|
|
|
!!! tip "Dealer's Choice"
|
|
The use of external barcodes is entirely up to the user, if it is deemed to be convenient.
|
|
|
|
## Linking Barcodes
|
|
|
|
### Via the API
|
|
|
|
Facility for barcode linking (and un-linking) is provided via the [API](../api/api.md).
|
|
|
|
- The `/api/barcode/link/` API endpoint is used to link a barcode with an existing database item
|
|
- The `/api/barcode/unlink/` API endpoint is used to unlink a barcode from an existing database item
|
|
|
|
### Via the Web Interface
|
|
|
|
To link an arbitrary barcode, select the *Link Barcode* action as shown below:
|
|
|
|
{% with id="barcode_link_1", url="barcode/barcode_link_1.png", description="Link barcode" %}
|
|
{% include 'img.html' %}
|
|
{% endwith %}
|
|
|
|
{% with id="barcode_link_2", url="barcode/barcode_link_2.png", description="Link barcode" %}
|
|
{% include 'img.html' %}
|
|
{% endwith %}
|
|
|
|
If an item already has a linked barcode, it can be un-linked by selecting the *Unlink Barcode* action:
|
|
|
|
{% with id="barcode_unlink", url="barcode/barcode_unlink.png", description="Unlink barcode" %}
|
|
{% include 'img.html' %}
|
|
{% endwith %}
|
|
|
|
### Via the App
|
|
|
|
External barcodes can be linked to (or unlinked from) database items via the [mobile app](../app/barcode.md)
|