Skip to content

Commit 4ddf09c

Browse files
committed
Add docs for mailchimp
1 parent 2bb967e commit 4ddf09c

File tree

2 files changed

+73
-10
lines changed

2 files changed

+73
-10
lines changed
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
With the [Mailchimp Extension](https://modmore.com/commerce/extensions/mailchimp/) you can allow your customers to sign up to a Mailchimp mailing list (or audience) when placing an order.
2+
3+
## Setup
4+
5+
First install the free extension from the modmore package provider.
6+
7+
Navigate to Extras > Commerce > Modules and find Mailchimp in the list. Open its configuration and enter your API Key; you can find this in Mailchimp by clicking on your name in the top right > Account > Extras > API Keys.
8+
9+
Save the api key on the module configuration, at which point you'll get some additional options on the module.
10+
11+
- **Mailchimp List** allows you to select the list to subcribe customers to.
12+
- **Address Type** lets you choose if you want to use the email address on the provided billing or shipping address. This will fallback to the other type if the preferred type is not set.
13+
- **Enable Double Opt-in** will instruct Mailchimp to send a double opt-in email to the user to confirm their subscription.
14+
15+
Also very important: **add the opt-in markup to your template**.
16+
17+
## Add the required markup
18+
19+
The module supports the cart, address, and payment method steps/templates, so you can choose which one you want to place the opt-in on:
20+
21+
- `frontend/checkout/cart.twig`
22+
- `frontend/checkout/address.twig`
23+
- `frontend/checkout/payment-method.twig`
24+
25+
(If you haven't used the templating in Commerce before, see [Front-end Theming for how to do that.](../Front-end_Theming))
26+
27+
The module expects a POST value with the name `mailchimp_opt_in` and a value of `on`. You could for example use this markup, which will only be shown if the module is properly configured and the customer is not already subscribed:
28+
29+
``` html
30+
{% if mailchimp_enabled and not mailchimp_subscribed %}
31+
<label class="c-subscribe-newsletter">
32+
<input type="checkbox" name="mailchimp_opt_in" value="on">
33+
{{ lex('commerce_mailchimp.subscribe_to_newsletter') }}
34+
</label>
35+
{% endif %}
36+
```

en/01_Commerce/v1/50_Modules/index.md

Lines changed: 37 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,43 @@
1-
Commerce uses Modules to provide most functionality and features.
1+
---
2+
title: 'Modules & Extensions'
3+
---
24

3-
Many modules are shipped with the core Commerce package, requiring no further install, but third party modules are also available offering different payment providers, shipping partners, communication-related integrations or other features.
5+
Commerce uses Modules to provide most functionality and features.
46

5-
In this section of the documentation you'll find information about all modules that are available from modmore. Third party modules may be missing from the list, while we encourage third party developers to submit documentation to this site we can not force them to do so, and in some cases we may not accept these contributions until we have had a chance to review the module itself.
7+
Many modules are shipped with the core Commerce package, requiring no further install.
68

7-
Choose one of the following categories to see the matching modules:
9+
Other modules are provided as [standalone extensions](https://modmore.com/commerce/extensions/), installable through the MODX Extras installer. There are extensions for payment gateways, shipping partners, communication-related integrations and more.
810

9-
- Payments
10-
- Shipping
11-
- Communication
12-
- Taxes
13-
- Other
11+
[**All available extensions, including third party extensions, can be found here.**](https://modmore.com/commerce/extensions/)
1412

15-
**Note**: not all the modules are actually be exposed as modules in the Commerce admin area. For example payment providers and shipping integrations that are provided with the Commerce package are not shown as modules, instead they are just available when creating a payment or shipping method.
13+
In alphabetical order:
1614

15+
- [Accept Terms](Cart/AcceptTerms)
16+
- [AutoFill GeoIP](Cart/AutoFillGeoIP)
17+
- [Basic Address Validation](Address_Validation/Basic)
18+
- [Basic Custom Fields](Custom_Fields_(Basic))
19+
- [CloudPrint](CloudPrint)
20+
- [Combine Products](Cart/CombineProducts)
21+
- [Country Validation](Address_Validation/Country)
22+
- [Coupons](Discounts/Coupons)
23+
- [Customers](Admin/Customers)
24+
- [Default Address](Cart/DefaultAddress)
25+
- [Dymo Address Label](Shipping/DymoAddressLabel)
26+
- [Enforce Stock](Cart/EnforceStock)
27+
- [EU VAT](Taxes/EUVat)
28+
- [EU VAT Validator](Address_Validation/EUVat_Validator)
29+
- [Gateways Pack 1](Payments/GatewayPack1)
30+
- [Hide Products](Admin/HideProducts)
31+
- [ItemData](Cart/ItemData)
32+
- [Mailchimp](Mailchimp)
33+
- [MessageBird](Communication/MessageBird)
34+
- [Minimum Order Amount](Cart/MinOrderAmount)
35+
- [mPDF Writer](mPDFWriter)
36+
- [Packing Slip](Shipping/PackingSlip)
37+
- [PDFCrowd Writer](PDFCrowdWriter)
38+
- [Table Rates](Shipping/TableRates)
39+
- [TaxJar](Taxes/TaxJar)
40+
- [Update Stock](Cart/UpdateStock)
41+
- [UserProfileAddress](Cart/UserProfileAddress)
42+
- [User Group Shipment](Shipping/UserGroupShipment)
43+
- [User & User Group Discounts](Discounts/UserDIscounts)

0 commit comments

Comments
 (0)