Module overview, installation and lifecycle
This section explains the supplied version 1.0.0 package, its additive installation model, tenant-scoped architecture and supported activation lifecycle.
eCommerce & POS Module overview
eCommerce & POS Module overviewUnderstand how POS sales, e-commerce, stock, purchasing, reporting, API access, webhooks and audit evidence connect in the supplied module.
Open guide →GuideConfirm the module package name and root folder
Confirm the module package name and root folderVerify the installable archive structure before upload.
Open guide →GuideInstall and activate the eCommerce & POS Module
Install and activate the eCommerce & POS ModuleUse the host module lifecycle to install the supplied package safely.
Open guide →GuideVerify the first activation defaults
Verify the first activation defaultsCheck the default category, location, register, options and email templates created for an empty tenant.
Open guide →GuideUnderstand the module version and host compatibility
Understand the module version and host compatibilityConfirm the version declaration and supported host convention before deployment.
Open guide →GuideUnderstand the tenant-scoped data model
Understand the tenant-scoped data modelLearn how tenant_key confines module records to the current tenant.
Open guide →GuideUnderstand the bpos_ table prefix
Understand the bpos_ table prefixIdentify the 25 module-owned table suffixes without confusing them with core CRM tables.
Open guide →GuideUnderstand the idempotent installer
Understand the idempotent installerKnow what happens when install.php runs again on an existing installation.
Open guide →GuideUnderstand activation, deactivation and reactivation
Understand activation, deactivation and reactivationUse supported lifecycle actions without assuming deactivation deletes data.
Open guide →GuidePlan a safe production activation
Plan a safe production activationPrepare permissions, currency, locations, products, stock, SMTP and checkout settings before the first live transaction.
Open guide →GuideVerify required PHP extensions and services
Verify required PHP extensions and servicesConfirm OpenSSL, cURL for webhooks, MySQL or MariaDB InnoDB, and HTTPS for production.
Open guide →GuideUnderstand what the module stores about payments
Understand what the module stores about paymentsDistinguish tender records and invoice references from raw card data.
Open guide →GuideUnderstand the public store base route
Understand the public store base routeKnow how /shop connects to catalogue, cart, checkout, order, sitemap and PWA endpoints.
Open guide →GuideUnderstand the read-only API base route
Understand the read-only API base routeKnow where scoped GET endpoints are exposed and what they do not permit.
Open guide →GuideUnderstand the module-owned email templates
Understand the module-owned email templatesIdentify the order confirmation and internal new-order notification templates created on activation.
Open guide →GuideCheck module action links
Check module action linksUse Open and Settings links exposed on the module listing when permitted.
Open guide →GuideDeactivate the eCommerce & POS Module safely
Deactivate the eCommerce & POS Module safelyDisable module execution while preserving operational and audit records.
Open guide →GuideReactivate the eCommerce & POS Module safely
Reactivate the eCommerce & POS Module safelyRun the idempotent activation flow and verify retained data returns.
Open guide →GuideUnderstand module upgrade and rollback boundaries
Understand module upgrade and rollback boundariesRestore prior code through the approved deployment process while retaining data unless a separate authorised migration says otherwise.
Open guide →GuideRun the post-install readiness checklist
Run the post-install readiness checklistVerify menu access, permissions, settings, location, register, shift, product, stock, email, checkout and integrations before go-live.
Open guide →GuideUnderstand features intentionally outside the supplied module
Understand features intentionally outside the supplied moduleAvoid promising external card refunds, write APIs, advanced recipe/serial workflows or screens that the code does not expose.
Open guide →