Skip to content

Commit

Permalink
[ADD] integration: introducing barcodelookup documentation
Browse files Browse the repository at this point in the history
In this commit:
- Added detailed documentation regarding barcodelookup feature
and the detailed usage guide in all related modules.

Task- 4464181
  • Loading branch information
sjai-odoo committed Jan 17, 2025
1 parent abdcb37 commit b96df76
Show file tree
Hide file tree
Showing 13 changed files with 140 additions and 0 deletions.
1 change: 1 addition & 0 deletions content/applications/general/integrations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ Integrations
integrations/unsplash
integrations/geolocation
integrations/google_translate
integrations/generic_barcodelookup
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
=========================
E-commerce Barcode Lookup
=========================

Ensure you have configured the API key for the Barcode Lookup feature in Odoo.
If not, refer to the :doc:`Barcodelookup API documentation <../generic_barcodelookup>`.

Create product from E-commerce
------------------------------

First open session after setting up the API key:

- Go to :guilabel:`New` from top right of the navbar and select :guilabel:`Product` from options
appear.

.. image:: ecom_barcodelookup/ecomsettings.png

- You can use any barcode to test the feature. Scan the barcode using a barcode scanner
or manually enter its value.
- The product details will be automatically populated within seconds. You can then customize additional
settings such as category, inventory tracking, and tax options. After configuring these settings, click
:guilabel:`Save` to complete the process.

.. image:: ecom_barcodelookup/autofill.png

- Once you click :guilabel:`Save`, the product will be created and you will be redirected to the product page.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
==================
POS Barcode Lookup
==================

Ensure you have configured the API key for the Barcode Lookup feature in Odoo.
If not, refer to the :doc:`Barcodelookup API key <../generic_barcodelookup>`.

Instant Product Creation from Point-of-sale
-------------------------------------------

To instantly create and use a product in the Point of Sale module:

- Open the Point of Sale module.
- Navigate to :guilabel:`Create Product` from the :guilabel:`options` menu at the top right of the navbar.

.. image:: pos_barcodelookup/createmenu.png

- Product creation popup will appear. You can scan the barcode using a barcode scanner or manually enter
its value to test the feature.
- Within moments of scanning, all relevant product details will be displayed. You can then set
additional options such as category, inventory tracking, and tax settings. Once everything is
configured, click :guilabel:`Save` to finalize the process.

.. image:: pos_barcodelookup/autofill.png

- The newly created product will be immediately available on the screen, ready for use, as shown below.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
===========================
Barcode Lookup in transfers
===========================

Ensure you have configured the API key for the Barcode Lookup feature in Odoo.
If not, refer to the :doc:`Barcodelookup API key <../generic_barcodelookup>`.

Create product in Transfers
---------------------------

- During any type of transfers, you encounter a product that is not available in the system.
- You can just scan the barcode of the product using a barcode scanner.
- Now you will have a toaster message saying that the product is not available in the system, would
you like to create it.
- You can use this example barcode to test the feature. Scan the barcode using a barcode scanner
or manually enter its value.
- Click on the create button and you will be redirected to the product creation popup prefilled with
the product information of the scanned barcode.

.. image:: stock_barcodelookup/toaster.png

- A new line will be created for the scanned barcode in the transfer.

.. image:: stock_barcodelookup/transfer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
:show-content:

=============
Barcodelookup
=============

.. toctree::
:titlesonly:

barcodelookup/pos_barcodelookup
barcodelookup/ecom_barcodelookup
barcodelookup/stock_barcodelookup

The Barcode Lookup feature allows users to quickly retrieve product information by scanning or entering
barcode numbers. This includes details like product names, descriptions, images, categories and
much more for UPC, EAN, or ISBN codes.

This feature reduces manual data entry, improves accuracy, and enhances efficiency in retail, e-commerce,
and point-of-sale systems by automatically populating product details in databases.

Configuration
=============

.. _barcodelookup/credentials:

Locate your Barcodelookup API
-----------------------------

- Visit the `Barcodelookup website <https://www.barcodelookup.com/api>`_.
- Click on the :guilabel:`Sign Up for the API` button, choose appropriate plan and continue.
- Fill in the required details and complete the registration process.
- Copy the API key provided and :ref:`configure it in odoo <barcodelookup/configure>`.

You will need this API key to set up the Barcodelookup feature in Odoo.

Configuration on Odoo
---------------------

To use barcodelookup on odoo modules:

.. _barcodelookup/configure:

#. Access the :menuselection:`Settings --> Integrations --> Barcode Database`.
#. Fill in the field with your :ref:`copied Barcodelookup API key <barcodelookup/credentials>` to activate
:guilabel:`Barcodelookup` feature.

.. image:: generic_barcodelookup/setting.png
:alt: setting to enable the barcodelookup feature

Once the setup is completed, you can use barcodelookup features for modules like POS, Barcode & E-commerce.

.. tip::
For saas users we already have the API key configured, so you can directly use the feature in saas.

- To create general product from backend, you can simply go to the product form and fill in the
barcode field.
- By filling the barcode field, the product details will be automatically fetched from the barcode
lookup API.

.. image:: generic_barcodelookup/product_creation.gif
:alt: product creation from backend

- This will save you time and effort in manually entering product details and help to maintain accurate data.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b96df76

Please sign in to comment.