Contents

Plugixa Inventory - User Documentation

Welcome to the official documentation for Plugixa Inventory, a WordPress plugin that turns a site into a working stock system: records in its own normalised tables, stock held per warehouse, and every change written to a ledger nothing can edit.

Plugixa Inventory ships in two editions:

  • Free - items, warehouses, categories and recipients; stock movements; the append-only ledger and its reconcile; the dashboard and the per-warehouse view; average costing; barcode scanning; CSV import and export; and the whole application on a page of your own site.
  • Pro PRO - FIFO and LIFO costing, warehouse transfers, inventory adjustments, reports and analytics, custom fields, units of measurement, roles and permissions, desktop notifications, installation as a progressive web app, and dark mode.

The free edition is not a trial. See the complete Free vs Pro feature matrix.

Three decisions that shape everything else

Decision What it means for you
Stock belongs to an item and a warehouse “How much is in the west depot” is answerable. An item with one stock number and one address nets ten in one place and none in another into a figure that is true of nowhere.
The ledger is append-only No REST route, no admin screen, and a veto in the data layer. On-hand quantities are derived from it, so the two cannot drift apart unnoticed. A mistake is corrected with a second, opposite document.
Its own tables, not posts Stock levels, ledger rows and document lines are relational data. As posts and post meta, every list and report gets slower as the history grows.

Key concepts

Term What it is
Item Something you hold: an asset, a consumable or a sellable good.
Warehouse A location with its own stock levels and its own valuation.
On hand How much of one item is in one warehouse. Derived from the ledger.
Stock movement A document that moves stock. Drafted, then finalised.
Finalising The moment a document becomes real and writes to the ledger. It can no longer be edited or deleted.
Ledger Every change ever made, append-only, newest first.
Reconcile The check that on-hand still follows from the ledger.
Recipient A person an asset is checked out to.
Reorder level The point below which an item counts as low stock.
App A feature you can switch off in the App Manager. Off keeps its data.

Getting started

Section Description
Getting Started Install, activate, and post your first stock
Dashboard What it is worth and what is about to run out
Free vs Pro The complete feature matrix

Records

Section Description
Items The catalogue: SKUs, barcodes, reorder levels and prices
Warehouses Locations, and why stock belongs to a pair
Categories Grouping the catalogue
Recipients The people assets are checked out to
Custom Fields PRO Your own data on records
Units of Measurement PRO Counting in boxes, metres or litres

Moving stock

Section Description
Stock Movements Check in, check out, add and remove; draft then finalise
The Stock Ledger Every change ever made, and why it cannot be edited
Adjustments PRO Breakage, shrinkage and a count that disagrees
Transfers PRO Moving stock between warehouses

Insight

Section Description
Warehouse Overview One location’s stock, low stock and activity
Valuation and Costing What stock is worth, and how it is costed
Reports PRO Deeper reporting across movements and valuation

Data

Section Description
Import CSV, column matching, opening stock and revert
Export Writing any list, filters and all, to CSV

On your own site

Section Description
The Shortcode [plugixa_inventory_app], its attributes, and the frame
Scanner and Search Finding an item by barcode or by typing
Install as an App PRO Running it from a phone or tablet home screen
Dark Mode PRO For the people who are in it all day

Configuration

Section Description
Settings Formatting, currency, appearance and each app’s options
App Manager Turning features off without losing their data
Notifications Low stock and anything else needing somebody
Desktop Notifications PRO The same alerts as browser notifications
Roles and Permissions PRO Who may see and change what

For developers

Section Description
Hooks Reference Actions and filters
REST API The plugixa-inventory/v1 namespace
WP-CLI Reconcile from the command line
Privacy and Data What is stored, and what happens on uninstall

Support

Section Description
Troubleshooting Common problems and their causes

System requirements

  • WordPress: 6.5 or higher
  • PHP: 8.2 or higher
  • MySQL: 5.7+ / MariaDB 10.3+, InnoDB
  • Browsers: current Chrome, Firefox, Safari, Edge

Getting help

  1. Check Troubleshooting first.
  2. Read the page for the feature you are using.
  3. Contact support through your Plugixa account.

License

Plugixa Inventory is licensed under the GPL v2 or later. Pro features require a valid Plugixa license, managed through Freemius.

Quick Links