Mailchimp API for Commerce

Package Description

**Free Extra** This is a free extra and the code is publicly available for you to change. The extra is being actively maintained and you're free to put in pull requests which match our roadmap. Please create an issue if the pull request differs from the roadmap so we can make sure we're on the same page. Need help? Approach our support desk for paid premium support.

Usage/Installation Instructions

# Mailchimp API for Commerce # _Version: 1.0.0_ With this Extra it is possible to let Commerce interact with Mailchimp via an API. ## Features ## - Use your Commerce products in a Mailchimp newsletter. - The plugin is only triggered for selected templates. - Template variables can be used for product information. ## How to start? ## Install the Mailchimp API for Commerce extra via the package manager. ### At Mailchimp ### 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). ### In MODX Manager ### 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. ## Configuration ## To use the Mailchimp API for Commerce, you have to supply some data. This can be configured with system settings: ### 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` #### commercemailchimp.templates #### Comma separated (,) ids of templates which are used for Commerce products. #### commercemailchimp.api_key #### Get your API key from Mailchimp.com > Account > Extras > API keys. #### commercemailchimp.store_created #### Set to "1" if the store is already created in Mailchimp. #### commercemailchimp.api_endpoint #### Do not change, default (api_key).api.mailchimp.com/3.0/ecommerce/stores. #### commercemailchimp.api_store_id #### The unique identifier for the store. #### commercemailchimp.api_list_id #### The unique identifier for the Mailchimp List that’s associated with the store. #### commercemailchimp.api_name #### The name of the store. #### commercemailchimp.api_domain #### The store domain. Without http:// or https://. #### commercemailchimp.api_email_address #### The email address for the store. #### commercemailchimp.api_currency_code #### For example EUR, USD. #### commercemailchimp.api_product_id #### Id of the product in Commerce, should be set with a template variable prefixed with "tv.". By default template variable with name "productId" #### commercemailchimp.api_product_title #### The name of a resource field, or template variable prefixed with "tv.". #### commercemailchimp.api_product_image_url #### By default Commerce product image. The name of a resource field, or template variable prefixed with "tv.". #### commercemailchimp.api_product_description #### Does not work yet. The name of a resource field, or template variable prefixed with "tv.". #### commercemailchimp.api_product_variants_sku #### By default Commerce product SKU. The name of a resource field, or template variable prefixed with "tv.". #### commercemailchimp.api_product_variants_title #### The name of a resource field, or template variable prefixed with "tv.". #### commercemailchimp.api_product_variants_price #### By default Commerce product price. The name of a resource field, or template variable prefixed with "tv.". #### Documentation #### For reference: https://developer.mailchimp.com/documentation/mailchimp/reference/ecommerce/stores/