Magento 2 integration

NOTE: The Magento 2 integration is currently in beta and is coming soon for all users. Contact us via for early access to Magento 2.

When you connect a Magento 2 store view to Ortto, you will unlock all of your customers purchase, cart, order and review data. It gives you the ability to craft highly personalized and relevant messages across the customer journey and unleashes powerful data visualization and segmentation.

Magento 2 prerequisites

IMPORTANT: Ortto currently only supports integrations with Magento version 2.

To integrate Magento 2 with Ortto you must have an active Magento store with a store view. You are also required to set up a Magento 2 access token before you can connect Magento 2 to Ortto.

The Magento 2 integration must be initiated from Magento 2 by:

Create your Magento 2 access token

In your Magento 2 account:

  1. Go to System > Integrations.
  2. Click Add new integration.
  3. In the integration setup:
    1. Populate the name and email address fields, and populate your Magento 2 account password.
    2. At API, under Resource Access, select Custom from the drop-down menu. Then scroll down and select the Ortto checkbox.
  4. Click Save.
  5. You will then return to the Integrations page where you will see your Ortto integration.
  6. Next to your Ortto integration, click Activate, then Allow.
  7. Magento 2 will show you your API credentials.
Example Ortto checkbox selection in Magento 2 API Resource Access

IMPORTANT: Copy and store the Access token key displayed, as you will need it in order to Connect to Ortto from Magento 2. (You will not need the Consumer keyConsumer secret, or Access token secret for this integration.)

Connect to Ortto from Magento 2

In your Magento 2 account:

  1. Got to Stores > Configuration.
  2. At Scope, select the store view you wish to integrate with Ortto, then ConfirmOrtto will appear in the left-hand configuration panel.
  3. Click Ortto to expand the section then click General.
  4. Click Authentication to expand the section, then change Enabled to Yes.
  5. Click on Get API credentials, and you will see a pop-up screen asking you to select the Ortto account you wish to connect to Magento 2 (you may need to login to Ortto first).
  6. On the Connect to Magento 2 page, populate the access token field with the access token you created earlier (at step 7 in Create your Magento 2 access token).
  7. At Data retention, select to either:
    • store only the last 90 days of activity data, or
    • select the time frame for the data stored, and the activities which will be stored.
  8. If needed, select Advanced options to:
    • Choose which CDP fields can be modified from the Magento 2 data source, or
    • Choose not to modify CDP data fields that already have a value.
  9. On the Merge page, select the appropriate strategy by which people’s (customers') data is merged from Magento 2 into your Ortto’s CDP.
  10. On the Enable page, Ortto will provide you with an API key for the Magento 2 data source. Copy and store the API key displayed, as you will need it at for the last steps of this procedure.
  11. Click Done, and close the pop-up window.
  12. Magento 2 is now connected to your Ortto instance.
  13. To finish the integration, return to your Magento 2 account.
  14. In the Authentication settings for Ortto on the Stores  Configuration page (where you navigated to at steps 3 and 4 above), populate API Key with the Magento 2 data source key you copied from Ortto (at step 10).
  15. Click Save Config.

You now have a complete Ortto and Magento 2 integration.

Example Magento 2 store configuration with Ortto API key field populated

NOTE: It is recommended to set the data retention limits while setting up the data source. Updating the data retention limits in the future will require a resync of the data source, which may affect multiple audiences and campaigns within your customer data platform (CDP). Learn more about configuring data retention under Configuring data retention.


The merge options:

  • Import and merge new records only,
  • Import and overwrite any records that exist, and
  • Import new records only

are equivalent to the respective emerge strategies for people:

  • Append only,
  • Overwrite existing, and
  • Ignore

Connect from Ortto

While you can access Magento 2 from Data sources  New data source, connecting Ortto to Magento 2 is only performed from your Magento 2 account by:

How is the data merged into Ortto?

Data is merged from Magento 2 to Ortto on the initial connection and subsequently when an event occurs within Magento 2.

When a person is added to your CDP from the Magento 2 data synchronization, if they do not already exist as a contact in your CDP, they are added as a new contact. New contacts are automatically subscribed to receive email communications (but are are unsubscribed to SMS by default.)

If a contact synced from Magento 2 already exists in Ortto, the contact will not have their email or SMS permissions changed; they will remain as they were set in Magento 2.

Initial data sync

People details for the Magento 2 customers, including the customer fields in Magento 2, and cart, order, review and product view data are merged into the Ortto CDP. The merge follows the data merge strategy selected during the initial connection with Magento 2.

The initial sync also creates activities in Ortto for store data for order, price drop, review, product view and waiting on stock events.

Ongoing data sync

Magento 2 data is merged to Ortto shortly after (generally a few minutes) activity events, including cart and checkout activities, occur.

Resynchronizing data

Magento 2 data is synced from the point of the last sync when the data source is reconnected. For example, where the data source has been disconnected for 24 hours, upon reconnection, any updates or events that occurred during that 24 hours will be synced to Ortto. If data retention settings are adjusted, such as to increase the data retention period, all data will be re-synced.

A resync of the Magento 2 data may affect the audiences and campaigns within the CDP by resetting the attributes for the person, and activities, causing a person to potentially re-enter an audience or campaign within the CDP.

What does the data source add to my account?

The Magento 2 data source adds:

  • Magento 2 customer records and their associated fields to your CDP (known as people or contacts in Ortto).
  • Magento 2 activities from the last 90 days, including cart activity, orders, reviews and product views. In some cases, however, it may be necessary to store an activity and its attribute data for longer. Therefore, Ortto provides a mechanism for customers on selected plans to opt-in to selectively store their activity data for longer. Learn more about data retention under Configuring data retention.
  • The ability to create new Magento 2 coupons.
  • A tracking code for your Magento 2 store site header to enable session tracking and capture widgets. The Magento 2 tracking code can be found in the Magento 2 data source view.
  • The ability to use Liquid syntax in campaign messages to personalize your messages using merge tags for Magento 2 person fields and activity attributes. Learn more about using Liquid syntax under Personalizing campaign content with Liquid.

Example Magento 2 merge tags used in an email message

NOTE: Deleting a Magento 2 data source connection will not remove the current entries in the CDP for people or activities that were merged from that Magento 2 connection.

View Magento fields in your CDP

Customize your CDP field visibility and add Magento 2 fields by clicking the cog icon, then select or clear the fields you want to show or hide. Magento 2 fields are indicated with the small Magento 2 icon.

Example Magento 2 fields selected for view in the CDP

Access the Magento 2 data source view

When a data source is connected, you are provided with a data source view. On the Data sources page, click the data source you wish to view.

A data source’s view is the administration page where you can:

  • view and manage the data source in the left-hand details panel, and
  • under the relevant tabs on the right-hand side, view:
    • an Overview of the data source,
    • an Activity feed, and
    • an Audience table, which displays the people (customers) imported from Magento 2.

In the details panel, you can give the data source a new name (this will not affect your Magento 2 account settings). To do so, hover over the name and click the pencil icon, then type the new name and click on a blank area of the page to save the name. You can also disconnect the data source, and modify the merge option and data retention period, and access the API key and tracking code.

Learn more about the data source view under Managing data sources.

Using Magento 2

Learn about how you can use Magento 2 with Ortto’s filters, reports, dashboards, campaigns, and coupons to get the most out of your integration under Using Magento 2 in Ortto.

Troubleshooting Magento 2

For help with common questions or issues you may encounter when using Magento as a data source, view Troubleshooting Magento 2.