Stocky · version 5.8

Inventory, point of sale, online store & accounting

One Laravel application for the counter, the stockroom, the web shop and the books. A touch-first register that keeps selling offline, live stock across every warehouse, purchases and returns, double-entry accounting, HRM, sixty reports and a storefront with five themes. This guide covers installing it and running it.

Welcome

Stocky is one system for one business. The product the cashier scans is the same row the online shop sells, the row a WooCommerce or Shopify sync pushes, the row a purchase order restocks and the row the stock-aging report counts. Nothing is copied between screens, so nothing has to be reconciled — one catalogue, one stock figure, every channel.

/next/dashboard

What is in the box

How to read this guide

Sections follow the order you will actually need them: install it, set the business up, then each module in the order the sidebar lists it. Every screen named here exists in the product — where something is deliberately absent it is listed under Deliberately not here rather than described as if it were built. Paths such as Settings → POS Settings refer to the sidebar; the address bar shows the same page under /next/….

The shape of every screen

Lists work the same way throughout: a search box and filters at the top of the card, a table, paging at the bottom, and export buttons where a list is worth exporting. Record pages open with a header — the reference, the status pills, the buttons that change its state — and then the detail. The POS is the exception: it is a full-screen application of its own, opened from the purple POS button in the header.

Server requirements

Stocky runs on ordinary PHP hosting. There is no Docker, no Node on the server and nothing to compile — the front-end assets ship already built. Cron and a queue worker are optional; see Cron & queue for what they add.

Optional hardware

Nothing is bundled and nothing is proprietary. A USB or Bluetooth barcode scanner behaves as a keyboard and needs no driver. A phone or tablet camera scans in the browser. Thermal receipt printers print through the browser dialog, silently through QZ Tray on the cashier's computer, or directly to a network printer by IP address. Cash drawers kick through the receipt printer. Label printers take the barcode sheets. Digital scales that print weight-embedded barcodes are read as product plus kilograms.

Installing Online

Stocky installs itself in a browser. You do not need shell access, phpMyAdmin or a command line.

1. Upload and unzip

   Put the contents of the ZIP on your server and point the domain at the public/ folder. Everything is included — you do not need to run composer install or npm.

2. Open /setup

   Browse to https://your-domain/setup. You land on the requirements check. Every card must be green — the PHP version, the twelve extensions and the ZipArchive class. If one is not, enable it on the server and press Re-check requirements. Nothing has been written yet.

   /setup

   

3. Application settings

   The application name, the environment (Production for a live shop), debug mode (Off on a live server), an application key — press Generate — and the application URL, exactly as people will type it, with https://. All of this lands in .env and can be edited there later.

   /setup/step-1

   

4. Database

   Host, port, database name, username and password for an empty MySQL database. Press Test connection; the Continue button only appears once the test passes.

   /setup/step-2

   

5. Review and install

   Check the summary, then press Install Stocky. This writes .env, creates every table, installs the API keys and seeds the reference data: the Owner role, the permissions, the default warehouse, currencies, payment methods, settings and the translations for all 24 languages. Keep the tab open; it can take a few minutes on slow hosting.

6. Sign in

   The finish page shows the default administrator: admin@example.com with the password 123456. Press Go to login.

If the install fails

Installing Locally

To try Stocky on a Windows computer before you go live, install it on Laragon or XAMPP. The browser installer is the same one described above; only the preparation differs. Laragon is the easier of the two — it creates a local domain pointing at public/ on its own, and it ships MySQL 8. XAMPP needs a virtual host written by hand.

Laragon

1. Install Laragon and check PHP

   Download Laragon from laragon.org and install it in C:\laragon. Open Menu → PHP → Version: Stocky needs PHP 8.2 or newer. If only an older one is listed, download a PHP 8.2+ build (VS16 x64 Thread Safe ZIP) from windows.php.net, unzip it into its own folder under C:\laragon\bin\php\, and pick it in the same menu.

2. Enable the extensions

   Menu → PHP → Extensions. Make sure curl, fileinfo, gd, mbstring, openssl, pdo_mysql and zip are ticked. Laragon restarts Apache on its own after each change.

3. Copy the files

   Unzip Stocky into C:\laragon\www\stocky, so that C:\laragon\www\stocky\public exists — not C:\laragon\www\stocky\stocky\public. The folder name becomes the local address.

4. Start and get the address

   Run Laragon as administrator the first time (it needs to write the Windows hosts file) and press Start All. With Menu → Preferences → General → Auto create virtual hosts ticked (the default), Laragon creates http://stocky.test and points it at the public/ folder. If the address does not open, press Reload in Laragon.

5. Create the database

   Press Database in Laragon to open HeidiSQL and connect with user root and an empty password. Right-click the connection → Create new → Database, name it stocky, collation utf8mb4_unicode_ci.

6. Run the installer

   Open http://stocky.test/setup and follow the four steps. Application URL: http://stocky.test. Database: host 127.0.0.1, port 3306, database stocky, user root, password empty.

XAMPP

1. Install XAMPP

   Download the PHP 8.2 or newer build of XAMPP from apachefriends.org and install it in C:\xampp. Open the XAMPP Control Panel and start Apache and MySQL.

2. Enable the extensions

   Control Panel → Apache Config → PHP (php.ini). Remove the leading ; from any of these lines that still have one, raise the two limits, save, then Stop and Start Apache:

   extension=curl
   extension=fileinfo
   extension=gd
   extension=mbstring
   extension=openssl
   extension=pdo_mysql
   extension=zip
   
   max_execution_time=300
   memory_limit=512M

3. Copy the files

   Unzip Stocky into C:\xampp\htdocs\stocky, so that C:\xampp\htdocs\stocky\public exists.

4. Add a virtual host

   XAMPP does not create local domains. Open C:\xampp\apache\conf\extra\httpd-vhosts.conf in a text editor and add at the end:

   <VirtualHost *:80>
       ServerName localhost
       DocumentRoot "C:/xampp/htdocs"
   </VirtualHost>
   
   <VirtualHost *:80>
       ServerName stocky.test
       DocumentRoot "C:/xampp/htdocs/stocky/public"
       <Directory "C:/xampp/htdocs/stocky/public">
           AllowOverride All
           Require all granted
       </Directory>
   </VirtualHost>

   The first block keeps http://localhost and phpMyAdmin working. Then open Notepad as administrator, open C:\Windows\System32\drivers\etc\hosts, add the line below, save, and restart Apache:

   127.0.0.1    stocky.test

5. Create the database

   Open http://localhost/phpmyadmin → Databases. Name stocky, collation utf8mb4_unicode_ci, Create.

6. Run the installer

   Open http://stocky.test/setup and follow the four steps. Application URL: http://stocky.test. Database: host 127.0.0.1, port 3306, database stocky, user root, password empty.

Common local problems

Scheduled tasks are optional on a local install; if you want them, see Cron & queue — on Windows they run from Task Scheduler. To move a local install to a live server later, export the database, upload the files and the public/images folder, import the database there, and change APP_URL and APP_DEBUG=false in .env.

Updating

Settings → Update. Three tabs: Automatic Update, Manual Update and the Update Guide. The installed version is shown against the latest one published on the update server.

/next/settings/update

Automatic update

1. Back up

   The updater takes its own backup of the files and the database, but take a database backup of your own first anyway.

2. Upload the ZIP

   Download the new version from CodeCanyon and drop the full application ZIP onto the page. Nothing is touched yet: the pre-update checks validate the archive, its structure, the version, PHP requirements, permissions, disk space and the database connection.

3. Install

   Press Install. Stocky backs up the files and the database to storage/app/updater/backups, puts the site into maintenance mode, replaces the files, runs the migrations and permission sync, and comes back. Keep the tab open; a bypass link is shown in case you lose the page.

4. Reload

   Hard-refresh the browser (Ctrl + Shift + R) so it loads the new admin files. Check the version number in the footer.

If anything fails the previous version is restored automatically. If the rollback itself cannot finish, the page says Recovery required and offers Open Recovery Console — a standalone page at /system-update/recovery that works even in maintenance mode, where you can continue where it stopped, roll back, or discard the run. The pre-update backup stays intact until you resolve it. Update backups keeps the last few (three by default); the only remaining complete one can never be deleted.

Manual update

For hosts where the automatic updater cannot write, or if you prefer to see each step. The Manual Update tab describes it; in short:

1. Back up the database and the public/images and storage/app folders.
2. Upload the new files over the old ones. Do not delete or replace your .env file, the public/images/ folder or the storage/ folder — they hold your configuration, uploaded images and generated files, and removing them would break the installation and lose your data.
3. Open https://your-domain/update.
4. Hard-refresh the browser.

Your first hour

A fresh install already knows the shape of a shop — it has a default warehouse, a walk-in customer, a set of payment methods and a currency. This is the shortest route from there to a counter that sells.

1. Company details

   Settings → System Settings. Company name, logo, phone, email and address print on every receipt and invoice. Set the default currency, the timezone, the date and price formats, and the default warehouse and customer the POS opens with.

2. Warehouses

   Settings → Warehouses. One is enough. Add one per shop, store-room or van if stock physically lives in different places — every stock figure is per warehouse, and users can be limited to the warehouses they may see.

3. Categories, brands and units

   Products → Categories / Brand / Units. Short lists you edit rarely. Units can convert (a carton of 12 pieces); categories can carry an icon and an image for the POS tiles and the store.

4. Products

   Products → Create product for a few, Import products for a spreadsheet. A product needs a name, a code, a category, a unit, a cost and a price; everything else — barcode symbology, tax, images, variants, stock alerts — can come later.

5. Opening stock

   Products → Opening Stock imports a quantity per product per warehouse. Or receive your first purchase, which is the honest way to start a stock figure with a cost behind it.

6. Payment methods

   Settings → Payment Methods. Cash, card, bank transfer and so on are seeded; hide the ones you do not take. Add a cash account under Accounting → List accounts if you want payments to land in named accounts.

7. The receipt

   Settings → POS Receipt. Pick the paper width (58 or 80 mm), one of the five layouts, and what prints on it — the preview on the right is live. Settings → POS Settings holds the rest: auto-print, hold sales, the cash drawer and keyboard shortcuts.

8. Users

   User Management → Group Permissions to create a Cashier role with only the POS and sales permissions, then Users to add each person with that role and the warehouses they may see.

9. Open the POS and sell something

   Press the purple POS button in the header. Open the register with a float, pick the warehouse, tap or scan a product, Pay Now, cash, Complete Payment. The receipt prints; the stock moved.

Demo catalogues

Four seeders fill the store with a themed catalogue, complete with pictures, so you can see a theme with real products before entering your own. Each one switches the store to its theme and is safe to run more than once:

php artisan db:seed --class=ElectronicsDemoSeeder
php artisan db:seed --class=ToysDemoSeeder
php artisan db:seed --class=GroceryDemoSeeder
php artisan db:seed --class=RealEstateDemoSeeder

For a general set of customers, suppliers, products, sales, purchases, quotations and expenses without any theme, use the demo-data generator in Settings → System Settings — it works from the panel and needs no shell.

Around the screen

A few things sit outside the modules and are worth knowing before you start.

/next/dashboard · dark

/next/dashboard · العربية

The sidebar shows only the modules that are switched on and only the pages your role may open. A cashier with POS-only permissions sees a very short sidebar; that is by design. The version number in the bottom corner is what Settings → Update compares against the update server.

System settings

Settings → System Settings. The one page nearly every other screen reads from. It is split into tabs; each saves only its own fields.

/next/settings/system

Feature switches

Settings → Modules → Features (the same switches are on the Features tab of System Settings). These change how the whole system behaves, so they live together rather than hidden in the module they affect.

/next/settings/business-modules · Features

Business modules

Settings → Modules. Twenty-three optional modules, each with its own menu group, pages, permissions and reports. Switch off what your business does not do and the sidebar shrinks to match. Core commerce — products, sales, purchases, people, settings and reports — cannot be turned off.

/next/settings/business-modules

A module that is off is also off for the router: its pages answer not found even by direct address, and its permissions disappear from the role editor. Turning it back on restores everything — no data is deleted by the switch.

Settings → Module Settings is a different page: it lists add-on modules installed as packages and offers Upload Module for a ZIP supplied by the vendor. A fresh install lists none.

Warehouses & locations

Settings → Warehouses. A warehouse is any place stock physically lives: a shop, a stockroom, a van, a market stall. Every stock quantity, every alert and every sale, purchase, transfer and adjustment is tied to one.

/next/warehouses

Internal locations

The Locations tab holds aisle, rack and bin positions inside a warehouse. Products can be assigned to a location so the picker knows where to walk; the Internal Location report lists what sits where.

Who sees which warehouse

Each user is assigned the warehouses they may work in (User Management → Users). The POS, the lists and the reports then only offer those. A cashier in the downtown shop never sees the airport store's stock; a manager assigned to all of them can switch. The default warehouse from System Settings is where the POS opens.

Users & roles

User Management → Users. A user is anyone who signs in to the admin or the POS. Each has a role, a status (inactive users cannot sign in but keep their history), an avatar and the warehouses they may see.

/next/users

/next/users/create

The install ships one role, Owner, which holds every permission — the administrator account has it. Create a role per job, not per person: Cashier, Stock keeper, Accountant, Store manager. Then give people the role.

Users can be signed out remotely from Settings → Login Devices, and every sign-in is listed in the Login Activity report.

Permissions

User Management → Group Permissions. A role is a named set of permissions. The editor lists more than 300 of them, grouped by module, with a search box and a select-all per group.

/next/permissions/create

Most groups follow the same pattern — View, Create, Edit, Delete — with extras where a module has a sensitive action: override FEFO / sell quarantined under batches, write off, Pay due, report-level permissions, and the settings pages one by one, so a manager can be given POS Settings without Payment Gateway.

A cashier role

The minimum for somebody who only runs the till: POS, Sales → View and Create, Customers → View and Create (for quick-add at the counter), and nothing under Settings, Purchases or Reports. Add Sales → Edit only if they should be able to change a completed sale, and Cash Register Report if they close their own drawer.

Categories, brands, units & currencies

Short reference lists under Products and Settings. Get them roughly right before importing products, because the import matches on their names.

/next/categories

/next/units

Payment methods & accounts

Settings → Payment Methods. The ways money arrives: the install seeds Cash, Credit Card, Check, TPE, Western Union, bank transfer and other. Rename, add or deactivate them; the POS payment screen and every payment form offer the active ones. Store credit and wallet are handled by the e-wallet module.

/next/settings/payment-methods

Accounts (Accounting → List accounts) are where the money is kept: the till, the bank account, the mobile-money float. Every payment, deposit and expense may name an account, and the account balance moves with it. The default account in System Settings is pre-selected on new payments. See Accounts, deposits & expenses.

Payment gateways are separate: Settings → Payment Gateway holds the Stripe keys the POS uses for card payments; the online store's twelve gateways are under Store → Payment Gateway.

Products

Products → All Products. The catalogue. One row per product with its image, code, category, brand, cost, price, unit and the stock across the warehouses you may see. The list filters by warehouse, category and brand, exports to Excel and PDF, and opens the Print Labels sheet for any selection.

/next/products

The product form

/next/products/create

The product page

/next/products/1

Every product has a detail page with its stock per warehouse, a movement history — every sale, purchase, return, transfer and adjustment that touched it, in order — and the sales and purchase lines it appeared on. The Product Report under Reports is the same view with a date range and export.

Variants, combos & services

The type at the top of the product form decides how stock behaves.

Subscription products (their own module, see Subscriptions) add a billing cycle to any product. Packs and wholesale tiers are pricing on top of a single or variable product, switched on under Feature switches.

Importing

Every import page has the same shape: a drop zone, a Download example button that gives you a template with the right columns, a table explaining each column and which are required, and Import now. Rows that fail are reported by line number; rows that pass are saved.

/next/products/import

/next/products/opening-stock-import

Barcode labels

Products → Print Labels. Pick products (or a whole purchase), set a quantity per product, choose one of the five label templates and what prints on it — shop name, product name, price, barcode number — and print. The preview is true to size.

/next/products/barcode

Labels go to a normal printer as a sheet, or directly — no print dialog — to a TSPL label printer over USB or the network. Products without a barcode of their own are printed with their product code, which the POS scanner reads just the same.

Batches & expiry

For food, pharmacy, cosmetics and anything with a shelf life. Turn batch tracking on per product; from then on every purchase line asks for a batch number and an expiry date, and stock is kept per batch.

/next/products/batches

Sales allocate first-expiry-first-out: the POS takes from the batch that expires soonest. Expired or quarantined batches are skipped unless the user holds the override FEFO / sell quarantined permission. Batches can be written off, and the Expiry report lists what expires in the coming days by warehouse; the Batch Register and Batch History reports show where each batch went.

/next/reports/expiry

Serial numbers

With the Track serial number / IMEI switch on (Feature switches) a product can require one serial per unit. Receiving a purchase asks for the serials; selling asks you to pick which units leave; returns bring a specific unit back. Phones, laptops, appliances, tools with a warranty.

/next/serial-numbers

Four reports cover them: Available Serial Numbers, Sold Serial Numbers, Serial Movement Log and Product Serial Inventory. The Warranty & Guarantee report combines the serial with the product's warranty period to show what is still covered.

Count, adjust, transfer, damage

Four operations move stock without a sale or a purchase. Each is a document with a date, a warehouse, lines and a note, and each shows up in the product's movement history and in its own report.

/next/products/count-stock

/next/adjustments/create

/next/transfers/create

/next/damages

The Negative Stock, Quantity Alerts, Dead Stock, Zero Sales, Stock Aging and Inventory Valuation reports are the places to look for what needs counting, reordering or clearing.

The register

The purple POS button in the header opens the register full-screen. It is built for a touch screen and a scanner: large product tiles with image, code, stock and price; category and brand filters; a search box that also takes a scanner; and a cart on the left with a running total.

/next/pos

Opening the register

With registers enabled, the top-left pill reads CLOSED until you open one. Press it, enter the opening float, and the register is yours for the shift. Every sale, payment and hold is stamped with the register and the cashier. At the end of the shift press the pill again, enter the counted cash and a closing note, and the Cash Register report shows the float, the cash sales, the counted amount and the difference — per register and per cashier.

Warehouse and customer

The warehouse chip picks which stock you are selling from — the POS opens on the default warehouse from System Settings, limited to the warehouses your user may see. The customer chip defaults to walk-in-customer; search for a named customer to attach the sale to their ledger and their loyalty points, or press the person-plus icon to create one without leaving the screen.

Building the cart

• Tap a tile or scan a barcode. A USB or Bluetooth scanner types into the search box; the scan icon opens the phone or tablet camera as a scanner (HTTPS required). A weight-embedded barcode from a scale adds the product with the weight as the quantity.
• Variants ask which one; batch products allocate first-expiry-first-out; serial products ask you to pick the unit; packs ask single, 6-pack or case.
• Each line has a quantity, a unit, a per-line discount, a tax and a price level — Retail or Wholesale. With wholesale tiers on, the price drops itself when the quantity reaches a tier and the line says so.
• Below the lines: an order tax, an order discount, shipping, a promo code box and the promotions that apply.
• Hold parks the sale under a reference so you can serve the next person and recall it; Recent Drafts lists what is parked. Drafts survive a page reload and, with offline mode, a lost connection.
• A sale can also be saved as a quotation and turned into an invoice later.

/next/pos · العربية

/next/real-time-sales-counter

Live sales counter

Sales → Real-time Sales Counter is a board for a back-office screen: the count and value of today's sales, refreshed by polling every few seconds with a chime when a new sale arrives. It needs no websocket server.

Taking payment

Pay Now opens the payment screen. The total is pre-filled; pick a method and press Complete Payment, or split it.

/next/pos · Pay Now

• Split payments. Add Payment Method adds a second line — part cash, part card, part bank transfer, part wallet. The breakdown on the left shows what is paid, the balance and the change.
• Quick cash. The buttons on the right enter the exact total or a round note; the change is computed.
• Partial payment and credit. Pay less than the total and the sale is saved as partial with a due balance on the customer's ledger. A customer with a credit limit cannot go past it. Pay due on the sales list settles it later.
• Store credit and wallet. With the e-wallet module, a customer's balance is a payment method.
• Loyalty points. A named customer's available points show on the screen; convert them into a discount, or redeem a reward from the loyalty catalogue. Points earned by the sale are credited when it completes.
• Card through Stripe. With keys in Settings → Payment Gateway, the card method charges through Stripe from the register; refunds sync back.
• Kitchen routing. With the kitchen display on, the sale can be sent to the kitchen, saved without sending, or sent later.

Completing the payment saves the sale, moves the stock, posts the journal (if auto journals are on), credits the loyalty points, prints the receipt (if auto-print is on) and, if a cash drawer is configured, kicks it open.

POS settings & receipts

Settings → POS Settings decides how the register behaves; Settings → POS Receipt decides what it prints.

/next/settings/pos

The receipt

/next/settings/pos-receipt

Paper size (58, 80 or 88 mm); one of five layouts — Standard, Compact, Detailed, Bilingual and Minimal; logo and its size; font family and size; and which blocks print: the customer, the tax breakdown, the previous dues and net balance, a note to the customer, and — with ZATCA phase 1 on — the QR code Saudi receipts require. The Bilingual layout prints each label in two languages, for Arabic and English receipts.

Printing

Keyboard shortcuts

Turn them on in Settings → POS Settings; the switch is per device and saves as soon as you flip it, so a touch till can leave them off while the counter PC has them on. Press Shift + ? on the register for the cheat sheet; the same list is under View Shortcuts in POS Settings.

The shortcuts cover what a cashier does a hundred times a day: focus the search or scan box, open the payment screen, complete a cash payment, hold the sale, open the drafts, clear the cart, change the customer, open the drawer and close the register. They are ignored while you are typing in a form field, except the function keys and Esc, so a barcode typed by a scanner is never misread as a command.

Offline mode

The register keeps selling when the internet does not. Switch it on with offline sync in Settings → System Settings → System.

1. The register caches

   While online, the POS keeps a copy of the catalogue and the customers in the browser, and refreshes it as you work. The status pill bottom left reads Online · synced.

2. The connection drops

   The pill turns red and reads Offline. Tiles, search, the cart, holds and drafts keep working from the cache. Sales you complete are queued in the browser with their payments, and the pill shows how many are waiting. Reloading the page while offline is fine — the register comes back from the cache.

3. It comes back

   The queue uploads itself, oldest first; each sale gets its reference and moves the stock as if it had been taken online. The pill returns to Online · synced. If a queued sale is refused — a product deleted meanwhile, say — it stays in the queue with the error so nothing is silently lost.

Customer display

A second screen facing the customer — a tablet on a stand, a monitor, an old phone — that mirrors the cart as the cashier works: the lines, the totals, and a thank-you when the sale completes. It is a web page, so any device with a browser on the same network will do.

/next/customer-display/setup

1. Generate a token

   Sales → Customer Screen → Generate New Token. The page shows the display URL — /customer-display?token=… — and a QR code for it.

2. Open it on the display device

   Scan the QR or type the URL. The page installs as a PWA and runs full-screen. It supports light and dark themes and needs no login — the token is the credential.

3. Sell

   The display updates as items are added. Tokens expire after 24 hours; generate a new one to rotate access, and the old link stops working at once.

/customer-display?token=…

If the display does not connect, check that the device is on the same network and uses the full URL including the token. If items stop updating, make sure the POS is still open on the cashier's side — the display shows the last cart the register broadcast.

Kitchen display

For restaurants, cafés and anywhere an order is prepared after it is taken. Switch it on under Feature switches; the POS then offers Send to Kitchen on every sale and Kitchen → Kitchen Display appears in the sidebar.

/next/kitchen-display

• Tickets carry a daily token number, the items with special instructions, the customer and the source (POS or online). Start preparation, check items off one by one — the ticket completes itself when the last one is done — Mark completed, with a ten-second Undo. A ticket whose sale was deleted shows Voided.
• Overdue colours. Set a preparation-time target in Features; tickets past half of it turn amber, past all of it turn red, pulse and jump to the top of their lane.
• Stations. Define stations by product category — grill, bar, dessert — and pin a screen to one; it shows only its items. Items in a category no station claims appear on every station, so nothing is missed. The All stations view is the expo screen with full tickets.
• Kitchen mode is full-screen for a wall-mounted TV; chits print at 72 mm, station-aware.
• Online orders can create a ticket automatically when confirmed.

The order-ready screen

A customer-facing board of token numbers under Preparing and Ready, with a chime when one moves. Press Order Ready Screen on the kitchen display to generate a secure link (/order-ready?token=…), open it on a screen in the collection area, and it updates on its own. The link stays valid for seven days; generating a new one replaces it.

/next/kitchen/report

Sales

Sales → All Sales. Every invoice, from the POS or from the back office, in one list: date, reference, customer, warehouse, status, grand total, paid, due, payment status and shipping status. Filter by any of them, export, and act from the row — Pay due, print, PDF, email, SMS, edit, return, delete.

/next/sales

Creating a sale in the back office

/next/sales/create

The form is the POS in a page: customer, warehouse, date, lines with discount, tax, unit and batch or serial, an order tax, discount and shipping, a status (pending, ordered, complete), a sales agent, a note, and a payment you can record at once. Stock moves when the sale is completed. With multi-currency on, pick the sale currency and the base-currency equivalent shows alongside.

The sale page

/next/sales/227

Payments are recorded against the sale with a date, a method and an account; each one updates the paid and due figures and the customer's ledger. Attach a file — a signed delivery note, a purchase order from the customer — under documents. Email and SMS use the templates from Settings, merged with the sale.

Quotations

Quotations. A priced offer that moves no stock. Same form as a sale; same lines; a status of pending or sent. Print or PDF it, email it, and when the customer agrees press Create sale — the quotation's lines become a sale in one click, and the quotation is marked as converted.

/next/quotations

/next/quotations/30

Business customers can also see their quotations in the client portal, accept them there, or request a new one; shoppers can send a quote request from the store for service products.

Returns

A return is always against an original document, so the stock, the money and the reports agree on what came back.

/next/sale-returns

/next/purchase-returns

• Sale return — from the sale's row or page. Pick the lines and quantities coming back (a serial product asks which unit); stock returns to the warehouse; the refund is recorded as a payment on the return, by any method, or left as a credit on the customer's ledger.
• Purchase return — the mirror image, against a purchase, with the supplier's refund recorded the same way.
• Store returns — shoppers request a return from their account within the return window; you approve it under Store → Returns Requests and it becomes a sale return.

The Return Ratio report shows what comes back most, by product and by customer.

Shipments

Sales → Shipments. One shipment per sale that needs delivering: the carrier, a tracking number, the delivery address and a status — packed, shipped, delivered, cancelled. The shipping status shows on the sale and on the sales list, and the store's customer account shows it to the shopper.

/next/shipments

To hand the parcel to a courier company, print its label and have the status follow by itself, use Couriers; those shipments are listed here as well.

Suppliers & purchases

People → Suppliers holds who you buy from — name, contact, tax number, address, opening balance — with a detail page listing every purchase, return and payment. Purchases is how stock arrives with a cost behind it.

/next/suppliers

/next/purchases

Receiving a purchase

/next/purchases/create

Supplier, warehouse, date, lines with the unit cost, the purchase unit, a discount and a tax; per line a batch number and expiry for batch products and the serials for serial products; an order tax, discount and shipping. The status is pending, ordered or received — stock moves when it is received. Record the supplier payment at once or later from the row. A purchase can also open the label printer for everything it contains.

/next/purchases/180

The product's cost is what you paid; Inventory Valuation uses it, and the profit reports subtract it from the sale price. Purchases can be imported from CSV to bring in history; see Importing.

Couriers: how it works

Couriers in the sidebar. Send a sale to a courier company in one click, print its label, and let the courier's own updates — picked up, out for delivery, delivered, returned, cash collected and paid out — arrive in Stocky by themselves. Forty couriers are built in, from Pakistan, the Gulf, Egypt, Bangladesh, India and Southeast Asia to DHL, FedEx and UPS, plus shipping aggregators that reach hundreds more and a manual courier for anyone without an API.

The sidebar group has six pages: Courier Shipments, Courier report, Courier Accounts, Courier Settings, Courier logs and Courier guide. The sale page gains a Courier shipment panel, and the sales list a Send to courier action.

Courier guide is the in-app companion to this chapter: a checklist that shows how far your setup has gone, with a link for each step, a picker that shows any courier's keys, options, how its updates arrive and what to watch for, with an Add this courier button, and your accounts' webhook addresses with copy buttons.

Switching it on and who can use it

Couriers is a business module, Courier Integration: switch it off in Settings → Modules to hide the sidebar group, the sale page panel and the Send to courier actions. Four permissions, in the Couriers group of the role editor, decide who does what:

Courier accounts

Couriers → Courier Accounts lists your accounts with their connection state — Connected, Failed or Not tested — the warehouses they serve and which one is the default. You can hold several accounts for the same courier, for example one per warehouse or one per city.

1. Choose the courier

   Add courier account, then pick the courier from the catalogue. Each card shows the courier's region and what it does — booking, labels, live rates, cancellation, status pushes, COD, city lists, pickup requests, test mode.

2. Paste the API credentials

   Each courier asks for its own keys; the help under every field says where to find them, and Courier-by-courier setup sums them up. Saved secrets are never shown again: leave a field blank to keep the stored value.

3. Test mode or live

   Couriers that offer a sandbox have a Mode switch. In Test the account talks to the courier's test system — bookings are not real and nobody comes to collect them. Sandbox and live keys are usually different, so paste the matching pair.

4. Courier options and pickup address

   Courier options are that courier's own settings — a pickup location code, a service, a country. The Pickup address is where parcels are collected; couriers that work with full postal addresses (aggregators, DHL, FedEx, UPS, Ninja Van, Flash Express) also ask for the pickup postal code, state and two-letter country code, and a default parcel size.

5. Booking defaults

   The warehouses the account serves (orders from those warehouses pick it automatically), a default weight in kg, a service type, and whether customers may open the parcel before paying. Tick Default account for the one used when no warehouse rule applies.

6. Test the connection

   Save, then Test connection. Many couriers answer with something useful — your pickup addresses, stores, warehouses or package codes with the codes to paste into Courier options.

7. Register the webhook URL

   Couriers that push status changes show a Webhook URL on the account once it is saved. Paste it in the courier's dashboard — the setup tables say where — so updates arrive instantly. Bosta, Sendbox and UPS Track Alert register it themselves with every parcel. Couriers that sign their updates — AfterShip, EasyPost, Shiprocket, OTO, Biteship, Pathao and Steadfast — also need the webhook secret you set there pasted on the account: until it is, their updates are rejected (Courier logs shows why).

Manual / Other courier has one extra field, Tracking link: the courier's public tracking page with {tracking} where the number goes, for example https://courier.example/track?id={tracking}. Staff and customers get a working link from it.

Sending orders to a courier

Three ways in: Send to courier in a sale's row menu on the sales list, the button on the sale page's Courier shipment panel, or — for many orders at once — tick sales on the list and press Send to courier (n) in the toolbar.

The booking form

Everything is filled from the sale and can be changed before booking:

• Courier account — the warehouse's account, else the default one. Couriers like Manual, AfterShip and 17TRACK ask for the tracking number printed on the courier's receipt.
• Receiver — name, phone, email and address from the online order's shipping details, or from the customer. Couriers with full postal addresses add state, postal code and country.
• Courier city — couriers that work from their own city, area or zone list show a searchable picker. Your choice is remembered, so the next order to the same city picks it by itself.
• Drop-off latitude and longitude — only for couriers that route by map point (Lalamove). Right-click the address in Google Maps to copy them.
• Parcel — COD amount (the amount still due on the sale; 0 means prepaid), weight (from the products' weights, else the account default), pieces, contents and delivery instructions.

The customer's return-risk badge sits next to Receiver; a high-risk customer also gets a red warning above it.

Compare rates

Aggregators (EasyPost, Shippo, Shiprocket, Sendcloud, OTO, Torod, EasyParcel, Biteship, Shiplogic, Sendbox), DHL Express, FedEx, UPS and Lalamove offer Compare rates: prices and delivery days straight from the carriers for this exact parcel. Pick one and Book buys that option. Without a pick, the account's default service is used — or, for DHL, FedEx and UPS with no default, the cheapest quote.

Booking many orders

The bulk window lists every ticked sale as Ready, Incomplete (hover it to see what is missing — a phone, an address, a city) or Already booked. Choose the account, optionally one Weight for all (kg) instead of From products, and press Book n orders. Each order is booked on its own, so one rejection does not stop the rest; the result shows what was booked and why anything failed, with Print labels for the lot.

Labels

Print label prints the courier's own label or airway bill when the courier issues one — a PDF, a link, or for UPS a label image laid out for 4 × 6 paper. Couriers without labels get a Stocky label: 100 × 150 mm with the tracking barcode, sender, receiver and the amount to collect. Allow pop-ups for the Stocky, or the browser blocks the print window.

Cancelling

Cancel booking works while the shipment is still Booked. Couriers with a cancel call (or UPS's void) are told; for the others, cancel in the courier's portal as well. Once the courier has the parcel it can only come back as a return. A cancelled sale can be sent again, and so can a sale whose parcel came back — the returned parcel keeps its own record and leaves the returns queue as Sent again. Once returned goods were restocked with a sale return, they are back in stock: ship them on a new sale.

Tracking shipments

Couriers → Courier Shipments. Every courier shipment with its tracking number, sale, customer, city, status, COD and return state. The tabs — All, On the way, Returns to review, COD to be paid out and Status check errors — have a counter card each on top; click a card to open its tab. Search by tracking number, sale or customer; filter by account, status or booking dates; tick rows to print their labels together.

The row menu holds the actions: Timeline, Check status now, Open tracking page, Print label, Update status, Update COD, the return actions, Cancel booking and View sale. The same shipment, with its timeline, shows on the sale page.

The statuses

Statuses only move forward, so a late or repeated update never drags a parcel back. The one exception: a delivered parcel can still be reported as returning or returned, when the customer refuses it after hand-over. Each courier's own wording is kept on the timeline next to the status.

Where updates come from

• Pushed by the courier — instantly, once the webhook URL is registered. The timeline marks these Courier update.
• Status checks — couriers that cannot push are asked on the schedule in Courier Settings → Status updates → Check every, from 15 minutes to a day. Shipments stop being checked once delivered, returned or cancelled, 90 days after booking, or after repeated failures; Status check errors shows the reason. Check status now asks at once.
• By hand — Update status with an optional note, for manual couriers or to correct a shipment. Marked Entered by staff.

Courier logs

Couriers → Courier logs records every call Stocky makes to a courier — connection tests, bookings, rates, city lists, labels, cancellations, status checks — every update a courier sends, accepted or rejected, and every error. Filter by account, action, result, direction and date, or search inside the content; Details shows what was sent and the courier's exact answer, with a link to the shipment and the sale. It is the first place to look when a test fails, a booking is refused or statuses stop moving.

Keys, tokens and passwords are masked before anything is stored, and long content is shortened. Scheduled status checks are logged only when they fail; Check status now is always logged. Entries are kept 30 days; Clear logs older than 7 days and Delete all logs tidy up sooner. The page needs the Manage courier accounts and settings permission.

COD, charges & returns

Couriers → Courier Settings decides what Stocky does with money and returned parcels. Everything is optional and happens once per shipment, however many times the courier reports the same thing.

Cash on delivery

A COD shipment goes Not collected → Collected by courier (on delivery) → Paid out to you. Couriers that report payouts — PostEx, Leopards, TCS, Trax, M&P, Shiprocket, Pathao, RedX and eCourier — move the last step themselves, with the payout reference; for the others use Update COD.

With Record the payment on the sale when the courier pays out the COD amount on and an Account chosen, a payout is saved as a payment on the sale, into that account, with the payment method you pick — the sale's balance and the account balance follow. Without an account, payouts are only marked.

Courier charges

Save the delivery charges reported by the courier as an expense adds one expense in the chosen category when a shipment is delivered, returned or cancelled, for the charges the courier reported.

Returned parcels

• Send to the review queue (recommended) — a returned parcel waits under Returns to review. Open it, look at the goods, then Restock (a sale return for the whole order, items back in stock) or Dismiss (no restock) for damaged or lost parcels.
• Restock automatically — the sale return is created and the stock put back as soon as the courier reports the return.

A sale that already has a return is never restocked twice; the queue says why.

Customer messages & tracking page

Customer notifications

Courier Settings → Customer notifications. Switch on any of the three channels — they use the senders you already set up:

• SMS through the gateway in SMS Settings.
• Email through your mail server.
• WhatsApp through WhatsApp Business: the same text as the SMS, sent through the Cloud API and kept in the WhatsApp message log. Meta delivers free-form text only within 24 hours of the customer's last message to you; outside that window the log shows Meta's error.

Then tick the statuses worth a message — shipped (booked), picked up, in transit, out for delivery, delivery attempt failed, delivered, returning. Each ticked status has its own text, filled with a sensible default you can edit or Reset to default. Placeholders: {contact_name}, {business_name}, {invoice_number}, {courier}, {tracking_number}, {tracking_url}, {cod_amount} and {cod_note} (“Please keep 1,500.00 ready.” on COD parcels, nothing on prepaid ones).

Messages go to the phone and email on the booking, else the customer's. Each status is sent at most once per parcel, and the timeline records every send — or why one failed — as Notification. A failing channel does not stop the others.

The tracking page

With Show the tracking page on, your online store answers at /track (under the store's address, e.g. https://yourshop.com/online_store/track). Customers enter the tracking number, or their order number with the phone number used on the order, and see the status, a progress bar, the courier and its scan history. The customer's first name, destination city and the courier's delivery details appear only after the order number and phone check — never for a bare tracking number. The page never shows the address or staff notes, and limits how often it can be queried.

{tracking_url} in messages points to this page. If the online store is off, it points to the courier's own tracking page instead.

Courier report & return risk

Couriers → Courier report. For parcels booked in a date range, optionally one courier account:

• Shipments and how many are still on the way.
• Delivery rate and Return rate — counted over finished parcels only (delivered or returned), so parcels still moving do not lower them.
• COD total, COD to be paid out (collected or pending and not yet paid to you), and what was paid out.
• Avg. delivery time from booking to delivery, and courier charges.

The same figures follow By courier — to compare couriers on the same lanes — and By city, the 25 busiest destinations, to see where parcels come back.

Return risk

Every customer is rated from their own courier history: parcels returned out of parcels delivered or returned.

The badge shows in the booking form (with a warning for high risk), next to the customer on Courier Shipments (medium and high only), on the sale's courier panel and on the customer's page; hover it for “2 of 5 finished parcels returned (40%)”. The walk-in customer is never rated. Both thresholds are in Courier Settings → Return risk.

Courier-by-courier setup

What each courier needs and what it does. Push means the courier sends updates to the webhook URL; otherwise status checks keep the shipment current. Each account form has the same fields, with help text, and Test connection lists the codes it can.

Any courier

Pakistan

Shipping aggregators

Gulf & Egypt

Bangladesh, India & Southeast Asia

Global express

International parcels with DHL, FedEx and UPS carry customs data built from the booking: contents, declared value (the COD amount when none is set), quantity and the pickup country as origin. Set Customs value currency on the account if it is not your company currency.

Status checks run from the scheduler (see Cron & queue) every 15 minutes, at the interval set in Courier Settings — without the cron entry, only couriers that push updates move by themselves. Courier pushes arrive on your site's own address; nothing needs opening on the server.

Customers & ledger

People → Customers. Name, email, phone, address, tax number, an opening balance and a credit limit. The POS creates them on the spot; the store creates them when a shopper registers; the import brings them in bulk.

/next/customers

/next/customers/2/details

The ledger

/next/customers/2/ledger

Every invoice, return and payment for a customer on one statement, with the opening balance, the sales due, the returns due, the payments and the outstanding total. Download PDF produces the statement you send them. Pay due takes a payment against the oldest open invoices. The credit limit — No limit by default — stops the POS and the sale form from going past it.

Two further lists under People split customers by store access: Customers with Login can sign in to the online store; Customers without Login cannot. The Client Portal link under People opens the portal itself; access to it is granted per customer from this list.

Client portal

A separate front door at /portal for business customers — the ones who buy on account, ask for quotations and want their statement without phoning. It is not the online store: no cart, no checkout, no catalogue.

/portal/login

/portal/dashboard

Inviting a customer

People → Customers. Open the row's actions and choose Portal Client. Confirm the email address the invitation goes to and press Enable: an email with a set-password link is sent, and until they use it the customer shows as invitation pending. Disable revokes access without deleting anything.

/portal/invoices

/portal/statement

Loyalty & promotions

Loyalty points

Settings → Loyalty Rewards. Customers earn points on what they spend at the rate you set (points per amount, a minimum sale, an expiry). Points show on the customer's page, on the POS when the customer is picked, and in the store account. They are spent two ways: converted into a discount at the point-to-amount rate, or redeemed for a reward from the catalogue on this page — a discount amount, a gift card or a product, each with a points cost, a stock and a per-customer limit. Redemptions are listed with their status and fulfilled from here; points can be credited or deducted by hand with a note.

/next/loyalty/rewards

Promotions

Promotions. Rules that apply themselves at the POS checkout: a percentage or a fixed amount off, on chosen products, categories or the whole cart, within a date range, optionally behind a promo code, with a usage limit. The register lists the promotions that matched; the Promotion Usage report shows what each one cost.

/next/promotions

The online store has its own coupons and flash sales; they are separate from POS promotions on purpose, because a web coupon and a counter promotion rarely have the same rules.

E-wallet & commissions

E-wallet

E-Wallet. A prepaid balance per customer. Top it up in the admin or let shoppers do it in the store; spend it as a payment method at the POS and at checkout; refund to it instead of to cash. Wallet Items are the products or amounts on offer; the dashboard shows balances, top-ups and spend; the settings decide minimums and whether withdrawals are allowed.

/next/ewallet/dashboard

Commissions

Commissions. For salespeople paid on what they sell. A program sets the rule — a percentage of the sale, of the profit, or a fixed amount per line — and which products it covers; agents are the users or employees in it; rules add tiers and exceptions. Every sale with a sales agent accrues, receipts record what was paid out, and the report reconciles the two.

/next/commissions/programs

Setting up the store

The online store sells the products you mark visible, from the warehouses you choose, with the same prices, stock and customers as the counter. It is switched on per install under Settings → Modules → Store, then configured from Store → Settings.

/next/store/settings

1. Basics

   Store name, the theme, the warehouses it sells from (or all), the default language and the display currency. Online store enabled is the master switch; off, the storefront answers with a closed page.

2. Address

   By default the store lives at /online_store. Set a custom URL path such as /shop, or tick use the root domain so the shop is your home page and the admin stays at /login and /next. On the root domain the shop's sign-in and register pages move under /customer/…. Old links are redirected.

3. Stock behaviour

   Show stock or not, hide out-of-stock products, allow or prevent overselling, hide prices for guests (a wholesale catalogue that shows prices only after sign-in).

4. Registration

   Public registration on or off; require an invite code, admin approval, email verification, or any combination. See Customer accounts.

5. Returns and reviews

   The return window in days, whether shoppers may cancel unshipped orders, and whether reviews publish at once or wait for moderation.

6. Make products visible

   A product appears in the store only when its online store switch is on. Set it per product, or in bulk from the product list.

Real estate

With the Real Estate theme the store becomes a listings site: Store → Real Estate holds properties (for sale or rent, price, beds, baths, area, photos, map), their categories and the inquiries the form sends. Products and the cart are not used.

Themes

Five themes on one catalogue. Switching is a dropdown in Store → Settings → Basics; each theme has a tab of its own for the blocks it draws, and every theme shares the same product page, cart, checkout and account.

/online_store · Default

/online_store · Electronics

/online_store · Toys & Baby

/online_store · Grocery

/online_store · Real Estate

Each theme tab holds its own slides, tiles, banners, section headings, featured products per tab, deals and testimonials. What you fill in for Electronics is kept when you try Grocery, so switching back loses nothing. The demo seeders described under Demo catalogues fill each theme with a matching catalogue.

/online_store/shop

/online_store/product/…

Collections, banners, pages & menus

Everything a shopper sees that is not a product is managed under Store.

/next/store/collections

/next/store/banners

/next/store/pages

/next/store/menus

Shipping, tax & payment

Checkout quotes are computed on the server from these three lists, so the shopper's total is the same one that lands on the sale.

/next/store/shipping-methods

/next/store/tax-rates

• Shipping zones group countries or regions; shipping methods belong to a zone and carry a price, a free-over threshold and a delivery estimate — Standard, Express, Pickup in store.
• Tax rates apply by zone at checkout; product-level tax from the catalogue still applies to the POS.
• Coupons are codes with a percentage or fixed value, a minimum order, a validity period and a usage limit. Flash sales put chosen products on a timed discount with a countdown on the store's flash-sales page.

/next/store/coupons

/online_store/flash-sales

Payment gateways

/next/store/payment-gateway

/online_store/checkout

Orders & requests

Store → Online Orders. A web order is a sale with a source of online: it appears here and in Sales, moves stock from the store's warehouse, and can be shipped, returned and refunded like any other. Confirm it, set the shipping status, print the invoice; with the kitchen on, confirmed orders can become tickets.

/next/store/orders

/next/store/returns

Customer accounts

A shopper can check out as a guest or with an account. The account is the same customer row the POS and the ledger use — sign in at the counter with the same email and the loyalty points are there.

/online_store/account

/online_store/account/orders

Who may register

Store → Settings → Basics → Registration access control. Four switches that combine:

• Public registration — anyone may create an account. Off, only accounts you create in the admin can sign in.
• Require an invite code — codes you issue under Store → Invite Codes, each with a usage limit and an expiry. For a members-only or trade-only shop.
• Require admin approval — new accounts wait under Pending Customers until you approve them.
• Require email verification — a link is emailed and must be clicked before the first sign-in.

Sign-in, registration, password reset and verification pages live under the store's address (/online_store/login, or /customer/login on the root domain).

Branding, SEO & PWA

Store → Settings → Branding, Contact, SEO, Social. Logo and tagline, favicon, primary and secondary colours, font family, whether shoppers get a dark-mode toggle, the top bar and footer text, contact details, social links, and the cookie-consent banner.

SEO: a title template ({product} — {store}), a default description, per-product and per-page SEO fields, an automatic sitemap.xml and robots.txt. Languages and currency: the store switcher offers the languages enabled in Settings and shows prices in the display currencies you enable; orders are still recorded in the base currency unless multi-currency is on.

PWA: Settings → PWA holds the name, icons and colours for each installable surface — the admin, the store, the customer display and the portal. On HTTPS the store shows an install prompt and works as an app on a phone's home screen.

/next/settings/pwa

Accounts, deposits & expenses

The simple books most shops start with, under Accounting. They work with or without the double-entry ledger described in the next section.

/next/accounts

/next/expenses

/next/expenses/create

/next/deposits

The Cash Flow report reads all four together with sales and purchase payments to show what came in and went out of each account over a period.

Accounting

Accounting → Dashboard, Chart of Accounts, Journal Entries and the financial reports. Proper double-entry books that post themselves: with the auto journal entries switch on (Feature switches), every sale, purchase, return, payment, expense, deposit and money transfer writes a balanced journal against the chart of accounts. Nothing has to be keyed twice.

/next/accounting-v2/dashboard

Chart of accounts

/next/accounting-v2/chart-of-accounts

A standard chart is created for you — cash and bank, receivables, inventory, payables, sales, cost of goods sold, expense accounts, tax accounts. Rename, renumber or add accounts to match your accountant's chart; the automatic journals map onto the accounts you mark for each purpose.

Journal entries

/next/accounting-v2/journal-entries

Automatic journals are posted as the document is saved and carry its reference. Manual journals — an accrual, a depreciation charge, an owner's drawing — are entered as draft, must balance, and are posted when you are sure. Posted journals are not edited; reverse them with a new entry.

The statements

/next/accounting-v2/reports/trial-balance

/next/accounting-v2/reports/profit-and-loss

/next/accounting-v2/reports/balance-sheet

/next/accounting-v2/reports/tax-report

Trial balance, profit and loss, balance sheet and tax summary, each for any period, each exportable to Excel and PDF. If you began trading before turning the switch on, the journals for existing documents are not created retroactively — post an opening-balance journal as of the start date instead. QuickBooks and Xero can take the invoices and payments if your accountant works there.

Multi-currency

Off by default. Turn it on under Feature switches, then give each currency in Settings → Currencies an exchange rate against the base currency. From then on a sale, a purchase or an online order can be recorded in another currency: the document keeps its own currency, rate and totals, and the base-currency equivalent is shown alongside and used everywhere else.

Rates are manual — you type them and update them; nothing is fetched. Reports, stock valuation, the ledger and the accounting journals stay in the base currency, so a euro sale and a dollar sale add up in one figure. The store's currency switcher is a separate, display-only feature that works even with this switch off.

ZATCA e-invoicing

For businesses in Saudi Arabia. Settings → ZATCA E-Invoicing.

/next/settings/zatca

• Phase 1. One switch: Enable ZATCA QR on sales receipts. Every receipt then carries the TLV QR code with the seller name, VAT number, timestamp, total and VAT. Fill in the company's Arabic name and VAT number first.
• Phase 2. Company details (VAT number, CRN, national address, business category), the EGS unit details, the environment — sandbox, simulation or production — and onboarding with the OTP from the ZATCA portal, which generates the CSR and runs the compliance checks. Once onboarded, sales are reported or cleared with ZATCA; auto submit does it as each sale is created, otherwise submit from the Documents tab, which lists every invoice, credit note and debit note with its status and ZATCA's messages.

Company structure

The HRM module (Settings → Modules → HRM) starts with the shape of the organisation, under HRM:

/next/hrm/departments

Employees, attendance & leave

/next/hrm/employees

/next/hrm/attendance

Employees carry personal details, the company, department, designation and shift, the joining date, documents with expiry, and the basic salary the payroll starts from. An employee may or may not be a system user — a warehouse picker without a login is still on the payroll.

Attendance is a row per employee per day: clock in, clock out, the hours and whether they were late against the shift. Enter it by hand, import it, or let staff record it. The Attendance Summary report totals days, hours and lateness per employee for a month.

/next/hrm/leaves

Leave requests name a type, a period and a reason, and wait for approval. Approved leave counts against the type's allowance and shows on the attendance grid.

Payroll

/next/hrm/payrolls

HRM → Payroll. A payroll entry is a payment to an employee: the employee, the date, the amount (pre-filled from the basic salary on their record), the account it is paid from, the payment method, a reference and a status. The list is the record of what was paid to whom and when, filterable by month and exportable. Stocky does not compute income tax or social contributions for you, because those differ by country and year — enter the net amount you actually pay.

Because a payroll names an account, it moves that account's balance and reaches the cash-flow report; with auto journals on it is posted to the ledger as well.

Recruitment & meetings

Two small modules of their own, each with a switch under Settings → Modules.

/next/recruit/dashboard

/next/meeting/dashboard

Recruits and Jobs: job openings by category, candidates, their applications with a status, interviews with a date and an interviewer, and a report of the funnel. Meetings: a meeting with attendees, an agenda and a time, on a calendar, with reminders sent by the scheduler (see Cron & queue) and a report of attendance.

Projects & tasks

Projects Management. Projects with a client, a budget, dates and members; tasks with an assignee, a priority, a due date and a status, in a list or on a drag-and-drop board; milestones; timesheets of hours per task; and reports of hours and progress per project.

/next/projects/dashboard

/next/tasks/board

Bookings

Booking Management. Appointments and reservations: a customer, a service or a resource, a date and time, a status and a note, in a list and on a calendar. Trays hold the items prepared for a booking — a hamper, a cake, a hire kit — so the shop knows what to have ready. With the Google Calendar connection in System Settings, bookings appear in a Google calendar too; portal clients can book their own appointments.

/next/bookings

/next/bookings/calendar

Service & maintenance

Service & Maintenance. For repair shops, phone and computer clinics, appliance servicing, workshops. A service job is a device or an item brought in by a customer, and it moves through a fixed path:

intake → diagnostic → quoted → in progress → ready → delivered

/next/service/jobs

/next/service/jobs/details/2

• Technicians are the people work is assigned to; checklist categories and items are the inspections a technician ticks off — the Checklist Completion report shows how thoroughly.
• A job carries the parts used (from stock) and the labour (service products), a quote the customer approves, photos, a warranty period and the payments.
• Maintenance history lists every job per customer and per item, so the second visit starts with the first one's notes. The Service Jobs and Customer Maintenance History reports cover turnaround and revenue.

/next/service/technicians

/next/service/checklists

Subscriptions

Subscription Product. Recurring sales of a product or service: a customer, the product, a billing cycle (weekly, monthly, yearly), a start date and the next billing date. Each cycle produces a sale; the list shows what is due next and what has lapsed. For water deliveries, maintenance contracts, memberships and software seats.

/next/subscriptions

Manufacturing

Manufacturing (MRP). For businesses that make what they sell. A bill of materials lists the components and quantities that make one unit of a finished product; a production order asks for a quantity of it, reserves the components, and on completion consumes them from stock and adds the finished goods. Work centres are the machines or stations; the shop floor page is the work orders in progress; quality control records inspections and rejects; planning compares demand with stock and open orders to say what to make and buy; the reports cover output, cost and yield.

/next/mrp

Assets & fleet

/next/assets/dashboard

/next/fleet/dashboard

Asset Management: the things the business owns and does not sell — laptops, tills, tools, furniture — by category, with a purchase date and value, assignments to employees, transfers between locations, maintenance, depreciation schedules, and a Due Assets list of what needs returning or checking. A daily scheduled task flags assets whose validation is due.

Fleet Management: vehicles with registration and documents, fuel logs with cost per litre and consumption, maintenance with reminders, assignments to drivers, and reports of cost per vehicle.

Documents, contracts & knowledge base

/next/documents

/next/contracts

• Document Archive — folders and files with versions, tags and access by role: licences, certificates, supplier agreements, scanned invoices.
• Contracts (part of HRM) — an agreement with a customer or an employee: parties, value, start and end dates, renewal, attachments. Portal clients see theirs.
• Knowledge Base — articles in groups, written in the rich-text editor, published to staff and to the portal. Manuals, policies, how-tos.

/next/kb

Marketing

Marketing. Campaigns by email, SMS or WhatsApp to a customer segment — everyone, top spenders, inactive for 90 days, a loyalty tier — using a template with placeholders, sent now or scheduled. The dashboard and the reports show sends, deliveries and the sales attributed to a campaign. Templates for each channel and the gateway defaults live under Marketing Settings.

/next/marketing/dashboard

/next/marketing/campaigns

Scheduled campaigns are sent by the scheduler every minute — they need the cron entry from Cron & queue. Sending thousands of emails from a shared host is how a domain gets blacklisted; for large lists connect Mailchimp and let it do the sending.

Hospital & school

Two vertical modules for businesses that also run a clinic or a school alongside the shop — a pharmacy with a consulting room, an academy with a bookshop. Both are switched on under Settings → Modules and use the same customers, users and accounting.

/next/hospital/dashboard

/next/school/dashboard

Hospital Management: patients, doctors and departments, appointments, consultations, admissions with wards and beds, a lab test catalogue with orders, billing and reports. School Management: students, teachers, academic setup (classes, sections, subjects), enrolment, attendance, a timetable, exams and results, fees and reports.

Integrations: before you start

Integrations → All Integrations lists every connector with its state — connected, configured, or not set up — and opens each one's own page. Most pages carry a Guide tab that repeats the steps below with this server's own addresses and cron lines filled in, ready to copy.

/next/integrations

Switch it on, give people access

An integration you cannot find in the sidebar is switched off or not permitted:

• Module switch — Settings → Modules. The online-shop connectors sit under one master switch, Ecommerce Platforms; turning it off hides WooCommerce, Shopify, Salla, PrestaShop and Jumia together, and each also has a switch of its own.
• Permission — Settings → Permissions, per role. Each connector has its own: woocommerce_settings, shopify_stores / shopify_sync / shopify_logs, salla_settings, prestashop_settings, jumia_settings, quickbooks_settings, xero_settings, google_sheets_settings, mailchimp_settings, slack_settings, telegram_settings, whatsapp_settings and webhooks_view / _add / _edit / _delete.

Three ways data moves

Cron lines at a glance

Add only the lines for the integrations you use. Replace /path/to/stocky with the install folder — each integration's Guide tab shows its lines with the real path already filled in. On cPanel these go in Cron Jobs; use the full path to PHP 8.2+ if php is older. On Windows, create a Task Scheduler task with program php, the same arguments, started in the install folder.

Append >> /dev/null 2>&1 to each line to keep cron from emailing its output.

WooCommerce

Ecommerce Platforms → WooCommerce. Two-way sync between Stocky and a WordPress shop: products, stock, categories, brands, customers and orders. Stocky is the source of truth for stock and catalogue; WooCommerce is where online orders are placed.

/next/woocommerce

Connect the shop

1. Create REST API keys in WooCommerce

   In WordPress: WooCommerce → Settings → Advanced → REST API → Add key, permission Read/Write. Copy the consumer key (ck_…) and consumer secret (cs_…) — the secret is shown only once.

2. Optional: a WordPress application password

   Only needed for product images: the WooCommerce API moves everything else, while the WordPress API searches the Media Library and uploads images that are not there yet. Use a WordPress user who can manage media and create the password under Users → Profile → Application Passwords. Leave both fields empty and everything still syncs except images.

3. Enter them in Stocky

   On the Settings tab: the store URL — the site address with https:// and no trailing slash, e.g. https://yoursite.com — the consumer key and secret, and optionally the WordPress username and application password. Save runs a connection test against the shop; the status tile turns Connected.

The first sync

Each tab — Products, Stock, Categories, Brands, Customers, Orders — shows what is linked and what is not, and offers a push (Stocky → WooCommerce) or a pull (WooCommerce → Stocky). On a fresh connection, go in this order:

1. Categories, then brands

   So a pushed product lands in the right category.

2. Products

   Push to publish your catalogue, or pull if the shop already has it. If both sides already have the same products, use Auto-link by SKU on the Products tab first, so nothing is created twice.

3. Stock

   Push. From then on keep it right with the instant push and the hourly sync below.

4. Customers and orders

   Pull. Orders become sales in Stocky.

Imported orders and pulled products use the default warehouse from System Settings; stock published to WooCommerce is the total across every warehouse, with negative figures sent as zero.

Right away: push stock and products as they change

• Push stock the moment it changes (Settings tab): every stock movement — POS sale, return, adjustment, transfer, received purchase — sends a push of just those products. Only products already linked to WooCommerce are pushed, variable products go through their parent, and a combo is re-pushed when any of its components move. A twenty-line sale costs one push, not twenty.
• Push products the moment they are saved: a product created, edited or duplicated is sent right after it is saved — details, price, variants and images, then its stock. Bulk imports are not pushed one by one; run a products sync after an import.

Neither needs a queue worker or a cron entry: the push runs after the screen has been answered, pushes never overlap, and if the shop stops answering they pause for five minutes (recorded in Logs) and catch up with the next push. Bulk operations such as deleting a product move stock without firing an event — keep the hourly stock sync on as the safety net.

On a schedule

WooCommerce has no webhook receiver here, so everything coming in — orders, product changes made in the shop, customers — arrives on the schedule. The five WooCommerce cron lines cover it; each runs on its own, so add only what you want. woocommerce:sync works through its own queue while it runs, so no separate worker is needed. Without any cron, every tab still syncs on demand while its page is open — orders then arrive only when someone presses the button.

--user= chooses which user imported sales are recorded under. The orders pull only moves its bookmark forward after a run with no errors, so an order that failed — usually because one of its products is not linked — is retried on the next run.

Sync tuning & logs

The Settings tab has a Sync tuning card for slow or busy hosts: products per batch (default 25), stock products per batch (25), the HTTP timeout (30 s), retries on timeouts and 429/5xx answers (2), how long a run may sit before it counts as stuck (10 min), and media timeouts for image uploads. A blank field restores the default. The Logs tab keeps every run with its outcome, filterable by action, status and date.

Troubleshooting

Shopify

Ecommerce Platforms → Shopify: Dashboard, Stores (one or more shops), Sync Centre (manual runs), Mappings (pairs Stocky records with Shopify ones), Logs and Guide. Products, inventory, customers, collections and fulfilments move both ways; orders come in from Shopify.

/next/shopify

Create the app in Shopify

Since January 2026 Shopify no longer creates custom apps inside the shop admin. Use whichever applies:

Connect a store

Stores → Add store. Every setting is changed the same way later — the pencil on the row, or Edit store on the store's page.

1. Connection

   A name, the shop domain (acme.myshopify.com; pasting the admin URL works too), the credential type and its values, the API version (default 2024-10) and, for a legacy app, the webhook signing secret. Saving tests the connection and fills in the shop's name and currency. When editing, a blank credential field keeps the stored value.

2. Where data lands

   The Stocky warehouse and the Shopify location it maps to (Fetch locations from Shopify fills the list) — each store pairs one warehouse with one location, and inventory sync and order import refuse to run without them. Also: which price is sent (retail, wholesale or minimum), and whether to create missing products (no SKU match) and missing customers (no email match). With the latter off, an order from an unknown customer is skipped.

3. What to sync

   A switch per entity. Off here means off everywhere — manual, scheduled and webhooks.

Products are matched on SKU (the product or variant code), never on title: before creating a product in Shopify, Stocky looks for a listing with the same SKU and links it instead. Customers match on email; customers without one are skipped. Mappings lets you link anything by hand; unlinking only forgets the pair and deletes nothing.

Automatic sync

Two mechanisms keep a shop in step, and they cover different things — use both.

1. Subscribe to the webhooks

   On the store's page, Webhooks tab, press Register in Shopify. It subscribes the shop to every topic whose entity is switched on — orders/create, orders/updated, orders/cancelled, orders/fulfilled, products/create, products/update, customers/create, customers/update, inventory_levels/update — pointing at https://your-domain/api/shopify/webhook. Pressing it twice is safe; Tidy up removes stale subscriptions. Each delivery is recorded once, so Shopify's retries cannot create a second order, and one that failed can be Replayed from the same tab.

2. Choose what runs on a schedule

   Edit the store, Automatic sync tab: switch it on, set a default interval (60 minutes unless changed) and build the plan. A step is one entity in one direction with its own interval — Orders · Shopify → Stocky every 15 min, Inventory · Stocky → Shopify every 30 min. Leave the plan empty and the store pulls orders and pushes stock at the default interval, which suits most shops. Add the shopify:sync cron line; five minutes is the finest interval it can honour.

3. Selling the same stock at a counter? Push stock the instant it changes

   Off until you ask for it. On the same tab, Push stock the moment it changes makes any stock movement in the store's own warehouse — POS sale, return, adjustment, received purchase — push just those products within seconds. It needs Inventory switched on, the store connected, and a warehouse and location set; only mapped products are pushed. Nothing else to install: the push runs after the sale has been answered. Keep the scheduled inventory push as the safety net for bulk operations.

4. Watch it

   The store's Overview shows every step with its last run, next due time and state — Waiting, Due now, Running, or Blocked with the reason (usually no warehouse or no location). Runs and Errors keep the history; scheduled runs appear exactly like manual ones.

5. Large syncs run in the background

   A sync started from the Sync Centre answers at once and is worked by the Shopify queue cron line in short slices, each carrying on from where the last stopped — so hosting that ends long web requests (LiteSpeed, nginx, a load balancer) cannot cut a big catalogue off part-way, and closing the page does not stop it. Without that cron line the open Sync Centre page carries the run on itself after a few seconds, one short request at a time.

A step is due when it last started longer ago than its interval, so a sync you start by hand postpones the next automatic one. Do the first catalogue push by hand — after a --dry-run — before putting it on a schedule.

Troubleshooting

Salla

Ecommerce Platforms → Salla. Products, stock and orders with a Salla store (Saudi Arabia and the Gulf). Orders arrive the moment they are placed, through Salla's webhooks.

/next/integrations/salla

1. Create the app in Salla Partners

   On salla.partners, create a private app in Custom Mode. Copy its Client ID and Client Secret into the Salla page in Stocky and save.

2. Set the addresses the page shows

   In the app, set the OAuth callback to https://your-domain/salla/callback. Under Webhooks, choose the Signature strategy, copy its secret into Stocky's Webhook Secret field, set the webhook URL to https://your-domain/api/salla/webhook, and subscribe at least to order.created, order.updated, product.updated, product.deleted, app.store.authorize and app.uninstalled.

3. Connect

   Choose the stock warehouse (or all warehouses added together), press Connect with Salla, sign in and approve. Test Connection shows the store name.

Salla access tokens last 14 days and the refresh token one month — and each refresh token works once. Stocky renews them on its own; the keep-alive cron line makes sure a quiet store is still renewed before the month runs out. If it lapses, press Connect again. Order lines are matched on SKU; lines that match nothing are listed in the sale's notes, and an order with no matching line is skipped with a warning in Logs.

PrestaShop

Ecommerce Platforms → PrestaShop. Products, stock and orders with a PrestaShop store, over its Webservice. There are no webhooks: orders come in when you pull them.

1. Create a Webservice key

   In the PrestaShop back office: Advanced Parameters → Webservice, enable the webservice, and add a key with View, Add, Edit on products and stock_availables, and View on orders and customers.

2. Connect

   Enter the store URL, the key, the shop language ID (1 unless your default language differs — it is the language product names are written in) and the stock warehouse. Test Connection reads one product.

• Products — push creates missing simple products (reference = product code) with their opening stock; edits to existing products are made in PrestaShop. Pull matches on the link, then reference, and imports combinations as their parent product, with zero stock.
• Stock — push for linked simple products.
• Orders — pull, newest first, as sales with reference PS-…. Cancelled, refunded and payment-error orders are skipped; an order already imported is not changed again. Run it after busy periods.

Keep references identical on both sides. A stock push that fails with “No stock_available row for product N” means that product has no stock record in PrestaShop yet — save it once there.

Jumia

Ecommerce Platforms → Jumia. Pushes prices and stock to your Jumia listings and imports Jumia orders.

1. Generate an API key

   In Jumia Seller Center: Settings → Integration Management, generate an API key.

2. Connect

   Enter the API URL for your country — e.g. https://sellercenter-api.jumia.com.ng (Nigeria), .co.ke (Kenya), .com.eg (Egypt) — the Seller Center account email, the API key and the stock warehouse. Test Connection reads one order.

• Prices & stock — push for every product whose code matches a Jumia Seller SKU, in batches of 100. Jumia processes the feed later; items it rejects are listed in Seller Center's feed status, not in Stocky.
• Orders — pull, as sales with reference JM-…. Cancelled, returned and failed orders are skipped; delivered orders arrive as completed and paid, others as unpaid (cash on delivery). An order already imported is not changed again.

New listings are created in Seller Center, not from Stocky; the Seller SKU must equal the Stocky product code. Nothing runs on a schedule — push and pull from the page.

QuickBooks Online

Integrations → QuickBooks Sync. Sends customers and sales to QuickBooks Online as customers and invoices, so your accountant works from the same figures.

/next/settings/quickbooks

1. Create an app at Intuit

   On developer.intuit.com, create an app with the Accounting scope (com.intuit.quickbooks.accounting). Under its keys, add the redirect URI https://your-domain/quickbooks/callback — it must match character for character, over HTTPS.

2. Enter the keys

   On the Settings tab: Client ID, Client Secret, the same redirect URI, the environment (Development for sandbox keys, Production for live ones), and optionally the income account name invoices should post to.

3. Connect

   On the Connection tab press Connect, sign in to Intuit and choose the company.

• Customers — Clients tab: sync all, selected, or one; matched on the saved link, then email, then display name.
• Sales — each new sale (POS or back office) becomes an invoice with the sale reference as its number; editing or deleting the sale updates or deletes the invoice. Products become QuickBooks Service items with the product code as SKU. This runs in the background — add the background queue cron line.
• Income account — the name you entered, else the first active income account, else one called “Sales of Product Income” is created.

The Audit Log tab records every call; a sale that failed to sync keeps the error on the sale. If the callback shows an error, the usual causes are a redirect URI that does not match exactly, or an http:// address.

Xero

Integrations → Xero. Pushes customers as contacts and sales as invoices (and their payments) to a Xero organisation.

/next/integrations/xero

1. Create a Xero app

   On developer.xero.com → My Apps → New app, type Web app, with the redirect URI https://your-domain/xero/callback. Copy the Client ID and generate a Client Secret.

2. Enter them and connect

   Paste both, save, press Connect and pick the organisation (with several authorised, the first is used). Test Connection shows its name.

3. Check the account codes

   Sales account code (default 200) receives invoice lines; Payment account code — a bank account in Xero — receives payments. Leave the payment code empty to send invoices only.

4. Push customers, then invoices

   Contacts first, so each invoice finds its contact.

Invoices are sent as Authorised, numbered with the sale reference, with shipping, discount and tax as separate lines on the sales account — totals match Stocky, and your accountant can remap those lines in Xero. A sale already in Xero is not sent again. With Auto-sync new sales on, each new sale is sent in the background (background queue cron line). Xero's connection expires after 60 days without use; the keep-alive line prevents that. Because invoice numbers are sale references, Xero rejects a sale it already has even after the links are reset.

Google Sheets

Integrations → Google Sheets. Writes sales, products and customers into a Google spreadsheet you own — one tab each, rewritten on every export. A snapshot, not a live feed.

1. Set up Google Cloud

   On console.cloud.google.com, create a project and enable the Google Sheets API (APIs & Services → Library). Configure the OAuth consent screen as External.

2. Create the OAuth client

   Credentials → Create credentials → OAuth client ID, type Web application, authorised redirect URI https://your-domain/google-sheets/callback.

3. Connect and pick the sheet

   Paste the Client ID and Secret, save, press Connect Google account. Then Create new (makes “Stocky Export”) or paste the URL of a sheet your account can edit, and run the exports.

Keep the page open while an export runs, until its counter stops. Switch on Auto-export nightly and add the Google Sheets cron line to refresh every tab at 02:30. If connecting fails with “no refresh token”, remove the app under your Google account's third-party access and connect again.

Mailchimp

Integrations → Mailchimp. Sends customers to a Mailchimp audience, so newsletters go out from Mailchimp rather than your own mail server.

1. Create an API key

   In Mailchimp: Account → Extras → API keys → Create a key. It ends in -us… (your data centre) — paste the whole thing.

2. Choose the audience

   Paste the key, press Load audiences, pick one, decide on double opt-in (on by default: new contacts get a confirmation email first) and save. Test Connection pings Mailchimp.

3. Push customers, then switch on auto-sync

   Push customers adds or updates everyone with an email, with first name, last name and phone; existing members keep their subscription status. Auto-sync then adds each new customer as they are created — in the background, so it needs the background queue cron line.

Telegram

Integrations → Telegram. Sends a message to a Telegram chat, group or channel for each sale, purchase, payment, expense or other event you choose. The Guide tab repeats these steps with this server's cron line filled in.

1. Create the bot

   In Telegram, open @BotFather, send /newbot, choose a name and a username, and copy the bot token it replies with (123456789:ABC…).

2. Find the chat ID

   Your own chat: send the bot any message first (a bot cannot start a conversation), then ask @userinfobot for your ID. A group: add the bot. A channel: add the bot as an administrator. For a group or channel, post a message there and open https://api.telegram.org/bot<YOUR_TOKEN>/getUpdates — the "chat":{"id": …} value is the chat ID, negative for groups and channels; copy the minus sign too.

3. Connect

   Paste the token and chat ID on the Settings tab, choose All events or only some (sale.created, purchase.created, payment.created, expense.created, cash_register.opened…), switch it on, save, and press Send test message.

Anything saved in Stocky — at the POS or in the admin — is sent right after it is saved, with its final totals; no cron and no queue worker, and the cashier never waits for Telegram. A save that is cancelled sends nothing. Two kinds of message wait on Telegram's own queue instead: a send that failed, retried up to three more times over the next few minutes, and events raised in the background, such as orders imported from WooCommerce or Shopify. The telegram:send cron line sends them, and nothing else; the Guide tab shows how many are waiting — a number that keeps growing means that line is not running.

Slack

Integrations → Slack. Posts the same one-line event messages to a Slack channel — 🛒 New sale — Ref: SL_0042 · Total: 125.50 · Status: completed.

1. Create an incoming webhook

   In Slack, create an app with Incoming Webhooks switched on (see api.slack.com/messaging/webhooks), add a webhook to the channel, and copy its URL — it starts with https://hooks.slack.com/.

2. Connect

   Paste the URL, choose all events or some, switch it on, save, and press Send test message. The URL is stored write-only: afterwards only its last characters are shown.

The test goes out at once; event messages are sent in the background and need the background queue cron line. A failed send is written to the application log.

WhatsApp Business

Integrations → WhatsApp, through Meta's WhatsApp Cloud API: send invoices, payment receipts and order updates to customers' phones, and see what was delivered and read. Tabs: Connection, Automations, Delivery log, Setup guide.

1. Create the Meta app

   On developers.facebook.com/apps, create a Business app and add the WhatsApp product. From WhatsApp → API Setup, copy the Phone number ID (a long number — not the phone number itself) and the WhatsApp Business Account ID.

2. Create a permanent token

   The token on API Setup expires after 24 hours. In Business Settings → System users, add an admin system user, assign it the WhatsApp account (full control) and the app, and Generate new token with whatsapp_business_messaging and whatsapp_business_management. Copy the App Secret from App settings → Basic as well.

3. Connect

   Enter the phone number ID, account ID, token, app secret and your default country code (added to numbers that start with 0), save, and press Test Connection — it shows the number, its verified name and quality rating.

4. Register the webhook

   In Meta: WhatsApp → Configuration → Webhook → Edit. Paste the Callback URL (https://your-domain/api/whatsapp/webhook) and the Verify Token shown on the Connection tab, Verify and save, then under Manage subscribe to messages. Meta only accepts https:// addresses.

5. Test, then switch on

   Send a test message (in development mode, add the recipient under API Setup → To first). When it arrives, turn on Enable WhatsApp sending and choose your automations.

Each automation has its own switch and editable text, sent to the customer's phone number (nothing is sent to a customer without one). Sales, quotations and purchases also get a WhatsApp action that sends through the API directly. Automations are delivered in the background — add the background queue cron line. The Delivery log shows every message as queued, sent, delivered, read, failed or received, with Retry for failed ones.

Webhooks

Integrations → Webhooks. For systems this guide has not heard of — your own app, Zapier, Make or n8n. A webhook is a URL of yours that Stocky calls with a JSON payload whenever a chosen event happens, signed with a secret so your side can check it came from Stocky.

/next/settings/webhooks

1. Add a webhook

   A name, your HTTPS URL, the events (or All), a timeout (15 seconds by default, 60 at most) and Active. A secret starting whsec_ is generated; it is shown in the edit window, with Regenerate.

2. Test it

   The lightning button sends a webhook.test event. Like every delivery it goes through the background queue, so it arrives within a minute when that cron line runs.

Events: sale.created / updated / deleted, sale_return.created / updated / deleted, purchase.created / updated / deleted, purchase_return.created / updated / deleted, payment.created / deleted, payment_purchase.created / deleted, payment_sale_return.created / deleted, payment_purchase_return.created / deleted, expense.created / updated / deleted, cash_register.opened and client.created.

Each call is a POST with this body:

{
  "id": "4f0c7c9e-…",            // unique per delivery
  "event": "sale.created",
  "created_at": "2026-10-03T14:05:22+00:00",
  "data": {
    "id": 1042,
    "type": "Sale",
    "attributes": { "Ref": "SL_1042", "GrandTotal": 125.5, "statut": "completed", … }
  }
}

…and these headers: X-Webhook-Event, X-Webhook-Id (the webhook), X-Webhook-Delivery (this delivery), X-Webhook-Attempt and X-Webhook-Signature — sha256= followed by the hex HMAC-SHA256 of the raw body, keyed with the webhook's secret. Verify it before trusting the payload:

$body      = file_get_contents('php://input');
$expected  = 'sha256=' . hash_hmac('sha256', $body, 'whsec_your_secret');
$signature = $_SERVER['HTTP_X_WEBHOOK_SIGNATURE'] ?? '';

if (! hash_equals($expected, $signature)) {
    http_response_code(401);
    exit;
}

Answer with any 2xx status. Anything else — or no answer within the timeout — is retried after 1 minute, 5 minutes, 30 minutes and 2 hours; after the fifth attempt the delivery is marked failed. The Delivery Logs tab shows each one as pending, retrying, success or failed, with the payload, the response code and body, and the time taken. Use X-Webhook-Delivery to ignore a delivery you have already processed.

Google Calendar & payment gateways

• Google Calendar (Settings → System Settings → Calendar) mirrors bookings into a calendar: a confirmed booking becomes an event, and changes and deletions follow. Create an OAuth client in Google Cloud with the Google Calendar API enabled and the redirect URI https://your-domain/google-calendar/callback, enter the client ID, secret and calendar ID (primary for your main calendar), then Connect. Updates are sent by the background queue. If connecting reports “no refresh token”, remove the app's access in your Google account and connect again.
• Payment gateways (Settings → Payment Gateway, also under the online store) — Stripe for the POS and the store, plus PayPal, Paystack, Flutterwave, Razorpay, bKash, SSLCommerz and offline methods for the store checkout. Each tab takes that provider's keys and switches it on or off; Stripe's keys are shared by the admin and the store.

Mobile app & API

Stocky's admin, POS, store, customer display and portal are all installable web apps (PWAs). A native companion app is sold separately; this package holds its server side.

/next/settings/mobile-app

Settings → Mobile App: enable or disable sign-in from the app (with a maintenance message when it is off), the app name, logo, primary colour and theme mode, which modules it shows, whether the scanner, offline data and price editing are allowed, the minimum app version that may connect, and support contacts.

The API

The app authenticates at POST /api/mobile/login with an email and password and receives a Laravel Passport personal access token, sent on every later call as Authorization: Bearer …. GET /api/mobile/ping lets a client validate a server URL before signing in. The token carries the user's role, so the app sees exactly what the browser would.

The rest of the API — the endpoints the admin itself uses under /api/… — accepts the same Bearer token, which is how your own integrations read products, create sales or pull reports. Tokens issued to devices are listed, and can be revoked, under Settings → Login Devices.

Every endpoint — path, parameters, validation rules, required permission, response shapes and cURL / JavaScript / PHP samples — is documented in the API reference, which ships with this package. It also exposes an OpenAPI 3 document you can import into Postman or Insomnia, and a try-it console that sends real requests against your own server.

Dashboard

The first page after sign-in. A date range — today, 7 days, this month, this year or a custom period — and a warehouse filter at the top; everything below follows them.

/next/dashboard

• Tiles: sales, purchases, sales returns, purchase returns, dues, invoices, profit.
• Charts: sales and purchases over the period, top-selling products, top customers, payments sent and received, sales by payment method, stock value.
• Lists: recent sales and the products under their stock alert.

Which widgets show and in what order is set in System Settings → Dashboard, and the default range too, so a stock keeper can open on alerts and a manager on profit. The Today's summary drawer in the header is the short version, available from any page.

Reports

Reports. Sixty screens, each the same shape: a date range with quick picks (today, 7 days, 30 days, 90 days, this year), a warehouse filter where it applies, a chart where one helps, a table, and Excel and PDF export. Reports default to today; pick a range first.

/next/reports/sales

/next/reports/profit-and-loss

/next/reports/stock-aging

/next/reports/inventory-valuation-summary

/next/reports/top-selling-products

Analytics, 3D & AI reports

/next/reports/analytics

/next/reports/sales-3d-dashboard

Analytics is a one-page summary — revenue, margin, growth against the previous period, best sellers, best customers — for a manager who wants one screen. The 3D sales dashboard is the same data drawn for a wall screen.

/next/reports/ai-reports

AI Reports answers a fixed list of business questions — what sells best on weekends, which customers are slipping, which products are about to run out — from your own database. Nothing is sent to a third-party model and no API key is needed; the name describes the questions, not a chatbot. See Deliberately not here.

Email, SMS & notifications

Mail

/next/settings/mail

Settings → Mail Settings. Mailer (SMTP), host, port, encryption, username, password, sender name and address. Send a test before relying on it. Everything Stocky emails — invoices and quotations from a document, portal invitations, store verification and password resets, order confirmations — goes through this.

SMS and WhatsApp

Settings → SMS Settings: Twilio, Termii, Infobip or a custom HTTP gateway (URL, method, parameter names), with the default gateway in System Settings. SMS Templates hold the text sent for a sale, a purchase, a quotation, a return and a payment, with placeholders such as the customer name, the reference and the amount. WhatsApp templates live under Marketing and use the same placeholders.

/next/settings/sms-templates

/next/settings/email-templates

In-app

The bell in the header collects stock alerts, new online orders, kitchen tickets, sync results and approvals. Slack and Telegram can receive the same alerts (see Telegram and Slack). Settings → Custom Fields adds your own fields to products, customers, suppliers and documents, and they appear on the forms, the PDFs and the templates.

Languages & translations

Settings → Languages. Twenty-four languages ship: English, French, Arabic, Turkish, Thai, Hindi, German, Spanish, Italian, Indonesian, Simplified and Traditional Chinese, Russian, Vietnamese, Korean, Bangla, Portuguese, Danish, Japanese, Polish, Swahili, Hausa, Yoruba and Amharic. Enable the ones you want offered; set the default in System Settings. Arabic runs the admin, the POS and the store right-to-left.

/next/settings/languages

/next/settings/translations/fr

Strings live in the database, not in files, so Translations edits them from the panel: search a key or a phrase, type the translation, save. A language you add from the panel starts as a copy of English and is translated the same way. Product names and descriptions can be translated per language on the product form for the store; the customer portal and the store each have their own language switcher.

Appearance & PWA

Settings → Appearance: the login page and sidebar branding, the accent colours, the sidebar style — default, large, flat or dark — the default theme mode, and the sidebar menu manager, which hides, renames and reorders entries for everyone (permissions still apply on top). Reset to default undoes it.

/next/settings/appearance

Each user's own choice — light or dark, sidebar layout — is the gear button bottom right and is saved in their browser. Settings → PWA holds the install manifests described under Branding, SEO & PWA.

Backups

Settings → Backup. Generate backup dumps the database to storage/app/public/backup/; the list shows every dump with its date and size, to download or delete. With the cron entry in place the database:backup command runs on the schedule as well.

/next/settings/backup

Cloud backup copies each dump off the server: Amazon S3 (or any S3-compatible bucket — key, secret, region, bucket, endpoint, path) or Google Drive (client ID and secret, refresh token, folder ID). A backup that lives only on the server it protects is not a backup.

System health & security

/next/settings/system-health

/next/settings/login-devices

System Health: PHP and Laravel versions, environment, database size, storage usage, the queue status (pending jobs — a growing number means the scheduler is not running), the last backup date, and a PDF of it all for a support ticket.

Login Devices: every active session and API token with its device, address and last activity; sign out any of them, or all but this one. The Login Activity report keeps the history. Passwords are reset from the login page by email; the storefront's request-safety middleware rate-limits and screens form submissions.

Cron & queue

Stocky works without either — sales, stock, receipts, the store and the reports need nothing in the background. A single cron entry unlocks the scheduled work:

* * * * * cd /path/to/stocky && php artisan schedule:run >> /dev/null 2>&1

On cPanel this is Cron Jobs; use the full path to PHP 8.2+ if php is older. If you would rather schedule only the integrations you use, each has a cron line of its own — see Cron lines at a glance; use one style or the other, not both. What the scheduler runs:

The queue driver is database, so there is nothing to install and no Redis. Because the scheduler drains the queue each minute, you do not need a separate queue:work process; if you run one anyway (Supervisor, a systemd unit), the scheduler's pass simply finds nothing to do. Without any cron, queued jobs drain inline while somebody uses the admin, which is enough for a small shop but delays webhooks and syncs until the next visit.

Troubleshooting

Deliberately not here

Every link in the sidebar opens a real screen. A few things a system like this could plausibly do are absent on purpose, and this guide would rather name them than let you find out:

• No native mobile app in this package. The admin, POS, store, customer display and portal are installable PWAs. Settings → Mobile App holds the server side of the separately sold companion app.
• No AI model calls. AI Reports answers a fixed list of business questions from your own data. Nothing is sent to a third-party model, and no key is needed.
• No multi-tenant or SaaS mode. One install is one business, with as many warehouses, users and stores as you like.
• No tax engine. Tax rates are what you enter, per product and per store rate. ZATCA covers Saudi e-invoicing only.
• No payroll tax tables. Payroll records what you pay; the deductions are yours to compute.
• No live exchange rates. Multi-currency rates are typed and updated by you.
• No hardware is bundled. Scanners, scales, printers and cash drawers are standard devices talking over the browser, QZ Tray or the network.
• No restore button. Restoring a backup overwrites everything, and a mis-click there costs a business its history. Restore with phpMyAdmin or the command line, deliberately.

Changelog

5.8

• Reports & pricing — Product Sales Summary report; quantity-based wholesale pricing; multi-currency; ZATCA phase 2.
• Online store — configurable store URL (a custom path or the root domain); bKash and SSLCommerz; new Electronics, Toys & Baby and Grocery themes; the Real Estate theme redesigned and the Default theme upgraded; product images by link.
• Offline POS — the register works fully offline, including a reload while offline.
• PWA & updates — Install App in the header; automatic updates with pre-update checks, backup, rollback and a recovery console.
• Integrations hub — Salla, PrestaShop, Jumia, Xero, Google Sheets and Mailchimp; Slack and Telegram notifications; Xero auto-sync for new sales, Mailchimp auto-sync for new customers, nightly Google Sheets export, keep-alive for Salla and Xero; module toggles for WooCommerce, Shopify and Zapier fixed.
• Shopify automatic sync — a scheduled sync per shop: a plan of steps (which entity, which direction, how often), each with its next due time and the reason it is blocked when it is; one-press webhook registration from the store page; and php artisan shopify:sync for running or inspecting a schedule by hand.
• Kitchen display — daily token numbers; full-screen kitchen mode; overdue colour escalation with a target time; per-item check-off; stations by category with per-device pinning; automatic tickets for confirmed online orders; a ten-second undo; 72 mm station-aware chit printing; a kitchen report; the public order-ready screen; a Voided badge.
• Bug fixes and performance, stability and documentation improvements.

5.8

• Shopify integration.
• Advanced manufacturing (MRP): bills of materials, work centres, production and work orders, quality control, planning.
• Barcode label printing redesigned: five templates, saved label settings, a true-size live preview and direct TSPL printing to USB or network label printers.
• Documentation updated; minor bugs fixed.

The full history back to 1.0 is in README.md in the package.

Credits & support

Stocky is built on Laravel with Laravel Passport for API tokens; the admin, POS, customer display and portal are Vue 3 applications with Vue Router, Pinia and Ant Design Vue, charts by ApexCharts and ECharts, icons by Lucide, built with Vite; the storefront is Blade with Alpine.js and Tailwind CSS; silent printing through QZ Tray. Thanks to everyone who maintains them.

Getting help

When you write in, three things turn a slow answer into a fast one: the version and the PDF from Settings → System Health, the exact steps that produced the problem, and the last few lines of storage/logs/laravel.log (or the Error Logs report). A screenshot of the screen you were on helps more than a description of it. Support runs for six months from purchase; updates are free for life.

Stocky documentation · version 5.8
Thank you for buying it.