Skip to content

Commerce Phase A Built

Commerce is the business-structure module: it lets a business owner set up an Organization (the brand) and one or more Merchants (the legal point-of-sale units where transactions happen), each with its own sale channels and product categories. It is the first thing a new user touches — onboarding creates the whole structure in one atomic step — and everything else (products, orders, inventory, finance) hangs off the merchant it creates.

1. Identity

PropertyValue
Module IDCORE-03
TierCore
StatusBuilt
PhaseP1 (Onboarding) · P2 (Full management)
PriorityHIGH
Primary usersBusiness Owner · Manager · (read access for Employees)

2. Purpose & Scope

IncludedExcluded
One-step business onboarding (org + merchant + channels + access)Employee lifecycle and login (→ User Management)
Organization profile, hierarchy, settings, attachmentsRole/permission definition (→ Permissions)
Merchant creation (single, batch, aggregate) and profileProduct catalog content (→ Products)
Business-type classification (DEFAULT / TICKET / FNB / THEATER)Stock levels (→ Inventory)
Sale-channel managementOrder / checkout processing (→ Orders)
Category management with add-on flagPayment processing (→ Payment)
Per-merchant deletion policyE-invoice issuance (→ Tax & Invoice)
Encrypted merchant configuration (payment/integration credentials)

Organization vs Merchant. The Organization is the virtual brand layer (name, logo, public profile) and carries no legal identity. The Merchant is the physical/legal unit — it holds the tax number (MST), e-invoice profile, and wallet, and is where sales actually occur. Creating an Organization always auto-creates one default Merchant.

3. Capabilities

CapabilityWhat the user can doStatus
Business onboardingCreate the whole structure (organization + default merchant + sale channels + owner access) in one stepBuilt
Organization profileEdit name (multilingual), slug, contact, address, social links, registration infoBuilt
Organization hierarchyLink a parent organization to child organizationsBuilt
Organization settingsStore polymorphic key-value configuration on an organizationBuilt
Merchant — single createAdd one merchant to an organizationBuilt
Merchant — batch createAdd several merchants in one requestBuilt
Merchant — aggregate create/updateCreate or update a merchant with its categories and channels in one atomic operationBuilt
Business typeSet the POS interface type per merchant (DEFAULT / TICKET / FNB / THEATER)Built
Deletion policyConfigure per-merchant cascade rules for category/product deletionBuilt
Merchant configurationStore encrypted payment-provider and integration credentialsBuilt
Sale channelsManage channels via merchant aggregate; batch-add to existing merchant; hierarchyBuilt
CategoriesManage categories via merchant aggregate; mark as add-onBuilt
Status lifecycleActivate / deactivate / archive organizations and merchantsBuilt
Identifier lookupFind an organization or merchant by ID or by slugBuilt
Role-based filteringOwners see their own data; employees see only assigned merchantsBuilt
Standalone channel/category CRUDManage channels/categories independently of the merchant aggregatePlanned
Ownership transferReassign an organization to a different ownerPlanned

4. Module Dependencies

Depends onWhy
User ManagementThe owner and employees belong to the organization / merchants
PermissionsRoles are scoped to organization or merchant; onboarding grants the owner access
Depended on byWhy
ProductsProducts are scoped to a merchant
DeviceDevices are assigned to merchants
OrdersSales occur per merchant and sale channel
Tax & InvoiceTax info is captured on the merchant; invoice profiles are per merchant
ExpensesFinance wallets are per merchant

5. Backend Packages

Implementation detail lives in the developer docs — this section only maps the module to the service that powers it.

PackageRoleDeveloper docs
@nx/commerceOrganizers, merchants, onboarding, sale channels, categories, settings, devices, encrypted integrations; CDC source of truthcommerce

6. Key User Flows

Onboarding (atomic setup)

Aggregate merchant create/update (smart update)

7. Roles & Permissions

RoleCanCannot
OwnerOnboard, create/update/deactivate/archive organization and merchants, manage channels/categories/settings, assign employeesAccess other owners' organizations
ManagerManage assigned merchants and their channels/categories (per granted scope)Create organizations; manage merchants outside scope
EmployeeView assigned merchants and their structureCreate or modify merchants; see unassigned merchants
Super AdminAccess all organizations and merchants (bypasses role filtering)

8. Status & Roadmap

PhaseCapabilities
P1Atomic onboarding (organization + default merchant + sale channels + owner access)
P2Full organization & merchant management: profiles, hierarchy, aggregate create/update, business types, deletion policy, encrypted configuration, role-based filtering
P3Planned: standalone channel/category CRUD, ownership transfer, cascade deactivation, company-wide setting defaults, MST validation, multi-brand support

Proprietary and Confidential. Unauthorized copying, distribution, or use of this software is strictly prohibited.