Documentation & Developer Guides
OmnifyWP Knowledge Base
Everything you need to install, configure, scale, and extend your ultra-high-speed eCommerce store on WordPress with 18 dedicated SQL tables and 0% platform commission.
Browse Documentation by Topic
Getting Started →
Installation prerequisites, 4-step setup wizard, and core page shortcode mapping.
Products & HMAC Locker →
Physical, variable, digital downloads, and bundle kits with expiring SHA-256 tokens.
Orders & Refunds →
6 order workflow states, 1-click refunds, and automated digital access revocation.
Customer Portal 2.0 →
SupportHub emerald UI, 4-col KPI cards, live tab pills, and account management.
Storefront & Checkout →
4-layout switcher, quick filter pills, flash sale tickers, and 1-step guest checkout.
14 Payment Gateways →
Stripe, PayPal, Paystack, Tap, Mollie, Khalti, eSewa, COD, and 0% platform fee.
SQL Architecture →
18 dedicated relational SQL tables, sub-15ms direct queries, bypassing wp_postmeta.
Settings, Shipping & Taxes →
Delivery zones, regional VAT/GST tax rules, automated emails, and currencies.
REST API, Webhooks & CLI →
API keys, outbound HMAC-SHA256 webhooks, actions, filters, and WP-CLI commands.
Getting Started with OmnifyWP
OmnifyWP eCommerce takes under 5 minutes to install and launch. Unlike legacy WordPress store plugins, it automatically provisions its own high-speed SQL tables and configures necessary pages upon activation.
System Prerequisites
| Component | Minimum Required | Recommended Spec |
|---|---|---|
| WordPress Version | 6.5+ | 6.6+ or 6.7+ (Full Site Editing ready) |
| PHP Runtime | 8.2+ | 8.2 or 8.3 (with curl, openssl, json, mbstring) |
| Database Engine | MySQL 5.7+ / MariaDB 10.3+ | MySQL 8.0+ / MariaDB 10.6+ (InnoDB default) |
| Web Server | Nginx or Apache with mod_rewrite | Nginx with HTTP/2 or HTTP/3 |
| Security / SSL | HTTPS Active | Strict HSTS enabled for payment tokenization |
Core Store Shortcodes Registry
OmnifyWP automatically generates and assigns pages with these optimized shortcodes:
[omnify_storefront]— Displays the responsive product catalog with 4-layout grid switcher, filters, and color swatches.[omnify_cart]— Interactive real-time shopping cart with coupon validator and line item recalculation.[omnify_checkout]— Frictionless single-page checkout engine with country/state auto-complete and guest support.[omnify_customer_portal]— Customer Portal 2.0 with KPI cards, order history, and instant download token locker.[omnify_order_tracking]— Public guest order and invoice tracking by order number and billing email.[omnify_download_page]— Encrypted streaming endpoint validating expiring SHA-256 HMAC digital file links.
Products & Cryptographic Digital Locker
Manage physical goods, variable licenses, and high-value digital files. Digital assets are never exposed via raw server URLs; every download is generated on-demand with expiring cryptographic SHA-256 HMAC signatures.
1. Digital Products
Software binaries, plugins, eBooks, media files, or presets delivered with tamper-proof HMAC tokens.
2. Physical Goods
SKU inventory management, dimensional weight tracking, and real-time shipping zone rate calculations.
3. Variable Products
Multi-attribute variation matrices (Single Site / Agency License, or Size / Color swatches) with unique prices.
4. Product Bundles
Curated package deals grouping multiple digital assets or physical goods into a discounted promotional bundle.
Each digital download link is cryptographically bound to the purchasing order, customer identifier, and timestamp. Links automatically expire after your configured window (default: 48 hours) or maximum download count (e.g. 5 downloads), preventing unauthorized link sharing.
Orders, Fulfillment & Instant Refund Revocation
OmnifyWP automates the entire order lifecycle from payment capture to digital file provisioning. When an order is refunded, customer digital file permissions are revoked instantly to protect your intellectual property.
The 6 Order Lifecycle States
- Pending Payment: Order created; awaiting customer payment settlement through gateway.
- Processing: Payment verified; digital files unlocked; physical packing slip generated.
- Completed: Order fully fulfilled, files delivered, tracking numbers dispatched.
- On Hold: Awaiting offline manual wire transfer or paper check clearance.
- Cancelled: Abandoned or customer-terminated order prior to payment capture.
- Refunded: Payment reversed via gateway; digital download access automatically and irreversibly revoked.
Customer Portal 2.0 & Downloads Hub
Built with a modern SupportHub-inspired emerald design, Customer Portal 2.0 provides shoppers with an executive overview of their purchase history, digital locker, and account security.
Displays Total Spent, Orders Placed, Available Downloads, and Saved Addresses in real time.
1-click download buttons stream files via 8KB chunked memory flushes with live token validation.
Guest shoppers track order statuses and download invoices using shortcode [omnify_order_tracking].
Modern Storefront & Single-Page Checkout
Designed for maximum conversion rate, the OmnifyWP storefront features sub-millisecond catalog filtering, 4-layout grid switching, sticky reassurance bars, and single-step checkout.
- 4-Layout Catalog Switcher: Shoppers switch effortlessly between 4-column compact, 3-column standard, 2-column large, and detailed horizontal list view. Selection persists across sessions.
- Quick Filter Pills Strip: Instant 1-click filtering by Flash Deals, Bestsellers, New In, or categories with dynamic count badges.
- Floating Product Card Toolbar: Hover actions trigger Quick View modal, Wishlist toggling, or Product Compare without leaving the grid.
- Flash Sale Announcement Ticker: Top-bar countdown timer with 1-click coupon code copy button (
FLASH30). - Single-Page Guest Checkout: Country and state auto-complete, inline coupon code validation, and dynamic tax calculation in sub-15ms.
14 Payment Gateways & 0% Platform Commission
OmnifyWP includes 14 native payment adapters out of the box with zero third-party plugin fees and 0% platform transaction fees. All gateways start safely disabled by default until configured by the merchant.
Stripe Elements
Credit & Debit cards, Apple Pay, Google Pay, SEPA Direct Debit.
Webhook:/wp-json/omnify/v1/webhook/stripe
PayPal Commerce
PayPal Smart Buttons, Venmo, Pay in 4, and Vaulting.
Webhook:/wp-json/omnify/v1/webhook/paypal
Paystack (Africa)
Nigeria, Ghana, South Africa, Kenya (Cards, Mobile Money, USSD).
Webhook:/wp-json/omnify/v1/paystack/webhook
Tap Payments (Middle East & GCC)
Saudi Arabia, UAE, Kuwait, Bahrain (mada, KNET, Benefit).
Webhook:/wp-json/omnify/v1/tap/webhook
Mollie (European Union)
iDEAL (Netherlands), Bancontact (Belgium), SEPA, Klarna.
Webhook:/wp-json/omnify/v1/webhook/mollie
Khalti & eSewa (Nepal)
Digital wallets for NPR payments with cryptographic HMAC verification.
Native API v2 verification18 Dedicated SQL Tables (Zero-Postmeta Latency)
Traditional WordPress carts store eCommerce data in wp_posts and the dreaded wp_postmeta table. Loading an order or catalog requires dozens of expensive self-joins. OmnifyWP stores everything in 18 dedicated, normalized, indexed tables for sub-15ms execution.
Settings, Delivery Zones & Tax Engine
Configure regional operational settings under Omnify → Settings. Define localized delivery rates, tax rules, automated transaction emails, and currency formats.
- Localization & Currency: Choose any ISO currency code, customize prefix/suffix symbol placement, thousand and decimal separators, and weight/dimension units.
- Flexible Shipping Zones: Configure flat-rate, free shipping thresholds, and country/state conditional rules for physical inventory.
- Tax Calculation: Support for VAT/GST tax rates, inclusive or exclusive price display, and per-country tax exemption rules.
- Automated Notifications: Branded email templates for Order Confirmation, Digital Download Delivery, Refund Receipt, and Abandoned Cart Recovery.
REST API, Outbound Webhooks & WP-CLI
Build headless storefronts (Next.js, Astro), integrate ERP pipelines, and automate administrative tasks using our comprehensive developer tooling.
Primary REST API Endpoints
GET /wp-json/omnify/v1/products— List products with filtering, taxonomy, and pricingGET /wp-json/omnify/v1/products/{id}— Fetch single product with variations & filesPOST /wp-json/omnify/v1/checkout— Process high-speed single-page checkoutGET /wp-json/omnify/v1/orders— Authenticated order query endpointPOST /wp-json/omnify/v1/webhook/{gateway}— Inbound gateway payment listener
Outbound HMAC Webhooks
Subscribe to store events (order.created, order.completed, order.refunded, customer.created). Every outbound POST includes the X-Omnify-Signature header generated via HMAC-SHA256 for secure verification in external systems.
Developer Quick Reference
Copy battle-tested code snippets directly into your theme, custom plugin, or CLI terminal.
wp plugin install omnifywp-ecommerce --activate
Quick Links & Resources
Access the official guides and interactive developer tools bundled with OmnifyWP eCommerce.
- Official User Manual & Merchant Guide → — comprehensive walkthrough for store owners
- Developer Documentation & REST API Reference → — hooks, filters, endpoints, and schema
- Interactive Live Playground Demo (No Setup) → — test drive the plugin immediately in-browser
- OmnifyWP on WordPress.org → — official plugin repository page
- Release Changelog → — complete version history from v1.0.0 to v1.4.1