Magento 2 WebPOS User Guide

Aug 22, 2021 admin User Guide 0 comments

1. Installation

Never do anything directly on a live store. First setup and test on a development domain (i.e. “”).

Make sure that you set your Magento application to the developer mode.

1.1 Upload Extension

Use the zip “POS v1.4.7” for Magento 2.3.3 only. It requires a few vendor files which are available in 2.3.4 or 2.3.5 or 2.3.6. 

Use the zip of “POS v1.x.x” for Magento 2.4.x or any 2.3.x version (expect 2.3.3).

Unzip the zip file and upload all files and folders to the root folder of your Magento installation.

1.2 Install Extension

To install POS extensions, use the following commands:

bin/magento module:enable Acx_Webpos Acx_Backend
bin/magento setup:upgrade
rm -rf var/di generated/*
bin/magento setup:di:compile
rm -rf pub/static/*/*; rm -rf var/*/*;
bin/magento setup:static-content:deploy -f
bin/magento cache:flush

Please follow this link to learn more about Magento 2 module installation.

2. POS Configuration

WebPOS Configuration
WebPOS Configuration
  • Web POS Logo: Upload a logo for web POS. Recommended size is 250X50px and the logo format should be jpeg or png.
  • Web POS Color: Select a color for POS from dropdown list. Available colors are Blue, Green, Orange, and Red.
  • Enable Delivery Date: Yes/No can enable/disable delivery date for POS.
  • Session Timeout: Input integer value as second.
  • Allow to sync Order from WebPOS if there are out-stock items in that order: Yes/No can enable/disable sync order from WebPOS.
  • Enable Pole Display: Yes/No can enable/disable.
  • Enable All Products: Yes/No can enable/disable.

2.1.2  Shipping for POS:

  • Applicable Shipping Method: You can allow all shipping methods for POS that are available in your Magento store. Otherwise you can allow specific shipping methods for POS.
  • Default Shipping Method: Select a shipping method for work as default shipping method for POS.

2.1.3.  Payment for POS:

Payment for POS
  • Applicable Payment Method: You can allow all payment method for POS those are available in your Magento store. Otherwise you can allow specific payment method for POS.
  • Default Payment Method: Select a shipping method for work as default shipping method for POS.

2.1.4.  Product Search:

Product Search
  • Product Attribute for search: Select one or multiple attributes for searching any product on POS software. If you select “SKU”, you will be able to search products by SKU on POS frontend.
  • Default Shipping Method: Select a shipping method as default shipping method for POS.

2.1.5.  Barcode Attribute: By default, SKU attribute is used for Product Barcode. If you have a separate barcode data, you can select its attribute name for Barcode Product Attribute as below:

Barcode Configuration

To make an attribute visible in POS configuration, the attribute should be Unique.

product attribute for barcode

2.1.6.  Synchronization:

  • Product Synchronization Time: You can set a time interval how frequently the product data will be synced between the POS frontend and Magento backend. An interval time can be selected from the dropdown list in POS configuration.
  • Stock Item Synchronization Time: You can configure the time interval how frequently the inventory stock data will be synchronized automatically between POS and Magento store.
  • Customer Synchronization Time: You can select a duration from this dropdown list and set a time interval for syncing the customer data between POS and Magento store.
  • Limit Synchronization Orders: You can use this configuration to set a duration how old data can be synced with your POS frontend. It can be from the range of a week to a year.

2.1.7.  Default Guest Checkout: You can configure the default guest customer for POS.

2.2 POS Users and their Roles:

2.2.1 Go to AGILECODEX -> POS Settings -> Employees for POS

Employees for POS

You can see a list of staff that are added for POS as employees. For adding a new staff click on the “Add Staff” button top right corner. You will see the following screen appear.

New Staff
  • User name: Write a unique username. It will be needed for login to POS software.
  • Password: Password for POS user.
  • Display Name: User name will be displayed on POS frontend. 
  • Email Address: User email address.
  • Customer group: You can add the staff for specific customer groups. Such as  General, Wholesaler, Retailer.
  • Location: You can set a POS user for a specific location.
  • Role: Select the staff role as “admin” or “employees”. For creating a staff role, see the Employee Roles section.
  • Status: You can enable/disable staff.

2.2.2 Employee Roles: Go to AGILECODEX -> POS Settings -> Employee Role

Employee Role

You can see a list of roles that will be assigned for a POS staff. For adding a new role click on the “Add Role” button top right corner. You will see the following screen appear.

Employee New Rolee
  • General: 
    • Role Name: Write a unique role name.
    • Maximum Discount: Maximum discount percent cannot be higher than 100.
    • Description: Write a description to describe the role.
New Role Staff list

    Staff List: Select the staff that you want to assign for this role.

New Role Staff List

3. Sales Reports: Go to AGILECODEX -> POS Reports-> Sales


You can see or download the POS sales reports based on different criteria. You can filter sales reports for specific dates and you can set Order Status any or specified. 

4. POS Login:

You can access this POS software by clicking on AGILECODEX -> POS Checkout -> Checkout from Magento backend or directly browsing /webpos URL.


After clicking on Checkout from Magento backend, you will see POS login screen as below:


After login to POS, a splash screen will appear and the POS database will be synced automatically with your Magento store. When syncing is completed, you can see the below screen.

Add to Cart

4.1 WebPOS Checkout:

4.1.1 Add to cart: By clicking on the Product image or name, you can add it to the POS cart.

Add Customer

4.1.2 Create/Change Customer: Click on the top right corner “customer icon” will display below screen. You can create a new customer by clicking on the “Create Customer” button. Or you can search existing customers by name/email/phone.

Custom Price

4.1.3 Custom Price/Discount: Click on cart product allows you to change quantity, change product original price to custom price and add discount for this particular product.


4.1.4 Discount/Promotion: “Add Discount” button is for applying Discount/Promotion for all cart products.

  • Approved By: Name of staff.
  • Note: Reason for the discount.
  • Amount: Discount can maximum 100%

4.1.5 Checkout: Click on the “CHECKOUT” button to select payment or shipping methods according to the following screen.

Palace Order

4.1.5.a) Shipping: The Shipping Methods are what you allowed in Magento backend configuration. To proceed, please select a shipping method.

4.1.5.b) Payment: You can see available payment here. After choosing a payment method you will see the screen below.

Place Order

4.1.5.c) Mark as shipped: If you want to deliver directly to your customer, mark this Order as shipped.

4.1.5.d) Invoice: If you make this toggle active, invoice will generate automatically in Magento backend for this order. Disabling this toggle will just create an order without invoice.

4.1.5.e) Place Order: “PLACE ORDER” button will create the order and sync with Magento backend according to the configuration policy.


4.1.5.f) Print Invoice: Click on the “PRINT” button to generate an invoice sleep like the above screenshot.

4.1.5.g) New Order: Click on the “NEW ORDER” button you will go to the homepage of the POS.


Sync Notification: This notifies to the POS user when a synchronization event is successfully completed or even if failed.


5. Orders: Click “Orders” in the sidebar menu to see a list of orders available.

POS Order

6. On-hold Orders: Go to the “On-hold Orders” menu from the sidebar you will see on-hold orders available. You can delete on-hold order click on “Delete” button or you can continue checkout click on “Checkout” button.

On Hold Order

7. Shifts: Go to the “Shifts” menu from the sidebar, click on the “+” icon to register a shift for the POS employee.


8. Inventory: Go to the “Inventory” menu from the sidebar to see all products inventory are available here. You can search the specific product by Name/SKU.


9. Sync: You can sync Category, Product, Stock item etc from here. Click on “Update All” for sync all and if you want sync Product only click on “Product”.


10. Account: Go to the “Account” menu from the sidebar to change your POS account password


11. Catalog Management in Backend:

catalog backend

Enable On WebPOS: If you add a new product or edit an existing product make sure “Enable On WebPOS is YES” to display the product in WebPOS.

Updated: 09/09/2020

By: Agile Codex Ltd.


Copyright © Agile Codex Ltd.

Related Posts

Leave a Comment!

Your email address will not be published. Required fields are marked *

Let us know about your project!

We’d love to know more about your project and give estimation.