Mailchimp API for Commerce

• Use your Commerce products in a Mailchimp newsletter.
• The plugin is only triggered for selected templates.
• Template variables can be used for product information.

Version: 1.0.0

With this Extra it is possible to let Commerce interact with Mailchimp via an API.

• Use your Commerce products in a Mailchimp newsletter.

• The plugin is only triggered for selected templates.

• Template variables can be used for product information.

Install the Mailchimp API for Commerce extra via the package manager.

You should have a Mailchimp account.

• Create an API key. The Mailchimp API key can be generated in your Mailchimp environment: go to Account > Extras > API keys > Create A Key (copy it).

• Create a List to use for the connection. Go to the List > Settings > List name and defaults > List ID (copy it).

Configure at least the following system settings:

• commercemailchimp.templates
• commercemailchimp.api_key
• commercemailchimp.api_store_id
• commercemailchimp.api_list_id
• commercemailchimp.api_name
• commercemailchimp.api_domain
• commercemailchimp.api_email_address

You can find the an explanation of the settings below.

When you save a resource (that has a template which is defined in the system settings) the E-commerce Store is created at Mailchimp. Thereafter, the product is inserted to Mailchimp. At each save it will be updated.

You can define custom fields (template variables) in the system settings for several product data fields. It is required to create a template variabele (default: "productId", or set in system settings) to connect resources with your modmore Commerce store products.

If it is configured right, you will find the products when you create a new campaign in Mailchimp.

To use the Mailchimp API for Commerce, you have to supply some data. This can be configured with system settings:

• commercemailchimp.templates
• commercemailchimp.api_key
• commercemailchimp.store_created
• commercemailchimp.api_endpoint
• commercemailchimp.api_store_id
• commercemailchimp.api_list_id
• commercemailchimp.api_name
• commercemailchimp.api_domain
• commercemailchimp.api_email_address
• commercemailchimp.api_product_id
• commercemailchimp.api_product_title
• commercemailchimp.api_product_image_url
• commercemailchimp.api_product_description
• commercemailchimp.api_product_variants_sku
• commercemailchimp.api_product_variants_title
• commercemailchimp.api_product_variants_price

Comma separated (,) ids of templates which are used for Commerce products.

Get your API key from Mailchimp.com > Account > Extras > API keys.

Set to "1" if the store is already created in Mailchimp.

Do not change, default (api_key).api.mailchimp.com/3.0/ecommerce/stores.

The unique identifier for the store.

The unique identifier for the Mailchimp List that’s associated with the store.

The name of the store.

The store domain. Without http:// or https://.

The email address for the store.

For example EUR, USD.

Id of the product in Commerce, should be set with a template variable prefixed with "tv.". By default template variable with name "productId"

The name of a resource field, or template variable prefixed with "tv.".

By default Commerce product image. The name of a resource field, or template variable prefixed with "tv.".

Does not work yet. The name of a resource field, or template variable prefixed with "tv.".

By default Commerce product SKU. The name of a resource field, or template variable prefixed with "tv.".

The name of a resource field, or template variable prefixed with "tv.".

By default Commerce product price. The name of a resource field, or template variable prefixed with "tv.".

For reference: https://developer.mailchimp.com/documentation/mailchimp/reference/ecommerce/stores/

Initial public release.