Product Phase A Built
The Product module is the merchant's catalog. Owners and managers define what they sell - products, the sellable variants beneath each product, the prices (fares) those variants carry, the categories that group them, and the codes (SKU, barcode, QR) used to find them. Everything sold through POS, online, or any channel starts here.
1. Identity
| Property | Value |
|---|---|
| Module ID | CORE-05 |
| Tier | Core |
| Status | Built |
| Phase | P1 (catalog) · P2 (variants + fares) · P3 (advanced types + promotions) |
| Priority | HIGH |
| Primary users | Owner / Manager (catalog setup) · Cashier / Employee (lookup at POS) |
2. Purpose & Scope
| Included | Excluded |
|---|---|
| Products, categories, and product images | Bill of Materials / recipe management → Inventory |
| Variants (the sellable units) + variant types | Stock levels per location → Inventory |
| Pricing via fares (base, tiered, time/quantity/channel) | Order processing & checkout → Orders |
| Product & variant identifiers (SYSTEM, SLUG, SKU, BARCODE, QRCODE) | Tax rates & e-invoice → Tax & Invoice |
| Sale-channel availability | CSV / bulk import (Planned) |
| Bundles (combo, add-on, frequently-bought-together) | Promotion discount calculation (In-progress) |
3. Capabilities
| Capability | What the user can do |
|---|---|
| Product catalogue | Create, update, deactivate, archive, and reactivate products |
| Multilingual info | Name & description per product / variant in multiple languages |
| Categories | Group products; flag a category as add-on |
| Product images | Attach media to products and variants |
| Default variant | Every product gets one variant automatically on creation |
| Identifiers | Look up by SYSTEM, SLUG, SKU, BARCODE, QRCODE |
| Variants | Add multiple sellable variants per product (atomically with info, fares, IDs) |
| Variant types | STORABLE, CONSUMABLE, SERVICE, KIT, COMBO, MANUFACTURED, ENTITLEMENT |
| Product options | Define option axes & ordered values; each variant binds one value per axis, combinations unique |
| Units of measure | Base / purchase / sale unit stored per variant |
| Sale-channel availability | Control which products appear in which channels |
| Fares (pricing) | One fare set per variant; tiered prices by quantity, time, channel |
| Bundles | Combo, add-on, and frequently-bought-together relationships |
| Effective date range | Variants available only inside a validity window |
| Variant pricing read endpoint | Retrieve a variant's resolved price in isolation |
| Promotions | Discount campaigns (create/manage) |
| Unit conversions | Buy in one unit, sell in another |
| CSV / bulk import | Upload a catalogue from a spreadsheet |
Promotions can be created and managed today, but the discount calculation engine is disabled - discounts are not yet applied automatically at pricing time. See developer Promotions doc.
4. Module Dependencies
| Depends on | Why |
|---|---|
| Commerce | Products and categories are scoped to a merchant |
| Inventory | Stockable variants seed inventory items; BOM lives here |
| Orders | Variants are what gets sold in an order |
| Tax & Invoice | Tax groups are applied to products |
5. Backend Packages
Implementation detail lives in the developer docs - this section only maps the module to the services that power it.
| Package | Role | Developer docs |
|---|---|---|
@nx/commerce | Products, variants, categories, identifiers, bundles, sale channels | commerce |
@nx/pricing | Fare sets, fares, rules, fare selection, promotions | pricing |
@nx/core | Shared schemas for all catalog entities | core |
Engineering Mapping (Feature ⇄ Package)
The horizontal axis of the Feature Spine - each business feature (
<AREA>in the URD) maps to its engineering home. Reciprocal: the package docs link back here.
| Feature | Dev package | Status |
|---|---|---|
PRD Product Catalogue | @nx/commerce · @nx/core | Built |
CAT Categories | @nx/commerce | Built |
PID Identifiers | @nx/commerce | Built |
ACC Access Control | @nx/commerce | Built |
VAR Variants | @nx/commerce | Built |
BND Combos & Bundles | @nx/core · @nx/commerce · @nx/sale | Built |
OPT Product Options | @nx/commerce · @nx/core | Built |
FAR Fares / Pricing | @nx/pricing · @nx/commerce | Built |
SCH Sale Channels | @nx/commerce · @nx/core · @nx/search | Built |
CMP Promotions | @nx/pricing | In-progress |
6. Key User Flows
Product creation (aggregate)
Fare resolution (at sale)
7. Roles & Permissions
| Role | Can | Cannot |
|---|---|---|
| Owner | Full catalogue management within own merchants | See products of other organizations |
| Manager / Employee | View and look up products in assigned merchants | See merchants they are not assigned to |
| Admin / Super Admin | View across all organizations (role filtering bypassed) | - |
8. Status & Roadmap
| Phase | Capabilities |
|---|---|
| P1 | Product CRUD, categories, images, default variant, base fare, SYSTEM/SLUG identifiers |
| P2 | Multiple variants (aggregate), multi-scheme identifiers, tiered fares (date/quantity), sale-channel availability, bundles |
| P3 | Advanced variant types (KIT/COMBO/MANUFACTURED with BOM), UOM, promotion discount engine, CSV import |
Variant types and UOM storage are already built; the BOM consumption, unit-conversion, and promotion-discount behaviors that complete P3 are still pending - see the Capabilities table.