Files
InvenTree/docs/docs/barcodes/external.md
Oliver 3e73162368 Barcode scanning (#8732)
* Implement new "general purpose" barcode scan dialog

- Separated widgets for camera / keyboard / wedge scanner
- UI / UX improvements

* Handle scan results

* Fix missing imports

* Handle successful global scan

* Handle error when linking barcode

* Backend fix for InvenTreeInternalBarcodePlugin

* Error handling

* Working on scanner input

* Refactor scan page

* Callback from scanner input

* Refactoring <Scan> page

* Allow InvenTreeTable to be used with supplied data

* Refactor optionalparams

* Refactoring table of scan results

* Implement callbacks

* Navigate from barcode table

* Fix delete callback

* Refactor callbacks

* Refactor idAccessor

- Access as part of useTable hook
- No longer hard-coded to 'pk'

* prevent duplicate scans

* Fix for deleting items from table

* Cleanup

* Bump API version

* Adjust playwright tests

* Update playwright tests

* Update barcode screenshots

* Fix links

* Add quick links to barcode formats

* Updated screenshots

* Fix for BuildLineSubTable

* Specify idAccessor values

* Clear barcode input after timeout period

* Move items

* Fix for playwright test

* Remove debug print

* Additional error ignores

* Cleanup scanner input

- Simplify
- Prevent errant keycodes from closing the scanner dialog

* Playwright test adjustments
2024-12-28 20:38:53 +11:00

2.1 KiB

title
title
External Barcodes

External Barcodes

In addition to defining an internal barcode format, 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).

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.

  • 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_1", url="barcode/barcode_unlink_1.png", description="Unlink barcode" %} {% include 'img.html' %} {% endwith %}

{% with id="barcode_unlink_2", url="barcode/barcode_unlink_2.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