Maileon for Shopify provides 2-way synchronization between Maileon and between your Shopify shop.

Installation

To install the addon search for it on the Shopify Marketplace, or click here.

After the authorization process you should be redirected to your Integration’s Settings screen:

Open

You can always visit this page by going to your shop/apps/maileon-integration screen.

The final step is to enter the API key of the Maileon account you wish to integrate. For more information about Maileon API keys please contact your Maileon distributor. Make sure that you add this or the plugin won’t work.

Click the TestAPI Key to test the key you’ve supplied. Now you can proceed to configuring your integration.

Note: At the section ‘Webhooks’ you should see your unique webhooks settings which you can copy into your maileon settings. (See at Configuration/Webhooks)

As for the Shopify Settings: here you can check which entity should be tracked in Maileon too. By default all of them are set. You can either unset or set them later.

Make sure that you save the configuration every time after you are satisfied with your settings!

Configuration

Maileon Settings

Open

Make sure you SAVE your configuration after you’re satisfied with your settings.

Contact Settings

Maileon API Key

This is the API key you’ve supplied during installation. You can always change this key by clicking the Change API Key button and submitting a new value.

Double Opt-in Process

With this option enabled a double opt-in process will be started for each contact that is created in your Shopify account.

Double Opt-in Process Plus

With this option enabled the double opt-in process will result in a double opt-in plus permission instead of double opt-in. Only available if the DOI process is enabled.

Double Opt-in Mailing Key

If you want to customize the DOI mailing that will be sent from Maileon you can input the key of the mailing here. Only available if the DOI process is enabled. Do NOT leave this field empty if your Maileon account has no default DOI mailing set!

Contact Permission

If you want to just create Maileon contacts with a set permission you can select it here. Only available if the DOI process is disabled.

Webhooks

Double Opt-in Confirmation

The webhook URL to use in Maileon for Double Opt-in confirmation events.

Unsubscription

The webhook URL to use in Maileon for unsubscription events.

Maileon Webhooks Configuration

If you want Maileon to publish relevant changes to your Shopify contacts you should configure Maileon webhooks. You can find the Webhook URLs in the Maileon Settings section.

In order for these to work you need to set 'email address' and 'external ID' to 'are transferred to unsubscriber database' in settings/lists&contacts/unbsubscriber management (in your maileon account).

Unsubscription Webhook

Unsubscription events should have the following JSON information enabled:

• external id (required)

• email (required)

Example configuration in Maileon:

DOI Webhook

DOI confirmation events should have the following JSON information enabled:

• external id (required)

• email (required)

Example configuration in Maileon:

For more information about Maileon webhooks please contact your Maileon distributor.

Shopify Settings

Here you can check which entity (with what action) should be tracked in Maileon too. By default all of them are set. You can either unset or set them later. Make sure you save your configuration after you’re satisfied with your settings.

Import Settings

Beware! You can import the same orders over and over, so there will be duplicate entries. If you do import more than once, and you don’t need the duplicates then you need to delete the imported events MANUALLY in Maileon.

Before you press the import button, make sure the selected date is the one you want. All the orders before the date will be imported.

In case of orders, if the customer doesn’t agree to receive marketing emails, we still create the contact in Maileon with permission ‘NONE’. In any other case the contact will be created with the selected options in the Maileon Settings section.

Synchronized Data

The plugin currently matches the following Shopify properties to their equivalent contact fields in Maileon:

If the order webhook is set then following transactions are created:

shopify_orders_v2: the given order with ALL the line items

shopify_orders_extended_v2: the given order PER line item