The Mailchimp integration provides a set of ready-made functions you can call when building mappings. They handle common lookups and conversions for Mailchimp, such as resolving a Mailchimp product or customer from an iPaaS.com SKU, ID, or email, building a Mailchimp address, and formatting birthdays and date-times to the formats Mailchimp expects, so you don't have to write that logic yourself.

These functions are available anywhere you write a formula for the Mailchimp integration:

The functions are grouped below by the area of the integration they support.

Use these to resolve a Mailchimp product from an iPaaS.com SKU, or an iPaaS.com product name from its ID.

What it does: Finds a Mailchimp product ID (or variant ID) from an iPaaS.com product SKU within a Mailchimp store. It looks the product up directly first; if that does not match, it resolves the SKU through the variant mapping. Returns nothing if the SKU or store is missing, or no product or variant matches.

Signature: Task<string> GetProductIdBySku(string Sku, string StoreId, bool isVariant = false)

How to call it: await GetProductIdBySku(Sku, StoreId)

Returns: string. The Mailchimp product ID (or variant ID when isVariant is true), or nothing if no match is found.

Example: await GetProductIdBySku("ABC-123", "store_1") returns the Mailchimp product ID for that SKU.

When to use it: When mapping a product or line to Mailchimp and you have the SKU but need the Mailchimp product or variant ID.

What it does: Returns the name of an iPaaS.com product for a given iPaaS.com product ID. Returns nothing if the ID is not valid or the product is not found.

Signature: Task<string> GetProductNameById(long Id)

How to call it: await GetProductNameById(Id)

Returns: string. The iPaaS.com product name, or nothing if the product is not found.

Example: await GetProductNameById(1001) returns the name of that iPaaS.com product.

When to use it: When mapping product details to Mailchimp and you have the iPaaS.com product ID but need its name.

Use these to resolve a Mailchimp customer identifier from an iPaaS.com customer ID or email.

What it does: Finds a Mailchimp customer identifier from an iPaaS.com customer ID within a Mailchimp store. Returns nothing if the customer is not found in iPaaS.com or Mailchimp.

Signature: Task<string> GetCustomerIdById(long? customerId, string storeId)

How to call it: await GetCustomerIdById(customerId, storeId)

Returns: string. The Mailchimp customer identifier, or nothing if the customer is not found.

Example: await GetCustomerIdById(12345, "store_1") returns the Mailchimp customer identifier for that customer.

When to use it: When mapping an order to Mailchimp and you have the iPaaS.com customer ID but need the Mailchimp customer identifier.

What it does: Finds a Mailchimp customer identifier from an iPaaS.com customer email within a Mailchimp store. Returns nothing if no customer matches.

Signature: Task<string> GetCustomerIdByEmail(string email, string storeId)

How to call it: await GetCustomerIdByEmail(email, storeId)

Returns: string. The Mailchimp customer identifier, or nothing if no customer matches.

Example: await GetCustomerIdByEmail("user@example.com", "store_1") returns the Mailchimp customer identifier for that email.

When to use it: When mapping an order to Mailchimp and you have the customer's email but need the Mailchimp customer identifier.

Use this to convert an iPaaS.com address into the Mailchimp address model.

What it does: Converts an iPaaS.com address into the address model Mailchimp expects, mapping fields such as company, street lines, city, region, postal code, country, and phone.

Signature: Address BuildAddress(object addressResponse)

How to call it: BuildAddress(addressResponse)

Returns: Address. The Mailchimp address model built from the supplied iPaaS.com address.

Example: BuildAddress(addressResponse) returns the Mailchimp address model for the supplied address.

When to use it: When mapping an iPaaS.com address to a Mailchimp address field.

Use these to format birthdays and date-times to the formats Mailchimp expects.

What it does: Formats a date as a Mailchimp birthday string in MM/dd format. Returns nothing if the input is empty. Raises an error if the value is not a valid date.

Signature: string FormatBirthdayMMDD(object input)

How to call it: FormatBirthdayMMDD(input)

Returns: string. The date formatted as MM/dd, or nothing if the input is empty.

Example: FormatBirthdayMMDD("1990-01-15") returns "01/15".

When to use it: When mapping a birthday to Mailchimp and it expects the MM/dd format.

What it does: Formats a date as a Mailchimp birthday string in dd/MM format. Returns nothing if the input is empty. Raises an error if the value is not a valid date.

Signature: string FormatBirthdayDDMM(object input)

How to call it: FormatBirthdayDDMM(input)

Returns: string. The date formatted as dd/MM, or nothing if the input is empty.

Example: FormatBirthdayDDMM("1990-01-15") returns "15/01".

When to use it: When mapping a birthday to Mailchimp and it expects the dd/MM format.

What it does: Converts a date-time string that includes an offset into UTC, formatted as an ISO 8601 string ending in Z.

Signature: string ConvertToUtcFormat(string dateTimeWithOffset)

How to call it: ConvertToUtcFormat(dateTimeWithOffset)

Returns: string. The date-time in UTC, formatted as yyyy-MM-ddTHH:mm:ssZ.

Example: ConvertToUtcFormat("2024-01-15T10:30:00-05:00") returns "2024-01-15T15:30:00Z".

When to use it: When mapping a date-time to Mailchimp and it expects a UTC ISO 8601 value.