• Ready for review
  • UNAS Integration

    General

    This extension is responsible for handling subscriber and order information between Maileon and the Unas Webshop engine (www.unas.hu)

    This plugin requires Unas VIP or higher subscription as automated processes are necessary for the plugin functionality.

    When syncing orders, we also sync the available loyalty points of the customer. Note: The value of that field is only updated when a new order is placed.

     

    Installing

    You can find this extension in Your Maileon account settings once enabled by the Maileon service team.

    Screenshot 2024-07-16 at 10.19.51.png
    Maileon default home view

     

    Screenshot 2024-07-16 at 10.12.00.png
    Maileon account settings

     

     

    Configuration

    The plugin setup process is handled in your Maileon account.

     

    Authentication

    UNAS API Key

    The api key generated at Unas API Key configuration page

    When creating Your api key make sure You add the following permissions:

    • getOrder

    • getProduct

    • getCustomer

    • getNewsletter

    • setNewsletter

    • getAutomatism

    • setAutomatism

    UNAS Shop ID

    Your Unas shop id. Usually it's the prefix of the orders (eg in case of 39689-100008, it’s 39689).

    Maileon API Key

    The API Key can be created and viewed in the Maileon account under "Settings" → "API Keys" and ensures the connection to your account. Make sure this API key is only used by this integration.

    Initial sync settings

    Initial sync permission

    The permission new contacts receive when saved in Maileon.

    If you want to send Double Optin emails to the contacts choose „no permission available“.

    Initial DOI process

    You can determine if the initial sync of contacts should also trigger the double opt-in process.

    Double opt-in process can only be enable with permission setting “no permission”.

    Initial sync DOI Key

    Here you can define a DOI mailing key that determines which DOI mailing should be triggered for the imported contacts. The key can be configured or read out in Maileon for the corresponding DOI mailing in the basic settings.

    You can leave this field empty - in that case the default DOI mailing will be used.

    Regular sync settings

    Regular sync permission

    The permission new contacts receive when saved in Maileon.

    If you want to send Double Optin emails to the contacts choose „no permission available“.

    Regular sync DOI process

    Here you can specify whether the DOI mails are sent from Maileon or not. Recommended setting: yes.

    IMPORTANT: This does NOT suppress the DOI mails from Unas, You need to disable it manually.

    Regular sync DOI Key

    If you have multiple Double Optin mailings in your account you can specifiy with this setting which shall be used. Leave empty for default DOI.

    Notification email

    This is the email address you would like to receive notifications sent by the integration.

    Webhooks

    The creation and setup of Unas webhooks is fully handled by the integration. Do not change any settings of the respected webhooks in Unas, as it could lead to malfunctions. Use the options below to enable/disable webhooks.

    Sync newsletter subscriptions

    If this checkbox is ticked, a webhook will be created after saving which will send the newsletter subscribers and unsubscribers to Maileon in real time.

    Sync checkouts

    If this checkbox is ticked, a webhook will be created after saving which will send the order data to Maileon as a contact event in real time.

    Transaction:
    unas_orders_1.0

    Sync abandoned carts

    Transactions for shopping cart abandoners are sent to Maileon if this option is active. This does not prevent Unas from sending abandoned cart emails, You need to deactivate them manually.

    Transaction:
    unas_abandoned_carts_1.0

    Abandoned cart intervall

    You can determine the delay by hour for abandoned cart event trigger. By default it's 1 hour.

     

    Transaction data

    Keys and data types of transaction object

    unas_orders_1.0

    Key

    Data

    Key

    Data

    order.id

    string

    order.date

    stringified datetime (“Y-m-d H:i:s”)

    order.status

    string

    order.items

    JSON. This field contains all of the order products data. More information below in another table

    order.product_ids

    This is a comma-separated list of the ordered product ids. Does not contain duplicates.

    order.product_names

    This is a comma-separated list of the ordered product names. Does not contain duplicates.

    order.categories

    This is a comma-separated list of the ordered product categories. Does not contain duplicates.

    order.total

    float

    order.total_no_shipping

    float

    order.currency

    string

    payment.method.name

    string

    customer.fullname

    string

    billing.address.firstname

    string

    billing.address.lastname

    string

    billing.address.zip

    string

    billing.address.street

    string

    billing.address.city

    string

    shipping.address.country

    string

    billing.address.region

    string

    shipping.address.firstname

    string

    shipping.address.lastname

    string

    shipping.address.street

    string

    shipping.address.zip

    string

    shipping.address.city

    string

    shipping.address.country

    string

    shipping.address.county

    string

    shipping.service.name

    string

     

    order.items

    Key

    Data

    Key

    Data

    id

    ID from products at webhook

    sku

    sku from products at webhook

    title

    name from products at webhook

    category

    category.name from products at webhook

    quantity

    quantity from products at webhook

    unit

    unit from products at webhook

    total_price

    grossPrice from products at webhook

    net_price

    netPrice from products at webhook

    vat_rate

    VATRate from products at webhook

    description

    Description.Short from getProduct API

    product_url

    Url from getProduct API

    image_url

    Images.Image.Import.Url from getProduct API

    unas_ordered_products_1.0

    Key

    Data

    Key

    Data

    order.id

    orderID from webhook

    order.date

    time from webhook Format: “Y-m-d H:i:s”

    product.sku

    sku from products at webhook

    product.id

    ID from products at webhook

    product.title

    name from products at webhook

    product.short_description

    Description.Short from getProduct API

    product.url

    Url from getProduct API

    product.image_url

    Images.Image.Import.Url from getProduct API

    product.status

    Statuses.Status from getProduct API

    product.quantity

    quantity from products at webhook

    product.single_price

    products.grossPice / products.quantity from webhook

    product.categories

    category.name from products at webhook

    product.total

    products.grossPice from webhook

    order.total

    grandTotal from webhook

    order.currency

    currency from webhook

    unas_abandoned_carts_1.0

    Maileon

    Unas

    Maileon

    Unas

    cart.id

     abandonedCartID from abandoned carts webhook

    cart.date

     time from abandoned carts webhook.  Y-m-d H:i:s

    cart.items

     This is JSON field. This field contains all of the order products data. More information below in another table

    cart.product_ids

     This is a comma-separated list of the ordered product ids. Do not contain duplicates.

    cart.product_names

     This is a comma-separated list of the ordered product names. Do not contain duplicates.

    cart.categories

    This is a comma-separated list of the ordered product categories. Do not contain duplicates.

    cart.total

     

    cart.total_tax

     

    cart.currency

     currency from abandoned cart webhook

    customer.fullname

     customer.name from abandoned cart webhook

     

    Cart items

    Maileon

    Unas

    Maileon

    Unas

    id

    ID from abandoned cart at webhook

    sku

    sku from abandoned cart at webhook

    title

    name from abandoned cart at webhook

    category

    category.name from abandoned cart at webhook

    quantity

    quantity from abandoned cart at webhook

    unit

    unit from abandoned cart at webhook

    total_price

    grossPrice from abandoned cart at webhook

    net_price

    netPrice from abandoned cart at webhook

    vat_rate

    VATRate from abandoned cart at webhook

    description

    Description.Short from getProduct API

    product_url

    Url from getProduct API

    image_url

    Images.Image.Import.Url from getProduct API

     

     

     

     

     

     

    Custom fields

    Field

    Data type

    Description

    Field

    Data type

    Description

    UnasShopId

    string

    The Id of the Unas webshop

    UnasImports

    boolean

    A boolean value which shows if a contact was created during initial sync

    UnasPoints

    float

    The available loyalty points of contact

    phone

    string

    Telephone number of contact

    mobile

    string

    Mobile phone number of contact

    Available permissions

    • None: No permission. The contact will not receive newsletters.

    • Single Opt-in: Permission was simply granted, e.g. by entering an email address in a form. This method technically allows the contact to receive newsletters, but does not ensure that the email address belongs to the person who entered it.

    • Double Opt-in: With this permission, a confirmation email with a confirmation link is sent to the email address. Only when the link in the mail has been clicked and thus the interest in the entry has been confirmed, the contact can be sent.

    • Double Opt-in Plus: Double opt-in including consent for single user tracking. Please note: Without individual user tracking, no openings, clicks, etc. may be traced back to individual users and significant data for evaluating newsletter performance is missing. newsletter performance is missing.

     

     

    Syncing all existing subscriber from Unas to Maileon

    All subscribers can be transferred to Maileon. This is done in a background process. You will need to provide an email address to which a notification will be sent at the end of the import. The contacts will be created in Maileon with the permission selected in the Initial sync permission field. DOI process is handled based on Initial DOI process field. Enabling it is not recommended for bulk imports. Once the import is complete, an email notification will be sent.