Skip to end of metadata
Go to start of metadata
You are viewing an old version of this content. View the current version.
Compare with Current
View Version History
Version 1
Current »
Seamlessly integrate your BigCommerce storefront with Maileon to streamline your email marketing. Sync subscribers, orders and abandoned carts.
Getting your 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.
Plugin settings
API Key
Your Maileon API key.
Permission level
The permission assigned to subscribers coming from your store.
Send Double Opt-In mail to new leads*
Only available if permission “none” selected. Check this if you want to send Double Opt-in emails to the leads.
Double Opt-In mailing key*
Only available if permission “none” selected. You can specify which mailing you’d like to send out. if left empty, the one specified as default in Maileon will be used.
You can set which BigCommerce field data should be sent to which Maileon field.
Make sure to select correct field type relations (BigCommerce string fields can be sent to Maileon string, numbers to numbers, booleans to booleans etc).
Webhooks
Subscriber
Triggers when a subscriber is created or edited
Customer
Triggers when a customer or customer address is created or edited
Abandoned cart
Triggers when a cart is abandoned. A cart is considered abandoned when no changes have been made for at least one hour after the last modified property
Orders
Triggers when an order is placed, or the status of the order is modified
Shipment
Triggers when a shipment is created or edited
bigcommerce_order_create_1.0
Key | Datatype |
---|
order.id
| string |
order.date
| string |
order.status
| string |
order.items
| json |
order.product_ids
| string |
order.product_titles
| string |
order.product_categories
| string |
order.total_ex_tax
| float |
order.total_inc_tax
| float |
order.currency
| string |
payment.method.name
| string |
billing.address.phone
| string |
billing.address.email
| string |
billing.address.firstname
| string |
billing.address.lastname
| string |
billing.address.zip
| string |
billing.address.street
| string |
billing.address.city
| string |
billing.address.country
| string |
shipping.address.phone
| string |
shipping.address.email
| string |
shipping.address.firstname
| string |
shipping.address.lastname
| string |
shipping.address.company
| string |
shipping.address.street
| string |
shipping.address.zip
| string |
shipping.address.city
| string |
shipping.address.country
| string |
shipping.service.name
| string |
shipping.service.cost_inc_tax
| float |
bigcommerce_order_status_updated_1.0
Key | Datatype |
---|
order.id
| string |
order.date
| string |
order.status
| string |
order.items
| json |
order.product_ids
| string |
order.product_titles
| string |
order.product_categories
| string |
order.total_ex_tax
| float |
order.total_inc_tax
| float |
order.currency
| string |
payment.method.name
| string |
billing.address.phone
| string |
billing.address.email
| string |
billing.address.firstname
| string |
billing.address.lastname
| string |
billing.address.zip
| string |
billing.address.street
| string |
billing.address.city
| string |
billing.address.country
| string |
shipping.address.phone
| string |
shipping.address.email
| string |
shipping.address.firstname
| string |
shipping.address.lastname
| string |
shipping.address.company
| string |
shipping.address.street
| string |
shipping.address.zip
| string |
shipping.address.city
| string |
shipping.address.country
| string |
shipping.service.name
| string |
shipping.service.cost_inc_tax
| float |
bigcommerce_order_items_1.0
Key | Datatype |
---|
product_id
| string |
variant_id
| string |
sku
| string |
product_image
| string |
product_url
| string |
product_categories
| string |
description
| string |
title
| string |
type
| string |
price_inc_tax
| float |
quantity
| integer |
total_inc_tax
| float |
bigcommerce_abandoned_cart_1.0
Key | Datatype |
---|
cart_id
| string |
items
| json |
product_ids
| string |
product_titles
| string |
product_categories
| string |
tax_included
| boolean |
base_amount
| float |
discount_amount
| float |
cart_amount
| float |
bigcommerce_abandoned_cart_items_1.0
Key | Datatype |
---|
cart_id
| string |
product_type
| string |
variant_id
| integer |
product_id
| integer |
sku
| string |
title
| string |
description
| string |
product_url
| string |
image_url
| string |
quantity
| integer |
taxable
| boolean |
discount_amount
| float |
coupon_amount
| float |
original_price
| float |
list_price
| float |
sale_price
| float |
extended_list_price
| float |
extended_sale_price
| float |
is_require_shipping
| boolean |
is_mutable
| boolean |
added_by_promotion
| boolean |
bigcommerce_shipment_create_1.0
Key | Datatype |
---|
order_id
| integer |
date_created
| date |
tracking_number
| string |
merchant_shipping_cost
| float |
shipping_method
| string |
comments
| string |
shipping_provider
| string |
tracking_carrier
| string |
tracking_link
| string |
billing_address.first_name
| string |
billing_address.last_name
| string |
billing_address.company
| string |
billing_address.street_1
| string |
billing_address.street_2
| string |
billing_address.city
| string |
billing_address.state
| string |
billing_address.zip
| string |
billing_address.country
| string |
billing_address.country_iso2
| string |
billing_address.phone
| string |
billing_address.email
| string |
shipping_address.first_name
| string |
shipping_address.last_name
| string |
shipping_address.company
| string |
shipping_address.street_1
| string |
shipping_address.street_2
| string |
shipping_address.city
| string |
shipping_address.state
| string |
shipping_address.zip
| string |
shipping_address.country_iso2
| string |
shipping_address.phone
| string |
shipping_address.email
| string |
generated_tracking_link
| string |
shipping_provider_display_name
| string |
bigcommerce_shipment_update_1.0
Key | Datatype |
---|
order_id
| integer |
date_created
| date |
tracking_number
| string |
merchant_shipping_cost
| float |
shipping_method
| string |
comments
| string |
shipping_provider
| string |
tracking_carrier
| string |
tracking_link
| string |
billing_address.first_name
| string |
billing_address.last_name
| string |
billing_address.company
| string |
billing_address.street_1
| string |
billing_address.street_2
| string |
billing_address.city
| string |
billing_address.state
| string |
billing_address.zip
| string |
billing_address.country
| string |
billing_address.country_iso2
| string |
billing_address.phone
| string |
billing_address.email
| string |
shipping_address.first_name
| string |
shipping_address.last_name
| string |
shipping_address.company
| string |
shipping_address.street_1
| string |
shipping_address.street_2
| string |
shipping_address.city
| string |
shipping_address.state
| string |
shipping_address.zip
| string |
shipping_address.country_iso2
| string |
shipping_address.phone
| string |
shipping_address.email
| string |
generated_tracking_link
| string |
shipping_provider_display_name
| string |
Sync all subscribers
Permission level
The permission assigned to subscribers in store. If the subscriber already exists in Maileon, the higher level permission will be applied.
Send Double Opt-In mail to new leads*
Only available if permission “none” selected. Check this if you want to send Double Opt-in emails to the leads.
Double Opt-in mailing key*
Only available if permission “none” selected. You can specify which mailing you’d like to send out. if left empty, the one specified as default in Maileon will be used.
The subscriber database sync uses the field mapping defined for the plugin.