Versions Compared

Old Version 10

changes.mady.by.user Zsolt Mannheim

Saved on

compared with

New Version Current

changes.mady.by.user Zsolt Mannheim

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Current version: v1.9.0

...

The module synchronizes customer data, order data and shopping cart information between Magento and Maileon. Magento is the primary system, which means that the customer information in Magento is considered the main information and changes to that data are synchronized with Magento. Conversely, only certain information is synchronized: the DOI confirmation and unsubscription. For order details and cart abandonments, this information is sent to Maileon as transactions (events) and can be used either to analyze data using contact filters or to activate a trigger mailing. All functions can be set via a configuration panel in Magento.

Install the Module

Below version 1.0.8

The first step is to copy the Maileon directory into the /app/code directory of the Magento installation. If the app directory doesn't already contain a code subdirectory please create it. After this the module must be enabled using the following steps:

...

php bin/magento setup:upgrade

Configuration in Magento

The configuration can be found under “Stores” “Configuration” and, since version 1.8, can be set on Storeview level. This means, that for each Storeview, you can select an own API key, to use different Maileon accounts or you can select different DOI mail keys to send out DOIs in e.g. different languages.

...

  • Active: This enables the order confirmation module. This module synchronizes order events to Maileon. Each order creates two types of transactions: magento_orders_v2 and magento_orders_extended_v2. The transaction magento_orders_v2 contains one event for each order. The transaction magento_orders_extended_v2 contains one event per line item in the order.

  • Enable separate permission for buyers: If this setting is enabled, customers who do not yet exist in Maileon and have not unsubscribed will be created with the permission set below. They will be granted instant permission even if the permission are DOI or DOI+

  • Buyers permission: If the above option is enabled, you can set the permission here

After version 1.9 you do not need to disable Magento order confirmation emails in the settings. (Configuration/Sales/Sales Emails → Order)

Transaction type magento_orders_v2

Field name

Type

Description

order.id

string

Order id (incremental id)

order.date

timestamp

Order timestamp

order.status

string

Order status

order.total

float

Order grand total

order.total_tax

float

Order tax amount

order.total_no_shipping

float

Order total without shipping cost

order.currency

string

Order currency

shipping.service.name

string

Shipping method

payment.method.id

string

Payment id

payment.method.name

string

Payment name

order.items

JSON

Ordered items in json

shipping.address.firstname

string

Shipping address first name

shipping.address.lastname

string

Shipping address last name

shipping.address.phone

string

Shipping address phone

shipping.address.region

string

Shipping address region

shipping.address.city

string

Shipping address city

shipping.address.zip

string

Shipping address zip

shipping.address.street

string

Shipping address street

billing.address.firstname

string

Billing address first name

billing.address.lastname

string

Billing address last name

billing.address.phone

string

Billing address phone

billing.address.region

string

Billing address region

billing.address.city

string

Billing address city

billing.address.zip

string

Billing address zip

billing.address.street

string

Billing address street

Transaction type magento_orders_v2 order.items

Field name

Type

Description

product_id

string

Product id

title

string

Product title

single_price

float

Product single price

total

float

Item total price

sku

string

Product sku

quantity

integer

Item quantity

url

string

Product url

image_url

string

Product image url

categories

string

Product categories list separated with ,

short_description

string

Product short description

Transaction type magento_orders_extended_v2

Field name

Type

Description

order.id

string

Order id (incremental id)

order.date

timestamp

Order timestamp

order.status

string

Order status

order.total

float

Order grand total

order.total_tax

float

Order tax amount

order.total_no_shipping

float

Order total without shipping cost

order.currency

string

Order currency

shipping.service.name

string

Shipping method

payment.method.id

string

Payment id

payment.method.name

string

Payment name

product.id

string

Product id

product.title

string

Product title

product.single_price

float

Product single price

product.total

float

Item total price

product.sku

string

Product sku

product.quantity

integer

Item quantity

product.image_url

string

Product image url

product.url

string

Product url

product.categories

string

Product categories list separated with ,

product.short_description

string

Product short description

shipping.address.firstname

string

Shipping address first name

shipping.address.lastname

string

Shipping address last name

shipping.address.phone

string

Shipping address phone

shipping.address.region

string

Shipping address region

shipping.address.city

string

Shipping address city

shipping.address.zip

string

Shipping address zip

shipping.address.street

string

Shipping address street

billing.address.firstname

string

Billing address first name

billing.address.lastname

string

Billing address last name

billing.address.phone

string

Billing address phone

billing.address.region

string

Billing address region

billing.address.city

string

Billing address city

billing.address.zip

string

Billing address zip

billing.address.street

string

Billing address street

Customer Related Email Notification settings

...

Transaction type magento_account_credentials_changed_v1

Field name

Type

Description

fullname

string

Customer full name

changed_field

string

The changed field name (email, password)

store_id

string

Store id

store_name

string

Store name

store_email

string

Store email address

store_phone

string

Store phone

Transaction type magento_password_reminder_v1

Field name

Type

Description

fullname

string

Customer full name

account_url

string

Customer account url

psw_reset_url

string

Customer password reset url

store_id

string

Store id

store_name

string

Store name

Transaction type magento_password_reset_confirmation_v1

Field name

Type

Description

fullname

string

Customer full name

psw_reset_url

string

Customer password reset url

store_id

string

Store id

store_name

string

Store name

Transaction type magento_new_account_v1

Field name

Type

Description

fullname

string

Customer full name

type

string

Notification type:

  • customer/create_account/email_template : welcome email, when confirmation is disabled and password is set

  • customer/create_account/email_no_password_template : welcome email, when confirmation is disabled and password is not set

  • customer/create_account/email_confirmation_template : welcome email, when confirmation is enabled and password is set

  • customer/create_account/email_confirmed_template : email with confirmation link

account_url

string

Customer account url

account_confirm_url

string

Customer account confirmation url

psw_reset_url

string

Customer password reset url

store_id

string

Store id

store_name

string

Store name

Order Related Email Notification Settings

...

Transaction types magento_order_creditmemo_v1 , magento_order_creditmemo_update_v1

Field name

Type

Description

order.id

string

Order id (incremental id)

order.date

timestamp

Order timestamp

order.status

string

Order status

order.total

float

Order grand total

order.total_tax

float

Order tax amount

order.total_no_shipping

float

Order total without shipping cost

order.currency

string

Order currency

shipping.service.name

string

Shipping method

payment.method.id

string

Payment id

payment.method.name

string

Payment name

order.items

JSON

Ordered items in json

shipping.address.firstname

string

Shipping address first name

shipping.address.lastname

string

Shipping address last name

shipping.address.phone

string

Shipping address phone

shipping.address.region

string

Shipping address region

shipping.address.city

string

Shipping address city

shipping.address.zip

string

Shipping address zip

shipping.address.street

string

Shipping address street

billing.address.firstname

string

Billing address first name

billing.address.lastname

string

Billing address last name

billing.address.phone

string

Billing address phone

billing.address.region

string

Billing address region

billing.address.city

string

Billing address city

billing.address.zip

string

Billing address zip

billing.address.street

string

Billing address street

order.creditmemo.id

string

Order credit memo id

order.comment

string

Order comment

store.id

string

Store id

store.name

string

Store name

Transaction types magento_order_invoice_v1 , magento_order_invoice_update_v1

Field name

Type

Description

order.id

string

Order id (incremental id)

order.date

timestamp

Order timestamp

order.status

string

Order status

order.total

float

Order grand total

order.total_tax

float

Order tax amount

order.total_no_shipping

float

Order total without shipping cost

order.currency

string

Order currency

shipping.service.name

string

Shipping method

payment.method.id

string

Payment id

payment.method.name

string

Payment name

order.items

JSON

Ordered items in json

shipping.address.firstname

string

Shipping address first name

shipping.address.lastname

string

Shipping address last name

shipping.address.phone

string

Shipping address phone

shipping.address.region

string

Shipping address region

shipping.address.city

string

Shipping address city

shipping.address.zip

string

Shipping address zip

shipping.address.street

string

Shipping address street

billing.address.firstname

string

Billing address first name

billing.address.lastname

string

Billing address last name

billing.address.phone

string

Billing address phone

billing.address.region

string

Billing address region

billing.address.city

string

Billing address city

billing.address.zip

string

Billing address zip

billing.address.street

string

Billing address street

order.invoice.id

string

Order invoice id

order.comment

string

Order comment

store.id

string

Store id

store.name

string

Store name

Transaction type magento_order_status_changed_v1

Field name

Type

Description

order.id

string

Order id (incremental id)

order.date

timestamp

Order timestamp

order.status

string

Order status

order.total

float

Order grand total

order.total_tax

float

Order tax amount

order.total_no_shipping

float

Order total without shipping cost

order.currency

string

Order currency

shipping.service.name

string

Shipping method

payment.method.id

string

Payment id

payment.method.name

string

Payment name

order.items

JSON

Ordered items in json

shipping.address.firstname

string

Shipping address first name

shipping.address.lastname

string

Shipping address last name

shipping.address.phone

string

Shipping address phone

shipping.address.region

string

Shipping address region

shipping.address.city

string

Shipping address city

shipping.address.zip

string

Shipping address zip

shipping.address.street

string

Shipping address street

billing.address.firstname

string

Billing address first name

billing.address.lastname

string

Billing address last name

billing.address.phone

string

Billing address phone

billing.address.region

string

Billing address region

billing.address.city

string

Billing address city

billing.address.zip

string

Billing address zip

billing.address.street

string

Billing address street

order.comment

string

Order comment

store.id

string

Store id

store.name

string

Store name

Transaction types magento_order_shipment_v1 , magento_order_shipment_update_v1

Field name

Type

Description

order.id

string

Order id (incremental id)

order.date

timestamp

Order timestamp

order.status

string

Order status

order.total

float

Order grand total

order.total_tax

float

Order tax amount

order.total_no_shipping

float

Order total without shipping cost

order.currency

string

Order currency

shipping.service.name

string

Shipping method

payment.method.id

string

Payment id

payment.method.name

string

Payment name

order.items

JSON

Ordered items in json

shipping.address.firstname

string

Shipping address first name

shipping.address.lastname

string

Shipping address last name

shipping.address.phone

string

Shipping address phone

shipping.address.region

string

Shipping address region

shipping.address.city

string

Shipping address city

shipping.address.zip

string

Shipping address zip

shipping.address.street

string

Shipping address street

billing.address.firstname

string

Billing address first name

billing.address.lastname

string

Billing address last name

billing.address.phone

string

Billing address phone

billing.address.region

string

Billing address region

billing.address.city

string

Billing address city

billing.address.zip

string

Billing address zip

billing.address.street

string

Billing address street

order.shipment.id

string

Order shipment id

order.comment

string

Order comment

store.id

string

Store id

store.name

string

Store name

shipping.service.id

string

Carrier code

shipping.service.tracking.url

string

Tracking popup url

shipping.service.tracking.code

string

Tracking code

order.items json content

Field name

Type

Description

product_id

string

Product id

title

string

Product title

single_price

float

Product single price

total

float

Item total price

sku

string

Product sku

quantity

integer

Item quantity

url

string

Product url

image_url

string

Product image url

categories

string

Product categories list separated with ,

short_description

string

Product short description

Abandoned Cart Settings

  • Active: This enables the cart abandonment module. This module synchronizes abandoned cart events to Maileon.

  • Fallback permission: the permission a contact will get when added to Maileon. This should be set to none in most cases.

  • # Of Hours Before Sending Reminder: This is the number of hours after an open cart is considered abandoned.

  • Shadow Email: This email address also receives a copy of the cart abandonment email.

  • Email Override: If this field is set customers won’t receive cart abandonment emails. This address will receive them instead.

  • Test Webhook Active: If this field is enabled, the corresponding API endpoint can be used for testing purposes.

  • Test Webhook Token: If the above field is enabled, the test API endpoint can be protected with this token.


Transaction type magento_abandoned_carts_v2

Field name

Type

Description

cart.id

string

The cart id (quote id)

cart.date

timestamp

The cart last updated timestamp

cart.items

JSON

Cart items

cart.product_ids

string

Cart items product ids in a list

cart.categories

string

Cart items product category names in a list

cart.total

float

Cart grand total

cart.total_tax

float

Cart tax amount

cart.currency

string

Cart currency

customer.salutation

string

Customer salutation

customer.full_name

string

Customer full name

customer.firstname

string

Customer first name

customer.lastname

string

Customer last name

customer.id

string

Customer id

Configuring Custom Forms

In order to submit other standard or custom data to Maileon, the following scheme must be used:

...

Example: custom_MySpecialField

Enhancing Transactional Data

In some cases, it is required to add custom data transactions. E.g. if you use a plugin, which allows customizing products with names, custom images, etc., and the image shall be displayed in the order confirmation mail, you need to pass this URL to Maileon. Or this case, the plugin provides a simple way to add data to the transactions by overriding class Maileon\SyncPlugin\Helper\External\Data from an external plugin.

...

If everything was installed as expected, the next time e.g. an order is triggered, some additional data should be attached to it.

Webhook Settings in Maileon

Changed parameters in version 1.8:
Since Magento 2.4, an email can be added as newsletter subscriber for each storeview, thus, the email can exist multiple times in the Magento newsletter module. As of version 1.8 of the plugin, configuration is based on storeview level, thus, an email can be added to different Maileon newsletter accounts based on its origin. Thus, when Maileon reports back a DOI confirmation or unsubscription, it needs to identify the correct storeview for a given contact. This is done by adding a new parameter “storeview_id”.

...

https://<my domain>/rest/V1/maileon/webhook-doi_-confirm

eg.: https://maileonmagento.com/rest/V1/maileon/webhook-doi_-confirm

Add the following URL parameters:

...

The token must match the value given for the DOI Hook Token given in Magento settings.

...

Changelog

2023.06.14 - v 1.9.0

  • Add customer account related transactions

  • Add order related transactions

  • Improve abandoned carts functionality

...