MailChimp Connector Setup Guide for AudienceStream

[#1]

With the Mailchimp Connector, you can set up automated triggers to manage subscribed/unsubscribed members in a Mailchimp List, report successful ecommerce transactions, and capture abandoned shopping cart details. 

Table of Contents Placeholder

Requirements

• Mailchimp Account
• Mailchimp API Key (how to find your API key?)

Supported Actions

Action Name	Description	Trigger on Audiences	Trigger on Streams
Subscribe Visitor to List	Add subscribed members to a list	✓	✗
Unsubscribe Visitor from List	Remove unsubscribed members from a list	✓	✗
Upsert Ecommerce Order	Upsert Ecommerce transaction details for successful orders	✓	✗
Upsert Ecommerce Cart	Upsert Ecommerce details for abandoned carts	✓	✗

Configure Settings

Go to the Connector Marketplace and add a new {vendor name} Connector. Read the Connector Overview article for general instructions on how to add a Connector.

To configure your vendor,

1. In the Configure tab, enter a suitable title.
2. Enter your Mailchimp API key. This is required. (how to find your API key?)
3. (Optional) Provide additional notes about this Mailchimp implementation.

Action Settings - Parameters and Options

Click Next or go to the Actions tab. It's where you'll set up Actions and trigger them. This section describes how to set up Parameters and Options for each Action.

Action - Subscribe Visitor to List

Parameters

1. Target Subscriber List (REQUIRED): Select the target Mailchimp list to add the subscriber to.
2. General Properties to Set (REQUIRED): Allows you to send additional data about the subscribed member to specific fields in the target Mailchimp list (see available options).
3. Update Existing Subscriber (RECOMMENDED): Check this box if you want existing subscriber information to be automatically updated.
4. Target Interest Group: Select the interest group(s) to add the subscriber to.
5. Set Field and Merge Tags: Add or update Tags for the subscriber (see available options).
6. New Notes: Provide additional notes for the subscriber.

For the following Options, choose an Attribute from the Map dropdown and an option from the To dropdown.

Options - General Properties to Set

Option	Description
Email Address - Plain (REQUIRED for new subscribers)	Plain email address of the subscriber, will be hashed with MD5 automatically according to Mailchimp email hash requirements.
Email Address - Hashed (OPTIONAL if plain email address is provided)	Hashed email address of the subscriber using MD5, according to Mailchimp email hash requirements.
New Member Status	Subscription status of new members. Possible values are: subscribed, unsubscribed, cleaned, and pending. If no member status is provided, the status defaults to subscribed
Email Type	Indicates the type of email message/content. Possible options are: html and text
Opt-in IP	The IP address used by the subscriber to confirm their opt-in status.
Signup IP	The IP address of the computer/device used by the subscriber during signup.
Language	The language set in the subscriber's browser at the time of signup.
Location - Latitude/Longitude	Geolocation of the subscriber at the time of signup
Current Status	Current subscription status of the subscriber. Possible values are: subscribed, unsubscribed, cleaned, and pending.
Opt-in Timestamp	The date and time when the subscriber confirmed their opt-in status
Signup Timestamp	The date and time when the subscriber signed up for your list.
VIP Status (true | false)	Indicates whether or not the subscriber is marked as a VIP

Options - Set Field and Merge Tags

Option	Description
FNAME - First Name - (type:text)	first name tag
LNAME - Last Name - (type:text)	last name tag

Action - Unsubscribe Visitor from List

Parameters

1. Target Subscriber List (REQUIRED): Select the target Mailchimp list to add the unsubscribed member to.
2. General Properties to Set (REQUIRED): Allows you to send the unsubscriber's data to specific fields in the target Mailchimp list (see available options below).

For the following Options, choose an Attribute from the Map dropdown and an option from the To dropdown.

Options - General Properties to Set

Option	Description
Email Address - Plain (REQUIRED)	Unhased email address of the subscriber
Email Address - Hashed	Hashed email address of the subscriber (OPTIONAL if the plain email address is already provided)

Action - Upsert Ecommerce Order

Parameters

1. Order Data (REQUIRED): For sending transactional information about the order. See available options below.
2. Customer Data (REQUIRED): For sending information about a specific customer. If the customer exists in your store, their information is updated. Otherwise, a new customer will be created. See available options below.
3. Order Line Item(s) Data (REQUIRED for new orders only): For sending information about one or more order line items (make sure the product already exists). See available options below.

For the following Options, choose an Attribute from the Map dropdown and an option from the To dropdown.

Options - Order Data

Option	Description
Store Foreign ID (REQUIRED)	Store identifier
Order Foreign ID (REQUIRED)	Unique order identifier
Campaign ID	Unique identifier of the campaign associated with the order
Financial Status	The order status (eg. refunded, processing, cancelled etc.)
Fulfillment Status	Indicates whether or not the order was fulfilled (eg. partial, fulfilled, etc.)
Currency Code (REQUIRED for new orders)	The three-letter ISO 4217 code for the currency that your store accepts.
Order Total (REQUIRED for new orders)	The total transaction (including shipping and tax)
Tax Total	The tax amount in the total transaction
Shipping Total	The shipping amount in the total transaction
Tracking Code	The MailChimp tracking code for the order i.e. the value of the ‘mc_tc’ parameter in your E-Commerce tracking URLs.
Foreign Processed Time	The date and time the order was processed.
Foreign Cancel Time	The date and time the order was cancelled.
Foreign Update Time	The date and time the order was updated.
Shipping Address - Name	The shipping address for the order
Shipping Address - Address Field 1	Additional field for the shipping address
Shipping Address - Address Field 2	Additional field for the shipping address
Shipping Address - City	The city in the shipping address
Shipping Address - Province	The state or normalized province in the shipping address
Shipping Address - Province Code	The two-letter code for the province or state in the shipping address
Shipping Address - Postal Code	The postal or zip code in the shipping address
Shipping Address - Country	The country in the shipping address
Shipping Address - Country Code	The two-letter code for the country in the shipping address
Shipping Address - Longitude	The longitude for the shipping address location
Shipping Address - Latitude	The latitude for the shipping address location
Shipping Address - Phone Number	The phone number for the shipping address
Shipping Address - Company	The company associated with the shipping address
Billing Address - Name	The name associated with the billing address
Billing Address - Address Field 1	The billing address for the order
Billing Address - Address Field 2	Additional field for the billing address
Billing Address - City	The city in the billing address
Billing Address - Province	The state or normalized province in the billing address
Billing Address - Province Code	The two-letter code for the province in the billing address
Billing Address - Postal Code	The postal or zip code in the billing address
Billing Address - Country	The country in the billing address
Billing Address - Country Code	The two-letter code for the country in the billing address
Billing Address - Longitude	The longitude for the billing address location
Billing Address - Latitude	The latitude for the billing address location
Billing Address - Phone Number	The phone number for the billing address
Billing Address - Company	The company associated with the billing address

Options - Customer Data

Option	Description
Customer Foreign ID (REQUIRED)	Customer identifier
Email Address (REQUIRED for new customers)	The customer's email address
Opt-in Status	The customer’s opt-in status. This flag applies only to list members that were added via Mailchimp's E-commerce API endpoints; however it will not overwrite the opt-in status of existing list members. Customers who didn't opt into your MailChimp list will be added as Transactional members. Possible values are true and false
Company	The customer's company
First Name	The customer's first name
Last Name	The customer's last name
Orders Count	The customer's total order count
Total Spent	The total amount the customer has spent
Address Field 1	The mailing address of the customer
Address Field 2	Additional field for the customer's mailing address.
City	The city the customer is located in
Province	The customer's state name or normalized province
Province Code	The two-letter code for the customer's province or state
Postal Code	The customer's postal or zip code
Country	The customer's country
Country Code	The two-letter code for the customer's country

Options - Order Line Item(s)

Option	Description
Line Item(s) Foreign ID (REQUIRED)	The unique identifier of the order line item
Line Item(s) Product Foreign ID (REQUIRED)	The unique identifier of the product associated with the order line item
Line Item(s) Product Variant Foreign ID (REQUIRED)	The unique identifier of the product variant associated with the order line item
Line Item(s) Quantity (REQUIRED)	The quantity of an order line item
Line Item(s) Price (REQUIRED)	The price of an order line item

Action - Upsert Ecommerce Cart

Parameters

1. Cart Data (REQUIRED): For sending general information about the cart. See available options below.
2. Customer Data (REQUIRED): For sending information about a specific customer. If the customer exists in your store, their information is updated. Otherwise, a new customer will be created. Click here to see available options.
3. Cart Line Item(s) Data (REQUIRED): For sending one or more cart line items (make sure the product already exists). Click here to see available options.

For the following Options, choose an Attribute from the Map dropdown and an option from the To dropdown.

Options - Cart Data

Option	Description
Store Foreign ID (REQUIRED)	Store identifier
Cart Foreign ID (REQUIRED)	Unique order identifier
Campaign ID	Unique identifier of the campaign associated with the cart
Checkout URL	The URL of the cart
Currency Code (REQUIRED for new orders)	The three-letter ISO 4217 code for the currency that your store accepts.
Order Total (REQUIRED for new orders)	The total transaction (including shipping and tax)
Tax Total	The tax amount in the total transaction

Usage Example

So far, we learned how to set up a new Mailchimp Connector. Next, we'll look at an example scenario on how to add a specific visitor segment, let's say shoe lovers, to a subscription list. Refer to the Usage Example article for more.

Vendor Documentation

• Lists
• Managing Subscribers and Unsubscribers
• Groups
• Merge Tags
• Mailchimp for Ecommerce
• Mailchimp API Reference

Connector Changelog

Released December 08, 2016

We have made changes to the following Actions to support Mailchimp's most recent API v3.0.

According to Mailchimp, prior versions will NOT be supported after 2016. Hence, we strongly recommend you doublecheck all existing Mailchimp Actions in your AudienceStream profile and reconfigure them as necessary.

Subscribe Visitor to List - Updated

Parameter	Functionality Change	What to do
General Properties to Set	Renamed option email.email to Email Address - Plain Added new option Email Address - Hashed Added new option New Member Status Renamed email_type to Email Type - (html | text) Renamed merge_vars.optin_ip to Opt-in IP Added new option Signup IP Renamed option merge_vars.mc_language to Language Renamed option merge_vars.mc_location.latitude) to Location - Latitude Renamed option merge_vars.mc_location.longitude to Location - Longitude) Added new option Current Status - (subscribed | unsubscribed | cleaned | pending) Renamed option merge_vars.optin_time to Opt-in Timestamp Added new option Signup Timestamp Added new option VIP Status (true | false) Deprecated options send_welcome merge_vars.new-email merge_vars.mc_location.anything email.leid email.euid double_optin replace_interests	Reconfigure the deprecated General Properties mappings using the new options.
Target Interest Group	No functionality changes but reconfiguration might be needed	If the dropdown doesn't show your previously selected option, please select the appropriate option again.
Set Field and Merge Tags	No functionality changes but reconfiguration might be needed	If the dropdown doesn't show your previously selected option, please select the appropriate option again.

Unsubscribe Visitor from List - Updated

Parameter	Functionality Change	What to do
General Properties to Set	Renamed option email.email to Email Address - Plain Added new option Email Address - Hashed Deprecated options email.euid email.leid delete_member send_goodbye send_notify	Reconfigure the deprecated General Properties mappings using the new options.

Add E-Commerce 360 - Deprecated

This is now replaced by the new Upsert Ecommerce Order Action. You must migrate all deprecated Parameters and Options to a new Action instance.