Ekom.Mailchimp
1.2.0
See the version list below for details.
dotnet add package Ekom.Mailchimp --version 1.2.0
NuGet\Install-Package Ekom.Mailchimp -Version 1.2.0
<PackageReference Include="Ekom.Mailchimp" Version="1.2.0" />
<PackageVersion Include="Ekom.Mailchimp" Version="1.2.0" />
<PackageReference Include="Ekom.Mailchimp" />
paket add Ekom.Mailchimp --version 1.2.0
#r "nuget: Ekom.Mailchimp, 1.2.0"
#:package Ekom.Mailchimp@1.2.0
#addin nuget:?package=Ekom.Mailchimp&version=1.2.0
#tool nuget:?package=Ekom.Mailchimp&version=1.2.0
Ekom.Mailchimp
Mailchimp Marketing API integration for Ekom. The first release supports audience subscriptions, unsubscriptions, and completed-purchase conversion tracking.
Ekom.Mailchimp supports Umbraco 17 on .NET 10 and reusable integration services on .NET 8. Use Ekom.Mailchimp.U18 for Umbraco 18.
Configuration
{
"Ekom": {
"Mailchimp": {
"Enabled": true,
"ApiKey": "your-api-key-us1",
"AudienceId": "audience-id",
"EcommerceStoreId": "stable-mailchimp-store-id",
"Purchases": {
"Enabled": true,
"TrackCompletedCheckouts": true
}
}
}
}
ServerPrefix is inferred from the suffix of a standard Mailchimp API key. It can be set explicitly. Values can be overridden for individual Ekom stores under Stores by matching Alias.
Register the integration during application startup with builder.Services.AddMailchimp();. The Umbraco package automatically registers the completed-checkout event component.
Usage
Inject IMailchimpService. Subscription calls require an explicit Pending or Subscribed status. Use Pending for double opt-in workflows.
await mailchimp.SubscribeAsync(new MailchimpSubscribeRequest
{
StoreAlias = "default",
Email = "person@example.com",
Status = MailchimpSubscriptionStatus.Pending,
FirstName = "Example",
Tags = ["customer"],
});
TrackPurchaseAsync(IOrderInfo) maps an Ekom order and queues an idempotent Mailchimp commerce upsert. Product and variant records referenced by the order are upserted before the order. Automatic checkout tracking is controlled by Purchases:TrackCompletedCheckouts.
The dispatcher uses a bounded in-memory queue. When the queue is full, new work is dropped with a warning rather than blocking checkout. Work still queued during process shutdown is not durable; call the public purchase method again to replay an order safely.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.