Campaigns 10 endpoints

POST /campaigns/{campaign_id}/actions/test Send test email

Send a test email.

operationId: Campaigns_sendTestEmail

Parameters

Name	In	Required	Type	Description
campaign_id	path	required	string	The unique id for the campaign.

Request Body

required

application/json

schema CampaignsSendTestEmailRequest

Property	Type	Required
send_type	string	required
test_emails	array	required

Responses

default

An error generated by the Mailchimp API.

204

Empty Response

POST /campaigns/{campaign_id}/actions/test

POST /campaigns/{campaign_id}/actions/unschedule Unschedule campaign

Unschedule a scheduled campaign that hasn’t started sending.

operationId: Campaigns_unscheduleAction

Parameters

Name	In	Required	Type	Description
campaign_id	path	required	string	The unique id for the campaign.

Responses

default

An error generated by the Mailchimp API.

204

Empty Response

POST /campaigns/{campaign_id}/actions/unschedule

GET /campaigns/{campaign_id}/content Get campaign content

Get the the HTML and plain-text content for a campaign.

operationId: Campaigns_getContent

Parameters

Name	In	Required	Type	Description
fields	query	optional	array	A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fields	query	optional	array	A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
campaign_id	path	required	string	The unique id for the campaign.

Responses

default

An error generated by the Mailchimp API.

200 —

GET /campaigns/{campaign_id}/content

PUT /campaigns/{campaign_id}/content Set campaign content

Set the content for a campaign.

operationId: Campaigns_setContent

Parameters

Name	In	Required	Type	Description
campaign_id	path	required	string	The unique id for the campaign.

Request Body

required

application/json

schema CampaignsSetContentRequest

Property	Type	Required
url	string	optional
html	string	optional
archive	object	optional
└ archive_type	string	optional
└ archive_content	string	required
template	object	optional
└ id	integer	required
└ sections	object	optional
plain_text	string	optional
variate_contents	array	optional
└ url	string	optional
└ html	string	optional
└ archive	object	optional
└ archive_type	string	optional
└ archive_content	string	required
└ template	object	optional
└ id	integer	required
└ sections	object	optional
└ plain_text	string	optional
└ content_label	string	required

Responses

default

An error generated by the Mailchimp API.

200 —

PUT /campaigns/{campaign_id}/content

GET /campaigns/{campaign_id}/feedback List campaign feedback

Get team feedback while you’re working together on a Mailchimp campaign.

operationId: Campaigns_listFeedback

Parameters

Name	In	Required	Type	Description
fields	query	optional	array	A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fields	query	optional	array	A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
campaign_id	path	required	string	The unique id for the campaign.

Responses

default

An error generated by the Mailchimp API.

200 —

GET /campaigns/{campaign_id}/feedback

POST /campaigns/{campaign_id}/feedback Add campaign feedback

Add feedback on a specific campaign.

operationId: Campaigns_addFeedback

Parameters

Name	In	Required	Type	Description
campaign_id	path	required	string	The unique id for the campaign.

Request Body

required

application/json

schema CampaignsAddFeedbackRequest

Property	Type	Required
message	string	required
block_id	integer	optional
is_complete	boolean	optional

Responses

default

An error generated by the Mailchimp API.

200 —

POST /campaigns/{campaign_id}/feedback

DELETE /campaigns/{campaign_id}/feedback/{feedback_id} Delete campaign feedback message

Remove a specific feedback message for a campaign.

operationId: Campaigns_removeFeedbackMessage

Parameters

Name	In	Required	Type	Description
campaign_id	path	required	string	The unique id for the campaign.
feedback_id	path	required	string	The unique id for the feedback message.

Responses

default

An error generated by the Mailchimp API.

204

Empty Response

DELETE /campaigns/{campaign_id}/feedback/{feedback_id}

GET /campaigns/{campaign_id}/feedback/{feedback_id} Get campaign feedback message

Get a specific feedback message from a campaign.

operationId: Campaigns_getFeedbackMessage

Parameters

Name	In	Required	Type	Description
fields	query	optional	array	A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fields	query	optional	array	A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
campaign_id	path	required	string	The unique id for the campaign.
feedback_id	path	required	string	The unique id for the feedback message.

Responses

default

An error generated by the Mailchimp API.

200 —

GET /campaigns/{campaign_id}/feedback/{feedback_id}

PATCH /campaigns/{campaign_id}/feedback/{feedback_id} Update campaign feedback message

Update a specific feedback message for a campaign.

operationId: Campaigns_updateFeedbackMessage

Parameters

Name	In	Required	Type	Description
campaign_id	path	required	string	The unique id for the campaign.
feedback_id	path	required	string	The unique id for the feedback message.

Request Body

required

application/json

schema CampaignsUpdateFeedbackMessageRequest

Property	Type	Required
message	string	optional
block_id	integer	optional
is_complete	boolean	optional

Responses

default

An error generated by the Mailchimp API.

200 —

PATCH /campaigns/{campaign_id}/feedback/{feedback_id}

GET /campaigns/{campaign_id}/send-checklist Get campaign send checklist

Review the send checklist for a campaign, and resolve any issues before sending.

operationId: Campaigns_getSendChecklist

Parameters

Name	In	Required	Type	Description
fields	query	optional	array	A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fields	query	optional	array	A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
campaign_id	path	required	string	The unique id for the campaign.

Responses

default

An error generated by the Mailchimp API.

200 —

GET /campaigns/{campaign_id}/send-checklist

Connectedsites 5 endpoints

GET /connected-sites List connected sites

Get all connected sites in an account.

operationId: ConnectedSites_listAll

Parameters

Name	In	Required	Type	Description
fields	query	optional	array	A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fields	query	optional	array	A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
count	query	optional	integer	The number of records to return. Default value is 10. Maximum value is 1000
offset	query	optional	integer	Used for pagination, this it the number of records from a collection to skip. Default value is 0.

Responses

default

An error generated by the Mailchimp API.

200 —

GET /connected-sites

POST /connected-sites Add connected site

Create a new Mailchimp connected site.

operationId: ConnectedSites_createNewMailchimpSite

Request Body

required

application/json

schema ConnectedSitesCreateNewMailchimpSiteRequest

Property	Type	Required
domain	string	required
foreign_id	string	required

Responses

default

An error generated by the Mailchimp API.

200 —

POST /connected-sites

DELETE /connected-sites/{connected_site_id} Delete connected site

Remove a connected site from your Mailchimp account.

operationId: ConnectedSites_removeSite

Parameters

Name	In	Required	Type	Description
connected_site_id	path	required	string	The unique identifier for the site.

Responses

default

An error generated by the Mailchimp API.

204

Empty Response

DELETE /connected-sites/{connected_site_id}

GET /connected-sites/{connected_site_id} Get connected site

Get information about a specific connected site.

operationId: ConnectedSites_getInfo

Parameters

Name	In	Required	Type	Description
fields	query	optional	array	A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fields	query	optional	array	A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
connected_site_id	path	required	string	The unique identifier for the site.

Responses

default

An error generated by the Mailchimp API.

200 —

GET /connected-sites/{connected_site_id}

POST /connected-sites/{connected_site_id}/actions/verify-script-installation Verify connected site script

Verify that the connected sites script has been installed, either via the script URL or fragment.

operationId: ConnectedSites_verifyScriptInstallation

Parameters

Name	In	Required	Type	Description
connected_site_id	path	required	string	The unique identifier for the site.

Responses

default

An error generated by the Mailchimp API.

204

Empty Response

POST /connected-sites/{connected_site_id}/actions/verify-script-installation

Customerjourneys 1 endpoints

POST /customer-journeys/journeys/{journey_id}/steps/{step_id}/actions/trigger Customer Journeys API trigger for a contact

A step trigger in a Customer Journey. To use it, create a starting point or step from the Customer Journey builder in the app using the Customer Journeys API condition. We’ll provide a url during the process that includes the {journey_id} and {step_id}. You’ll then be able to use this endpoint to trigger the condition for the posted contact.

operationId: CustomerJourneys_triggerStepAction

Parameters

Name	In	Required	Type	Description
journey_id	path	required	integer	The id for the Journey.
step_id	path	required	integer	The id for the Step.

Request Body

required

application/json

schema CustomerJourneysTriggerStepActionRequest

Property	Type	Required
email_address	string	required

Responses

default

An error generated by the Mailchimp API.

204

An empty response

POST /customer-journeys/journeys/{journey_id}/steps/{step_id}/actions/trigger

Ecommerce 34 endpoints

GET /ecommerce/orders List account orders

Get information about an account’s orders.

operationId: Ecommerce_listAccountOrders

Parameters

Name	In	Required	Type	Description
fields	query	optional	array	A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fields	query	optional	array	A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
count	query	optional	integer	The number of records to return. Default value is 10. Maximum value is 1000
offset	query	optional	integer	Used for pagination, this it the number of records from a collection to skip. Default value is 0.
campaign_id	query	optional	string	Restrict results to orders with a specific `campaign_id` value.
outreach_id	query	optional	string	Restrict results to orders with a specific `outreach_id` value.
customer_id	query	optional	string	Restrict results to orders made by a specific customer.
has_outreach	query	optional	boolean	Restrict results to orders that have an outreach attached. For example, an email campaign or Facebook ad.

Responses

default

An error generated by the Mailchimp API.

200 —

GET /ecommerce/orders

GET /ecommerce/stores List stores

Get information about all stores in the account.

operationId: Ecommerce_listStores

Parameters

Name	In	Required	Type	Description
fields	query	optional	array	A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fields	query	optional	array	A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
count	query	optional	integer	The number of records to return. Default value is 10. Maximum value is 1000
offset	query	optional	integer	Used for pagination, this it the number of records from a collection to skip. Default value is 0.

Responses

default

An error generated by the Mailchimp API.

200 —

GET /ecommerce/stores

POST /ecommerce/stores Add store

Add a new store to your Mailchimp account.

operationId: Ecommerce_addStoreToMailchimpAccount

Request Body

required

application/json

schema EcommerceAddStoreToMailchimpAccountRequest

Property	Type	Required
id	string	required
name	string	required
phone	string	optional
domain	string	optional
address	object	optional
└ city	string	optional
└ country	string	optional
└ address1	string	optional
└ address2	string	optional
└ latitude	number	optional
└ province	string	optional
└ longitude	number	optional
└ postal_code	string	optional
└ country_code	string	optional
└ province_code	string	optional
list_id	string	required
platform	string	optional
timezone	string	optional
is_syncing	boolean	optional
money_format	string	optional
currency_code	string	required
email_address	string	optional
primary_locale	string	optional

Responses

default

An error generated by the Mailchimp API.

200 —

POST /ecommerce/stores

DELETE /ecommerce/stores/{store_id} Delete store

Delete a store. Deleting a store will also delete any associated subresources, including Customers, Orders, Products, and Carts.

operationId: Ecommerce_deleteStore

Parameters

Name	In	Required	Type	Description
store_id	path	required	string	The store id.

Responses

default

An error generated by the Mailchimp API.

204

Empty Response

DELETE /ecommerce/stores/{store_id}

GET /ecommerce/stores/{store_id} Get store info

Get information about a specific store.

operationId: Ecommerce_getStoreInfo

Parameters

Name	In	Required	Type	Description
fields	query	optional	array	A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fields	query	optional	array	A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
store_id	path	required	string	The store id.

Responses

default

An error generated by the Mailchimp API.

200 —

GET /ecommerce/stores/{store_id}

PATCH /ecommerce/stores/{store_id} Update store

Update a store.

operationId: Ecommerce_updateStore

Parameters

Name	In	Required	Type	Description
store_id	path	required	string	The store id.

Request Body

required

application/json

schema EcommerceUpdateStoreRequest

Property	Type	Required
name	string	optional
phone	string	optional
domain	string	optional
address	object	optional
└ city	string	optional
└ country	string	optional
└ address1	string	optional
└ address2	string	optional
└ latitude	number	optional
└ province	string	optional
└ longitude	number	optional
└ postal_code	string	optional
└ country_code	string	optional
└ province_code	string	optional
platform	string	optional
timezone	string	optional
is_syncing	boolean	optional
money_format	string	optional
currency_code	string	optional
email_address	string	optional
primary_locale	string	optional

Responses

default

An error generated by the Mailchimp API.

200 —

PATCH /ecommerce/stores/{store_id}

GET /ecommerce/stores/{store_id}/carts List carts

Get information about a store’s carts.

operationId: Ecommerce_getStoreCarts

Parameters

Name	In	Required	Type	Description
fields	query	optional	array	A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fields	query	optional	array	A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
count	query	optional	integer	The number of records to return. Default value is 10. Maximum value is 1000
offset	query	optional	integer	Used for pagination, this it the number of records from a collection to skip. Default value is 0.
store_id	path	required	string	The store id.

Responses

default

An error generated by the Mailchimp API.

200 —

GET /ecommerce/stores/{store_id}/carts

POST /ecommerce/stores/{store_id}/carts Add cart

Add a new cart to a store.

operationId: Ecommerce_addCartToStore

Parameters

Name	In	Required	Type	Description
store_id	path	required	string	The store id.

Request Body

required

application/json

schema EcommerceAddCartToStoreRequest

Property	Type	Required
id	string	required
lines	array	required
└ id	string	required
└ price	number	required
└ quantity	integer	required
└ product_id	string	required
└ product_variant_id	string	required
customer	object	required
└ id	string	required
└ address	object	optional
└ city	string	optional
└ country	string	optional
└ address1	string	optional
└ address2	string	optional
└ province	string	optional
└ postal_code	string	optional
└ country_code	string	optional
└ province_code	string	optional
└ company	string	optional
└ last_name	string	optional
└ first_name	string	optional
└ email_address	string	optional
└ opt_in_status	boolean	optional
tax_total	number	optional
campaign_id	string	optional
order_total	number	required
checkout_url	string	optional
currency_code	string	required

Responses

default

An error generated by the Mailchimp API.

200 —

POST /ecommerce/stores/{store_id}/carts

DELETE /ecommerce/stores/{store_id}/carts/{cart_id} Delete cart

Delete a cart.

operationId: Ecommerce_removeCart

Parameters

Name	In	Required	Type	Description
store_id	path	required	string	The store id.
cart_id	path	required	string	The id for the cart.

Responses

default

An error generated by the Mailchimp API.

204

Empty Response

DELETE /ecommerce/stores/{store_id}/carts/{cart_id}

GET /ecommerce/stores/{store_id}/carts/{cart_id} Get cart info

Get information about a specific cart.

operationId: Ecommerce_getCartInfo

Parameters

Name	In	Required	Type	Description
fields	query	optional	array	A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fields	query	optional	array	A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
store_id	path	required	string	The store id.
cart_id	path	required	string	The id for the cart.

Responses

default

An error generated by the Mailchimp API.

200 —

GET /ecommerce/stores/{store_id}/carts/{cart_id}

PATCH /ecommerce/stores/{store_id}/carts/{cart_id} Update cart

Update a specific cart.

operationId: Ecommerce_updateCartById

Parameters

Name	In	Required	Type	Description
store_id	path	required	string	The store id.
cart_id	path	required	string	The id for the cart.

Request Body

required

application/json

schema EcommerceUpdateCartByIdRequest

Property	Type	Required
lines	array	optional
└ price	number	optional
└ quantity	integer	optional
└ product_id	string	optional
└ product_variant_id	string	optional
customer	object	optional
└ address	object	optional
└ city	string	optional
└ country	string	optional
└ address1	string	optional
└ address2	string	optional
└ province	string	optional
└ postal_code	string	optional
└ country_code	string	optional
└ province_code	string	optional
└ company	string	optional
└ last_name	string	optional
└ first_name	string	optional
└ opt_in_status	boolean	optional
tax_total	number	optional
campaign_id	string	optional
order_total	number	optional
checkout_url	string	optional
currency_code	string	optional

Responses

default

An error generated by the Mailchimp API.

200 —

PATCH /ecommerce/stores/{store_id}/carts/{cart_id}

GET /ecommerce/stores/{store_id}/carts/{cart_id}/lines List cart line items

Get information about a cart’s line items.

operationId: Ecommerce_listCartLines

Parameters

Name	In	Required	Type	Description
fields	query	optional	array	A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fields	query	optional	array	A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
count	query	optional	integer	The number of records to return. Default value is 10. Maximum value is 1000
offset	query	optional	integer	Used for pagination, this it the number of records from a collection to skip. Default value is 0.
store_id	path	required	string	The store id.
cart_id	path	required	string	The id for the cart.

Responses

default

An error generated by the Mailchimp API.

200 —

GET /ecommerce/stores/{store_id}/carts/{cart_id}/lines

POST /ecommerce/stores/{store_id}/carts/{cart_id}/lines Add cart line item

Add a new line item to an existing cart.

operationId: Ecommerce_addCartLineItem

Parameters

Name	In	Required	Type	Description
store_id	path	required	string	The store id.
cart_id	path	required	string	The id for the cart.

Request Body

required

application/json

schema EcommerceAddCartLineItemRequest

Property	Type	Required
id	string	required
price	number	required
quantity	integer	required
product_id	string	required
product_variant_id	string	required

Responses

default

An error generated by the Mailchimp API.

200 —

POST /ecommerce/stores/{store_id}/carts/{cart_id}/lines

DELETE /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id} Delete cart line item

Delete a specific cart line item.

operationId: Ecommerce_deleteCartLineItem

Parameters

Name	In	Required	Type	Description
store_id	path	required	string	The store id.
cart_id	path	required	string	The id for the cart.
line_id	path	required	string	The id for the line item of a cart.

Responses

default

An error generated by the Mailchimp API.

204

Empty Response

DELETE /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id}

GET /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id} Get cart line item

Get information about a specific cart line item.

operationId: Ecommerce_getCartLineItem

Parameters

Name	In	Required	Type	Description
fields	query	optional	array	A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fields	query	optional	array	A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
store_id	path	required	string	The store id.
cart_id	path	required	string	The id for the cart.
line_id	path	required	string	The id for the line item of a cart.

Responses

default

An error generated by the Mailchimp API.

200 —

GET /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id}

PATCH /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id} Update cart line item

Update a specific cart line item.

operationId: Ecommerce_updateCartLineItem

Parameters

Name	In	Required	Type	Description
store_id	path	required	string	The store id.
cart_id	path	required	string	The id for the cart.
line_id	path	required	string	The id for the line item of a cart.

Request Body

required

application/json

schema EcommerceUpdateCartLineItemRequest

Property	Type	Required
price	number	optional
quantity	integer	optional
product_id	string	optional
product_variant_id	string	optional

Responses

default

An error generated by the Mailchimp API.

200 —

PATCH /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id}

GET /ecommerce/stores/{store_id}/customers List customers

Get information about a store’s customers.

operationId: Ecommerce_getStoreCustomers

Parameters

Name	In	Required	Type	Description
fields	query	optional	array	A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fields	query	optional	array	A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
count	query	optional	integer	The number of records to return. Default value is 10. Maximum value is 1000
offset	query	optional	integer	Used for pagination, this it the number of records from a collection to skip. Default value is 0.
store_id	path	required	string	The store id.
email_address	query	optional	string	Restrict the response to customers with the email address.

Responses

default

An error generated by the Mailchimp API.

200 —

GET /ecommerce/stores/{store_id}/customers

POST /ecommerce/stores/{store_id}/customers Add customer

Add a new customer to a store.

operationId: Ecommerce_addCustomerToStore

Parameters

Name	In	Required	Type	Description
store_id	path	required	string	The store id.

Request Body

required

application/json

schema EcommerceAddCustomerToStoreRequest

Property	Type	Required
id	string	required
address	object	optional
└ city	string	optional
└ country	string	optional
└ address1	string	optional
└ address2	string	optional
└ province	string	optional
└ postal_code	string	optional
└ country_code	string	optional
└ province_code	string	optional
company	string	optional
last_name	string	optional
first_name	string	optional
email_address	string	required
opt_in_status	boolean	required

Responses

default

An error generated by the Mailchimp API.

200 —

POST /ecommerce/stores/{store_id}/customers

DELETE /ecommerce/stores/{store_id}/customers/{customer_id} Delete customer

Delete a customer from a store.

operationId: Ecommerce_removeCustomer

Parameters

Name	In	Required	Type	Description
store_id	path	required	string	The store id.
customer_id	path	required	string	The id for the customer of a store.

Responses

default

An error generated by the Mailchimp API.

204

Empty Response

DELETE /ecommerce/stores/{store_id}/customers/{customer_id}

GET /ecommerce/stores/{store_id}/customers/{customer_id} Get customer info

Get information about a specific customer.

operationId: Ecommerce_getCustomerInfo

Parameters

Name	In	Required	Type	Description
fields	query	optional	array	A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fields	query	optional	array	A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
store_id	path	required	string	The store id.
customer_id	path	required	string	The id for the customer of a store.

Responses

default

An error generated by the Mailchimp API.

200 —

GET /ecommerce/stores/{store_id}/customers/{customer_id}

PATCH /ecommerce/stores/{store_id}/customers/{customer_id} Update customer

Update a customer.

operationId: Ecommerce_updateCustomer

Parameters

Name	In	Required	Type	Description
store_id	path	required	string	The store id.
customer_id	path	required	string	The id for the customer of a store.

Request Body

required

application/json

schema EcommerceUpdateCustomerRequest

Property	Type	Required
address	object	optional
└ city	string	optional
└ country	string	optional
└ address1	string	optional
└ address2	string	optional
└ province	string	optional
└ postal_code	string	optional
└ country_code	string	optional
└ province_code	string	optional
company	string	optional
last_name	string	optional
first_name	string	optional
opt_in_status	boolean	optional

Responses

default

An error generated by the Mailchimp API.

200 —

PATCH /ecommerce/stores/{store_id}/customers/{customer_id}

PUT /ecommerce/stores/{store_id}/customers/{customer_id} Add or update customer

Add or update a customer.

operationId: Ecommerce_addOrUpdateCustomer

Parameters

Name	In	Required	Type	Description
store_id	path	required	string	The store id.
customer_id	path	required	string	The id for the customer of a store.

Request Body

required

application/json

schema EcommerceAddOrUpdateCustomerRequest

Property	Type	Required
id	string	required
address	object	optional
└ city	string	optional
└ country	string	optional
└ address1	string	optional
└ address2	string	optional
└ province	string	optional
└ postal_code	string	optional
└ country_code	string	optional
└ province_code	string	optional
company	string	optional
last_name	string	optional
first_name	string	optional
email_address	string	required
opt_in_status	boolean	required

Responses

default

An error generated by the Mailchimp API.

200 —

PUT /ecommerce/stores/{store_id}/customers/{customer_id}

GET /ecommerce/stores/{store_id}/orders List orders

Get information about a store’s orders.

operationId: Ecommerce_listStoreOrders

Parameters

Name	In	Required	Type	Description
fields	query	optional	array	A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fields	query	optional	array	A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
count	query	optional	integer	The number of records to return. Default value is 10. Maximum value is 1000
offset	query	optional	integer	Used for pagination, this it the number of records from a collection to skip. Default value is 0.
store_id	path	required	string	The store id.
customer_id	query	optional	string	Restrict results to orders made by a specific customer.
has_outreach	query	optional	boolean	Restrict results to orders that have an outreach attached. For example, an email campaign or Facebook ad.
campaign_id	query	optional	string	Restrict results to orders with a specific `campaign_id` value.
outreach_id	query	optional	string	Restrict results to orders with a specific `outreach_id` value.

Responses

default

An error generated by the Mailchimp API.

200 —

GET /ecommerce/stores/{store_id}/orders

POST /ecommerce/stores/{store_id}/orders Add order

Add a new order to a store.

operationId: Ecommerce_addOrderToStore

Parameters

Name	In	Required	Type	Description
store_id	path	required	string	The store id.

Request Body

required

application/json

schema EcommerceAddOrderToStoreRequest

Property	Type	Required
id	string	required
lines	array	required
└ id	string	required
└ price	number	required
└ discount	number	optional
└ quantity	integer	required
└ product_id	string	required
└ product_variant_id	string	required
promos	array	optional
└ code	string	required
└ type	string	required
└ amount_discounted	number	required
customer	object	required
└ id	string	required
└ address	object	optional
└ city	string	optional
└ country	string	optional
└ address1	string	optional
└ address2	string	optional
└ province	string	optional
└ postal_code	string	optional
└ country_code	string	optional
└ province_code	string	optional
└ company	string	optional
└ last_name	string	optional
└ first_name	string	optional
└ email_address	string	optional
└ opt_in_status	boolean	optional
outreach	object	optional
└ id	string	optional
order_url	string	optional
tax_total	number	optional
campaign_id	string	optional
order_total	number	required
landing_site	string	optional
tracking_url	string	optional
currency_code	string	required
tracking_code	string	optional
discount_total	number	optional
shipping_total	number	optional
billing_address	object	optional
└ city	string	optional
└ name	string	optional
└ phone	string	optional
└ company	string	optional
└ country	string	optional
└ address1	string	optional
└ address2	string	optional
└ latitude	number	optional
└ province	string	optional
└ longitude	number	optional
└ postal_code	string	optional
└ country_code	string	optional
└ province_code	string	optional
tracking_number	string	optional
financial_status	string	optional
shipping_address	object	optional
└ city	string	optional
└ name	string	optional
└ phone	string	optional
└ company	string	optional
└ country	string	optional
└ address1	string	optional
└ address2	string	optional
└ latitude	number	optional
└ province	string	optional
└ longitude	number	optional
└ postal_code	string	optional
└ country_code	string	optional
└ province_code	string	optional
tracking_carrier	string	optional
…4 more	object	optional

Responses

default

An error generated by the Mailchimp API.

200 —

POST /ecommerce/stores/{store_id}/orders

DELETE /ecommerce/stores/{store_id}/orders/{order_id} Delete order

Delete an order.

operationId: Ecommerce_deleteOrder

Parameters

Name	In	Required	Type	Description
store_id	path	required	string	The store id.
order_id	path	required	string	The id for the order in a store.

Responses

default

An error generated by the Mailchimp API.

204

Empty Response

DELETE /ecommerce/stores/{store_id}/orders/{order_id}

GET /ecommerce/stores/{store_id}/orders/{order_id} Get order info

Get information about a specific order.

operationId: Ecommerce_getStoreOrderInfo

Parameters

Name	In	Required	Type	Description
fields	query	optional	array	A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fields	query	optional	array	A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
store_id	path	required	string	The store id.
order_id	path	required	string	The id for the order in a store.

Responses

default

An error generated by the Mailchimp API.

200 —

GET /ecommerce/stores/{store_id}/orders/{order_id}

PATCH /ecommerce/stores/{store_id}/orders/{order_id} Update order

Update a specific order.

operationId: Ecommerce_updateSpecificOrder

Parameters

Name	In	Required	Type	Description
store_id	path	required	string	The store id.
order_id	path	required	string	The id for the order in a store.

Request Body

required

application/json

schema EcommerceUpdateSpecificOrderRequest

Property	Type	Required
lines	array	optional
└ price	number	optional
└ discount	number	optional
└ quantity	integer	optional
└ product_id	string	optional
└ product_variant_id	string	optional
promos	array	optional
└ code	string	required
└ type	string	required
└ amount_discounted	number	required
customer	object	optional
└ address	object	optional
└ city	string	optional
└ country	string	optional
└ address1	string	optional
└ address2	string	optional
└ province	string	optional
└ postal_code	string	optional
└ country_code	string	optional
└ province_code	string	optional
└ company	string	optional
└ last_name	string	optional
└ first_name	string	optional
└ opt_in_status	boolean	optional
outreach	object	optional
└ id	string	optional
order_url	string	optional
tax_total	number	optional
campaign_id	string	optional
order_total	number	optional
landing_site	string	optional
tracking_url	string	optional
currency_code	string	optional
tracking_code	string	optional
discount_total	number	optional
shipping_total	number	optional
billing_address	object	optional
└ city	string	optional
└ name	string	optional
└ phone	string	optional
└ company	string	optional
└ country	string	optional
└ address1	string	optional
└ address2	string	optional
└ latitude	number	optional
└ province	string	optional
└ longitude	number	optional
└ postal_code	string	optional
└ country_code	string	optional
└ province_code	string	optional
tracking_number	string	optional
financial_status	string	optional
shipping_address	object	optional
└ city	string	optional
└ name	string	optional
└ phone	string	optional
└ company	string	optional
└ country	string	optional
└ address1	string	optional
└ address2	string	optional
└ latitude	number	optional
└ province	string	optional
└ longitude	number	optional
└ postal_code	string	optional
└ country_code	string	optional
└ province_code	string	optional
tracking_carrier	string	optional
fulfillment_status	string	optional
…3 more	object	optional

Responses

default

An error generated by the Mailchimp API.

200 —

PATCH /ecommerce/stores/{store_id}/orders/{order_id}

GET /ecommerce/stores/{store_id}/orders/{order_id}/lines List order line items

Get information about an order’s line items.

operationId: Ecommerce_getStoreOrderLines

Parameters

Name	In	Required	Type	Description
fields	query	optional	array	A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fields	query	optional	array	A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
count	query	optional	integer	The number of records to return. Default value is 10. Maximum value is 1000
offset	query	optional	integer	Used for pagination, this it the number of records from a collection to skip. Default value is 0.
store_id	path	required	string	The store id.
order_id	path	required	string	The id for the order in a store.

Responses

default

An error generated by the Mailchimp API.

200 —

GET /ecommerce/stores/{store_id}/orders/{order_id}/lines

POST /ecommerce/stores/{store_id}/orders/{order_id}/lines Add order line item

Add a new line item to an existing order.

operationId: Ecommerce_addOrderLineItem

Parameters

Name	In	Required	Type	Description
store_id	path	required	string	The store id.
order_id	path	required	string	The id for the order in a store.

Request Body

required

application/json

schema EcommerceAddOrderLineItemRequest

Property	Type	Required
id	string	required
price	number	required
discount	number	optional
quantity	integer	required
product_id	string	required
product_variant_id	string	required

Responses

default

An error generated by the Mailchimp API.

200 —

POST /ecommerce/stores/{store_id}/orders/{order_id}/lines

DELETE /ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id} Delete order line item

Delete a specific order line item.

operationId: Ecommerce_deleteOrderLine

Parameters

Name	In	Required	Type	Description
store_id	path	required	string	The store id.
order_id	path	required	string	The id for the order in a store.
line_id	path	required	string	The id for the line item of an order.

Responses

default

An error generated by the Mailchimp API.

204

Empty Response

DELETE /ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id}

GET /ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id} Get order line item

Get information about a specific order line item.

operationId: Ecommerce_getOrderLineItem

Parameters

Name	In	Required	Type	Description
fields	query	optional	array	A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fields	query	optional	array	A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
store_id	path	required	string	The store id.
order_id	path	required	string	The id for the order in a store.
line_id	path	required	string	The id for the line item of an order.

Responses

default

An error generated by the Mailchimp API.

200 —

GET /ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id}

PATCH /ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id} Update order line item

Update a specific order line item.

operationId: Ecommerce_updateOrderLine

Parameters

Name	In	Required	Type	Description
store_id	path	required	string	The store id.
order_id	path	required	string	The id for the order in a store.
line_id	path	required	string	The id for the line item of an order.

Request Body

required

application/json

schema EcommerceUpdateOrderLineRequest

Property	Type	Required
price	number	optional
discount	number	optional
quantity	integer	optional
product_id	string	optional
product_variant_id	string	optional

Responses

default

An error generated by the Mailchimp API.

200 —

PATCH /ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id}

GET /ecommerce/stores/{store_id}/products List product

Get information about a store’s products.

operationId: Ecommerce_getStoreProducts

Parameters

Name	In	Required	Type	Description
fields	query	optional	array	A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
exclude_fields	query	optional	array	A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
count	query	optional	integer	The number of records to return. Default value is 10. Maximum value is 1000
offset	query	optional	integer	Used for pagination, this it the number of records from a collection to skip. Default value is 0.
store_id	path	required	string	The store id.

Responses

default

An error generated by the Mailchimp API.

200 —

GET /ecommerce/stores/{store_id}/products

POST /ecommerce/stores/{store_id}/products Add product

Add a new product to a store.

operationId: Ecommerce_addProductToStore

Parameters

Name	In	Required	Type	Description
store_id	path	required	string	The store id.

Request Body

required

application/json

schema EcommerceAddProductToStoreRequest

Property	Type	Required
id	string	required
url	string	optional
type	string	optional
title	string	required
handle	string	optional
images	array	optional
└ id	string	required
└ url	string	required
└ variant_ids	array	optional
vendor	string	optional
variants	array	required
└ id	string	required
└ sku	string	optional
└ url	string	optional
└ price	number	optional
└ title	string	required
└ image_url	string	optional
└ backorders	string	optional
└ visibility	string	optional
└ inventory_quantity	integer	optional
image_url	string	optional
description	string	optional
published_at_foreign	string	optional

Responses

default

An error generated by the Mailchimp API.

200 —

POST /ecommerce/stores/{store_id}/products