Quick reference
Every endpoint in the E-biz REST API — 569 operations — generated from the same OpenAPI spec that
powers the interactive reference at /api-docs on your API host. Paths are relative to /api/v1. Each row
links to the page that documents it in full.
By area
All endpoints
Auth
POST /auth/forgot-password— Request password reset link (docs)POST /auth/login— Login (docs)POST /auth/logout— Logout (docs)GET /auth/me— Get current user (docs)PUT /auth/me/email— Change email address (docs)PUT /auth/me/password— Change password (docs)POST /auth/register— Register admin user (docs)POST /auth/reset-password— Reset password with token (docs)POST /auth/ws-ticket— Issue a WebSocket authentication ticket (docs)
Products
GET /products— List products (docs)POST /products— Create product (docs)GET /products/:id— Get product (docs)PUT /products/:id— Update product (docs)DELETE /products/:id— Delete product (docs)GET /products/:id/currency-prices— Get currency price overrides for a product (docs)PUT /products/:id/currency-prices— Set or update currency price overrides (docs)POST /products/:id/duplicate— Duplicate a product (docs)POST /products/:id/generate-image-alt— Generate image alt text for a single product (docs)GET /products/ai-generation-status— Get AI generation job status (docs)POST /products/bulk-enhance-images— Enhance product images with AI (docs)POST /products/bulk-generate-ai— Generate AI descriptions and SEO for products (docs)POST /products/bulk-generate-image-alt— Generate image alt text and titles in bulk (docs)GET /products/export— Export products as CSV (docs)POST /products/import— Import products from CSV (docs)POST /products/popularity/recalculate— Recalculate popularity scores (docs)GET /products/template— Download product import template (docs)
Reservations
GET /reservations— List reservations (docs)POST /reservations— Create a reservation (front desk / phone) (docs)GET /reservations/:id— Get a reservation with its status history (docs)PUT /reservations/:id— Edit a reservation (docs)DELETE /reservations/:id— Delete a reservation (docs)PATCH /reservations/:id/status— Move a reservation to another status (docs)GET /reservations/areas— List bookable areas (docs)POST /reservations/areas— Create an area (docs)PUT /reservations/areas/:id— Update an area (docs)DELETE /reservations/areas/:id— Delete an area (docs)GET /reservations/availability— Bookable slots for a date (docs)GET /reservations/export/csv— Export the service book as CSV (docs)GET /reservations/settings— Get reservation settings (docs)PUT /reservations/settings— Update reservation settings (docs)GET /reservations/stats— Today's service counters (docs)
Categories
GET /categories— List categories (docs)POST /categories— Create category (docs)GET /categories/:id— Get category (docs)PUT /categories/:id— Update category (docs)DELETE /categories/:id— Delete category (docs)GET /categories/:id/branches— Get branch availability for category (docs)PUT /categories/:id/branches— Update branch availability for category (docs)POST /categories/:id/generate-seo— Generate SEO metadata for category (docs)POST /categories/bulk-generate-seo— Bulk-generate SEO metadata for categories (docs)
Brands
GET /brands— List brands (docs)POST /brands— Create brand (docs)GET /brands/:id— Get brand (docs)PUT /brands/:id— Update brand (docs)DELETE /brands/:id— Delete brand (docs)
Orders
GET /orders— List orders (docs)POST /orders— Create order (docs)GET /orders/:id— Get order details (docs)PUT /orders/:id— Update order (full) (docs)DELETE /orders/:id— Delete order (docs)POST /orders/:id/assign-rider— Assign or unassign a rider to an order (docs)POST /orders/:id/notes— Add a note to an order (docs)PATCH /orders/:id/payment-status— Update payment status (docs)POST /orders/:id/resend-confirmation-email— Resend order confirmation email (docs)PUT /orders/:id/status— Update order status (docs)PATCH /orders/:id/status— Update order status (PATCH) (docs)PATCH /orders/:id/view— Mark order as viewed (docs)GET /orders/batch— Fetch multiple orders by IDs (docs)POST /orders/batch— Create multiple orders (batch) (docs)GET /orders/count/unviewed— Count unviewed orders (docs)GET /orders/export— Export orders as CSV (docs)GET /orders/sources— List all order sources (docs)
Customers
GET /customers— List customers (docs)POST /customers— Create customer (docs)GET /customers/:id— Get customer details (docs)DELETE /customers/:id— Delete customer (docs)GET /customers/:id/loyalty— Get loyalty points balance and ledger (docs)POST /customers/:id/notes— Add customer note (docs)PUT /customers/:id/password— Update customer password (docs)POST /customers/import— Bulk import customers (docs)GET /customers/loyalty-registrations— List loyalty program registrations (docs)GET /customers/loyalty-registrations/:id— Get loyalty registration details (docs)POST /customers/loyalty-registrations/:id/approve— Approve loyalty registration (docs)POST /customers/loyalty-registrations/:id/reject— Reject loyalty registration (docs)
Branches
GET /branches— List branches (docs)POST /branches— Create branch (docs)GET /branches/:id— Get branch (docs)PUT /branches/:id— Update branch (docs)DELETE /branches/:id— Delete branch (docs)GET /branches/:id/integrations— Get branch integrations (docs)PUT /branches/:id/integrations/:integrationKey— Update branch integration (docs)GET /branches/config— Get branch options (docs)PUT /branches/config— Update branch options (docs)
Shipping
GET /shipping/convenient-couriers— Get Convenient Couriers Config (docs)PUT /shipping/convenient-couriers— Update Convenient Couriers Config (docs)GET /shipping/distance-based-shipping— Get Distance-Based Shipping Config (docs)PUT /shipping/distance-based-shipping— Update Distance-Based Shipping Config (docs)POST /shipping/external/calculate— Calculate shipping rates for external systems (docs)GET /shipping/methods— List Shipping Methods (docs)POST /shipping/methods— Create Shipping Method (docs)GET /shipping/methods/:id— Get Shipping Method (docs)PUT /shipping/methods/:id— Update Shipping Method (docs)DELETE /shipping/methods/:id— Delete Shipping Method (docs)GET /shipping/shipments— List shipments (docs)GET /shipping/shipments/:id— Get Shipment (docs)GET /shipping/zones— List shipping zones (docs)POST /shipping/zones— Create shipping zone (docs)GET /shipping/zones/:id— Get Shipping Zone (docs)PUT /shipping/zones/:id— Update Shipping Zone (docs)DELETE /shipping/zones/:id— Delete Shipping Zone (docs)GET /shipping/zones/:zoneId/areas— List shipping areas in a zone (docs)POST /shipping/zones/:zoneId/areas— Create a shipping area (docs)PUT /shipping/zones/:zoneId/areas/:areaId— Update a shipping area (docs)DELETE /shipping/zones/:zoneId/areas/:areaId— Delete a shipping area (docs)POST /shipping/zones/:zoneId/areas/import— Bulk import shipping areas (docs)
Webhooks
POST /storefront/webhooks/mpesa— M-Pesa payment callback webhook (docs)GET /webhooks— List webhooks (docs)POST /webhooks— Create webhook (docs)GET /webhooks/:id— Get webhook (docs)PUT /webhooks/:id— Update webhook (docs)DELETE /webhooks/:id— Delete webhook (docs)GET /webhooks/:id/deliveries— Get webhook delivery logs (docs)POST /webhooks/:id/test— Test webhook delivery (docs)POST /webhooks/mpesa— M-Pesa payment callback webhook (backwards-compat alias) (docs)
API Keys
GET /api-keys— List API keys (docs)POST /api-keys— Create API key (docs)GET /api-keys/:id— Get API key details (docs)PUT /api-keys/:id— Update API key (docs)DELETE /api-keys/:id— Delete API key (docs)POST /api-keys/:id/regenerate— Regenerate API key secret (docs)
Settings
GET /settings— Get all settings (docs)PUT /settings/:key— Update setting (docs)GET /settings/admin-maps-key— Get the admin Google Maps key (docs)PUT /settings/admin-maps-key— Update the admin Google Maps key (docs)GET /settings/api-operation-logs— List API operation logs (docs)DELETE /settings/api-operation-logs— Delete API operation logs (docs)POST /settings/api-operation-logs/:id/undo— Undo an API operation (docs)GET /settings/background-tasks— List background tasks (docs)GET /settings/background-tasks-archive— List archived (completed/failed) background tasks (docs)GET /settings/background-tasks/:id— Get a background task by ID (docs)POST /settings/background-tasks/:id/cancel— Cancel a background task (docs)GET /settings/background-tasks/:id/report— Download a background task failure report (docs)POST /settings/bulk-delete— Delete multiple resources in a background task (docs)POST /settings/clear-storefront-cache— Clear storefront cache (docs)GET /settings/currencies— List supported currencies (docs)POST /settings/currencies— Create a new currency (docs)PUT /settings/currencies/:id— Update currency (docs)DELETE /settings/currencies/:id— Delete currency (docs)POST /settings/currencies/refresh— Refresh all currency exchange rates (docs)GET /settings/emails— Get email templates (docs)POST /settings/emails— Create a new email template (docs)PUT /settings/emails/:id— Update email template (docs)DELETE /settings/emails/:id— Delete an email template (docs)POST /settings/emails/:id/generate— Generate email content using AI (docs)POST /settings/emails/:id/preview— Preview an email template with sample data (docs)POST /settings/emails/:id/test— Send a test email (docs)POST /settings/emails/seed-defaults— Create missing default email templates (docs)GET /settings/order-number— Get order number configuration (docs)POST /settings/order-number/reset-sequence— Reset order number sequence (docs)GET /settings/payment-gateways— Get payment gateways (docs)PUT /settings/payment-gateways/:id— Update payment gateway (docs)POST /settings/s3-migration/cancel— Cancel running S3 migration (docs)GET /settings/s3-migration/source-config— Get S3 source configuration (docs)POST /settings/s3-migration/start— Start S3 asset migration (docs)GET /settings/s3-migration/status— Get S3 migration status (docs)POST /settings/s3-migration/test-connection— Test S3 destination connection (docs)PUT /settings/shop/:key— Update shop setting (docs)PUT /settings/site-favicon— Upload site favicon (docs)PUT /settings/site-logo— Upload site logo (docs)
Transactions
GET /transactions— List transactions (docs)
Media
GET /media— List media files (docs)PATCH /media/:id— Update media metadata (docs)DELETE /media/:id— Delete media file (docs)POST /media/upload— Upload file (docs)
Marketing
GET /marketing— Marketing overview (docs)GET /marketing/abandoned-carts— List abandoned carts (docs)DELETE /marketing/abandoned-carts/:id— Delete abandoned cart (docs)POST /marketing/abandoned-carts/:id/trigger-automation— Trigger cart recovery automation (docs)PATCH /marketing/abandoned-carts/:id/view— Mark abandoned cart as viewed (docs)GET /marketing/abandoned-carts/count/unviewed— Count unviewed abandoned carts (docs)GET /marketing/automation/campaigns— List automation campaigns (docs)GET /marketing/automation/campaigns/:type— Get automation campaign (docs)PUT /marketing/automation/campaigns/:type— Update automation campaign (docs)GET /marketing/automation/runs— List automation runs (docs)GET /marketing/automation/status— Automation addon status (docs)GET /marketing/automation/template-variables— Get template variables (docs)POST /marketing/automation/templates/enhance— AI-enhance email template (docs)GET /marketing/contacts— List contacts (docs)POST /marketing/contacts— Create contact (docs)PUT /marketing/contacts/:id— Update contact (docs)DELETE /marketing/contacts/:id— Delete contact (docs)POST /marketing/contacts/bulk— Perform bulk actions on contacts (docs)GET /marketing/contacts/groups— List contact groups with member counts (docs)POST /marketing/contacts/import— Bulk import marketing contacts (docs)GET /marketing/contacts/stats— Contact statistics (docs)GET /marketing/coupons— List coupons (docs)POST /marketing/coupons— Create coupon (docs)GET /marketing/coupons/:id— Get coupon (docs)PUT /marketing/coupons/:id— Update coupon (docs)DELETE /marketing/coupons/:id— Delete coupon (docs)GET /marketing/coupons/:id/usage— Get coupon usage history (docs)POST /marketing/coupons/:id/validate— Validate coupon (docs)GET /marketing/coupons/stats— Coupon statistics (docs)POST /marketing/loyalty/adjust— Adjust loyalty points (docs)GET /marketing/loyalty/balances— List customer loyalty balances (docs)GET /marketing/loyalty/balances/:customer_id— Get customer loyalty balance (docs)GET /marketing/loyalty/config— Get loyalty program configuration (docs)GET /marketing/loyalty/ledger— Global loyalty points ledger (docs)GET /marketing/loyalty/registrations— List loyalty registrations (docs)PUT /marketing/loyalty/registrations/:id— Approve or reject loyalty registration (docs)GET /marketing/loyalty/stats— Loyalty program statistics (docs)POST /marketing/subscribe— Subscribe to newsletter (public) (docs)
Analytics
GET /analytics— Get full analytics dashboard (docs)GET /analytics/overview— Get quick analytics overview (docs)GET /analytics/revenue— Get revenue-focused analytics (docs)
Reviews
GET /reviews— List reviews (docs)PUT /reviews/:id— Update review (approve/reject) (docs)DELETE /reviews/:id— Delete review (docs)PUT /reviews/:id/approve— Approve a review (docs)PUT /reviews/:id/reject— Reject a review (docs)
Tags
GET /tags— List tags (docs)POST /tags— Create tag (docs)PUT /tags/:id— Update tag (docs)DELETE /tags/:id— Delete tag (docs)
Attributes
GET /attributes— List attributes (docs)POST /attributes— Create attribute (docs)PUT /attributes/:id— Update attribute (docs)POST /attributes/:id/values— Create attribute value (docs)
Subscriptions
GET /subscriptions/packages— List subscription packages (docs)POST /subscriptions/packages— Create subscription package (docs)GET /subscriptions/packages/:id— Get subscription package (docs)PUT /subscriptions/packages/:id— Update subscription package (docs)DELETE /subscriptions/packages/:id— Delete subscription package (docs)GET /subscriptions/payment-callback— Handle payment callback (GET) (docs)POST /subscriptions/payment-callback— Handle payment callback (POST) (docs)GET /subscriptions/subscribers— List subscriptions (docs)POST /subscriptions/subscribers— Create subscription (docs)GET /subscriptions/subscribers/:id— Get subscription (docs)PATCH /subscriptions/subscribers/:id— Update subscription (docs)DELETE /subscriptions/subscribers/:id— Delete subscription (docs)POST /subscriptions/subscribers/:id/payment-link— Generate Pesapal payment link (docs)POST /subscriptions/subscribers/:id/send-reminder— Send payment reminder (docs)
Admin
GET /admin/activity-logs— List activity logs (docs)GET /admin/activity-logs/:id— Get a single activity log entry (docs)GET /admin/activity-logs/export— Export activity logs as CSV (docs)GET /admin/roles— List roles (docs)POST /admin/roles— Create a role (docs)PUT /admin/roles/:id— Update a role (docs)DELETE /admin/roles/:id— Delete a role (docs)POST /admin/test-email— Send a test email (docs)GET /admin/users— List admin users (docs)POST /admin/users— Create a staff user (docs)PUT /admin/users/:id— Update a staff user (docs)DELETE /admin/users/:id— Delete a staff user (docs)GET /admin/users/:id/branches— Get user branch access (docs)PUT /admin/users/:id/branches— Update user branch access (docs)PUT /admin/users/:id/password— Reset a staff user password (docs)
Themes
GET /themes— List themes (docs)GET /themes/:id— Get theme (docs)PUT /themes/:id— Update theme (docs)
AI Image
GET /ai-image/config— Get AI Image Configuration (docs)PUT /ai-image/config— Update AI Image Configuration (docs)POST /ai-image/products/:id/images/apply— Save Generated Image to S3 (docs)POST /ai-image/products/:id/images/enhance— Enhance Existing Product Image (docs)POST /ai-image/products/:id/images/generate— Generate Image from Text (docs)POST /ai-image/test— Test AI Image Generation (docs)
AI Search
GET /ai-search/analytics— Get search analytics (docs)GET /ai-search/breaker— Get circuit breaker status (docs)POST /ai-search/breaker/reset— Reset circuit breaker (docs)GET /ai-search/config— Get AI Search configuration (docs)PUT /ai-search/config— Update AI Search configuration (docs)POST /ai-search/reindex— Enqueue bulk reindex (docs)GET /ai-search/stats— Get AI Search stats (docs)GET /ai-search/synonyms— List search synonyms (docs)POST /ai-search/synonyms— Create search synonym (docs)PUT /ai-search/synonyms/:id— Update search synonym (docs)DELETE /ai-search/synonyms/:id— Delete search synonym (docs)POST /ai-search/synonyms/import— Bulk import synonyms (docs)POST /ai-search/synonyms/seed-defaults— Seed default synonyms (docs)POST /ai-search/test-search— Test search query (docs)POST /ai/chat— Send messages to AI and receive responses (docs)
Affiliates
GET /affiliate— List affiliates (docs)GET /affiliate/:id— Get affiliate details (docs)PUT /affiliate/:id— Update affiliate rate overrides (docs)POST /affiliate/:id/adjust— Manually adjust affiliate wallet (docs)GET /affiliate/:id/ledger— Get affiliate wallet ledger (docs)GET /affiliate/:id/referrals— List affiliate referrals (docs)PUT /affiliate/:id/status— Update affiliate status (docs)GET /affiliate/commissions/list— List affiliate commissions (docs)GET /affiliate/config— Get affiliate configuration (docs)PUT /affiliate/config— Update affiliate configuration (docs)POST /affiliate/payouts/:id/cancel— Cancel payout and refund wallet (docs)POST /affiliate/payouts/:id/mark-paid— Mark payout as paid (docs)POST /affiliate/payouts/:id/retry— Retry failed Paystack transfer (docs)GET /affiliate/payouts/list— List affiliate payouts (docs)GET /affiliate/stats— Get affiliate program statistics (docs)GET /affiliate/wallets/list— List affiliate wallets (docs)GET /storefront/affiliate/config— Get affiliate program configuration (docs)POST /storefront/affiliate/preview-discount— Preview affiliate referral discount (docs)POST /storefront/affiliate/track— Track referral click (docs)
Appearance
GET /appearance/banners— List all banners (docs)POST /appearance/banners— Create a banner (docs)PUT /appearance/banners/:id— Update a banner (docs)DELETE /appearance/banners/:id— Delete a banner (docs)GET /appearance/blogs— Get storefront blog posts (docs)PUT /appearance/blogs— Update storefront blog posts (docs)GET /appearance/custom-scripts— Get custom scripts (head, body-start, body-end) (docs)PUT /appearance/custom-scripts— Update custom scripts (docs)GET /appearance/faqs— Get storefront FAQs (docs)PUT /appearance/faqs— Update storefront FAQs (docs)GET /appearance/homepage-sections— Get homepage sections configuration (docs)PUT /appearance/homepage-sections— Update homepage sections configuration (docs)PUT /appearance/menu-items/:id— Update a menu item (docs)DELETE /appearance/menu-items/:id— Delete a menu item (docs)GET /appearance/menus— List all menus (docs)POST /appearance/menus— Create a menu (docs)PUT /appearance/menus/:id— Update a menu (docs)DELETE /appearance/menus/:id— Delete a menu (docs)POST /appearance/menus/:id/items— Create a menu item (docs)GET /appearance/pages— List all pages (docs)POST /appearance/pages— Create a page (docs)PUT /appearance/pages/:id— Update a page (docs)DELETE /appearance/pages/:id— Delete a page (docs)POST /appearance/pages/regenerate-html— Generate page HTML with AI (docs)GET /appearance/shop-settings— Get all shop settings (docs)GET /appearance/store-locator— Get store-locator configuration (docs)PUT /appearance/store-locator— Update store-locator configuration (docs)POST /themes— Create theme (docs)DELETE /themes/:id— Delete theme (docs)POST /themes/:id/activate— Activate theme (docs)POST /themes/:id/deactivate— Deactivate theme (docs)GET /themes/active— Get active theme (docs)
Appearance Agent
GET /appearance/agent/changes— List changes made by agent or user (docs)POST /appearance/agent/changes/:id/undo— Undo a single change (docs)GET /appearance/agent/config— Get Appearance Agent configuration (docs)GET /appearance/agent/conversations— List user's conversations (docs)POST /appearance/agent/conversations— Create new conversation (docs)POST /appearance/agent/conversations/:id/cancel— Cancel a running conversation (docs)GET /appearance/agent/conversations/:id/messages— Retrieve conversation messages and changes (docs)POST /appearance/agent/conversations/:id/messages— Send message and run agent turn (docs)POST /appearance/agent/conversations/:id/undo-all— Undo all changes in conversation (docs)GET /appearance/agent/pages— List pages for Appearance Agent (docs)GET /appearance/agent/products/:id— Get product card state (docs)PUT /appearance/agent/products/:id/images— Reorder or remove product images (docs)POST /appearance/agent/products/:id/status— Publish or unpublish product (docs)POST /appearance/agent/uploads— Upload attachment for agent conversation (docs)
Catalog Feed
GET /catalog/products.xml— Product feed for Google Merchant Center and Facebook Catalog (docs)
Distributors
GET /distributors— List distributors (docs)GET /distributors/:id— Get distributor details (docs)PUT /distributors/:id/pricing— Set per-distributor pricing overrides (docs)PUT /distributors/:id/status— Update distributor approval status (docs)GET /distributors/bands— List store-wide discount bands (docs)POST /distributors/bands— Create a discount band (docs)PUT /distributors/bands/:id— Update a discount band (docs)DELETE /distributors/bands/:id— Delete a discount band (docs)GET /distributors/config— Get distributor programme configuration (docs)PUT /distributors/config— Update distributor programme configuration (docs)GET /distributors/product-pricing— List products with distributor pricing (docs)PUT /distributors/product-pricing/:productId— Upsert product-level distributor pricing (docs)DELETE /distributors/product-pricing/:productId— Delete product-level distributor pricing (docs)POST /distributors/product-pricing/bulk— Bulk import product distributor pricing (docs)GET /storefront/customer/distributor— Get customer's distributor status (docs)POST /storefront/customer/distributor/apply— Apply to the distributor programme (docs)POST /storefront/customer/distributor/preview-discount— Preview distributor discount (docs)GET /storefront/distributor/config— Get distributor programme config (docs)
Plugins
GET /plugins— List all plugins (docs)GET /plugins/:id— Get a single plugin (docs)PUT /plugins/:id/config— Update plugin configuration (docs)POST /plugins/:id/disable— Disable a plugin (docs)POST /plugins/:id/enable— Enable a plugin (docs)
Prescriptions
GET /prescriptions— List prescriptions (docs)GET /prescriptions/:id— Get prescription details (docs)DELETE /prescriptions/:id— Delete prescription (docs)POST /prescriptions/:id/create-order— Create order from prescription (docs)PUT /prescriptions/:id/notes— Update prescription notes (docs)PUT /prescriptions/:id/reject— Reject prescription (docs)PUT /prescriptions/:id/verify— Verify prescription (docs)GET /prescriptions/stats— Prescription statistics (docs)GET /storefront/prescriptions/check-cart— Check which cart products require prescriptions (docs)GET /storefront/prescriptions/mine— List authenticated customer's prescriptions (docs)POST /storefront/prescriptions/upload— Upload a prescription (docs)
Push Notifications
POST /push-tokens— Register device push token (docs)DELETE /push-tokens— Remove device push token (docs)
Rider App
POST /rider/location— Submit location samples (docs)GET /rider/me— Get current rider profile (docs)POST /rider/online— Toggle online/offline status (docs)GET /rider/orders— List rider's assigned orders (docs)GET /rider/orders/:id— Get single order details (docs)POST /rider/orders/:id/accept— Accept an assigned order (docs)POST /rider/orders/:id/deliver— Mark order as delivered (docs)POST /rider/orders/:id/pickup— Mark order as picked up (docs)POST /rider/orders/:id/proof— Attach proof of delivery photo (docs)POST /rider/push-token— Register Expo push token (docs)
Riders
GET /admin/orders/:id/track— Get order delivery tracking data (docs)GET /admin/riders/:id/locations— Get rider location history (docs)GET /riders— List riders (docs)POST /riders— Create a rider (docs)GET /riders/:id— Get a rider by ID (docs)PUT /riders/:id— Update a rider (docs)DELETE /riders/:id— Delete or archive a rider (docs)GET /riders/config— Get Riders addon configuration (docs)
Storefront - Cart
GET /storefront/cart— Get cart items (docs)POST /storefront/cart— Add item to cart (docs)DELETE /storefront/cart— Clear entire cart (docs)PUT /storefront/cart/:id— Update cart item quantity (docs)DELETE /storefront/cart/:id— Remove item from cart (docs)POST /storefront/cart/merge— Merge guest cart into customer cart (docs)POST /storefront/cart/validate-branch-stock— Validate cart items at a branch (docs)
Storefront - Catalog
GET /storefront/attributes— Get product attributes (docs)GET /storefront/branch-stock— Get live branch stock status (docs)GET /storefront/branches— Get shop branch locations (docs)GET /storefront/brands— Get all brands (docs)GET /storefront/categories— Get category tree (docs)GET /storefront/categories/:slug— Get category by slug (docs)GET /storefront/currencies— Get currencies and rates (docs)GET /storefront/locations/countries— Get list of supported countries (docs)GET /storefront/products— List products (docs)GET /storefront/products/:slug— Get product by slug (docs)GET /storefront/products/by-ids— Get products by IDs (docs)GET /storefront/tags— Get all product tags (docs)GET /storefront/test— Test storefront routing (docs)
Storefront - Checkout
POST /storefront/checkout/calculate-shipping— Calculate shipping costs (docs)GET /storefront/checkout/convenient-couriers-config— Get distance-based shipping configuration (docs)POST /storefront/checkout/create-order— Create order from cart (docs)GET /storefront/checkout/distance-based-shipping-config— Get distance-based shipping config (docs)GET /storefront/checkout/payment-gateways— List enabled payment gateways (docs)POST /storefront/checkout/process-payment— Process payment through gateway (docs)POST /storefront/checkout/unified-checkout/authorize— Authorize Unified Checkout payment (docs)POST /storefront/checkout/unified-checkout/capture-context— Get Unified Checkout capture context (docs)POST /storefront/checkout/unified-checkout/record-result— Record Unified Checkout orchestrated result (docs)POST /storefront/checkout/validate-coupon— Validate coupon code (docs)GET /storefront/orders/:id/payment-status— Get order payment status (docs)POST /storefront/orders/:id/verify-payment— Verify payment on-demand (docs)POST /storefront/paystack/reconcile— Reconcile Paystack payment status (docs)GET /storefront/shipping/areas— Get shipping areas (docs)GET /storefront/webhooks/pesapal/callback— Pesapal payment callback (docs)POST /storefront/webhooks/tingg/ipn/:secret— Tingg payment notification (IPN) (docs)GET /storefront/webhooks/tingg/return— Tingg customer return (docs)
Storefront - Content
GET /blog— List blog posts (docs)POST /blog— Create a blog post (docs)GET /blog/:id— Get a single blog post (docs)PUT /blog/:id— Update a blog post (docs)DELETE /blog/:id— Delete a blog post (docs)POST /blog/generate— Generate a blog post with AI (docs)GET /storefront/banners— Get active banners (docs)GET /storefront/blogs— List blog posts (docs)GET /storefront/blogs/:slug— Get blog post by slug (docs)POST /storefront/contact— Submit storefront contact form (docs)GET /storefront/custom-scripts— Get custom scripts (docs)GET /storefront/debug/routes— List debug routes registered on storefront (docs)GET /storefront/delivery-promise— Get delivery promise (docs)GET /storefront/faqs— List FAQs (docs)GET /storefront/homepage-sections— Get homepage section configuration (docs)GET /storefront/marketing/abandoned-cart/restore— Restore abandoned cart (docs)POST /storefront/marketing/abandoned-carts— Track abandoned checkout (docs)GET /storefront/menus— Get storefront menus (docs)GET /storefront/pages— List published pages (docs)GET /storefront/pages/:slug— Get page by slug (docs)GET /storefront/recipes— List recipes (deprecated, use /blogs) (docs)GET /storefront/reviews— List approved reviews (docs)POST /storefront/reviews— Submit a review (docs)GET /storefront/reviews/by-ids— Get reviews by IDs (docs)GET /storefront/settings— Get public shop settings (docs)GET /storefront/sitemap.xml— Get XML sitemap (docs)GET /storefront/sitemap/products— Get products for XML sitemap (docs)GET /storefront/store-locator— Get store locator config (docs)GET /storefront/theme— Get active theme configuration (docs)GET /storefront/wishlist— Get the wishlist (docs)POST /storefront/wishlist— Add product to wishlist (docs)DELETE /storefront/wishlist/:productId— Remove product from wishlist (docs)POST /storefront/wishlist/merge— Merge guest wishlist on login (docs)POST /storefront/wishlist/share— Create a share link (docs)GET /storefront/wishlist/shared/:token— View a shared wishlist (docs)
Storefront - Customers
POST /storefront/auth/forgot-password— Request password reset link (docs)POST /storefront/auth/login— Customer login (docs)POST /storefront/auth/logout— Logout and destroy session (docs)GET /storefront/auth/me— Get current customer (docs)POST /storefront/auth/register— Customer registration (docs)POST /storefront/auth/set-password— Set/reset password with token (docs)GET /storefront/auth/set-password/validate— Validate password reset token (docs)GET /storefront/customer/addresses— List customer addresses (docs)POST /storefront/customer/addresses— Create a new customer address (docs)PUT /storefront/customer/addresses/:id— Update customer address (docs)DELETE /storefront/customer/addresses/:id— Delete customer address (docs)GET /storefront/customer/affiliate— Get affiliate status and earnings (docs)POST /storefront/customer/affiliate/apply— Apply to join affiliate program (docs)POST /storefront/customer/affiliate/payout— Request affiliate payout (docs)PUT /storefront/customer/affiliate/payout-details— Update payout destination (docs)GET /storefront/customer/affiliate/payouts— Get affiliate payout history (docs)GET /storefront/customer/affiliate/referrals— Get affiliate referrals and conversions (docs)GET /storefront/customer/affiliate/wallet— Get affiliate wallet ledger (docs)GET /storefront/customer/loyalty— Get customer loyalty status and balance (docs)GET /storefront/customer/orders— Get customer's orders (docs)GET /storefront/customer/orders/:id— Get customer's order by ID (docs)GET /storefront/customer/profile— Get customer profile (docs)PUT /storefront/customer/profile— Update signed-in customer profile (docs)GET /storefront/customer/subscriptions— Get customer's subscriptions (docs)GET /storefront/loyalty/config— Get loyalty configuration (docs)POST /storefront/loyalty/register— Register for loyalty program opt-in (docs)
Storefront - Loyalty
POST /storefront/loyalty/preview— Preview loyalty point redemption (docs)POST /storefront/loyalty/redemption/send-otp— Send OTP for loyalty redemption (docs)POST /storefront/loyalty/redemption/verify-otp— Verify OTP and get redemption token (docs)
Storefront - Reservations
POST /storefront/reservations— Create a new reservation (docs)GET /storefront/reservations/:reference— Look up reservation by reference (docs)POST /storefront/reservations/:reference/cancel— Cancel a reservation (docs)GET /storefront/reservations/availability— Get available time slots (docs)GET /storefront/reservations/config— Get reservations configuration (docs)GET /storefront/reservations/mine— Get signed-in customer's bookings (docs)
Storefront - Search
GET /storefront/ai-search— Hybrid semantic + lexical product search (docs)GET /storefront/ai-search/health— AI search addon health check (docs)POST /storefront/ai-search/track-click— Track a product click in AI search results (docs)GET /storefront/recommendations/fbt— Frequently bought together recommendations (docs)GET /storefront/recommendations/fbt-cart— Frequently bought together for cart items (docs)GET /storefront/recommendations/for-you— Get personalized product recommendations (docs)GET /storefront/recommendations/similar— Similar product recommendations (docs)
Storefront - Subscriptions
GET /storefront/subscription-packages— Get active subscription packages (docs)POST /storefront/subscription-signup— Sign up for a subscription (docs)GET /storefront/subscriptions/:id/summary— Get subscription summary (docs)
GET /whatsapp/campaigns— List all WhatsApp campaigns (docs)POST /whatsapp/campaigns— Create a new campaign (docs)GET /whatsapp/campaigns/:id— Fetch a campaign and its recipients (docs)POST /whatsapp/campaigns/:id/pause— Pause a campaign mid-flight (docs)POST /whatsapp/campaigns/:id/send— Start sending a campaign (docs)POST /whatsapp/campaigns/preview— Preview the audience for a campaign (docs)GET /whatsapp/config— Get WhatsApp configuration (docs)PUT /whatsapp/config— Update WhatsApp configuration (docs)POST /whatsapp/onboarding/complete— Complete Embedded Signup handshake (docs)POST /whatsapp/onboarding/disconnect— Disconnect WhatsApp (docs)POST /whatsapp/openwa/logout— Unlink the paired WhatsApp number (docs)GET /whatsapp/openwa/qr— Fetch the pairing QR code (docs)GET /whatsapp/openwa/status— Check self-hosted WhatsApp (open-wa) pairing status (docs)GET /whatsapp/order-statuses— Get order statuses (docs)POST /whatsapp/phone/register— Register phone number (docs)GET /whatsapp/placeholders— Get template placeholders (docs)GET /whatsapp/reservation-statuses— Get reservation statuses (docs)GET /whatsapp/rider-triggers— Get rider notification triggers (docs)GET /whatsapp/templates— List templates (docs)POST /whatsapp/templates— Create template (docs)GET /whatsapp/templates/:id— Get template (docs)PUT /whatsapp/templates/:id— Update template (docs)DELETE /whatsapp/templates/:id— Delete template (docs)POST /whatsapp/templates/:id/dispatch— Test-send template against a real order (docs)POST /whatsapp/templates/:id/submit— Submit a template to Meta for approval (docs)POST /whatsapp/templates/:id/test— Send a test copy to a phone number (docs)POST /whatsapp/templates/generate— Generate template components using AI (docs)POST /whatsapp/templates/sync— Sync templates from Meta (docs)GET /whatsapp/webhook-log— Get webhook activity log (docs)DELETE /whatsapp/webhook-log— Clear webhook log (docs)
WhatsApp Storefront
GET /whatsapp-storefront/analytics— Dashboard stats (docs)GET /whatsapp-storefront/analytics/popular— Popular products (docs)GET /whatsapp-storefront/config— Get configuration (docs)PUT /whatsapp-storefront/config— Update configuration (docs)GET /whatsapp-storefront/faqs— List FAQs (docs)POST /whatsapp-storefront/faqs— Create FAQ (docs)PUT /whatsapp-storefront/faqs/:id— Update FAQ (docs)DELETE /whatsapp-storefront/faqs/:id— Delete FAQ (docs)PUT /whatsapp-storefront/faqs/reorder— Reorder FAQs (docs)GET /whatsapp-storefront/sessions— List conversations (docs)GET /whatsapp-storefront/sessions/:id— Get conversation details (docs)DELETE /whatsapp-storefront/sessions/:id— Reset or delete session (docs)PATCH /whatsapp-storefront/sessions/:id/bot-pause— Toggle bot pause (docs)POST /whatsapp-storefront/sessions/:id/resume— Resume bot (docs)POST /whatsapp-storefront/sessions/:id/send-message— Send manual message (docs)GET /whatsapp-storefront/sessions/active-count— Active session count (docs)
WooCommerce Migration
GET /woo-migration/config— Get masked WooCommerce migration configuration (docs)PUT /woo-migration/config— Update WooCommerce migration configuration (docs)GET /woo-migration/mapping/stats— Get row counts of imported WooCommerce entities (docs)GET /woo-migration/preview— Preview entity counts for migration (docs)POST /woo-migration/start— Start a WooCommerce migration task (docs)GET /woo-migration/status— Get latest migration task status (docs)POST /woo-migration/test— Test WooCommerce connection (docs)