Shopify Plugin v3

Introduction

Overview

The app provides a seamless solution for Shopify store owners and marketers to automate customer communication with ease. By integrating your Shopify store with Maileon, this plugin allows you to effortlessly manage customer engagement without the need for manual intervention.

Once installed, the app will:

Automatically sync newsletter subscribers from your Shopify store to your Maileon account as new contacts.
Track order events and register them as Contact events within Maileon.

These Contact events trigger automatic email flows, allowing you to stay connected with your customers based on their activity—whether it’s a new order or other key milestones. This means you only need to manage your customers through your Shopify store, and the plugin will handle the communication, ensuring timely and personalized engagement.

With this app, you can focus on growing your business while the customer outreach process runs on autopilot.

Target Audience

Our app is designed specifically for Shopify store owners and marketers who are looking to enhance their store's functionality and streamline their marketing efforts. Whether you’re managing a small boutique or a large-scale online store, this app provides the tools you need to optimize performance and drive sales.

Shop Owners: If you own a Shopify store, this app will help you manage various store operations more effectively, allowing you to save time and focus on growing your business.
Marketers: For marketing professionals, the app offers features to automate campaigns, analyze customer behavior, and improve conversion rates. It is designed to seamlessly integrate with your marketing strategies, making it easier to reach and engage your target audience.

Regardless of your technical expertise, the app is user-friendly and provides both basic and advanced functionalities to suit a variety of needs.

Key Features

Our app offers a powerful set of features to automate your customer communication and enhance your marketing efforts:

Real-time Contact Synchronization: Automatically sync newsletter subscribers from your Shopify store to your Maileon account as soon as they are subscribed.
Real-time Order Synchronization: Ensure that customer orders are instantly tracked and recorded as Contact events within Maileon, keeping your data up to date.
Automatic Welcome Email Flow: Greet new customers with personalized welcome emails, triggered automatically when a new contact is added.
Marketing Automation Flows Based on Orders: Leverage the power of Maileon's marketing automation to create tailored email flows based on customer order history.
Abandoned Cart Synchronization: Recover lost sales by synchronizing abandoned carts and setting up automated email reminders to re-engage customers.

These features are designed to streamline your communication, helping you build stronger relationships with your customers while saving time on manual tasks.

System Requirements

Our app is designed to be compatible with all Shopify plans, ensuring that any store owner, regardless of their subscription level, can take full advantage of its features.

Shopify Plans: The app works seamlessly with all Shopify plans, from Basic to Advanced and Shopify Plus.
Browser Compatibility: You can access and manage the app using any modern web browser, including:
- Google Chrome
- Mozilla Firefox
- Microsoft Edge
- Safari

No matter your setup, you can rely on the app to function smoothly across all devices and platforms.

Installation Guide

Step-by-Step Instructions

Follow these simple steps to install the app from the Shopify App Store:

Access the Shopify App Store:
- Navigate to the Shopify App Store and search for our app. Click on the app to open its details page.
Review Permissions:
- On the next screen, you will see a list of permissions required by the app. Review the permissions, and then click Install to proceed.
Payment Screen:
- You will be directed to the payment screen. Our app offers a 30-day free trial. Choose your preferred payment method from the available options (Credit or Debit Card, PayPal, or SEPA Direct Debit). Once selected, click Approve to continue.
Welcome Page:
- After the installation is complete, you will be taken to the Welcome page of the app, where you can begin configuring and using its features.

Screenshots

Shopify App Store

Review Permissions

Payment Screen

Welcome Page

Configuration

Configuration page

Settings Overview

Maileon API key

The API Key is essential for establishing a connection to your Maileon account. You can create and view your API Key in your Maileon account by navigating to Settings → API Keys.
When you save your settings in the app, the API key will be validated. If the key is invalid, an error message will be displayed. Common errors include:
- Validity period exceeded: The API key is no longer active.
- Key was deactivated in Maileon: The API key has been disabled.
- Characters were truncated at the beginning or end: Ensure the key is entered correctly without any missing characters.

Sync Subscribers

This option enables the synchronization of newsletter subscribers between Shopify and Maileon.
It creates a webhook in Shopify that is triggered by the Customers Email Marketing Consent Update event and two additional webhooks in Maileon:
- One for when someone unsubscribes from an email.
- One for when someone confirms their subscription via a confirmation email (triggered only if the DOI process is enabled).

Enable Double Opt-in (DOI) Process

Enabling the DOI process will send a confirmation email to the new contact's email address with a confirmation link. Clicking this link grants them Double Opt-In Plus access to Maileon, regardless of the settings above.
If this option is not enabled, the contact will receive permission immediately without any confirmation.

Contact permission:

None: No permission granted; the contact will receive only transaction emails (e.g., order confirmation).
Single Opt-in: Permission is granted by entering an email address in a form, but does not verify ownership of the email.
Confirmed Opt-in: Some
Double Opt-in: A confirmation email is sent; the contact can only be sent emails after confirming via the link.
Double Opt-in Plus: Includes consent for single user tracking. Note that without individual tracking, data for evaluating newsletter performance may be limited.

Double Opt-in (DOI) Mailing Key

Enter a DOI mailing ID to determine which DOI mailing should be triggered when a contact subscribes to the newsletter. This identifier can be set in Maileon or retrieved from the corresponding DOI mailing in the default settings.
If a default DOI mailing is set in Maileon, this field does not need to be filled. A common mistake is enabling the DOI process without specifying the DOI key or setting a default mailing in Maileon.

Subscribe Transaction Event

If enabled, a contact event will be sent to Maileon for each new subscriber. In cases where the DOI process is active, the event is triggered only after the subscriber confirms their email.

Order confirmations sync

Enable this option to send real-time order data to Maileon. After each new order, the order details will be transmitted to your Maileon account.

Abandoned cart notification

Activate this feature to send notifications for abandoned carts. When a cart is abandoned, the app sends a contact event to Maileon, allowing you to set up various automations.

Abandoned Carts Sync Duration

Specify the duration after which to send the event to Maileon for an abandoned cart. This setting helps you determine the timing for follow-up actions.

Using the App

Sync Newsletter Subscribers

If you want Maileon to send you the DOI letter, you have to enable the DOI process both in Shopify and in the App settings.

If you want Shopify to send the DOI letter, enable it in Shopify but not in the App settings.

If you do not want DOI process, then disable it in both Shopify and Maileon

Sync Order Confirmations

Order details are transferred to Maileon as a contact event for each new order. Two contact event types are used by the plugin:

shopify_orders_v3: in this contact event type, the order data is stored in a JSON type field, and the ordered products are stored in a JSON type field.
shopify_ordered_products_v1: in this contact event only one of the ordered products is included, so if three products were ordered when the order was placed, three contact events will be created.

If the subscriber is also a customer, the following contact fields will be filled in:

Custom field name	Type
`shopify_created`	boolean
`shopify_total_spent`	float
`shopify_total_spent_currency`	string
`shopify_total_orders`	integer
`shopify_phone`	string
`shopify_last_order_date`	date
`shopify_last_order_id`	string
`shopify_last_skus`	string

shopify_orders_v3 contact event type fields

Field name	Type
`order.id`	string
`order.date`	timestamp
`order.status`	string
`order.items`	JSON
`order.product_ids`	string
`order.product_names`	string
`order.categories`	string
`order.subcategories`	string
`order.brands`	string
`order.total`	float
`order.total_no_shipping`	float
`order.total_tax`	float
`order.currency`	string
`payment.method.id`	string
`payment.method.name`	string
`payment.status`	string
`discount.total`	float
`customer.firstname`	string
`customer.lastname`	string
`customer.id`	string
`billing.address.firstname`	string
`billing.address.lastname`	string
`billing.address.region`	string
`billing.address.city`	string
`billing.address.country`	string
`billing.address.zip`	string
`billing.address.street`	string
`shipping.address.firstname`	string
`shipping.address.lastname`	string
`shipping.address.region`	string
`shipping.address.city`	string
`shipping.address.country`	string
`shipping.address.zip`	string
`shipping.address.street`	string
`shipping.service.name`	string

`order.items` json content

Field name	Type
`id`	string
`name`	string
`sku`	string
`total`	float
`single_price`	float
`quantity`	string
`weight`	string
`gift_card`	boolean
`description`	string
`category`	string
`categories`	string
`brand`	string
`image_url`	string
`url`	string

shopify_ordered_products_v1 contact event type fields

Field name	Type
`order.id`	string
`order.date`	timestamp
`product.sku`	string
`product.id`	string
`single_price`	float
`product.is_gift`	boolean
`product.title`	string
`product.description`	string
`product.url`	string
`product.image_url`	string
`categories`	string
`product.quantity`	integer
`product.single_price`	string
`product.total`	float
`product.categories`	string
`product.brand`	string
`product.weight`	string
`order.total`	float
`order.currency`	string
`payment.method.id`	string
`payment.method.name`	string

Send Abandoned cart reminder

If the abandoned cart functionality is enabled in the settings and the duration is set, the abandoned carts will be transferred to Maileon as contact events.
The abandoned carts will be transferred if they are left in the cart by registered users and their email address is not empty.

shopify_abandoned_carts_v3 contact event fields

Field name	Type
`cart.id`	string
`cart.date`	timestamp
`cart.url`	string
`cart.items`	JSON
`cart.product_ids`	string
`cart.product_names`	string
`cart.categories`	string
`cart.subcategories`	string
`cart.brands`	string
`cart.total`	float
`cart.total_tax`	float
`cart.currency`	string
`discount.total`	float
`customer.firstname`	string
`customer.lastname`	string
`customer.id`	string

`cart.items` json content

Field name	Type
`id`	string
`name`	string
`sku`	string
`total`	float
`single_price`	float
`quantity`	string
`weight`	string
`gift_card`	boolean
`description`	string
`category`	string
`categories`	string
`brand`	string
`image_url`	string
`url`	string

Import all newsletters subscribers

This functionality imports the existing subscribers in Shopify into Maileon.
If a contact already exists in Maileon it will update their details. It will not recreate a contact that has unsubscribed in Maileon.
It will create the contact with the configured permission if it does not already exist in Maileon, if the contact already exists in Maileon it will not change its permission.
It will not start a DOI (Double Opt-in) process, if the permission is set to DOI or DOI+ then the contact will get the set permission without DOI process.

Import Orders history

You can import previous order details into Maileon as a contact event. A maximum of 1 month's data can be imported at a time. The import will take place in the background.

Please use this feature with care, if you have been using the plugin for a longer period of time and your orders are synchronized with Maileon, you may create duplicates if you re-import the data.

Webhook Monitor

This interface allows you to check the webhooks set up and used by the Maileon App.

If you have used an older version (V1 or V2) and switched to the new version (V3), be sure to check if the new webhooks have been created and delete the deprecated webhooks.

If everything is set up correctly you should see these webhooks: