menu-icon

Table of Contents

    Table of Contents

      Share On

      X IconLinkedIn IconFacebook Icon
      HomeIntegrationMagento
      Date: 26 March 2026

      Magento Integration

      This native integration with Magento enables seamless order, catalog, and inventory synchronization.

      Version: v1.0
      Date: March 10, 2026
      Owner: Sales Channel Product Team

      1. Overview

      What this integration does: The Magento integration connects your Magento Sales Channel store with Omniful so that:

      • Orders created through Magento automatically sync to Omniful for processing.
      • Inventory availability maintained in Omniful can be synced to Magento.
      • You can configure hub mapping and order status mapping, directly from Omniful.

      2. Prerequisites

      2.1 Sales Channel prerequisites

      You will need:

      • Omniful Magento Plugin installed on your Magento Store.
      • The shop domain URL associated with the Magento store.

      Install Omniful Plugin by following the guide: https://github.com/omniful/omniful-magento2-plugin

      3. Integration Methods and Setup

      3.1 Get API Details (Access Token) From Magento Store

      To obtain the above,

      1. Login to your Magento Partner Dashboard.

      2. Go to System > Manage API Keys, then Add New Integration or Use Existing Omniful Integration 1.png

      3. Click on View/Edit, And locate the Access Token 2.png

      3.2 Connect Magento store in Omniful

      Once you have the required details:

      1. In Omniful, go to: Settings → Apps & Integration → Sales Channel Apps

      2. Select Seller and choose Magento from the Sales Channel section

      3. Click Add Store 3.png

      4. Enter Shop Domain URL, and click Fetch Stores

      5. After stores are successfully fetched, enter the required details and Click Integrate to complete the integration.

      4. Omniful Configuration

      Once the store is connected, configure how data flows between Magento and Omniful.

      4.1 Store-level settings

      Depending on your requirements, you can enable:

      • Order Sync – Automatically fetch orders from Magento to Omniful.
      • Catalog Sync – Fetch catalog (SKUs) from Magento into Omniful.
      • Inventory Sync – Push available inventory from Omniful hubs to Magento.
      • Return Orders Sync - Fetch return orders from Magento into Omniful. 4.png

      4.2 Hub Mapping

      Configure how Magento orders are routed to Omniful hubs:

      • Map Omniful Hubs to the hubs configured in Magento.

      4.3 Order status mapping

      Order Status Mapping defines how Magento statuses and Omniful statuses stay in sync:

      • Sales Channel Mapping – Map incoming Magento order statuses (e.g., Processing, Pending) to internal Omniful order lifecycle stages (e.g., New, Ready for Picking).

      • Workspace Order Mapping – Define which outgoing Omniful shipment/order statuses should be pushed back to Magento. (for example, when the order is shipped or canceled).

      Note: Magento does not allow cancellations for prepaid orders due to refund policies. Please create a new status called "Rejected" and map it to "Cancelled." Omniful will use this "Rejected" status to update Magento when you cancel the prepaid order.

      Use Fetch Order Status within the configuration screen to load all available Magento statuses and then map them to Omniful statuses per your operational requirements.

      4.4 Configuration Log

      Use the Configuration Log to track changes to configurations.

      5. Data and Sync Behaviour

      5.1 Orders

      Which orders sync

      • All orders for the mapped hubs will sync to Omniful.

      • Only orders with the mapped order statuses will be visible in Omniful.

      5.2 Catalog

      • Seller’s Magento store catalog (SKUs) with valid SKU code is fetched automatically to Omniful when Catalog Sync is enabled.

      5.3 Inventory

      • Omniful automatically pushes and maintains inventory levels on the Magento store when Inventory Sync is enabled.

      5.4 Cancellations

      • Cancellations – When ‘Automated Order Cancellation On Sales Channel’ is enabled, canceling an order in Omniful triggers an automatic cancellation on Magento, keeping both systems aligned.

      6. FAQs

      Q: My Magento orders are not appearing in Omniful. What should I check? A: If orders are not syncing, verify the following:

      • Order Sync is enabled in Store-Level Settings.
      • The order’s Magento status is mapped under Sales Channel Mapping (e.g., Magento Pending → Omniful New).

      Q: Does Omniful update inventory to Magento automatically? A: Yes, if Inventory Sync is enabled, Omniful will send updated stock levels to Magento.

      Q4: Can Omniful cancel a Magento order? A: Yes, Omniful can send cancellation updates, but only if Magento allows cancellation for that order status.