Documentation

How can we help?

Everything you need to install, configure, extend and run Okommerce — for Community and Enterprise.

Platform Overview & Positioning Okommerce is a configurable, self-hostable commerce engine that runs physical, service, digital, quotation, subscription, and rental businesses —… 14 Editions, Licensing & Pricing Section pending final details — see notes inside. 1 Installation, Setup Wizard & Deployment At a minimum: obtain the build, point it at a SQL Server database, run it, and complete the first-run setup wizard. 22 Architecture & Tech Stack Okommerce is built on ASP.NET Core 9 using MVC with feature areas, on top of Entity Framework Core 9 over Microsoft SQL Server 2022. 14 User Roles & Access Control Okommerce supports nine distinct role types, and which ones exist in a given deployment depends on what the developer activates. 17 Product Catalogue — Products, Categories, Attributes A product is created from the admin (Catalogue → Products → Create). 17 Bundles, Scheduled Pricing & Discounts Any product can be flagged as a bundle (an IsBundle flag) composed of several component products. 10 Custom Fields & Column Visibility Okommerce has a global custom-field system: an "add a custom field" capability available on essentially every form across the platform — not just… 9 Product Type: Physical A Physical product is a tangible good — something picked, packed, and physically delivered. 5 Product Type: Service A Service product is labour or work performed rather than a physical good shipped — consulting, a repair, a cleaning, an installation, a booked appointment. 6 Product Type: Digital A Digital product is a downloadable or licensed item — an ebook, software, a media file, a template — delivered electronically with no physical logistics. 7 Product Type: Quotation A Quotation product is one where the price is negotiated before a formal order exists — the customer requests a quote, staff respond with an offer, the… 7 Product Type: Subscription A Subscription product bills the customer recurringly on a defined cycle — weekly, monthly, yearly, and so on — rather than as a one-off purchase. 11 Product Type: Rental / Access A Rental/Access product grants time-bound use of an item or access, with a start and end date, rather than transferring ownership — equipment hire,… 6 Configurable Status Workflows Statuses are data the admin defines, not values baked into code, because every business runs its operations differently and each product type has its… 7 Vendors, Branches & Multi-vendor In single-vendor mode the whole store is one business: every order flows into one central place where all orders and their internal details are visible. 10 Order Transfer & Split Fulfillment A vendor can shift an order (or a fulfilment portion) to another vendor — vendor to vendor — when they can't or shouldn't fulfil it themselves. 7 Inventory & Warehouse Any location can hold stock: a branch, a dedicated warehouse, or a head office — anything can be declared a stock location by marking the branch as a… 8 Cart & Checkout A visitor can browse the full catalogue without an account, and their cart is held in the session as they add items. 13 Orders & Order Lifecycle When an order is created, it is divided into one Fulfilment per vendor involved. 16 Fulfillment Fulfilment is the first internal process after an order is received, performed by the handling branch before the order is ready for delivery. 13 Delivery — In-house & Geo-zones Okommerce supports two kinds of delivery teams: in-house and external. 11 Delivery — External Companies You register an external delivery company in a dedicated section, recording its name and contact, and — where it offers one — its API connection (a… 10 COD, Payment Collection & Reconciliation For each COD job the driver is shown exactly what they need: the total to collect, how much is already paid, and the collection method (cash,… 8 Returns & Reverse Logistics After receiving a product, a customer submits a refund/return request from their account (the storefront's request-refund action), which opens a… 12 Payments & Gateways Payment gateways are plug-ins: you add one by choosing its provider key and entering its credentials (API key/secret and any extra config), along with… 9 BNPL — Tabby & Tamara Buy-Now-Pay-Later is integrated through the same gateway plug-in model, with Tabby and Tamara as the supported BNPL providers (a gateway is flagged as… 4 Vendor Accounting & Settlement For an online payment on a multi-vendor order, the main company collects the full payment, then transfers each vendor's share minus commission. 10 Wallet & Store Credit The wallet is a store-credit balance held per customer, recorded as a ledger of entries (credits and redemptions) in the customer's chosen currency. 4 Loyalty & Rewards Customers earn points on purchases, calculated immediately, based on the amount spent and the program's earn rate (points per unit of currency),… 9 Support & AI Agents AI agents are created using the Claude API and configured with a system prompt that acts as their knowledge base and instructions. 12 WhatsApp & Chat Commerce WhatsApp integration enables full conversational ordering: inbound WhatsApp messages drive the AI agents, which can answer product questions, assemble… 7 CRM The CRM provides a Kanban sales pipeline — leads as cards moving through configurable stages by drag-and-drop — and a 360° customer view that… 8 Marketing Automation Marketing automation is multi-channel across Email, WhatsApp, and SMS — a campaign targets one of these channels, and the platform supports building and… 8 Approval Workflows Large organizations can't act immediately on everything — significant actions (ordering new stock, large price corrections, certain operations) need… 7 Visitor Analytics & Journey Tracking A JavaScript snippet is copied from the admin panel and pasted onto the website — the same copy-paste approach as the chat widget. 8 Multi-country & Multi-currency One system serves multiple countries, and each country can have its own URL, all running from the same deployment. 6 Localization & RTL Okommerce is multilingual, with support including English, Arabic, Hindi, Urdu, Filipino, and French, among other major languages — and the set is… 6 Website Templates — Shopify & API Two kinds of storefront templates are supported: Shopify-format templates (which use the Liquid template language) and API-based templates (custom… 7 Progressive Web Apps (PWA) The system generates two PWAs by default: a Customer PWA (for shoppers) and a Delivery PWA (for drivers). 6 Dashboard & Widgets The dashboard is a dynamic, widget-based home screen: a grid of widgets (KPIs, charts, lists, shortcuts) that each user sees on login. 6 Email Templates & Notification Center Different events trigger different emails — order confirmed, refund processed, and so on — each mapped to its own template via an event key. 7 CMS & Content The CMS provides four content building blocks: Pages (full storefront pages with a slug, title, and rich multilingual body), Blocks (reusable… 6 Compliance, Security & Data Ownership ZATCA Phase 2 (Saudi e-invoicing) requires a statutory tax/e-invoicing engine and integration with the authority's clearance/reporting system. 9 Integrations The platform provides a generic external-delivery-company model: you register a courier and connect its API (base URL + key), or operate it manually. 5 Reporting The reporting hub provides core operational reports: Sales (revenue and order performance), Loyalty (points earned/redeemed/expired activity), and… 4 Marketing Site — Community & Downloads Section pending final details — see notes inside. 1 Admin Operations & Maintenance Because the platform is configuration-driven, an admin can add these at runtime without a code release. 6 Developer / API / Extensibility Because Okommerce is self-hosted with source access and built on Clean Architecture, a developer can extend or fork it cleanly: business logic… 8 Troubleshooting & FAQ If the app reaches the database but reports missing tables (or columns), the schema scripts haven't been fully run for the features in use. 8