Overview
Configuration is provided for establishing connections with the Mailchimp service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Manage remote files and directories
Use File Transfer Task to manage remote files and directories.
Demonstration
Quick Start
In this task, we will show you Step-by-Step how-to create a connection to Mailchimp service using COZYROC's REST Connection Manager.
Step 1. Run "Visual Studio" under "Administrator account".
Select "Data Flow task" tab and Click "Add new Data flow task"
Step 2. Right click on "Connection managers" tab and Select "New Connection"
Step 3. In "Add SSIS Connection Manager" Scroll down and Select REST "Connection managers for REST Connection" and Click "Add"
Step 4. From Configuration drop-down menu Select "Mailchimp" and Click New
Step 5. Enter your Mailchimp credentials and Click "Log In"
- Before to use use your credentials be sure you can login to your Mailchimp account from your browser.
Step 6. Save your Mailchimp token file and Click OK
Step 7. Copy Mailchimp generated URL address from the pop-up window.
- In "Server input field" please Enter Mailchimp's provided host server URL address from the previous screen.
- Click Test to test your connection and Click OK
Step 1. Open the right side panel and Drag and Drop "REST Source component"
Step 2. Double click on it and Select "Mailchimp Connection". Select from available Mailchimp resources listed in second drop-down menu.
Step 3. Click on "Columns tab" and Select from Mailchimp available columns.
Step 4. Click Preview to view the columns data. Click OK
Step 5. Drag and drop "OLE DB Destination component" from the left side panel - SSIS Toolbox
Step 6. Right click "Connection managers" Tab and Select "New OLE DB Connection".
Step 7. Select your "Data connection" and click OK
Step 8.Drag the blue arrow to Connect Mailchimp source with OLE DB Destination.
Step 9. Click on "OLE DB Destination component" and Select your "OLE DB connection" and "Table name"
Step 10. Click on "OLE Destination Mapping" tab and Map the columns. Click OK
Step 11. Run the package
Step 1. Open the right side panel and Drag and Drop "OLE DB Source component"
Step 2. Right click on "Connection managers" Tab and Select "New OLE DB Connection"
Step 3 Select your OLE DB connection and table name.
Step 4. Click on "Columns tab" on the left menu and Select "Columns" you want to map
Step 5. Drag and drop "REST Destination component" from the SSIS Toolbox Click on it and Rename to "Mailchimp destination"
Step 6. Drag the blue arrow to Connect OLE DB source with Mailchimp Destination
Step 7. Double click on "Mailchimp destination" component and Select "Mailchimp connection", Action, Resource and Parameters from drop down menu.
Step 8. Click on "Mapping" tab and Map the columns
Step 9. Run the package
Configuration
Base URL address: undefined.
-
The authentication uses an authorized token.
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
OAuth {{=token.Access}}
Documentation: http://developer.mailchimp.com/documentation/mailchimp/guides/how-to-use-oauth2/.
-
Authorization:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/authorized-apps.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/authorized-apps/#read-get_authorized_apps.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- description
Template: LongText.
- users
Template: LongText. A composite field.
- _links
Template: Link. An array field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/automations.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/automations/#read-get_automations.
- id
A key field. Template: ShortText.
- create_time
Template: DateTime.
- start_time
Template: DateTime.
- status
Template: ShortText.
- emails_sent
Data type: DT_I4
- recipients
Template: List.
- settings
Field components:
-
Uses template:
ShortText. - Contains the following components: title, from_name, reply_to, use_conversation, to_name, authenticate, auto_footer, inline_css.
-
Uses template:
- tracking
Template: TrackingT.
- trigger_settings
Template: TriggerSettings.
- report_summary
Template: CampaignSummary. A read-only field.
- _links
Template: Link. An array field.
- emails
-
An array field. The value is gathered from
/automations/{{=item.id}}/emailsaddress. Field components:-
Uses template:
ShortText. - Contains the following components: id, workflow_id, position, delay, create_time, start_time, archive_url, status, emails_sent, send_time, content_type, recipients, settings, tracking, social_card, trigger_settings, report_summary, _links, queue.
Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/automations/emails/.
-
Uses template:
- removed-subscribers
-
The value is gathered from
/automations/{{=item.id}}/removed-subscribersaddress. The gathered value is processed with{{=response.subscribers}}expression. Field components:-
Uses template:
ShortText. - Contains the following components: id, workflow_id, list_id, email_address, _links.
Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/automations/removed-subscribers/.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/batches.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/batches/#read-get_batches.
- [Create] action
-
Endpoint URL address:
/batches.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/batches/#create-post_batches.
- [Delete] action
-
Endpoint URL address:
/batches/{{=item.id}}.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/batches/#delete-delete_batches_batch_id.
- id
A key field. Template: ShortText.
- status
Template: ShortText. A read-only field.
- total_operations
Data type: DT_I4 A read-only field.
- finished_operations
Data type: DT_I4 A read-only field.
- errored_operations
Data type: DT_I4 A read-only field.
- submitted_at
Template: DateTime. A read-only field.
- completed_at
Template: DateTime. A read-only field.
- response_body_url
Template: ShortText. A read-only field.
- _links
Template: Link. An array field. A read-only field.
- operations
An array field. Field components:
-
Uses template:
ShortText. - Contains the following components: method, path, params, body, operation_id.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/batch-webhooks.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/batch-webhooks/#read-get_batch_webhooks.
- [Create] action
-
Endpoint URL address:
/batch-webhooks.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/batch-webhooks/#create-post_batch_webhooks.
- [Update] action
-
Endpoint URL address:
/batch-webhooks/{{=item.id}}.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/batch-webhooks/#edit-patch_batch_webhooks_batch_webhook_id.
- [Delete] action
-
Endpoint URL address:
/batch-webhooks/{{=item.id}}.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/batch-webhooks/#delete-delete_batch_webhooks_batch_webhook_id.
- id
A key field. Template: ShortText.
- url
Template: ShortText.
- _links
Template: Link. An array field. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/campaign-folders.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/campaign-folders/#read-get_campaign_folders.
- [Create] action
-
Endpoint URL address:
/campaign-folders.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/campaign-folders/#create-post_campaign_folders.
- [Update] action
-
Endpoint URL address:
/campaign-folders/{{=item.id}}.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/campaign-folders/#edit-patch_campaign_folders_folder_id.
- [Delete] action
-
Endpoint URL address:
/campaign-folders/{{=item.id}}.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/campaign-folders/#delete-delete_campaign_folders_folder_id.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- count
Data type: DT_I4 A read-only field.
- _links
Template: Link. An array field. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/campaigns.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/campaigns/#read-get_campaigns.
- [Read search] action
-
Endpoint URL address:
/search-campaigns.
The result is extracted from:{{=_.pluck(response.results, 'campaign')}}.The action has the following user-defined parameters:
- search: Required. Specify search query (alias for "query").
The following request parameters will be automatically processed:
-
query:
{{=parameters.search}}
Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/search-campaigns/.
- [Create] action
-
Endpoint URL address:
/campaigns.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/campaigns/#create-post_campaigns.
- [Update] action
-
Endpoint URL address:
/campaigns/{{=item.id}}.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/campaigns/#edit-patch_campaigns_campaign_id.
- [Delete] action
-
Endpoint URL address:
/campaigns/{{=item.id}}.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/campaigns/#delete-delete_campaigns_campaign_id.
- id
A key field. Template: ShortText.
- web_id
Data type: DT_I4 A read-only field.
- type
Template: ShortText.
- create_time
Template: DateTime. A read-only field.
- archive_url
Template: ShortText. A read-only field.
- long_archive_url
Template: ShortText. A read-only field.
- status
Template: ShortText. A read-only field.
- emails_sent
Data type: DT_I4 A read-only field.
- send_time
Template: DateTime. A read-only field.
- content_type
Template: ShortText. A read-only field.
- recipients
Template: List.
- settings
Template: CampaignSettings.
- variate_settings
Field components:
-
Uses template:
ShortText. - Contains the following components: winning_combination_id, winning_campaign_id, winner_criteria, wait_time, test_size, subject_lines, send_times, from_names, reply_to_addresses, contents, combinations.
-
Uses template:
- tracking
Template: TrackingT.
- rss_opts
Field components:
-
Uses template:
ShortText. - Contains the following components: feed_url, frequency, schedule, last_sent, constrain_rss_img.
-
Uses template:
- ab_split_opts
Field components:
-
Uses template:
ShortText. - Contains the following components: split_test, pick_winner, wait_units, wait_time, split_size, from_name_a, from_name_b, reply_email_a, reply_email_b, subject_a, subject_b, send_time_a, send_time_b, send_time_winner.
-
Uses template:
- social_card
Template: SocialCard.
- report_summary
Template: CampaignSummary. A read-only field.
- delivery_status
A read-only field. Field components:
-
Uses template:
ShortText. - Contains the following components: enabled, can_cancel, status, emails_sent, emails_canceled.
-
Uses template:
- _links
Template: Link. An array field. A read-only field.
- content
-
The value is gathered from
/campaigns/{{=item.id}}/contentaddress. The value is sent to/campaigns/{{=item.id}}/contentaddress. Field components:-
Uses template:
LongText. - Contains the following components: variate_contents, plain_text, html, archive_html, _links, url, template, archive.
Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/campaigns/content/.
-
Uses template:
- feedback
-
Template: FeedbackT. A read-only field. The value is gathered from
/campaigns/{{=item.id}}/feedbackaddress.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/campaigns/feedback/.
- send-checklist
A read-only field. The value is gathered from
/campaigns/{{=item.id}}/send-checklistaddress. The gathered value is processed with{{=response.items}}expression. Field components:-
Uses template:
ShortText. - Contains the following components: id, type, heading, details.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/campaigns/{{=parameters.campaign_id}}/feedback.The action has the following user-defined parameters:
- campaign_id: Required. Specify campaign identifier.
Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/campaigns/feedback/#read-get_campaigns_campaign_id_feedback.
- [Create] action
-
Endpoint URL address:
/campaigns/{{=item.campaign_id}}/feedback.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/campaigns/feedback/#create-post_campaigns_campaign_id_feedback.
- [Update] action
-
Endpoint URL address:
/campaigns/{{=item.campaign_id}}/feedback/{{=item.feedback_id}}.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/campaigns/feedback/#edit-patch_campaigns_campaign_id_feedback_feedback_id.
- [Delete] action
-
Endpoint URL address:
/campaigns/{{=item.campaign_id}}/feedback/{{=item.feedback_id}}.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/campaigns/feedback/#delete-delete_campaigns_campaign_id_feedback_feedback_id.
The resource includes the fields from the FeedbackT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/conversations.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/conversations/#read-get_conversations.
- id
A key field. Template: ShortText.
- message_count
Data type: DT_I4
- campaign_id
Template: ShortText.
- list_id
Template: ShortText.
- unread_messages
Data type: DT_I4
- from_label
Template: ShortText.
- from_email
Template: ShortText.
- subject
Template: ShortText.
- last_message
Template: Message.
- _links
Template: Link. An array field. A read-only field.
- messages
-
Template: Message. An array field. The value is gathered from
/conversations/{{=item.id}}/messagesaddress. The gathered value is processed with{{=response.conversation_messages}}expression.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/conversations/messages/.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/conversations/{{=parameters.conversation_id}}/messages.The action has the following user-defined parameters:
- conversation_id: Required. Specify conversation identifier.
Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/conversations/messages/#read-get_conversations_conversation_id_messages.
- [Create] action
-
Endpoint URL address:
/conversations/{{=item.conversation_id}}/messages.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/conversations/messages/#create-post_conversations_conversation_id_messages.
The resource includes the fields from the Message template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/ecommerce/stores.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/ecommerce/stores/#read-get_ecommerce_stores.
- [Create] action
-
Endpoint URL address:
/ecommerce/stores.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/ecommerce/stores/#create-post_ecommerce_stores.
- [Update] action
-
Endpoint URL address:
/ecommerce/stores/{=item.id}}.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/ecommerce/stores/#edit-patch_ecommerce_stores_store_id.
- [Delete] action
-
Endpoint URL address:
/ecommerce/stores/{=item.id}}.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/ecommerce/stores/#delete-delete_ecommerce_stores_store_id.
- id
A key field. Template: ShortText.
- list_id
Template: ShortText. A read-only field.
- name
Template: ShortText.
- platform
Template: ShortText.
- domain
Template: ShortText.
- is_syncing
Data type: DT_BOOL
- email_address
Template: ShortText.
- currency_code
Template: ShortText.
- money_format
Template: ShortText.
- primary_locale
Template: ShortText.
- timezone
Template: ShortText.
- phone
Template: ShortText.
- address
Template: AddressT.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- _links
Template: Link. An array field. A read-only field.
- carts
-
Template: Cart. An array field. A read-only field. The value is gathered from
/ecommerce/stores/{{=item.id}}/cartsaddress.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/ecommerce/stores/carts/.
- customers
-
Template: CustomerT. An array field. A read-only field. The value is gathered from
/ecommerce/stores/{{=item.id}}/customersaddress.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/ecommerce/stores/customers/.
- orders
-
Template: Order. An array field. A read-only field. The value is gathered from
/ecommerce/stores/{{=item.id}}/ordersaddress.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/ecommerce/stores/orders/.
- products
-
Template: Product. An array field. A read-only field. The value is gathered from
/ecommerce/stores/{{=item.id}}/productsaddress.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/ecommerce/stores/products/.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/ecommerce/stores/{{=parameters.store_id}}/carts.The action has the following user-defined parameters:
- store_id: Required. Specify store identifier.
Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/ecommerce/stores/carts/#read-get_ecommerce_stores_store_id_carts.
- [Create] action
-
Endpoint URL address:
/ecommerce/stores/{{=item.store_id}}/carts.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/ecommerce/stores/carts/#create-post_ecommerce_stores_store_id_carts.
- [Update] action
-
Endpoint URL address:
/ecommerce/stores/{{=item.store_id}}/carts/{{=item.id}}.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/ecommerce/stores/carts/#edit-patch_ecommerce_stores_store_id_carts_cart_id.
- [Delete] action
-
Endpoint URL address:
/ecommerce/stores/{{=item.store_id}}/carts/{{=item.id}}.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/ecommerce/stores/carts/#delete-delete_ecommerce_stores_store_id_carts_cart_id.
The resource includes the fields from the Cart template.
- store_id
A key field. Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/ecommerce/stores/{{=parameters.store_id}}/carts/{{=parameters.cart_id}}/lines.The action has the following user-defined parameters:
- store_id: Required. Specify store identifier.
- cart_id: Required. Specify cart identifier.
- [Create] action
-
Endpoint URL address:
/ecommerce/stores/{{=item.store_id}}/carts/{{=item.cart_id}}/lines.
- [Update] action
-
Endpoint URL address:
/ecommerce/stores/{{=item.store_id}}/carts/{{=item.cart_id}}/lines/{{=item.id}}.
- [Delete] action
-
Endpoint URL address:
/ecommerce/stores/{{=item.store_id}}/carts/{{=item.cart_id}}/lines/{{=item.id}}.
The resource includes the fields from the CartLine template.
- store_id
A key field. Template: ShortText.
- cart_id
A key field. Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/ecommerce/stores/{{=parameters.store_id}}/customers.The action has the following user-defined parameters:
- store_id: Required. Specify store identifier.
Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/ecommerce/stores/customers/#read-get_ecommerce_stores_store_id_customers.
- [Create] action
-
Endpoint URL address:
/ecommerce/stores/{{=item.store_id}}/customers.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/ecommerce/stores/customers/#create-post_ecommerce_stores_store_id_customers.
- [Update] action
-
Endpoint URL address:
/ecommerce/stores/{{=item.store_id}}/customers/{{=item.id}}.
- [Upsert] action
-
Endpoint URL address:
/ecommerce/stores/{{=item.store_id}}/customers/{{=item.id}}.
- [Delete] action
-
Endpoint URL address:
/ecommerce/stores/{{=item.store_id}}/customers/{{=item.id}}.
The resource includes the fields from the CustomerT template.
- store_id
A key field. Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/ecommerce/stores/{{=parameters.store_id}}/orders.The action has the following user-defined parameters:
- store_id: Required. Specify store identifier.
Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/ecommerce/stores/orders/#read-get_ecommerce_stores_store_id_orders.
- [Create] action
-
Endpoint URL address:
/ecommerce/stores/{{=item.store_id}}/orders.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/ecommerce/stores/orders/#create-post_ecommerce_stores_store_id_orders.
- [Update] action
-
Endpoint URL address:
/ecommerce/stores/{{=item.store_id}}/orders/{{=item.id}}.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/ecommerce/stores/orders/#edit-patch_ecommerce_stores_store_id_orders_order_id.
- [Delete] action
-
Endpoint URL address:
/ecommerce/stores/{{=item.store_id}}/orders/{{=item.id}}.
The resource includes the fields from the Order template.
- store_id
A key field. Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/ecommerce/stores/{{=parameters.store_id}}/orders/{{=parameters.order_id}}/lines.The action has the following user-defined parameters:
- store_id: Required. Specify store identifier.
- order_id: Required. Specify order identifier.
- [Create] action
-
Endpoint URL address:
/ecommerce/stores/{{=item.store_id}}/orders/{{=item.order_id}}/lines.
- [Update] action
-
Endpoint URL address:
/ecommerce/stores/{{=item.store_id}}/orders/{{=item.order_id}}/lines/{{=item.id}}.
- [Delete] action
-
Endpoint URL address:
/ecommerce/stores/{{=item.store_id}}/orders/{{=item.order_id}}/lines/{{=item.id}}.
The resource includes the fields from the OrderLine template.
- store_id
A key field. Template: ShortText.
- order_id
A key field. Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/ecommerce/stores/{{=parameters.store_id}}/products.The action has the following user-defined parameters:
- store_id: Required. Specify store identifier.
Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/ecommerce/stores/products/#read-get_ecommerce_stores_store_id_products.
- [Create] action
-
Endpoint URL address:
/ecommerce/stores/{{=item.store_id}}/products.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/ecommerce/stores/products/#create-post_ecommerce_stores_store_id_products.
- [Update] action
-
Endpoint URL address:
/ecommerce/stores/{{=item.store_id}}/products/{{=item.id}}.
- [Delete] action
-
Endpoint URL address:
/ecommerce/stores/{{=item.store_id}}/products/{{=item.id}}.
The resource includes the fields from the Product template.
- store_id
A key field. Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/ecommerce/stores/{{=parameters.store_id}}/products/{{=parameters.product_id}}/images.The action has the following user-defined parameters:
- store_id: Required. Specify store identifier.
- product_id: Required. Specify product identifier.
- [Create] action
-
Endpoint URL address:
/ecommerce/stores/{{=item.store_id}}/products/{{=item.product_id}}/images.
- [Update] action
-
Endpoint URL address:
/ecommerce/stores/{{=item.store_id}}/products/{{=item.product_id}}/images/{{=item.id}}.
- [Delete] action
-
Endpoint URL address:
/ecommerce/stores/{{=item.store_id}}/products/{{=item.product_id}}/images/{{=item.id}}.
The resource includes the fields from the ProductImage template.
- store_id
A key field. Template: ShortText.
- product_id
A key field. Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/ecommerce/stores/{{=parameters.store_id}}/products/{{=parameters.product_id}}/variants.The action has the following user-defined parameters:
- store_id: Required. Specify store identifier.
- product_id: Required. Specify product identifier.
- [Create] action
-
Endpoint URL address:
/ecommerce/stores/{{=item.store_id}}/products/{{=item.product_id}}/variants.
- [Update] action
-
Endpoint URL address:
/ecommerce/stores/{{=item.store_id}}/products/{{=item.product_id}}/variants/{{=item.id}}.
- [Upsert] action
-
Endpoint URL address:
/ecommerce/stores/{{=item.store_id}}/products/{{=item.product_id}}/variants/{{=item.id}}.
- [Delete] action
-
Endpoint URL address:
/ecommerce/stores/{{=item.store_id}}/products/{{=item.product_id}}/variants/{{=item.id}}.
The resource includes the fields from the ProductVariant template.
- store_id
A key field. Template: ShortText.
- product_id
A key field. Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/file-manager/files.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/file-manager/files/#read-get_file_manager_files.
- [Create] action
-
Endpoint URL address:
/file-manager/files.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/file-manager/files/#create-post_file_manager_files.
- [Update] action
-
Endpoint URL address:
/file-manager/files/{{=item.id}}.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/file-manager/files/#edit-patch_file_manager_files_file_id.
- [Delete] action
-
Endpoint URL address:
/file-manager/files/{{=item.id}}.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/file-manager/files/#delete-delete_file_manager_files_file_id.
- id
A key field. Data type: DT_I4
- folder_id
Data type: DT_I4
- type
Template: ShortText. A read-only field.
- name
Template: ShortText.
- full_size_url
Template: ShortText. A read-only field.
- thumbnail_url
Template: ShortText. A read-only field.
- size
Data type: DT_I4 A read-only field.
- created_at
Template: DateTime. A read-only field.
- created_by
Template: ShortText. A read-only field.
- width
Data type: DT_I4 A read-only field.
- height
Data type: DT_I4 A read-only field.
- _links
Template: Link. An array field. A read-only field.
- file_data
Data type: DT_IMAGE The value is gathered from
{{=item.full_size_url}}address. Before setting, the value is processed with{{=!_.isUndefined(value) && getClrType('System.Convert').ToBase64String(value)}}expression.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/file-manager/folders.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/file-manager/folders/#read-get_file_manager_folders.
- [Create] action
-
Endpoint URL address:
/file-manager/folders.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/file-manager/folders/#create-post_file_manager_folders.
- [Update] action
-
Endpoint URL address:
/file-manager/folders/{{=item.id}}.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/file-manager/folders/#edit-patch_file_manager_folders_folder_id.
- [Delete] action
-
Endpoint URL address:
/file-manager/folders/{{=item.id}}.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/file-manager/folders/#delete-delete_file_manager_folders_folder_id.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- file_count
Data type: DT_I4 A read-only field.
- created_at
Template: DateTime. A read-only field.
- created_by
Template: ShortText. A read-only field.
- _links
Template: Link. An array field. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/lists.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/#read-get_lists.
- [Create] action
-
Endpoint URL address:
/lists.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/#create-post_lists.
- [Update] action
-
Endpoint URL address:
/lists/{{=item.id}}.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/#edit-patch_lists_list_id.
- [Delete] action
-
Endpoint URL address:
/lists/{{=item.id}}.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/#delete-delete_lists_list_id.
- id
A key field. Template: ShortText.
- web_id
Data type: DT_I4 A read-only field.
- name
Template: ShortText.
- contact
Field components:
-
Uses template:
ShortText. - Contains the following components: company, address1, address2, city, state, zip, country, phone.
-
Uses template:
- permission_reminder
Template: ShortText.
- use_archive_bar
Data type: DT_BOOL
- campaign_defaults
Field components:
-
Uses template:
ShortText. - Contains the following components: from_name, from_email, subject, language.
-
Uses template:
- notify_on_subscribe
Template: ShortText.
- notify_on_unsubscribe
Template: ShortText.
- date_created
Template: DateTime. A read-only field.
- list_rating
Data type: DT_I4 A read-only field.
- email_type_option
Data type: DT_BOOL
- subscribe_url_short
Template: ShortText. A read-only field.
- subscribe_url_long
Template: ShortText. A read-only field.
- beamer_address
Template: ShortText. A read-only field.
- visibility
Template: ShortText.
- modules
Template: LongText. A read-only field. A composite field.
- stats
A read-only field. Field components:
-
Uses template:
DateTime. - Contains the following components: member_count, unsubscribe_count, cleaned_count, member_count_since_send, unsubscribe_count_since_send, cleaned_count_since_send, campaign_count, campaign_last_sent, merge_field_count, avg_sub_rate, avg_unsub_rate, target_sub_rate, open_rate, click_rate, last_sub_date, last_unsub_date.
-
Uses template:
- _links
Template: Link. An array field. A read-only field.
- activity
-
An array field. A read-only field. The value is gathered from
/lists/{{=item.id}}/activityaddress. Field components:-
Uses template:
DateTime. - Contains the following components: day, emails_sent, unique_opens, recipient_clicks, hard_bounce, soft_bounce, subs, unsubs, other_adds, other_removes, _links.
Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/activity/.
-
Uses template:
- clients
-
An array field. A read-only field. The value is gathered from
/lists/{{=item.id}}/clientsaddress. Field components:-
Uses template:
ShortText. - Contains the following components: client, members.
Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/clients/.
-
Uses template:
- growth-history
-
An array field. A read-only field. The value is gathered from
/lists/{{=item.id}}/growth-historyaddress. The gathered value is processed with{{=response.history}}expression. Field components:-
Uses template:
ShortText. - Contains the following components: list_id, month, existing, imports, optins, _links.
Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/growth-history/.
-
Uses template:
- locations
-
An array field. A read-only field. The value is gathered from
/lists/{{=item.id}}/locationsaddress. Field components:-
Uses template:
ShortText. - Contains the following components: country, cc, percent, total.
Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/locations/.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/lists/{{=parameters.list_id}}/members.The action has the following user-defined parameters:
- list_id: Required. Specify list identifier.
Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/members/#read-get_lists_list_id_members.
- [Read search_exact] action
-
Endpoint URL address:
/search-members.
The result is extracted from:{{=response.exact_matches.members}}.The action has the following user-defined parameters:
- search: Required. Specify search query (alias for "query").
- list_id: Required. Specify list identifier.
The following request parameters will be automatically processed:
-
query:
{{=parameters.search}} -
list_id:
{{=parameters.list_id}}
Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/search-members/.
- [Read search_full] action
-
Endpoint URL address:
/search-members.
The result is extracted from:{{=response.full_search.members}}.The action has the following user-defined parameters:
- search: Required. Specify search query (alias for "query").
- list_id: Required. Specify list identifier.
The following request parameters will be automatically processed:
-
query:
{{=parameters.search}} -
list_id:
{{=parameters.list_id}}
Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/search-members/.
- [Create] action
-
Endpoint URL address:
/lists/{{=parameters.list_id}}.
The result is extracted from:{{=Mailchimp.getActionResult(batch, response.new_members, response.errors)}}.The action has the following user-defined parameters:
- list_id: Required. Specify list identifier.
The following request parameters will be automatically processed:
-
application/json:
{{={ members: batch } }}
Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/.
- [Update] action
-
Endpoint URL address:
/lists/{{=parameters.list_id}}.
The result is extracted from:{{=Mailchimp.getActionResult(batch, response.updated_members, response.errors)}}.
The action uses POST method.The action has the following user-defined parameters:
- list_id: Required. Specify list identifier.
The following request parameters will be automatically processed:
-
application/json:
{{={ members: batch, update_existing: true } }}
Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/.
- [Delete] action
-
Endpoint URL address:
/lists/{{=item.list_id}}/members/{{=item.email_address && md5(item.email_address.toLowerCase())}}.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/members/#delete-delete_lists_list_id_members_subscriber_hash.
- id
A key field. Template: ShortText.
- email_address
A key field. Template: ShortText.
- unique_email_id
Template: ShortText.
- email_type
Template: ShortText.
- status
Template: ShortText.
- unsubscribe_reason
Template: ShortText.
- interests
Template: LongText. A composite field.
- stats
A read-only field. Field components:
- Contains the following components: avg_open_rate, avg_click_rate.
- ip_signup
Template: ShortText. A read-only field.
- timestamp_signup
Template: DateTime. A read-only field.
- ip_opt
Template: ShortText. A read-only field.
- timestamp_opt
Template: DateTime. A read-only field.
- member_rating
Data type: DT_I4 A read-only field.
- last_changed
Template: DateTime. A read-only field.
- language
Template: ShortText.
- vip
Data type: DT_BOOL
- email_client
Template: ShortText. A read-only field.
- location
Template: LocationT.
- last_note
Template: LastNote. A read-only field.
- list_id
A key field. Template: ShortText.
- _links
Template: Link. An array field. A read-only field.
- activity
-
An array field. A read-only field. The value is gathered from
/lists/{{=item.list_id}}/members/{{=item.email_address && md5(item.email_address.toLowerCase())}}/activityaddress. Field components:-
Uses template:
ShortText. - Contains the following components: action, timestamp, url, type, campaign_id, title, parent_campaign.
Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/members/activity/.
-
Uses template:
- goals
-
An array field. A read-only field. The value is gathered from
/lists/{{=item.list_id}}/members/{{=item.email_address && md5(item.email_address.toLowerCase())}}/goalsaddress. Field components:-
Uses template:
ShortText. - Contains the following components: goal_id, event, last_visited_at, data.
Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/members/goals/.
-
Uses template:
- notes
-
Template: MemberNote. An array field. A read-only field. The value is gathered from
/lists/{{=item.list_id}}/members/{{=item.email_address && md5(item.email_address.toLowerCase())}}/notesaddress.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/members/notes/.
- [External]
-
The external fields list is extracted from:
{{=connection.resourceManager['List Merge Field'].getData({ fields: ['tag', 'type', 'options', 'options.size'], batchSize: 100, parameters: ['list_id=' + parameters.list_id] })}}.- merge_fields.{{=external.tag}}
Data type: {{=Mailchimp.getDataType(external.type)}} ( length {{=(external.options && external.options.size) || 255}} )
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/lists/{{=parameters.list_id}}/members/{{=md5(parameters.email_address.toLowerCase())}}/notes.The action has the following user-defined parameters:
- list_id: Required. Specify list identifier.
- email_address: Required. Specify member email address.
Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/members/notes/#read-get_lists_list_id_members_subscriber_hash_notes.
- [Create] action
-
Endpoint URL address:
/lists/{{=item.list_id}}/members/{{=item.email_address && md5(item.email_address.toLowerCase())}}/notes.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/members/notes/#create-post_lists_list_id_members_subscriber_hash_notes.
- [Update] action
-
Endpoint URL address:
/lists/{{=item.list_id}}/members/{{=item.email_address && md5(item.email_address.toLowerCase())}}/notes/{{=item.id}}.
- [Delete] action
-
Endpoint URL address:
/lists/{{=item.list_id}}/members/{{=item.email_address && md5(item.email_address.toLowerCase())}}/notes/{{=item.id}}.
The resource includes the fields from the MemberNote template.
- email_address
A key field. Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/lists/{{=parameters.list_id}}/abuse-reports.The action has the following user-defined parameters:
- list_id: Required. Specify list identifier.
Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/abuse-reports/#read-get_lists_list_id_abuse_reports.
The resource includes the fields from the AbuseReport template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/lists/{{=parameters.list_id}}/interest-categories.The action has the following user-defined parameters:
- list_id: Required. Specify list identifier.
Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/interest-categories/#read-get_lists_list_id_interest_categories.
- [Create] action
-
Endpoint URL address:
/lists/{{=item.list_id}}/interest-categories.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/interest-categories/#create-post_lists_list_id_interest_categories.
- [Update] action
-
Endpoint URL address:
/lists/{{=item.list_id}}/interest-categories/{{=item.id}}.
- [Delete] action
-
Endpoint URL address:
/lists/{{=item.list_id}}/interest-categories/{{=item.id}}.
- id
A key field. Template: ShortText.
- list_id
A key field. Template: ShortText.
- title
Template: ShortText.
- display_order
Data type: DT_I4
- type
Template: ShortText.
- _links
Template: Link. An array field. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/lists/{{=parameters.list_id}}/interest-categories/{{=parameters.category_id}}/interests.The action has the following user-defined parameters:
- list_id: Required. Specify list identifier.
- category_id: Required. Specify category identifier.
Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/interest-categories/interests/.
- [Create] action
-
Endpoint URL address:
/lists/{{=item.list_id}}/interest-categories/{{=item.category_id}}/interests.
- [Update] action
-
Endpoint URL address:
/lists/{{=item.list_id}}/interest-categories/{{=item.category_id}}/interests/{{=item.id}}.
- [Delete] action
-
Endpoint URL address:
/lists/{{=item.list_id}}/interest-categories/{{=item.category_id}}/interests/{{=item.id}}.
- id
A key field. Template: ShortText.
- category_id
A key field. Template: ShortText.
- list_id
A key field. Template: ShortText.
- name
Template: ShortText.
- subscriber_count
Data type: DT_I4 A read-only field.
- display_order
Data type: DT_I4
- _links
Template: Link. An array field. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/lists/{{=parameters.list_id}}/merge-fields.The action has the following user-defined parameters:
- list_id: Required. Specify list identifier.
Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/merge-fields/#read-get_lists_list_id_merge_fields.
- [Create] action
-
Endpoint URL address:
/lists/{{=item.list_id}}/merge-fields.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/merge-fields/#create-post_lists_list_id_merge_fields.
- [Update] action
-
Endpoint URL address:
/lists/{{=item.list_id}}/merge-fields/{{=item.merge_id}}.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/merge-fields/#edit-patch_lists_list_id_merge_fields_merge_id.
- [Delete] action
-
Endpoint URL address:
/lists/{{=item.list_id}}/merge-fields/{{=item.merge_id}}.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/merge-fields/#delete-delete_lists_list_id_merge_fields_merge_id.
- merge_id
A key field. Data type: DT_I4
- list_id
A key field. Template: ShortText.
- tag
Template: ShortText.
- name
Template: ShortText.
- type
Template: ShortText.
- required
Data type: DT_BOOL
- default_value
Template: ShortText.
- public
Data type: DT_BOOL
- display_order
Data type: DT_I4
- options
Field components:
-
Uses template:
ShortText. - Contains the following components: default_country, phone_format, date_format, choices, size.
-
Uses template:
- help_text
Template: ShortText.
- _links
Template: Link. An array field. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/lists/{{=parameters.list_id}}/segments.The action has the following user-defined parameters:
- list_id: Required. Specify list identifier.
Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/segments/#read-get_lists_list_id_segments.
- [Create] action
-
Endpoint URL address:
/lists/{{=item.list_id}}/segments.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/segments/#create-post_lists_list_id_segments.
- [Update] action
-
Endpoint URL address:
/lists/{{=item.list_id}}/segments/{{=item.id}}.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/segments/#edit-patch_lists_list_id_segments_segment_id.
- [Delete] action
-
Endpoint URL address:
/lists/{{=item.list_id}}/segments/{{=item.id}}.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/segments/#delete-delete_lists_list_id_segments_segment_id.
- id
A key field. Data type: DT_I4
- list_id
A key field. Template: ShortText.
- name
Template: ShortText.
- member_count
Data type: DT_I4 A read-only field.
- type
Template: ShortText. A read-only field.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- options
Field components:
-
Uses template:
ShortText. - Contains the following components: match, conditions.
-
Uses template:
- _links
Template: Link. An array field. A read-only field.
- static_segment
Template: LongText. A composite field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/lists/{{=parameters.list_id}}/segments/{{=parameters.segment_id}}/members.The action has the following user-defined parameters:
- list_id: Required. Specify list identifier.
- segment_id: Required. Specify segment identifier.
Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/segments/members/#read-get_lists_list_id_segments_segment_id_members.
- [Create] action
-
Endpoint URL address:
/lists/{{=parameters.list_id}}/segments/{{=parameters.segment_id}}.
The result is extracted from:{{=Mailchimp.getActionResult(batch, response.members_added, response.errors)}}.The action has the following user-defined parameters:
- list_id: Required. Specify list identifier.
- segment_id: Required. Specify segment identifier.
The following request parameters will be automatically processed:
-
application/json:
{{={ members_to_add: _.pluck(batch, 'email_address') } }}
Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/segments/#create-post_lists_list_id_segments.
- [Delete] action
-
Endpoint URL address:
/lists/{{=parameters.list_id}}/segments/{{=parameters.segment_id}}.
The result is extracted from:{{=Mailchimp.getActionResult(batch, response.members_removed, response.errors)}}.The action has the following user-defined parameters:
- list_id: Required. Specify list identifier.
- segment_id: Required. Specify segment identifier.
The following request parameters will be automatically processed:
-
application/json:
{{={ members_to_remove: _.pluck(batch, 'email_address') } }}
Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/segments/#create-post_lists_list_id_segments.
- id
A key field. Template: ShortText.
- segment_id
A key field. Data type: DT_I4
- list_id
A key field. Template: ShortText.
- email_address
A key field. Template: ShortText.
- unique_email_id
Template: ShortText. A read-only field.
- email_type
Template: ShortText. A read-only field.
- status
Template: ShortText. A read-only field.
- interests
Template: LongText. A read-only field. A composite field.
- stats
A read-only field. Field components:
- Contains the following components: avg_open_rate, avg_click_rate.
- ip_signup
Template: ShortText. A read-only field.
- timestamp_signup
Template: DateTime. A read-only field.
- ip_opt
Template: ShortText. A read-only field.
- timestamp_opt
Template: DateTime. A read-only field.
- member_rating
Data type: DT_I4 A read-only field.
- last_changed
Template: DateTime. A read-only field.
- language
Template: ShortText.
- vip
Data type: DT_BOOL
- email_client
Template: ShortText.
- location
Template: LocationT.
- last_note
Template: LastNote. A read-only field.
- [External]
-
The external fields list is extracted from:
{{=connection.resourceManager['List Merge Field'].getData({ fields: ['tag', 'type', 'options', 'options.size'], batchSize: 100, parameters: ['list_id=' + parameters.list_id] })}}.- merge_fields.{{=external.tag}}
Data type: {{=Mailchimp.getDataType(external.type)}} ( length {{=(external.options && external.options.size) || 255}} )
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/lists/{{=parameters.list_id}}/signup-forms.The action has the following user-defined parameters:
- list_id: Required. Specify list identifier.
Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/signup-forms/#read-get_lists_list_id_signup_forms.
- [Create] action
-
Endpoint URL address:
/lists/{{=item.list_id}}/signup-forms.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/signup-forms/#create-post_lists_list_id_signup_forms.
- list_id
A key field. Template: ShortText.
- header
Field components:
-
Uses template:
ShortText. - Contains the following components: image_url, text, image_width, image_height, image_alt, image_link, image_align, image_border_width, image_border_style, image_border_color, image_target.
-
Uses template:
- contents
An array field. Field components:
-
Uses template:
ShortText. - Contains the following components: section, value.
-
Uses template:
- styles
An array field. Field components:
-
Uses template:
ShortText. - Contains the following components: selector, options.
-
Uses template:
- signup_form_url
Template: ShortText.
- _links
Template: Link. An array field. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/lists/{{=parameters.list_id}}/webhooks.The action has the following user-defined parameters:
- list_id: Required. Specify list identifier.
Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/webhooks/#read-get_lists_list_id_webhooks.
- [Create] action
-
Endpoint URL address:
/lists/{{=item.list_id}}/webhooks.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/webhooks/#create-post_lists_list_id_webhooks.
- [Update] action
-
Endpoint URL address:
/lists/{{=item.list_id}}/webhooks/{{=item.id}}.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/webhooks/#edit-patch_lists_list_id_webhooks_webhook_id.
- [Delete] action
-
Endpoint URL address:
/lists/{{=item.list_id}}/webhooks/{{=item.id}}.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/lists/webhooks/#delete-delete_lists_list_id_webhooks_webhook_id.
- id
A key field. Template: ShortText.
- list_id
A key field. Template: ShortText.
- url
Template: ShortText. A read-only field.
- events
Field components:
- Contains the following components: subscribe, unsubscribe, profile, cleaned, upemail, campaign.
- sources
Field components:
- Contains the following components: user, admin, api.
- _links
Template: Link. An array field. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/reports.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/reports/#read-get_reports.
The resource includes the fields from the ReportT template.
- abuse_reports
-
Template: AbuseReport. An array field. The value is gathered from
/reports/{{=item.id}}/abuse-reportsaddress.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/reports/abuse-reports/.
- advice
-
An array field. The value is gathered from
/reports/{{=item.id}}/adviceaddress. Field components:-
Uses template:
ShortText. - Contains the following components: type, message, _links.
Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/reports/advice/.
-
Uses template:
- click-details
-
An array field. The value is gathered from
/reports/{{=item.id}}/click-detailsaddress. The gathered value is processed with{{=response.urls_clicked}}expression. Field components:-
Uses template:
ShortText. - Contains the following components: id, url, total_clicks, click_percentage, unique_clicks, unique_click_percentage, last_click, ab_split, campaign_id, _links, members.
Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/reports/click-details/.
-
Uses template:
- domains
-
An array field. The value is gathered from
/reports/{{=item.id}}/domain-performanceaddress. Field components:-
Uses template:
ShortText. - Contains the following components: domain, emails_sent, bounces, opens, clicks, unsubs, delivered, emails_pct, bounces_pct, opens_pct, clicks_pct, unsubs_pct.
Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/reports/domain-performance/.
-
Uses template:
- eepurl
-
The value is gathered from
/reports/{{=item.id}}/eepurladdress. The gathered value is processed with{{=response}}expression. Field components:-
Uses template:
ShortText. - Contains the following components: eepurl, twitter, clicks, referrers, campaign_id, _links.
Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/reports/eepurl/.
-
Uses template:
- emails
-
An array field. The value is gathered from
/reports/{{=item.id}}/email-activityaddress. Field components:-
Uses template:
ShortText. - Contains the following components: email_id, campaign_id, list_id, email_address, activity, _links.
Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/reports/email-activity/.
-
Uses template:
- locations
-
An array field. The value is gathered from
/reports/{{=item.id}}/locationsaddress. Field components:-
Uses template:
ShortText. - Contains the following components: country_code, region, region_name, opens.
Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/reports/locations/.
-
Uses template:
- sent_to
-
An array field. The value is gathered from
/reports/{{=item.id}}/sent-toaddress. Field components:-
Uses template:
ShortText. - Contains the following components: email_id, campaign_id, list_id, email_address, merge_fields, vip, status, open_count, last_open, absplit_group, gmt_offset, _links.
Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/reports/sent-to/.
-
Uses template:
- reports
-
Template: ReportT. An array field. The value is gathered from
/reports/{{=item.id}}/sub-reportsaddress.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/reports/sub-reports/.
- unsubscribes
-
An array field. The value is gathered from
/reports/{{=item.id}}/unsubscribedaddress. Field components:-
Uses template:
ShortText. - Contains the following components: email_id, campaign_id, list_id, email_address, merge_fields, vip, timestamp, reason, _links.
Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/reports/unsubscribed/.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/template-folders.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/template-folders/#read-get_template_folders.
- [Create] action
-
Endpoint URL address:
/template-folders.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/template-folders/#create-post_template_folders.
- [Update] action
-
Endpoint URL address:
/template-folders/{{=item.id}}.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/template-folders/#edit-patch_template_folders_folder_id.
- [Delete] action
-
Endpoint URL address:
/template-folders/{{=item.id}}.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/template-folders/#delete-delete_template_folders_folder_id.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- count
Data type: DT_I4 A read-only field.
- _links
Template: Link. An array field. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/templates.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/templates/#read-get_templates.
- [Create] action
-
Endpoint URL address:
/templates.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/templates/#create-post_templates.
- [Update] action
-
Endpoint URL address:
/templates/{{=item.id}}.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/templates/#edit-patch_templates_template_id.
- [Delete] action
-
Endpoint URL address:
/templates/{{=item.id}}.Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/templates/#delete-delete_templates_template_id.
- id
A key field. Template: ShortText.
- type
Template: ShortText. A read-only field.
- name
Template: ShortText.
- drag_and_drop
Data type: DT_BOOL A read-only field.
- responsive
Data type: DT_BOOL A read-only field.
- category
Template: ShortText. A read-only field.
- date_created
Template: DateTime. A read-only field.
- created_by
Template: ShortText. A read-only field.
- active
Data type: DT_BOOL A read-only field.
- folder_id
Template: ShortText.
- thumbnail
Template: ShortText. A read-only field.
- share_url
Template: ShortText. A read-only field.
- _links
Template: Link. An array field. A read-only field.
- default-content
-
A read-only field. The value is gathered from
/templates/{{=item.id}}/default-contentaddress. Field components:-
Uses template:
LongText. - Contains the following components: sections, _links.
Documentation: http://developer.mailchimp.com/documentation/mailchimp/reference/templates/default-content/.
-
Uses template:
- html
Template: LongText.
- [Read] action
-
The result is extracted from:{{=response[resource.readList]}}.
The result is paginated.The following request parameters will be automatically processed:
-
fields:
{{=_.map(parameters.fields, function(field) { return resource.readList + '.' + field; }).join()}} -
count:
{{=parameters.batchSize}} -
offset:
{{=parameters.iterator}} -
_includeUserParameters:
{{=parameters}}
-
fields:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Update] action
-
The action uses PATCH method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Upsert] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Delete] action
-
The action uses DELETE method.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Link
Field components:
-
Uses template:
ShortText. - Contains the following components: rel, href, method, targetSchema, schema.
-
Uses template:
- List
Field components:
-
Uses template:
ShortText. - Contains the following components: list_id, list_name, recipient_count, segment_text, segment_opts.
-
Uses template:
- TrackingT
Field components:
-
Uses template:
ShortText. - Contains the following components: opens, html_clicks, text_clicks, goal_tracking, ecomm360, google_analytics, clicktale, salesforce, capsule.
-
Uses template:
- CampaignSummary
Field components:
- Contains the following components: opens, unique_opens, open_rate, clicks, subscriber_clicks, click_rate, ecommerce.
- CampaignSettings
Field components:
-
Uses template:
ShortText. - Contains the following components: subject_line, title, from_name, reply_to, use_conversation, to_name, folder_id, authenticate, auto_footer, inline_css, auto_tweet, auto_fb_post, fb_comments, timewarp, template_id, drag_and_drop.
-
Uses template:
- SocialCard
Field components:
-
Uses template:
ShortText. - Contains the following components: image_url, description, title.
-
Uses template:
- TriggerSettings
Field components:
-
Uses template:
ShortText. - Contains the following components: workflow_type, send_immediately, trigger_on_import, category_name, recurringEvent, workflow_emails_count, workflow_title, merge_field_trigger.
-
Uses template:
- FeedbackT
Field components:
-
Uses template:
LongText. - Contains the following components: feedback_id, parent_id, block_id, message, is_complete, created_by, created_at, updated_at, source, campaign_id, _links.
-
Uses template:
- Message
Field components:
-
Uses template:
ShortText. - Contains the following components: id, conversation_id, list_id, from_label, from_email, subject, message, read, timestamp, _links.
-
Uses template:
- AddressT
Field components:
-
Uses template:
ShortText. - Contains the following components: address1, address2, city, province, province_code, postal_code, country, country_code, longitude, latitude.
-
Uses template:
- CustomerT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, email_address, opt_in_status, company, first_name, last_name, orders_count, total_spent, address, created_at, updated_at, _links.
-
Uses template:
- CartLine
Field components:
-
Uses template:
ShortText. - Contains the following components: id, product_id, product_title, product_variant_id, product_variant_title, quantity, price, _links.
-
Uses template:
- Cart
Field components:
-
Uses template:
ShortText. - Contains the following components: id, customer, campaign_id, checkout_url, currency_code, order_total, tax_total, lines, created_at, updated_at, _links.
-
Uses template:
- OrderLine
Field components:
-
Uses template:
ShortText. - Contains the following components: id, product_id, product_title, product_variant_id, product_variant_title, quantity, price, discount, _links.
-
Uses template:
- Order
Field components:
-
Uses template:
ShortText. - Contains the following components: id, customer, campaign_id, landing_site, financial_status, fulfillment_status, currency_code, order_total, order_url, discount_total, tax_total, shipping_total, tracking_code, processed_at_foreign, cancelled_at_foreign, updated_at_foreign, shipping_address, billing_address, lines, _links.
-
Uses template:
- ProductVariant
Field components:
-
Uses template:
ShortText. - Contains the following components: id, title, url, sku, price, inventory_quantity, image_url, backorders, visibility, created_at, updated_at, _links.
-
Uses template:
- ProductImage
Field components:
-
Uses template:
ShortText. - Contains the following components: id, url, variant_ids, _links.
-
Uses template:
- Product
Field components:
-
Uses template:
ShortText. - Contains the following components: id, title, handle, url, description, type, vendor, image_url, variants, images, published_at_foreign, _links.
-
Uses template:
- MemberNote
Field components:
-
Uses template:
DateTime. - Contains the following components: id, created_at, created_by, updated_at, note, list_id, email_id, _links.
-
Uses template:
- RegularCondition
Field components:
-
Uses template:
ShortText. - Contains the following components: op, field, value.
-
Uses template:
- LocationT
Field components:
-
Uses template:
ShortText. - Contains the following components: latitude, longitude, gmtoff, dstoff, country_code, timezone.
-
Uses template:
- LastNote
Field components:
-
Uses template:
DateTime. - Contains the following components: note_id, created_at, created_by, note.
-
Uses template:
- ABSplit
Field components:
-
Uses template:
DateTime. - Contains the following components: bounces, abuse_reports, unsubs, recipient_clicks, forwards, forwards_opens, opens, last_open, unique_opens.
-
Uses template:
- AbuseReport
Field components:
-
Uses template:
ShortText. - Contains the following components: id, campaign_id, list_id, email_id, email_address, merge_fields, vip, date, _links.
-
Uses template:
- ReportT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, campaign_title, type, list_id, list_name, subject_line, emails_sent, abuse_reports, unsubscribed, send_time, rss_last_send, bounces, forwards, opens, clicks, facebook_likes, industry_stats, list_stats, ab_split, timewarp, timeseries, share_report, ecommerce, delivery_status, _links.
-
Uses template:
What's New
- Fixed: Missing user-defined parameters from
CreateandUpdateactions. - New: Support for address merge fields (Thank you, Hardy).
- Fixed: Only 10 merge fields appeared in 'List Member' resource (Thank you, Jo).
- Fixed: Inserting data into 'List Member' resource failed with error "Index was outside the bounds of the array" when service reported error (Thank you, Steve).
- Fixed: Failed to update data in 'List Member' resource (Thank you, Steve).
- New: Introduced connection.
Related documentation
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.