Operations (sample payloads)
Main operations
Archive list member
Archive a list member. Sample Input Sample Output
Create customer
Add a new customer to a store. Sample Input
{
"store_id": "store123",
"customer_id": "cust456",
"email_address": "johndoe@example.com",
"opt_in_status": true,
"company": "Acme Corp",
"first_name": "John",
"last_name": "Doe",
"address": \{
"address1": "123 Main St",
"address2": "Apt 4B",
"city": "New York",
"province": "New York",
"province_code": "NY",
"postal_code": "10001",
"country": "United States",
"country_code": "US"
\}
}
Sample Output
{
"id": "cust456",
"email_address": "johndoe@example.com",
"opt_in_status": true,
"company": "Acme Corp",
"first_name": "John",
"last_name": "Doe",
"orders_count": 0,
"total_spent": 0,
"address": \{
"address1": "123 Main St",
"address2": "Apt 4B",
"city": "New York",
"province": "New York",
"province_code": "NY",
"postal_code": "10001",
"country": "United States",
"country_code": "US"
\},
"created_at": "2023-05-15T10:30:00Z",
"updated_at": "2023-05-15T10:30:00Z",
"_links": [
\{
"rel": "self",
"href": "https://us1.api.mailchimp.com/3.0/ecommerce/stores/store123/customers/cust456",
"method": "GET",
"targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Definitions/Ecommerce/Customers/Response.json"
\},
\{
"rel": "parent",
"href": "https://us1.api.mailchimp.com/3.0/ecommerce/stores/store123/customers",
"method": "GET",
"targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Definitions/Ecommerce/Customers/CollectionResponse.json",
"schema": "https://us1.api.mailchimp.com/schema/3.0/CollectionLinks/Ecommerce/Customers.json"
\}
]
}
Create ecommerce store
Add a new store. Sample Input
{
"store_foreign_id": "store123",
"list_id": "a1b2c3d4e5",
"store_name": "My Online Shop",
"currency_code": "USD",
"platform": "Shopify",
"domain": "myonlineshop.com",
"is_syncing": true,
"email_address": "support@myonlineshop.com",
"money_format": "$",
"primary_locale": "en",
"timezone": "America/New_York",
"phone": "+1 (555) 123-4567",
"address": \{
"address1": "123 Main St",
"address2": "Suite 456",
"city": "New York",
"province": "New York",
"province_code": "NY",
"postal_code": "10001",
"country": "United States",
"country_code": "US"
\}
}
Sample Output
Create member in list
Add a new member to the list. Sample Input Sample Output
Create segment member
Add a member to a static segment. Sample Input Sample Output
{
"id": "3a7b4e2c1f",
"email_address": "johndoe@example.com",
"unique_email_id": "def456abc123",
"email_type": "html",
"status": "subscribed",
"merge_fields": {
"FNAME": "John",
"LNAME": "Doe",
"ADDRESS": \{
"addr1": "123 Main St",
"addr2": "Apt 4B",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "USA"
\},
"PHONE": "555-123-4567",
"BIRTHDAY": "01/15"
},
"interests": {
"a": true
},
"stats": \{
"avg_open_rate": 0.25,
"avg_click_rate": 0.05
\},
"ip_signup": "192.168.1.1",
"timestamp_signup": "2023-06-15T10:30:00+00:00",
"ip_opt": "192.168.1.2",
"timestamp_opt": "2023-06-15T10:35:00+00:00",
"member_rating": 4,
"last_changed": "2023-06-15T10:35:00+00:00",
"language": "en",
"vip": false,
"email_client": "Gmail",
"location": \{
"latitude": 40.7128,
"longitude": -74.006,
"gmtoff": -4,
"dstoff": -5,
"country_code": "US",
"timezone": "America/New_York"
\},
"last_note": \{
"note_id": 12345,
"created_at": "2023-06-15T11:00:00+00:00",
"created_by": "user@example.com",
"note": "Added to VIP segment"
\},
"list_id": "abc123def456",
"_links": [
\{
"rel": "self",
"href": "https://us1.api.mailchimp.com/3.0/lists/abc123def456/members/3a7b4e2c1f",
"method": "GET",
"targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Definitions/Lists/Members/Response.json"
\},
\{
"rel": "parent",
"href": "https://us1.api.mailchimp.com/3.0/lists/abc123def456/members",
"method": "GET",
"targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Definitions/Lists/Members/CollectionResponse.json",
"schema": "https://us1.api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Members.json"
\}
]
}
Delete customer
Delete a customer from a store. Sample Input Sample Output
{
"deleted": true
}
Delete ecommerce store
Delete a store. Sample Input
{
"store_id": "store123"
}
Sample Output
{
"deleted": true
}
Delete list member
Delete all personally identifiable information related to a list member, and remove them from a list. This will make it impossible to re-import the list member. Sample Input Sample Output
Delete order
Delete an order from a store. Sample Input Sample Output
{
"deleted": true
}
Get ecommerce store
Get information about a specific store. Sample Input
\{
"store_id": "store123",
"fields": [
"id",
"name",
"platform",
"domain",
"currency_code"
],
"exclude_fields": [
"_links",
"connected_site"
]
\}
Sample Output
\{
"id": "store123",
"name": "My Online Store",
"platform": "Shopify",
"domain": "myonlinestore.com",
"currency_code": "USD"
\}
List account orders
Get information about an account's orders. Sample Input Sample Output
{
"orders": [
{
"id": "ORD123456",
"customer": \{
"id": "CUST987654",
"email_address": "johndoe@example.com",
"opt_in_status": true,
"first_name": "John",
"last_name": "Doe",
"orders_count": 3,
"total_spent": 250.75
\},
"order_total": 89.99,
"currency_code": "USD"
},
{
"id": "ORD789012",
"customer": \{
"id": "CUST345678",
"email_address": "janesmith@example.com",
"opt_in_status": true,
"first_name": "Jane",
"last_name": "Smith",
"orders_count": 1,
"total_spent": 129.99
\},
"order_total": 129.99,
"currency_code": "USD"
}
],
"total_items": 2,
"_links": [
\{
"rel": "self",
"href": "https://api.mailchimp.com/3.0/ecommerce/orders",
"method": "GET",
"targetSchema": "https://api.mailchimp.com/schema/3.0/Ecommerce/Orders/Collection.json"
\}
]
}
List campaign email activity
Get a list of email activities that have happened for a given campaign. Sample Input Sample Output
{
"emails": [
{
"email_address": "john.doe@example.com",
"activity": [
\{
"action": "open",
"type": "open",
"timestamp": "2023-05-02T10:15:30Z",
"ip": "192.168.1.1"
\},
\{
"action": "click",
"type": "click",
"timestamp": "2023-05-02T10:16:45Z",
"url": "https://example.com/product",
"ip": "192.168.1.1"
\}
]
},
{
"email_address": "jane.smith@example.com",
"activity": [
\{
"action": "open",
"type": "open",
"timestamp": "2023-05-03T14:20:00Z",
"ip": "192.168.2.2"
\}
]
}
],
"campaign_id": "b1234abc",
"total_items": 2
}
List campaign folders
Get all folders used to organize campaigns. Sample Input Sample Output
{
"folders": [
{
"name": "Newsletter Campaigns",
"id": "abc123def456",
"count": 5,
"_links": [
\{
"rel": "self",
"href": "https://us1.api.mailchimp.com/3.0/campaign-folders/abc123def456",
"method": "GET",
"targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Definitions/CampaignFolders/Response.json"
\}
]
},
{
"name": "Promotional Campaigns",
"id": "ghi789jkl012",
"count": 3,
"_links": [
\{
"rel": "self",
"href": "https://us1.api.mailchimp.com/3.0/campaign-folders/ghi789jkl012",
"method": "GET",
"targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Definitions/CampaignFolders/Response.json"
\}
]
}
],
"total_items": 2,
"_links": [
\{
"rel": "self",
"href": "https://us1.api.mailchimp.com/3.0/campaign-folders",
"method": "GET",
"targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Definitions/CampaignFolders/CollectionResponse.json",
"schema": "https://us1.api.mailchimp.com/schema/3.0/CollectionLinks/CampaignFolders.json"
\}
]
}
List campaign recipients
Get a list of all the people who received a particular campaign. Sample Input Sample Output
List campaign sub reports
Get a list of sub reports for a parent campaign. Sample Input
{
"campaign_id": "b1234abc"
}
Sample Output
{
"reports": [
{
"id": "sub123",
"campaign_title": "Summer Sale Newsletter",
"type": "regular",
"list_id": "list456",
"list_is_active": true,
"list_name": "Customers",
"subject_line": "Don't Miss Our Summer Sale!",
"preview_text": "Exclusive discounts inside",
"emails_sent": 10000,
"abuse_reports": 2,
"unsubscribed": 15,
"send_time": "2023-06-15T10:00:00Z",
"rss_last_send": null,
"bounces": \{
"hard_bounces": 50,
"soft_bounces": 30,
"syntax_errors": 0
\},
"forwards": \{
"forwards_count": 75,
"forwards_opens": 40
\},
"opens": \{
"opens_total": 5500,
"unique_opens": 4800,
"open_rate": 48,
"last_open": "2023-06-18T23:59:59Z"
\},
"clicks": \{
"clicks_total": 1200,
"unique_clicks": 950,
"unique_subscriber_clicks": 900,
"click_rate": 9.5,
"last_click": "2023-06-18T22:45:30Z"
\},
"facebook_likes": \{
"recipient_likes": 30,
"unique_likes": 28,
"facebook_likes": 35
\},
"industry_stats": \{
"type": "Retail",
"open_rate": 22.5,
"click_rate": 2.7,
"bounce_rate": 0.8,
"unopen_rate": 77.5,
"unsub_rate": 0.2,
"abuse_rate": 0.01
\},
"list_stats": \{
"sub_rate": 0.5,
"unsub_rate": 0.15,
"open_rate": 48,
"click_rate": 9.5
\},
"ab_split": null,
"timewarp": null,
"timeseries": [
\{
"timestamp": "2023-06-15T10:00:00Z",
"emails_sent": 10000,
"unique_opens": 2000,
"recipients_clicks": 400
\},
\{
"timestamp": "2023-06-15T14:00:00Z",
"emails_sent": 10000,
"unique_opens": 3500,
"recipients_clicks": 700
\}
],
"share_report": \{
"share_url": "https://mailchimp.com/reports/share/abc123",
"share_password": "summerSale2023"
\},
"ecommerce": \{
"total_orders": 250,
"total_spent": 12500,
"total_revenue": 15000,
"currency_code": "USD"
\},
"delivery_status": \{
"enabled": true,
"can_cancel": false,
"status": "delivered",
"emails_sent": 10000,
"emails_canceled": 0
\},
"_links": [
\{
"rel": "parent",
"href": "https://us1.api.mailchimp.com/3.0/reports/b1234abc",
"method": "GET",
"targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Definitions/Reports/Response.json",
"schema": "https://us1.api.mailchimp.com/schema/3.0/Paths/Reports/Collection.json"
\}
]
}
],
"campaign_id": "b1234abc",
"total_items": 1,
"_links": [
\{
"rel": "self",
"href": "https://us1.api.mailchimp.com/3.0/reports/b1234abc/sub-reports",
"method": "GET",
"targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Definitions/Reports/SubReports/CollectionResponse.json",
"schema": "https://us1.api.mailchimp.com/schema/3.0/Paths/Reports/SubReports/Collection.json"
\}
]
}
List campaign subscriber activity
Get a list of email activities that have happened for a given campaign and a particular subscriber. Sample Input
\{
"campaign_id": "b1234abc",
"email": "subscriber@example.com"
\}
Sample Output
List campaigns
Get a list of campaigns. Sample Input Sample Output
{
"campaigns": [
{
"id": "a1b2c3d4e5",
"web_id": 123456,
"type": "regular",
"create_time": "2023-03-15T10:00:00Z",
"archive_url": "https://mailchimp.com/campaigns/a1b2c3d4e5-archive",
"long_archive_url": "https://us1.campaign-archive.com/?u=abcdef123456&id=a1b2c3d4e5",
"status": "sent",
"emails_sent": 5000,
"send_time": "2023-03-20T09:00:00Z",
"content_type": "html",
"needs_block_refresh": false,
"resendable": true,
"recipients": \{
"list_id": "list123",
"list_is_active": true,
"list_name": "Newsletter Subscribers",
"recipient_count": 5000
\},
"settings": \{
"subject_line": "March Newsletter: Exciting Updates!",
"preview_text": "Check out our latest news and offers",
"title": "March 2023 Newsletter",
"from_name": "Your Company",
"reply_to": "newsletter@yourcompany.com",
"use_conversation": true,
"to_name": "*|FNAME|*",
"folder_id": "folder456",
"authenticate": true,
"auto_footer": true,
"inline_css": true
\},
"tracking": \{
"opens": true,
"html_clicks": true,
"text_clicks": true,
"goal_tracking": false,
"ecomm360": true,
"google_analytics": "utm_source=newsletter&utm_medium=email&utm_campaign=march2023"
\},
"report_summary": {
"opens": 3500,
"unique_opens": 3000,
"open_rate": 60,
"clicks": 1200,
"subscriber_clicks": 1000,
"click_rate": 20,
"ecommerce": \{
"total_orders": 50,
"total_spent": 2500,
"total_revenue": 3000
\}
}
}
],
"total_items": 1,
"_links": [
\{
"rel": "self",
"href": "https://us1.api.mailchimp.com/3.0/campaigns",
"method": "GET",
"targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Definitions/Campaigns/CollectionResponse.json",
"schema": "https://us1.api.mailchimp.com/schema/3.0/Paths/Campaigns/Collection.json"
\}
]
}
List customers
Get information about a store's customers. Sample Input Sample Output
List ecommerce stores
Get information about all stores. Sample Input Sample Output
List interest categories
Get information about a list’s interest categories. Sample Input
\{
"list_id": "a1b2c3d4e5",
"interest_group_type": "checkboxes",
"fields": [
"id",
"title",
"type"
],
"exclude_fields": [
"_links"
],
"count": 10,
"offset": 0
\}
Sample Output
{
"list_id": "a1b2c3d4e5",
"categories": [
\{
"list_id": "a1b2c3d4e5",
"id": "abc123def",
"title": "Favorite Products",
"display_order": 1,
"type": "checkboxes"
\},
\{
"list_id": "a1b2c3d4e5",
"id": "ghi456jkl",
"title": "Preferred Communication",
"display_order": 2,
"type": "checkboxes"
\}
],
"total_items": 2
}
List interests
Get information about an interest category's interests. Sample Input
\{
"list_id": "abc123def456",
"interest_category_id": "9876fedcba",
"fields": [
"id",
"name",
"subscriber_count"
],
"exclude_fields": [
"_links"
],
"count": 50,
"offset": 0
\}
Sample Output
List list merge fields
Retrieve all merge fields for a specific list. Sample Input Sample Output
{
"merge_fields": [
{
"merge_id": 1,
"tag": "FNAME",
"name": "First Name",
"type": "text",
"required": true,
"default_value": "",
"public": true,
"display_order": 1,
"options": {
"size": 25
},
"help_text": "Enter your first name",
"list_id": "a1b2c3d4e5"
},
{
"merge_id": 2,
"tag": "LNAME",
"name": "Last Name",
"type": "text",
"required": true,
"default_value": "",
"public": true,
"display_order": 2,
"options": {
"size": 25
},
"help_text": "Enter your last name",
"list_id": "a1b2c3d4e5"
}
],
"list_id": "a1b2c3d4e5",
"total_items": 2
}
List list segments
Get a list of all segments in a list. Sample Input
\{
"list_id": "abc123def456",
"type2": "saved",
"include_cleaned": true,
"include_transactional": false,
"include_unsubscribed": true,
"count": 50,
"offset": 0
\}
Sample Output
List lists
Get a list of lists. Sample Input
\{
"count": 2,
"offset": 0
\}
Sample Output
{
"lists": [
{
"id": "a1b2c3d4e5",
"web_id": 123456,
"name": "Newsletter Subscribers",
"contact": \{
"company": "Acme Corp",
"address1": "123 Main St",
"address2": "Suite 100",
"city": "Springfield",
"state": "IL",
"zip": "62701",
"country": "US",
"phone": "555-123-4567"
\},
"permission_reminder": "You're receiving this email because you signed up for our newsletter.",
"use_archive_bar": true,
"campaign_defaults": \{
"from_name": "Acme Corp",
"from_email": "newsletter@acmecorp.com",
"subject": "Monthly Newsletter",
"language": "en"
\},
"notify_on_subscribe": "owner@acmecorp.com",
"notify_on_unsubscribe": "owner@acmecorp.com",
"date_created": "2023-01-15T10:30:00+00:00",
"list_rating": 4,
"email_type_option": true,
"subscribe_url_short": "http://eepurl.com/abcdef",
"subscribe_url_long": "https://acmecorp.us1.list-manage.com/subscribe?u=a1b2c3d4e5f6g7h8i9j0&id=1234567890",
"beamer_address": "us1-abcdef123-abcdef123@inbound.mailchimp.com",
"visibility": "pub",
"double_optin": true,
"has_welcome": true,
"marketing_permissions": false,
"modules": [
"email"
],
"stats": \{
"member_count": 5000,
"total_contacts": 5500,
"unsubscribe_count": 150,
"cleaned_count": 50,
"member_count_since_send": 100,
"unsubscribe_count_since_send": 10,
"cleaned_count_since_send": 5,
"campaign_count": 25,
"campaign_last_sent": "2023-05-01T09:00:00+00:00",
"merge_field_count": 5,
"avg_sub_rate": 2.5,
"avg_unsub_rate": 0.5,
"target_sub_rate": 5,
"open_rate": 22.5,
"click_rate": 3.2,
"last_sub_date": "2023-05-10T14:23:00+00:00",
"last_unsub_date": "2023-05-09T11:45:00+00:00"
\},
"_links": [
\{
"rel": "self",
"href": "https://us1.api.mailchimp.com/3.0/lists/a1b2c3d4e5",
"method": "GET",
"targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Lists/Instance.json"
\}
]
},
{
"id": "f6g7h8i9j0",
"web_id": 789012,
"name": "Product Updates",
"contact": \{
"company": "Acme Corp",
"address1": "456 Oak Ave",
"address2": "",
"city": "Springfield",
"state": "IL",
"zip": "62702",
"country": "US",
"phone": "555-987-6543"
\},
"permission_reminder": "You're receiving this email because you opted in for product updates.",
"use_archive_bar": false,
"campaign_defaults": \{
"from_name": "Acme Product Team",
"from_email": "products@acmecorp.com",
"subject": "Product Update",
"language": "en"
\},
"notify_on_subscribe": "",
"notify_on_unsubscribe": "",
"date_created": "2023-03-01T14:45:00+00:00",
"list_rating": 3,
"email_type_option": false,
"subscribe_url_short": "http://eepurl.com/ghijkl",
"subscribe_url_long": "https://acmecorp.us1.list-manage.com/subscribe?u=f6g7h8i9j0k1l2m3n4o5&id=0987654321",
"beamer_address": "us1-ghijkl456-ghijkl456@inbound.mailchimp.com",
"visibility": "prv",
"double_optin": false,
"has_welcome": false,
"marketing_permissions": true,
"modules": [
"email",
"ads"
],
"stats": \{
"member_count": 2000,
"total_contacts": 2100,
"unsubscribe_count": 50,
"cleaned_count": 20,
"member_count_since_send": 30,
"unsubscribe_count_since_send": 5,
"cleaned_count_since_send": 2,
"campaign_count": 10,
"campaign_last_sent": "2023-05-05T16:30:00+00:00",
"merge_field_count": 3,
"avg_sub_rate": 1.8,
"avg_unsub_rate": 0.3,
"target_sub_rate": 3,
"open_rate": 35.7,
"click_rate": 5.9,
"last_sub_date": "2023-05-11T09:12:00+00:00",
"last_unsub_date": "2023-05-10T17:30:00+00:00"
\},
"_links": [
\{
"rel": "self",
"href": "https://us1.api.mailchimp.com/3.0/lists/f6g7h8i9j0",
"method": "GET",
"targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Lists/Instance.json"
\}
]
}
],
"total_items": 2,
"constraints": \{
"may_create": true,
"max_instances": 100,
"current_total_instances": 2
\},
"_links": [
\{
"rel": "self",
"href": "https://us1.api.mailchimp.com/3.0/lists",
"method": "GET",
"targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Lists/Collection.json",
"schema": "https://us1.api.mailchimp.com/schema/3.0/CollectionLinks/Lists.json"
\}
]
}
List member activity
Retrieve details about a subscriber's recent activity. Sample Input Sample Output
{
"activity": [
\{
"action": "open",
"timestamp": "2023-05-15T10:30:00Z",
"type": "email",
"campaign_id": "camp123",
"title": "Summer Sale Newsletter"
\},
\{
"action": "click",
"timestamp": "2023-05-15T10:32:00Z",
"type": "email",
"campaign_id": "camp123",
"title": "Summer Sale Newsletter"
\}
],
"email_id": "johndoe@example.com",
"contact_id": "cont789",
"list_id": "abc123def456",
"total_items": 2
}
List recent member notes
Retrieve recent notes for a specific list member. Sample Input
\{
"list_id": "abc123def456",
"email_address": "johndoe@example.com",
"sort_field": "created_at",
"sort_dir": "DESC",
"fields": [
"notes",
"email_id",
"list_id"
],
"exclude_fields": [
"_links"
],
"count": 10,
"offset": 0
\}
Sample Output
Raw HTTP request (advanced)
Perform a raw HTTP request with some pre-configuration and processing by the connector, such as authentication. Sample Input
{
"method": "GET",
"url": {
"endpoint": "/lists"
},
"headers": [
\{
"key": "Accept",
"value": "application/json"
\}
],
"query_parameters": [
\{
"key": "count",
"value": "10"
\},
\{
"key": "offset",
"value": "0"
\}
],
"body": {
"none": null
},
"include_raw_body": false,
"parse_response": "true"
}
Sample Output
Search members
Search for members across your Mailchimp lists. Sample Input
\{
"query": "john@example.com",
"list_id": "abc123def456",
"fields": [
"email_address",
"full_name",
"status"
],
"exclude_fields": [
"tags",
"merge_fields"
]
\}
Sample Output
{
"exact_matches": {
"members": [
{
"id": "a1b2c3d4e5",
"email_address": "john@example.com",
"unique_email_id": "abc123def456ghi789",
"contact_id": "jkl012mno345",
"full_name": "John Doe",
"web_id": 123456789,
"email_type": "html",
"status": "subscribed",
"consents_to_one_to_one_messaging": true,
"stats": \{
"avg_open_rate": 0.25,
"avg_click_rate": 0.1
\},
"ip_signup": "192.168.1.1",
"timestamp_signup": "2023-04-15T10:30:00Z",
"ip_opt": "192.168.1.1",
"timestamp_opt": "2023-04-15T10:30:00Z",
"member_rating": 4,
"last_changed": "2023-04-20T14:45:00Z",
"language": "en",
"vip": false,
"email_client": "Gmail",
"location": \{
"latitude": 37.7749,
"longitude": -122.4194,
"country_code": "US",
"timezone": "America/Los_Angeles"
\},
"source": "Website",
"tags_count": 2,
"list_id": "abc123def456"
}
],
"total_items": 1
},
"full_search": \{
"members": [],
"total_items": 0
\},
"_links": [
\{
"rel": "self",
"href": "https://us1.api.mailchimp.com/3.0/search-members",
"method": "GET"
\}
]
}
Update ecommerce store
Update a store. Sample Input Sample Output
{
"id": "store123",
"list_id": "abc123def456",
"name": "My Updated Online Shop",
"platform": "Shopify",
"domain": "myupdatedonlineshop.com",
"is_syncing": true,
"email_address": "contact@myupdatedonlineshop.com",
"currency_code": "USD",
"money_format": "$",
"primary_locale": "en",
"timezone": "America/New_York",
"phone": "+1 (555) 123-4567",
"address": \{
"address1": "123 Main St",
"address2": "Suite 456",
"city": "New York",
"province": "New York",
"province_code": "NY",
"postal_code": "10001",
"country": "United States",
"country_code": "US",
"longitude": -73.9857,
"latitude": 40.7484
\},
"connected_site": {
"site_foreign_id": "shopify_12345",
"site_script": {
"url": "https://chimpstatic.com/mcjs-connected/js/users/abc123def456/store123.js",
"fragment": "<script id=\"mcjs\">!function(c,h,i,m,p)\{m=c.createElement(h),p=c.getElementsByTagName(h)[0],m.async=1,m.src=i,p.parentNode.insertBefore(m,p)\}(document,\"script\",\"https://chimpstatic.com/mcjs-connected/js/users/abc123def456/store123.js\");</script>"
}
},
"automations": {
"abandoned_cart": \{
"is_supported": true,
"id": "abc123",
"status": "sending"
\},
"abandoned_browse": \{
"is_supported": true,
"id": "def456",
"status": "paused"
\}
},
"list_is_active": true,
"created_at": "2023-01-15T10:00:00+00:00",
"updated_at": "2023-06-20T14:30:00+00:00",
"_links": [
\{
"rel": "self",
"href": "https://us1.api.mailchimp.com/3.0/ecommerce/stores/store123",
"method": "GET",
"targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Definitions/Ecommerce/Stores/Response.json"
\},
\{
"rel": "parent",
"href": "https://us1.api.mailchimp.com/3.0/ecommerce/stores",
"method": "GET",
"targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Definitions/Ecommerce/Stores/CollectionResponse.json",
"schema": "https://us1.api.mailchimp.com/schema/3.0/Paths/Ecommerce/Stores/Collection.json"
\}
]
}
Update order
Update a specific order. Sample Input
{
"store_id": "store123",
"order_id": "order456",
"currency_code": "USD",
"order_total": 89.99,
"lines": [
\{
"id": "line789",
"product_id": "prod101",
"product_variant_id": "var202",
"quantity": 2,
"price": 39.99,
"discount": 5
\}
],
"customer": \{
"id": "cust303",
"email_address": "john.doe@example.com",
"opt_in_status": true,
"first_name": "John",
"last_name": "Doe"
\},
"campaign_id": "camp404",
"financial_status": "paid",
"fulfillment_status": "shipped",
"order_url": "https://mystore.com/orders/order456",
"discount_total": 5,
"tax_total": 7.2,
"shipping_total": 7.8,
"processed_at_foreign": "2023-06-15T14:30:00Z",
"updated_at_foreign": "2023-06-15T15:00:00Z",
"shipping_address": \{
"name": "John Doe",
"address1": "123 Main St",
"city": "Anytown",
"province": "California",
"province_code": "CA",
"postal_code": "12345",
"country": "United States",
"country_code": "US"
\}
}
Sample Output
{
"id": "order456",
"customer": {
"id": "cust303",
"email_address": "john.doe@example.com",
"opt_in_status": true,
"first_name": "John",
"last_name": "Doe",
"orders_count": 5,
"total_spent": 450.75,
"address": \{
"address1": "123 Main St",
"city": "Anytown",
"province": "California",
"province_code": "CA",
"postal_code": "12345",
"country": "United States",
"country_code": "US"
\},
"created_at": "2023-01-01T10:00:00Z",
"updated_at": "2023-06-15T15:00:00Z"
},
"store_id": "store123",
"campaign_id": "camp404",
"financial_status": "paid",
"fulfillment_status": "shipped",
"currency_code": "USD",
"order_total": 89.99,
"order_url": "https://mystore.com/orders/order456",
"discount_total": 5,
"tax_total": 7.2,
"shipping_total": 7.8,
"processed_at_foreign": "2023-06-15T14:30:00Z",
"updated_at_foreign": "2023-06-15T15:00:00Z",
"shipping_address": \{
"name": "John Doe",
"address1": "123 Main St",
"city": "Anytown",
"province": "California",
"province_code": "CA",
"postal_code": "12345",
"country": "United States",
"country_code": "US"
\},
"lines": [
\{
"id": "line789",
"product_id": "prod101",
"product_title": "Sample Product",
"product_variant_id": "var202",
"product_variant_title": "Large",
"image_url": "https://mystore.com/images/sample-product.jpg",
"quantity": 2,
"price": 39.99,
"discount": 5
\}
],
"_links": [
\{
"rel": "self",
"href": "https://us1.api.mailchimp.com/3.0/ecommerce/stores/store123/orders/order456",
"method": "GET",
"targetSchema": "https://us1.api.mailchimp.com/schema/3.0/Definitions/Ecommerce/Orders/Response.json"
\}
]
}
Upsert list member
Add or update a list member. Sample Input
{
"list_id": "abc123def456",
"email_address": "johndoe@example.com",
"status": "subscribed",
"email_type": "html",
"merge_fields": [
\{
"key": "FNAME",
"value": "John"
\},
\{
"key": "LNAME",
"value": "Doe"
\}
],
"interests": [
\{
"key": "9a8b7c6d5e",
"value": true
\}
],
"language": "en",
"vip": false,
"location": \{
"latitude": 40.7128,
"longitude": -74.006
\},
"marketing_permissions": [
\{
"marketing_permission_id": "1a2b3c4d5e",
"enabled": true
\}
],
"ip_signup": "192.168.1.1",
"timestamp_signup": "2023-04-15T10:30:00Z"
}
Sample Output
DDL operations
List campaign folders (DDL)
Sample Input Sample Output
{
"folders": [
\{
"id": "12345abcde",
"name": "Newsletter Campaigns",
"count": 5,
"type": "campaign"
\},
\{
"id": "67890fghij",
"name": "Promotional Campaigns",
"count": 3,
"type": "campaign"
\},
\{
"id": "54321klmno",
"name": "Event Campaigns",
"count": 2,
"type": "campaign"
\}
],
"total_items": 3
}
List campaigns (DDL)
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input Sample Output
List currency code (DDL)
Sample Input
{}
Sample Output
[
\{
"value": "USD",
"label": "US Dollar"
\},
\{
"value": "EUR",
"label": "Euro"
\},
\{
"value": "GBP",
"label": "British Pound"
\},
\{
"value": "CAD",
"label": "Canadian Dollar"
\},
\{
"value": "AUD",
"label": "Australian Dollar"
\},
\{
"value": "JPY",
"label": "Japanese Yen"
\},
\{
"value": "CHF",
"label": "Swiss Franc"
\}
]
List ecommerce store IDs (DDL)
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
{}
Sample Output
List interest categories (DDL)
Sample Input
{}
Sample Output
List interests (DDL)
Sample Input Sample Output
[
\{
"id": "a1b2c3d4e5",
"name": "Technology",
"display_order": 1
\},
\{
"id": "f6g7h8i9j0",
"name": "Sports",
"display_order": 2
\},
\{
"id": "k1l2m3n4o5",
"name": "Travel",
"display_order": 3
\},
\{
"id": "p6q7r8s9t0",
"name": "Food & Cooking",
"display_order": 4
\},
\{
"id": "u1v2w3x4y5",
"name": "Fashion",
"display_order": 5
\}
]
List language codes (DDL)
Sample Input
{}
Sample Output
[
\{
"value": "en",
"label": "English"
\},
\{
"value": "es",
"label": "Spanish"
\},
\{
"value": "fr",
"label": "French"
\},
\{
"value": "de",
"label": "German"
\},
\{
"value": "it",
"label": "Italian"
\},
\{
"value": "pt",
"label": "Portuguese"
\},
\{
"value": "ja",
"label": "Japanese"
\},
\{
"value": "zh",
"label": "Chinese"
\},
\{
"value": "ru",
"label": "Russian"
\},
\{
"value": "ar",
"label": "Arabic"
\}
]
List list merge fields (DDL)
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
{}
Sample Output
{
"merge_fields": [
{
"merge_id": 1,
"tag": "FNAME",
"name": "First Name",
"type": "text",
"required": false,
"default_value": "",
"public": true,
"display_order": 1,
"options": {
"size": 25
},
"help_text": "",
"list_id": "abc123def456"
},
{
"merge_id": 2,
"tag": "LNAME",
"name": "Last Name",
"type": "text",
"required": false,
"default_value": "",
"public": true,
"display_order": 2,
"options": {
"size": 25
},
"help_text": "",
"list_id": "abc123def456"
},
{
"merge_id": 3,
"tag": "BIRTHDAY",
"name": "Birthday",
"type": "date",
"required": false,
"default_value": "",
"public": true,
"display_order": 3,
"options": {
"date_format": "MM/DD"
},
"help_text": "Please enter your birthday",
"list_id": "abc123def456"
}
],
"total_items": 3
}
List list segments (DDL)
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
{}
Sample Output
List lists (DDL)
Sample Input
{}
Sample Output