Installing and Configuring Magento 2 - Gateway OMS

Installing and Configuring Magento 2 - Gateway OMS

The below video gives an overview of the process for installing and configuring the Personalise iT module for Magento 2 and is followed by some more detailed information.

Personalise iT extension for magento 2 can be found here



Please note that these instructions assume that you have SSH access to your host.

Getting the Code

via SSH & Composer

The easiest way to download the module is by using Composer. Simply run the below command in the root folder of your Magento installation.

         $ composer require gateway3d/magento2-personaliseit2
         Using version ^2.0 
         ./composer.json has been updated
         Loading composer repositories with package information
         Updating dependencies 
         including require-dev
         - Installing gateway3d/magento2-personaliseit2 
         Loading from cache
         Writing lock file
         Generating autoload files

Additional guidance on how to install Composer and how to install Magento using Composer can be found at

Using Magento's Command Line Tool

Additional information on using Magento2 command line tool can be found at

Enabling the Module

Magento's command line tool can now be used to enable the Personalise-iT module.

From the root Magento directory, run the following.

         $ bin/magento module:enable Gateway3D_PersonaliseIt
         The following modules have been enabled:
         - Gateway3D_PersonaliseIt

Updating the Database

Subsequently, the Magento command line tool must now also be used to update the database schema.

$ bin/magento setup:upgrade Cache cleared successfully File system cleanup:

Updating your Theme files

Personalise iT will integrate itself into "Simple" product pages on the Magento 2 default theme on install. This is done by code which replaces the catalog image on the product page when an Iframe Source URL has been added to the product in the Magento Admin.

If you are using a custom theme or need to update the size / placement of the iframe you can use the code in the default theme as a base to add / move as required.  


Connecting Magento to OMS

In contrast to the original Personalise-iT module which used a cronjob to push orders into OMS, Personalise-iT 2 now relies on Magento's standard SOAP API to allow OMS to pull orders from the eCommerce site.

To allow this, it is necessary to create a new Magento intregration service which can be accomplished in Magento's admin backend,  System  >  Integration  >  Add New Integration .

It is recommended that  oms  is entered as the integration name. At a minimum, the new integration should be given access to the  Orders  and  Shipments  APIs.

Once the relevant APIs have been enabled, the integration can be activated after which Magento will display an  Access Token  and an  Access Secret Token .

Please provide both tokens as well as the integration name to your Custom Gateway Onboarder who will then configure OMS to pull in orders from your site.

The Personalise iT extension has  sanity check and doesn't pull in orders in which are older than 2 days.



Configuring the Magento Extension

Once installed the extension adds a tab to the product management screen allowing you to enter required values.

The tab in product management is titled "Gateway3D Personalise-it" - See Screenshot below


1) Default App URL - You can get your Iframe sources from the Custom Gateway CPP, Ask your Onboarder for details and sample links you can try


2) Mobile App URL - is not required and should be used if you need to load a different personalisation app on mobile devices

3) Print On Demand Reference - can be used when ordering a POD product from the CG CATALOG system, the POD ref can be found in CATALOG, no other setting is needed on products to pull these and no personalisation is available on products ordered in this way 

4) Always create new cart items should be left as "Yes" which is the default unless agreed with your Implementation Manager

5) Textual Product ID and Variant ID - are used together and do not work with any other settings. These are using specifically when targeting an order for a specific virtual product and its variant. It works in a similar way to POD orders except that a print job will be generated when the order is accepted in the system and it targets a specific variant.


If your installation and setup on the theme was done correctly then adding an iframe source into "Default App URL" will make the personalisation app load on the product page you updated

If you need help with this you can raise support tickets by emailing

    • Related Articles

    • Installing our Personalise iT Magento Extension

      1) Here is the plugin for your Magento installation:   Here are 2 documents that will help during the installation and configuration   ...
    • Kornit X Feeds | Magento

      Platform has the capability to create a CSV feed from product data for both magneto 1 and 2. This functionality is accessed by first limiting your view of products to less than 10000, by using any of the search options to make this limit, or by using ...
    • Configuring the Magento 2 Auto Import Extension

      The below video has an explanation of the basic settings on the Custom Gateway Auto Import Extension for Magento 2       
    • Configuring the Magento 1 Auto Import Extension

      The Magento Auto Import Extension enables products to be auto added to your Gateway Site / Magento Website It has been designed to work with  Gateway Custom Product Platform (CPP) Once installed go to System > Configuration > Gateway 3D Settings > ...
    • Consideration when Products are added to eCommerce Websites

      When setting up your customisable products it is also worth understand how they can work on an eCommerce website. Detailed below are the considerations when using a Magento website.  1. Colour Options - usually these are set in the customiser so can ...