CCV Shop Plugin

Install App

You can find the plugin at the CCV Shop App Store.

install_1.png

 

After pressing the install button you can see what permissions the plugin will use.

Once this is accepted you will be taken to the plugin configuration page.

The following data must be entered here:

General settings

Maileon API key

The API Key can be created and viewed in the Maileon account under "Settings" → "API Keys" and ensures the connection to the account. When you save your settings, the API key will be checked and if it is invalid an error message will be displayed. Common errors:

  • Validity period exceeded

  • Key was deactivated in Maileon

  • Characters were truncated at the beginning or end

Initial permission:

  • None: No permission. The contact will not receive newsletters, only transaction emails (e.g. reservation confirmation mail).

  • 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.

DOI process

If we enable the DOI process, then when the contact is created a confirmation email will be sent to the email address with a confirmation link, which if the contact clicks on will give them Double Opt-In Plus access to Maileon, regardless of what we have set in the above setting. If this option is not turned on, the contact will receive the permission set above instantly, without any confirmation.

DOI Mailing ID

Here you can enter a DOI mailing ID, which determines which DOI mailing should be triggered as soon as a contact subscribes to the newsletter. The identifier can be set in Maileon or retrieved from the corresponding DOI mailing in the default settings. If the Maileon account has a default DOI mailing set in the settings, this field does not need to be filled in. Common mistake:

  • The DOI process above will be enabled but the DOI key is not specified here and no default DOI mailing is set in the Maileon account.

CCV Shop webhook settings

Send subscribers to Maileon

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

Send unsubscribers to Maileon

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

Send orders to Maileon

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:
ccvshop_orders_v1

Abandoned carts settings

Abandoned cart enabled

Transactions for shopping cart abandoners are sent to Maileon if this option is active.

Transaction:
ccvshop_abanoned_carts_v1

After how many minutes a shopping cart should be reminded

This setting specifies the time period in minutes after the shopping cart has been created after which it should be reminded if it has not been ordered. The minimum adjustable time is 5 minutes.

 

Clicking the Install App button saves the settings and closes the installation window.

Update settings

If you want to change the settings later, you can do so by clicking on the Edit button.

You can check the configured webhooks using the following table:

Sync unsubscribers from Maileon

If you want your Maileon unsubscribers to be transferred back to the CCV Shop, you need to set up a webhook in Maileon. You can copy the webhook url from the settings page.

Order confirmation

If the option to send order confirmations to Maileon is enabled, the app will send this information:

Field name

Type

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

order.total_refunds

float

payment.method.id

string

payment.method.name

string

discount.code

string

discount.total

float

discount.rules_string

string

customer.salutation

string

customer.fullname

string

customer.firstname

string

customer.lastname

string

billing.address.salutation

string

billing.address.firstname

string

billing.address.lastname

string

billing.address.phone

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.salutation

string

shipping.address.phone

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

shipping.service.tracking.code

string

shipping.service.tracking.url

string

order.items json content

Field name

Type

Field name

Type

id

string

title

string

sku

string

total

float

single_price

float

quantity

string

weight

string

attributes

string

ean

string

description

string

discount_price

float

category

string

subcategory

string

brand

string

image_url

string

url

string

Sync all subscriber 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 here. DOI will not start DOI process, because it is not recommended for bulk imports.

After clicking the button, the window will close and the import will start in the background. Once the import is complete, an email notification will be sent.

Abandoned cart

If the abandoned cart alert 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 basket by registered users and their email address is not empty.

Field name

Type

Field name

Type

cart.id

string

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_no_shipping

float

cart.total_tax

float

cart.currency

string

cart.total_refunds

float

discount.code

string

discount.total

float

discount.rules_string

string

customer.salutation

string

customer.fullname

string

customer.firstname

string

customer.lastname

string

cart.items json content

Field name

Type

Field name

Type

id

string

title

string

sku

string

total

float

single_price

float

quantity

string

weight

string

attributes

string

ean

string

description

string

discount_price

float

category

string

subcategory

string

brand

string

image_url

string

url

string