Requirements<\/h3>\n<\/div><\/div>\n\n\n\n

Bagisto<\/strong> 2.5.0<\/li>\n\n\n\n
Bagisto SaaS<\/strong> 2.5.0<\/li>\n\n\n\n
Bagisto POS<\/strong> 2.5.0<\/li>\n\n\n\n
Bagisto API<\/strong> for Bagisto 2.5<\/li>\n\n\n\n

PHP<\/strong> 8.4<\/li>\n<\/ul>\n\n\n\n
Note:<\/strong> Follow the POS SaaS installation steps below. Do not follow the installation steps in the Bagisto POS README.<\/p>\n\n\n\n
\n
Installation<\/h3>\n<\/div><\/div>\n\n\n\n
Step 1: Unzip and merge the files<\/h4>\n\n\n\n
Unzip the extension and merge its packages<\/code> folder into the project root directory.<\/p>\n\n\n\n
Step 2: Update composer.json<\/code><\/h4>\n\n\n\nAdd these lines under the psr-4<\/strong> section:<\/p>\n\n\n\n \"Webkul\\\\Pos\\\\\": \"packages\/Webkul\/Pos\/src\",\n\"Webkul\\\\PosSaas\\\\\": \"packages\/Webkul\/PosSaas\/src\"<\/pre>\n\n\n\nStep 3: Update bootstrap\/providers.php<\/code><\/h4>\n\n\n\nAdd these lines to the providers array:<\/p>\n\n\n\n Webkul\\Pos\\Providers\\PosServiceProvider::class,\nWebkul\\PosSaas\\Providers\\PosSaasServiceProvider::class,<\/pre>\n\n\n\nStep 4: Update config\/concord.php<\/code><\/h4>\n\n\n\nAdd these lines to the modules<\/code> array. The PosSaas line must be the last<\/strong> entry, after the SAASCustomizer module:<\/p>\n\n\n\n Webkul\\Pos\\Providers\\ModuleServiceProvider::class,\nWebkul\\PosSaas\\Providers\\ModuleServiceProvider::class,<\/pre>\n\n\n\nStep 5: Update .env<\/code><\/h4>\n\n\n\nAPP_DEBUG=false<\/pre>\n\n\n\nStep 6: Run the commands<\/h4>\n\n\n\nRun these commands from the project root directory:<\/p>\n\n\n\n composer dump-autoload<\/pre>\n\n\n\nphp artisan saas-pos:install<\/pre>\n\n\n\nsaas-pos:install<\/code> sets up POS for every existing tenant: it adds the POS settings, a ready-made receipt titled Preview Receipt<\/strong>, and the till’s connection key. Tenants who register later get the same setup automatically.<\/p>\n\n\n\n \nInclude POS in a subscription plan<\/h3>\n<\/div><\/div>\n\n\n\nPOS is a plan module. A tenant can only switch POS on when their plan includes it; if their plan changes to one without POS, POS is switched off for them.<\/p>\n\n\n\n \nIn the super admin panel, go to Subscription >> Plans<\/strong>.<\/li>\n\n\n\n Open the plan you want to change, or create a new one.<\/li>\n\n\n\n In the Module Assignment<\/strong> section, select Pos<\/strong> in Allow Modules<\/strong>.<\/li>\n\n\n\n Save the plan.<\/li>\n<\/ol>\n\n\n\nThe Module Assignment<\/strong> section appears when the subscription payment module is switched on in the super admin configuration.<\/p>\n\n\n\n \nConfigure POS for a tenant<\/h3>\n<\/div><\/div>\n\n\n\nThe tenant admin sets up POS from the tenant’s own admin panel. POS starts switched off<\/strong>, and the Point Of Sale (POS)<\/strong> menu stays hidden until it is switched on for at least one channel.<\/p>\n\n\n\n Switch POS on<\/h3>\n\n\n\n\nGo to Configure >> Point Of Sale >> Settings<\/strong>.<\/li>\n\n\n\n In the General<\/strong> section, switch Status<\/strong> on.<\/li>\n\n\n\n Click Save Configuration<\/strong>.<\/li>\n<\/ol>\n\n\n\n<\/figure>\n<\/div>\n\n\nSettings marked with a channel or language badge are saved per channel or per language. Choose the channel and language at the top of the page before you change them.<\/p>\n\n\n\n General<\/h3>\n\n\n\n\nStatus<\/strong>: Switches POS on for the channel. Agents cannot sign in while it is off.<\/li>\n\n\n\n Pos Logo<\/strong>: The logo on the till’s sign-in page. JPEG, PNG or SVG.<\/li>\n\n\n\n Heading On Login<\/strong>: The heading on the sign-in page, up to 50 characters.<\/li>\n\n\n\n Sub-Heading On Login<\/strong>: The line under the heading, up to 50 characters.<\/li>\n\n\n\n Footer Content<\/strong>: Text or HTML shown under the sign-in form, up to 250 characters.<\/li>\n\n\n\n Footer Note<\/strong>: A second footer line, such as a copyright notice, up to 100 characters.<\/li>\n<\/ul>\n\n\n\nBarcode<\/h3>\n\n\n\nThese settings apply to every channel of the tenant, except Hide Barcode<\/strong>, which is set per channel. Changing them does not change barcodes already generated: generate the barcodes again.<\/p>\n\n\n\n \nPrint Product Name<\/strong>: Prints the product name under each barcode.<\/li>\n\n\n\n Width<\/strong>: Barcode width in pixels.<\/li>\n\n\n\n Height<\/strong>: Barcode height in pixels.<\/li>\n\n\n\n Generate Barcode With<\/strong>: Product Sku<\/strong> or Product Id<\/strong>: what the barcode encodes.<\/li>\n\n\n\n Prefix<\/strong>: Up to 6 characters added in front of every barcode. The till adds it to a scanned code that lacks it.<\/li>\n\n\n\n Hide Barcode<\/strong>: Hides the barcode button from the till.<\/li>\n<\/ul>\n\n\n\nProducts<\/h3>\n\n\n\nAllow SKU for Custom Product:<\/strong> shows a SKU<\/strong> field when an agent adds a product that exists only at the till.<\/p>\n\n\n\n POS API<\/h3>\n\n\n\n\nAgent Token Lifetime (Days)<\/strong>: How long an agent who ticked Remember Password<\/strong> stays signed in. Leave it empty for 30 days. Without Remember Password<\/strong>, a sign-in lasts one day.<\/li>\n\n\n\n Storefront Key<\/strong>: The key the till uses to reach your store. It is filled in automatically; leave it unchanged.<\/li>\n<\/ul>\n\n\n\nEU Withdrawals<\/h3>\n\n\n\nHandle EU Withdrawals on POS:<\/strong> lets authorised agents handle EU right-of-withdrawal requests at the till. EU withdrawals must also be enabled under Configure >> Sales >> EU Withdrawals<\/strong> for the same channel, and the agent must be allowed to handle them, which you set on the agent (see Agents below).<\/p>\n\n\n\n Customers<\/h3>\n\n\n\nEmail New Customers a Password Setup Link:<\/strong> customers registered at the till receive an email with a link to set their own password. It is on by default.<\/p>\n\n\n\n Payment method titles<\/h3>\n\n\n\nGo to Configure >> Point Of Sale >> Payment Methods<\/strong> to change the Title<\/strong> and Description<\/strong> of Pos Cash Payment<\/strong>, Pos Card Payment<\/strong> and Pos Split Payment<\/strong>. These names appear on orders and in the sales report.<\/p>\n\n\n \n<\/figure>\n<\/div>\n\n\n\nReceipts<\/h3>\n<\/div><\/div>\n\n\n\nA receipt is the template the till prints after a sale. Each outlet uses one receipt, and every tenant starts with a receipt titled Preview Receipt<\/strong>.<\/p>\n\n\n \n<\/figure>\n<\/div>\n\n\nCreate a receipt<\/h3>\n\n\n\n\nGo to Point Of Sale (POS) >> Receipts<\/strong>.<\/li>\n\n\n\n Click Create Receipt<\/strong>.<\/li>\n\n\n\n Enter the Receipt Title<\/strong> and choose the Paper Width<\/strong>: 58 mm<\/strong>, 80 mm<\/strong> or 104 mm<\/strong>.<\/li>\n\n\n\n Switch on what the receipt shows, such as Display Outlet Name<\/strong>, Show Order Barcode<\/strong>, Display Date<\/strong>, Display Order ID<\/strong>, Display Customer Name<\/strong>, Display Tax<\/strong> and Display Cashier Name<\/strong>, and change the labels printed beside them.<\/li>\n\n\n\n Switch on Mask Customer Details<\/strong> to hide part of the customer’s details on the printed receipt.<\/li>\n\n\n\n In Logo<\/strong>, switch on Display Logo<\/strong> and upload the logo.<\/li>\n\n\n\n Enter the Header Content<\/strong> and Footer Content<\/strong>.<\/li>\n\n\n\n Switch Status<\/strong> on.<\/li>\n\n\n\n Click Save Receipt<\/strong>.<\/li>\n<\/ol>\n\n\n\n<\/figure>\n<\/div>\n\n\nClick Preview<\/strong> in the receipts list to see a receipt as it prints. A receipt that an outlet uses cannot be deleted.<\/p>\n\n\n\n \nOutlets<\/h3>\n<\/div><\/div>\n\n\n\nAn outlet is a physical store. It sells from its own inventory source and prints its own receipt.<\/p>\n\n\n\n Create an outlet<\/h3>\n\n\n\n\nGo to Point Of Sale (POS) >> Agents >> Outlets<\/strong>.<\/li>\n\n\n\n Click Create Outlet<\/strong>.<\/li>\n\n\n\n Switch Status<\/strong> on. An outlet saved with Status<\/strong> off is inactive, and its agents cannot sign in.<\/li>\n\n\n\n Enter the Outlet Name<\/strong>, Email<\/strong>, Phone<\/strong>, Website<\/strong> and Customer Care Number<\/strong>, and the GST Number<\/strong> if you have one.<\/li>\n\n\n\n In Receipt<\/strong>, choose the receipt the outlet prints.<\/li>\n\n\n\n Enter the Outlet Address<\/strong>: Address<\/strong>, Country<\/strong>, State<\/strong>, City<\/strong> and Postcode<\/strong>.<\/li>\n\n\n\n In Inventory<\/strong>, choose the Inventory Source<\/strong> and enter the Low Stock Quantity<\/strong>.<\/li>\n\n\n\n Click Save Outlet<\/strong>.<\/li>\n<\/ol>\n\n\n\n<\/figure>\n<\/div>\n\n\n<\/figure>\n<\/div>\n\n\nClick POS Front<\/strong> to open the till in a new tab.<\/p>\n\n\n\n Stock is shared with your online store<\/h3>\n\n\n\nAn outlet sells from the inventory source you choose, the same stock your online store sells from. A sale at the till lowers the stock online, and an online sale lowers the stock at the till. Each inventory source can belong to only one outlet.<\/p>\n\n\n\n The Low Stock Quantity<\/strong> decides which products the till lists as low in stock. The agent can change it at the till under Products >> Settings<\/strong>.<\/p>\n\n\n\n Assign products to an outlet<\/h3>\n\n\n\nAn outlet sells only the products you assign to it. New products are not assigned automatically.<\/p>\n\n\n\n \nGo to Point Of Sale (POS) >> Agents >> Outlets<\/strong>.<\/li>\n\n\n\n In the outlet’s row, click the Assign Product<\/strong> icon.<\/li>\n\n\n\n For each product, set the POS Status<\/strong> to Active<\/strong>. To assign or unassign several products at once, select them and use Select Action >> Update Assign<\/strong>.<\/li>\n<\/ol>\n\n\n\n<\/figure>\n<\/div>\n\n\nThe quantity shown is the stock in the outlet’s inventory source.<\/p>\n\n\n\n Deleting an outlet<\/h3>\n\n\n\nAn outlet that still has agents cannot be deleted. Move its agents to another outlet, or delete them, first.<\/p>\n\n\n\n \nAgents<\/h3>\n<\/div><\/div>\n\n\n\nAn agent is a person who sells at the till. Each agent belongs to one outlet.<\/p>\n\n\n\n Create an agent<\/h3>\n\n\n\n\nGo to Point Of Sale (POS) >> Agents >> Agents<\/strong>.<\/li>\n\n\n\n Click Create Agent<\/strong>.<\/li>\n\n\n\n Enter the Username<\/strong>, First Name<\/strong>, Last Name<\/strong> and Email<\/strong>. The username and email must be unique within your store.<\/li>\n\n\n\n Switch Status<\/strong> on.<\/li>\n\n\n\n Switch Can Handle EU Withdrawals<\/strong> on if this agent may handle EU withdrawal requests.<\/li>\n\n\n\n Choose the agent’s Outlet<\/strong>.<\/li>\n\n\n\n Enter the Password<\/strong>, at least 6 characters, and Confirm Password<\/strong>.<\/li>\n\n\n\n Optionally, upload a picture in Upload Agent Image<\/strong>.<\/li>\n\n\n\n Click Save Agent<\/strong>.<\/li>\n<\/ol>\n\n\n\n<\/figure>\n<\/div>\n\n\nThe agent receives a registration email. Changing an agent’s password later signs them out of the till.<\/p>\n\n\n \n<\/figure>\n<\/div>\n\n\n\nBanks<\/h3>\n<\/div><\/div>\n\n\n\nBanks appear at the till when an agent takes a card or split payment, so the payment is recorded against the right bank.<\/p>\n\n\n\n \nGo to Point Of Sale (POS) >> Banks<\/strong>.<\/li>\n\n\n\n Click Create Bank<\/strong>.<\/li>\n\n\n\n Enter the bank’s Name<\/strong>, Address<\/strong>, Email<\/strong> and Phone<\/strong>. The name can contain letters, spaces, apostrophes, full stops and hyphens, but no digits.<\/li>\n\n\n\n Switch Bank Status<\/strong> on.<\/li>\n\n\n\n In Assign Pos Agent<\/strong>, choose the agent who uses this bank.<\/li>\n\n\n\n Click Save Bank<\/strong>.<\/li>\n<\/ol>\n\n\n\n<\/figure>\n<\/div>\n\n\n<\/figure>\n<\/div>\n\n\n\nBarcode products<\/h3>\n<\/div><\/div>\n\n\n\nGo to Point Of Sale (POS) >> Barcode Products<\/strong> to give products a barcode the till can scan.<\/p>\n\n\n\n Generate barcodes<\/h3>\n\n\n\n\nSelect the products.<\/li>\n\n\n\n Choose Select Action >> Generate Barcode<\/strong>.<\/li>\n\n\n\n Click Agree<\/strong>.<\/li>\n<\/ol>\n\n\n\nTo generate one product’s barcode, click the Generate Barcode<\/strong> icon in its row.<\/p>\n\n\n \n<\/figure>\n<\/div>\n\n\nPrint barcodes<\/h3>\n\n\n\n\nClick the Print Barcode<\/strong> icon in a product’s row, or select several products and click Print Barcode<\/strong>.<\/li>\n\n\n\n Enter the Qty<\/strong>: how many copies of each barcode to print, from 1 to 100.<\/li>\n\n\n\n Click Print<\/strong>.<\/li>\n<\/ol>\n\n\n\n<\/figure>\n<\/div>\n\n\nA product without a barcode cannot be printed: generate its barcode first.<\/p>\n\n\n\n \nOrders<\/h3>\n<\/div><\/div>\n\n\n\nGo to Point Of Sale (POS) >> Orders<\/strong> to see every till sale with its customer, agent, outlet, date, total and status. Click the eye icon to open the order in Sales >> Orders<\/strong>, where POS orders also show the Order Note<\/strong> the agent added.<\/p>\n\n\n \n<\/figure>\n<\/div>\n\n\n\nSales report<\/h3>\n<\/div><\/div>\n\n\n\nGo to Point Of Sale (POS) >> Sales Report<\/strong> to see each sale with its outlet, agent, payment method, bank and order note. Use Filter<\/strong> to narrow the list, and Export<\/strong> to download it.<\/p>\n\n\n \n<\/figure>\n<\/div>\n\n\n\nProduct requests<\/h3>\n<\/div><\/div>\n\n\n\nWhen an outlet runs low, its agent sends a request from the till. Go to Point Of Sale (POS) >> Requests<\/strong> to see them.<\/p>\n\n\n \n<\/figure>\n<\/div>\n\n\nComplete a request<\/h3>\n\n\n\n\nGo to Point Of Sale (POS) >> Requests<\/strong>.<\/li>\n\n\n\n Click the view icon in the request’s row.<\/li>\n\n\n\n Check the User Information<\/strong> and Request Information<\/strong>, including the agent’s Comment<\/strong>.<\/li>\n\n\n\n Set Status<\/strong> to Complete<\/strong> or Decline<\/strong>.<\/li>\n\n\n\n Click Save<\/strong>.<\/li>\n<\/ol>\n\n\n\n<\/figure>\n<\/div>\n\n\nCompleting a request adds the requested quantity<\/strong> to the outlet’s inventory source, and cannot be undone. A request can be declined only while it is pending. A request for a configurable product cannot be completed: ask the agent to request a specific variant.<\/p>\n\n\n\n To update several requests at once, select them and use Select Action >> Update Status<\/strong>.<\/p>\n\n\n\n \nDrawer sessions<\/h3>\n<\/div><\/div>\n\n\n\nGo to Point Of Sale (POS) >> Drawer Sessions<\/strong> to see every cash drawer an agent opened: who opened it, at which outlet, when it opened and closed, the opening and closing amounts, and the remarks. Use Export<\/strong> to download the list.<\/p>\n\n\n \n

Installation<\/h3>\n<\/div><\/div>\n\n\n\n

Step 1: Unzip and merge the files<\/h4>\n\n\n\n
Unzip the extension and merge its `packages<\/code> folder into the project root directory.<\/p>\n\n\n\n`

Configure POS for a tenant<\/h3>\n<\/div><\/div>\n\n\n\n
The tenant admin sets up POS from the tenant’s own admin panel. POS starts switched off<\/strong>, and the Point Of Sale (POS)<\/strong> menu stays hidden until it is switched on for at least one channel.<\/p>\n\n\n\n

Products<\/h3>\n\n\n\n
Allow SKU for Custom Product:<\/strong> shows a SKU<\/strong> field when an agent adds a product that exists only at the till.<\/p>\n\n\n\n

Outlets<\/h3>\n<\/div><\/div>\n\n\n\n
An outlet is a physical store. It sells from its own inventory source and prints its own receipt.<\/p>\n\n\n\n

Agents<\/h3>\n<\/div><\/div>\n\n\n\n
An agent is a person who sells at the till. Each agent belongs to one outlet.<\/p>\n\n\n\n

Barcode products<\/h3>\n<\/div><\/div>\n\n\n\n
Go to Point Of Sale (POS) >> Barcode Products<\/strong> to give products a barcode the till can scan.<\/p>\n\n\n\n

Installation<\/h3>\n<\/div><\/div>\n\n\n\n

Step 1: Unzip and merge the files<\/h4>\n\n\n\nUnzip the extension and merge its packages<\/code> folder into the project root directory.<\/p>\n\n\n\n

Configure POS for a tenant<\/h3>\n<\/div><\/div>\n\n\n\nThe tenant admin sets up POS from the tenant’s own admin panel. POS starts switched off<\/strong>, and the Point Of Sale (POS)<\/strong> menu stays hidden until it is switched on for at least one channel.<\/p>\n\n\n\n

Products<\/h3>\n\n\n\nAllow SKU for Custom Product:<\/strong> shows a SKU<\/strong> field when an agent adds a product that exists only at the till.<\/p>\n\n\n\n

Outlets<\/h3>\n<\/div><\/div>\n\n\n\nAn outlet is a physical store. It sells from its own inventory source and prints its own receipt.<\/p>\n\n\n\n