Versions Compared

Key

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

...

The app allows you to synchronise your subscribers with Maileon, send order details to Maileon or create an RSS feed of your products.

Versions

Oxid eShop version

Plugin version

Oxid eShop 6.x.x

Maileon Oxid Module 1.3.x

Oxid eShop 7.x.x

Maileon Oxid Module 1.4.x

Download:

1.3.1: Download here

...

  • Unzip the package and copy the content (xqueue) into your [SHOPROOTDIR]/source/modules/ directory

  • Go to the root directory:

    Code Block
    cd [SHOPROOTDIR]
  • Run command: Add the repository to composer.json.

    Code Block
    composer config repositories.xqueue/maileon-oxid-module \
     --json '{"type":"path", "url":"./source/modules/xqueue/maileon-oxid-module", "options": {"symlink": true}}'
  • Add the maileon-oxid-module to composer

    Code Block
    composer require xqueue/maileon-oxid-module --no-update
    composer update --no-interaction
  • Install module
    Oxid eShop 6.x.x

    Code Block
    vendor/bin/oe-console oe:module:install-configuration source/modules/xqueue/maileon

    Run command:

    Code Block
    composer config repositories.xqueue/maileonoxidsync path-oxid-module/

    Oxid eShop 7.x.x

    Code Block
    vendor/bin/oe-console oe:module:install source/modules/xqueue/maileon
  • Run command (if it asks you questions, always answer (N) no):

    Code Block
    composer require xqueue/maileonoxidsync
  • Activate the plugin at admin

    Image Removed
  • -oxid-module/
    vendor/bin/oe-console oe:module:install-assets
  • Activate the plugin at admin

    Image Added

    or activate at command line.

    Code Block
    vendor/bin/oe-console oe:module:activate xq_maileonoxidmodule

After installing, you need to set up a cronjob and an optional cronjob if you want to use the abandoned cart functionality.

Plugin status cronjob (Run every day once)

Code Block
0 4 * * * curl "http(s)://[MYSHOPURL]/index.php?cl=maileonstatus" >> [some-path-to-a-log-file] 2>&1

Abandoned cart cronjob (optional) (Run every 5 minutes)

Code Block
*/5 * * * * curl "http(s)://[MYSHOPURL]/index.php?cl=maileonabandonedcart" >> [some-path-to-a-log-file] 2>&1

Uninstallation

The plugin can be installed from the command line. The installation steps:

  • Deactivate the plugin at admin Run command: or at the command line

    Code Block
    cd [SHOPROOTDIR]
    Run command:
    vendor/bin/oe-console oe:module:deactivate xq_maileonoxidmodule
  • Uninstall the module:
    Oxid eShop 6.x.x

    Code Block
    vendor/bin/oe-console oe:module:uninstall-configuration maileonoxidsync xq_maileonoxidmodule

    Oxid eShop 7.x.x

    Code Block
    vendor/bin/oe-console oe:module:uninstall xq_maileonoxidmodule
  • Remove the package from composer

    Code Block
    composer remove xqueue/maileon-oxid-module --no-update
    composer update --no-interaction

Settings

After installation you can see the settings interface at the plugin Settings tab.

...

With Oxid Enterprise edition, sub shop management is also possible. In this case you can choose on the top left of the admin page which sub shop settings you want to see. This allows you to set different configuration settings per sub shop.

...

Connection settings

Maileon API Key

...

Here you can enable the generation of RSS feed for your products. See below for more details.

Abandoned carts

Enabled

Here you can enable the abandoned cart functionality. (Cronjob needed)

After how many minutes a shopping cart should be reminded

here you can set after how many minutes the plugin will send abandoned cart transactions to Maileon. The minimum is 5 minutes and can be increased by 5 minute intervals.

DOI process

If you disable the DOI process in the plugin, you should also disable it in the shop, otherwise it may lead to different functionality and vice versa if you enable the DOI process in the plugin, you should also enable it in the shop.

...

Contact event name: oxid_eshop_orders_v12.0

The following data will be transferred:

Name

Type

Description

order.id

string

Order number

order.date

datetime (YYYY-MM-DD)

Order date

order.status

string

Order status

order.items

json

Ordered items

order.product_ids

string

Comma-separated list with the ordered product ids

order.product_names

string

Comma-separated list with the ordered product names

order.categories

string

Comma-separated list with the ordered product category names

order.subcategories

string

Comma-separated list with the ordered product subcategory names

order.brands

string

Comma-separated list with the ordered product manufacturer names

order.total

float

Order total

order.total_no_shipping

float

Order total without shipping cost

order.total_tax

float

Order tax

order.total_fees

float

Order fees total

order.fees

json

Order fee names

order.total_refunds

float

Order refunds total

order.refunds

json

Order refund names

order.currency

string

Order currency

payment.method.id

string

Payment method id

payment.method.name

string

Payment method name

customer.fullname

string

Customer full name

customer.firstname

string

Customer first name

customer.lastname

string

Customer last name

customer.id

string

Customer id

billing.address.salutation

string

Billing salutation

billing.address.firstname

string

Billing first name

billing.address.lastname

string

Billing last name

billing.address.street

string

Billing address

billing.address.zip

string

Billing zip

billing.address.city

string

Billing city

billing.address.country

string

Billing country

shipping.address.salutation

string

Shipping salutation

shipping.address.firstname

string

Shipping first name

shipping.address.lastname

string

Shipping last name

shipping.address.street

string

Shipping address

shipping.address.zip

string

Shipping zip

shipping.address.city

string

Shipping city

shipping.address.country

string

Shipping country

shipping.service.name

string

Shipping service name

shipping.service.tracking.code

string

Shipping service tracking code

...

  • external_id → Contact external id

  • token → The token you set in the plugin settings

Abandoned carts

Once enabled in the plugin settings and cronjob is configured, it will send abandoned cart transactions to Maileon after the configured time.

Contact event name: oxid_eshop_abandoned_carts_1.0

The following data will be transferred:

Name

Type

Description

cart.id

string

Order number

cart.date

datetime (YYYY-MM-DD)

Order date

cart.items

json

Cart items

cart.product_ids

string

Comma-separated list with the ordered product ids

cart.product_names

string

Comma-separated list with the ordered product names

cart.categories

string

Comma-separated list with the ordered product category names

cart.subcategories

string

Comma-separated list with the ordered product subcategory names

cart.brands

string

Comma-separated list with the ordered product manufacturer names

cart.total

float

Cart total

cart.total_no_shipping

float

Cart total without shipping cost

cart.total_fees

float

Cart other fees

cart.currency

string

Cart currency

customer.fullname

string

Customer full name

customer.firstname

string

Customer firstname

customer.lastname

string

Customer lastname

customer.id

string

Customer Id

Cart items

Name

Type

Description

id

string

Product id

sku

string

Product sku

url

string

Product url

single_price

float

Product single price

total

float

Product total

name

string

Product name

short_description

string

Product short description

tax_rate

float

Product tax rate

image_url

string

Product image url

quantity

integer

Ordered quantity