Mailchimp Ecommerce API
The Ecommerce API from Mailchimp — 10 operation(s) for ecommerce.
Operations 120
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
Ask an LLM
“Can I see every ecommerce order across all the stores in my Mailchimp account at once?”
“Which orders account-wide were attributed to a particular email campaign?”
Tell an agent
List all orders across every store in my account.
Show account-wide orders placed by customer {customer_id} in any store.
Ask an LLM
“Which online stores are connected to my Mailchimp account?”
“How do I get a list of all my ecommerce stores and their settings?”
Tell an agent
List all the ecommerce stores in my account.
Show the first {count} connected stores.
Ask an LLM
“How do I connect a new online store to a Mailchimp audience?”
“What do I need to provide to register a store, like its currency and linked audience?”
Tell an agent
Add a store named {name} with id {id} tied to audience {list_id} using currency {currency_code}.
Register new store {id} called {name} on domain {domain} for audience {list_id} in {currency_code}.
Ask an LLM
“What settings and contact details does a specific connected store have?”
“Can I check which audience and currency one of my stores is using?”
Tell an agent
Show the details of store {store_id}.
Get the currency and domain configured for store {store_id}.
Ask an LLM
“Can I change a connected store's name, domain or timezone after setting it up?”
“How do I mark a store as syncing so automations pause while I import data?”
Tell an agent
Rename store {store_id} to {name}.
Set is_syncing to {is_syncing} on store {store_id}.
Ask an LLM
“What happens to customers, orders and products when I delete a connected store?”
“Can I completely remove a store I no longer sell through?”
Tell an agent destructive · confirm first
Delete store {store_id} along with its customers, orders, products and carts.
Disconnect and remove store {store_id} from my account.
Ask an LLM
“Which shopping carts are currently tracked for my store, including abandoned ones?”
“Can I page through all the carts a store has sent to Mailchimp?”
Tell an agent
List the carts in store {store_id}.
Show {count} carts from store {store_id}.
Ask an LLM
“How do I send a shopper's cart to Mailchimp so abandoned-cart emails can go out?”
“What's required to create a cart record, like the customer, total and line items?”
Tell an agent
Add cart {id} to store {store_id} for customer {customer} totaling {order_total} {currency_code} with lines {lines}.
Create a cart in store {store_id} with checkout link {checkout_url}.
Ask an LLM
“What's in a specific cart, and what's its checkout URL and total?”
“Can I look up a single cart to see which customer it belongs to?”
Tell an agent
Show cart {cart_id} in store {store_id}.
Get the order total for cart {cart_id} from store {store_id}.
Ask an LLM
“Can I update a cart's total or checkout URL after the shopper changes it?”
“How do I attribute an existing cart to a campaign?”
Tell an agent
Set the order total of cart {cart_id} in store {store_id} to {order_total}.
Link existing cart {cart_id} in store {store_id} to campaign {campaign_id}.
Ask an LLM
“Can I remove a cart once the shopper has checked out so no abandoned-cart email fires?”
“Is there a way to delete a stale cart from my store's data?”
Tell an agent destructive · confirm first
Delete cart {cart_id} from store {store_id}.
Remove the abandoned cart {cart_id} in store {store_id}.
GET
/ecommerce/stores/{store_id}/carts/{cart_id}/lines
List a cart's line items · List cart line items
#
Ask an LLM
“Which products and quantities are sitting in a particular cart?”
“Can I list every line item on a shopper's cart?”
Tell an agent
List the line items in cart {cart_id} of store {store_id}.
Show what products are in cart {cart_id} at store {store_id}.
POST
/ecommerce/stores/{store_id}/carts/{cart_id}/lines
Add a line item to a cart · Add cart line item
#
Ask an LLM
“How do I add another product to a cart that already exists?”
“What fields do I need to put a product variant into a shopper's cart?”
Tell an agent
Add {quantity} of variant {product_variant_id} of product {product_id} at {price} to cart {cart_id} in store {store_id} as line {id}.
Put product {product_id} into cart {cart_id} at store {store_id}.
GET
/ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id}
Get one cart line item · Get cart line item
#
Ask an LLM
“What quantity and price does a single line in a cart have?”
“Can I look up one specific line item in a shopper's cart?”
Tell an agent
Show line {line_id} of cart {cart_id} in store {store_id}.
Get the quantity on cart line {line_id} for cart {cart_id}, store {store_id}.
PATCH
/ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id}
Update a cart line item · Update cart line item
#
Ask an LLM
“Can I change the quantity of a product that's already in a cart?”
“How do I update the price on one line of a shopper's cart?”
Tell an agent
Change the quantity of line {line_id} in cart {cart_id}, store {store_id}, to {quantity}.
Set the price of cart line {line_id} in cart {cart_id} at store {store_id} to {price}.
DELETE
/ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id}
Remove a line item from a cart · Delete cart line item
#
Ask an LLM
“Can I take one product out of a cart without deleting the whole cart?”
“What's the way to remove a single line from a shopper's cart?”
Tell an agent destructive · confirm first
Remove line {line_id} from cart {cart_id} in store {store_id}.
Delete cart line item {line_id} on cart {cart_id} at store {store_id}.
Ask an LLM
“Which shoppers are recorded as customers of my store?”
“Can I find a store customer by their email address?”
Tell an agent
List the customers of store {store_id}.
Find the customer with email {email_address} in store {store_id}.
Ask an LLM
“How do I add a new shopper to my store's customer records?”
“Do I have to set an opt-in status when creating a store customer?”
Tell an agent
Add customer {id} with email {email_address} to store {store_id}, opted in {opt_in_status}.
Create a new customer {first_name} {last_name} in store {store_id}.
GET
/ecommerce/stores/{store_id}/customers/{customer_id}
Get one store customer · Get customer info
#
Ask an LLM
“What does my store know about a particular customer, like their name and opt-in status?”
“Can I pull up one customer record by its ID?”
Tell an agent
Show customer {customer_id} in store {store_id}.
Check whether customer {customer_id} of store {store_id} is opted in.
PUT
/ecommerce/stores/{store_id}/customers/{customer_id}
Create or update a store customer (upsert) · Add or update customer
#
Ask an LLM
“Is there a single call that adds a customer if they're new and updates them if they exist?”
“Can I upsert a store customer by ID without checking first?”
Tell an agent
Upsert customer {customer_id} in store {store_id} with email {email_address}.
Add or update store {store_id} customer {customer_id} with id {id}.
PATCH
/ecommerce/stores/{store_id}/customers/{customer_id}
Update an existing store customer · Update customer
#
Ask an LLM
“Can I change an existing customer's company or address without resending everything?”
“How do I flip a store customer's opt-in status later?”
Tell an agent
Set opt-in status of existing customer {customer_id} in store {store_id} to {opt_in_status}.
Update the address of customer {customer_id} at store {store_id} to {address}.
DELETE
/ecommerce/stores/{store_id}/customers/{customer_id}
Delete a store customer · Delete customer
#
Ask an LLM
“Can I remove a shopper from my store's customer records?”
“What's the call to delete one customer from a connected store?”
Tell an agent destructive · confirm first
Delete customer {customer_id} from store {store_id}.
Remove store {store_id} customer {customer_id} permanently.
Ask an LLM
“Which discount rules are set up for my store?”
“Can I see every promo rule my store has synced?”
Tell an agent
List promo rules for store {store_id}.
Show the discount rules configured in store {store_id}.
Ask an LLM
“How do I set up a discount rule, like 10% off an order, for my store?”
“What kinds of promo rule targets and types can I define?”
Tell an agent
Create promo rule {id} in store {store_id}: {description}, {type} discount of {amount} on {target}.
Add a promo rule to store {store_id} that runs from {starts_at} to {ends_at}.
Ask an LLM
“What discount amount and dates does a specific promo rule have?”
“Can I check whether one promo rule is enabled?”
Tell an agent
Show promo rule {promo_rule_id} in store {store_id}.
Get the start and end dates of promo rule {promo_rule_id} at store {store_id}.
PATCH
/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}
Update a promo rule · Update promo rule
#
Ask an LLM
“Can I extend the end date or change the amount of an existing discount rule?”
“How do I disable a promo rule without deleting it?”
Tell an agent
Set promo rule {promo_rule_id} in store {store_id} to end at {ends_at}.
Set enabled to {enabled} on promo rule {promo_rule_id} at store {store_id}.
DELETE
/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}
Delete a promo rule · Delete promo rule
#
Ask an LLM
“Can I remove a discount rule that's no longer running?”
“What's the way to delete a promo rule from my store?”
Tell an agent destructive · confirm first
Delete promo rule {promo_rule_id} from store {store_id}.
Remove the discount rule {promo_rule_id} in store {store_id}.
GET
/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes
List codes under a promo rule · List promo codes
#
Ask an LLM
“Which coupon codes belong to a particular promo rule?”
“Can I list all the promo codes shoppers can redeem under one discount rule?”
Tell an agent
List the promo codes for rule {promo_rule_id} in store {store_id}.
Show coupon codes under promo rule {promo_rule_id} at store {store_id}.
POST
/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes
Create a promo code · Add promo code
#
Ask an LLM
“How do I add a coupon code shoppers can use under an existing discount rule?”
“What's needed to create a promo code, like the code and redemption URL?”
Tell an agent
Add promo code {code} with id {id} and redemption URL {redemption_url} to rule {promo_rule_id} in store {store_id}.
Create coupon {code} under promo rule {promo_rule_id} at store {store_id}.
GET
/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id}
Get one promo code · Get promo code
#
Ask an LLM
“How many times has a specific coupon code been used?”
“Can I look up one promo code's redemption URL and status?”
Tell an agent
Show promo code {promo_code_id} under rule {promo_rule_id} in store {store_id}.
Get the usage count for coupon {promo_code_id} of rule {promo_rule_id} at store {store_id}.
PATCH
/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id}
Update a promo code · Update promo code
#
Ask an LLM
“Can I change a coupon's code text or disable it after it's created?”
“How do I update the usage count on a promo code?”
Tell an agent
Change promo code {promo_code_id} under rule {promo_rule_id} in store {store_id} to {code}.
Set enabled to {enabled} on coupon {promo_code_id} of rule {promo_rule_id} at store {store_id}.
DELETE
/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id}
Delete a promo code · Delete promo code
#
Ask an LLM
“Can I delete a single coupon code but keep its discount rule?”
“What's the way to retire a promo code from my store?”
Tell an agent destructive · confirm first
Delete promo code {promo_code_id} from rule {promo_rule_id} in store {store_id}.
Remove coupon {promo_code_id} under promo rule {promo_rule_id} at store {store_id}.
Ask an LLM
“Which orders has a single store sent to Mailchimp?”
“Can I filter one store's orders by customer or by the campaign that drove them?”
Tell an agent
List orders in store {store_id}.
Show store {store_id} orders from customer {customer_id}.
Ask an LLM
“How do I send a completed purchase to Mailchimp so it counts toward campaign revenue?”
“What's required to record a new order, like the customer, total and line items?”
Tell an agent
Add order {id} to store {store_id} for customer {customer} totaling {order_total} {currency_code} with lines {lines}.
Record a new order in store {store_id} credited to campaign {campaign_id}.
Ask an LLM
“What's the status, total and shipping info for a specific order?”
“Can I look up one order to see its fulfillment and tracking details?”
Tell an agent
Show order {order_id} in store {store_id}.
Get the tracking details for order {order_id} at store {store_id}.
PUT
/ecommerce/stores/{store_id}/orders/{order_id}
Create or update an order (upsert) · Add or update order
#
Ask an LLM
“Is there one call that adds an order if it's new and overwrites it if it already exists?”
“Can I upsert an order by its ID when syncing from my shop?”
Tell an agent
Upsert order {order_id} in store {store_id} with id {id}.
Add or update order {order_id} at store {store_id} with total {order_total}.
Ask an LLM
“Can I mark an existing order as shipped or add a tracking number later?”
“How do I update an order's financial status after a refund?”
Tell an agent
Set fulfillment status of existing order {order_id} in store {store_id} to {fulfillment_status}.
Add tracking number {tracking_number} from {tracking_carrier} to order {order_id} at store {store_id}.
Ask an LLM
“Can I remove an order that was sent to Mailchimp by mistake?”
“What's the way to delete a single order from a store?”
Tell an agent destructive · confirm first
Delete order {order_id} from store {store_id}.
Remove the test order {order_id} in store {store_id}.
GET
/ecommerce/stores/{store_id}/orders/{order_id}/lines
List an order's line items · List order line items
#
Ask an LLM
“Which products were bought in a specific order?”
“Can I list each line item on an order with its quantity and price?”
Tell an agent
List the line items of order {order_id} in store {store_id}.
Show what was purchased in order {order_id} at store {store_id}.
POST
/ecommerce/stores/{store_id}/orders/{order_id}/lines
Add a line item to an order · Add order line item
#
Ask an LLM
“How do I add another product line to an order that's already recorded?”
“Can I include a discount when adding a line to an existing order?”
Tell an agent
Add line {id} to order {order_id} in store {store_id}: {quantity} of variant {product_variant_id} of product {product_id} at {price}.
Append product {product_id} with discount {discount} to order {order_id} at store {store_id}.
GET
/ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id}
Get one order line item · Get order line item
#
Ask an LLM
“What was the price and quantity on one specific line of an order?”
“Can I fetch a single order line by its ID?”
Tell an agent
Show line {line_id} of order {order_id} in store {store_id}.
Get the discount on order line {line_id} for order {order_id}, store {store_id}.
PATCH
/ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id}
Update an order line item · Update order line item
#
Ask an LLM
“Can I correct the quantity or price on a line of an existing order?”
“How do I apply a discount to one line of an order after the fact?”
Tell an agent
Change the quantity of line {line_id} in order {order_id}, store {store_id}, to {quantity}.
Set discount {discount} on order line {line_id} of order {order_id} at store {store_id}.
DELETE
/ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id}
Remove a line item from an order · Delete order line item
#
Ask an LLM
“Can I delete one product line from an order while keeping the rest of it?”
“What's the call to remove a returned item's line from an order?”
Tell an agent destructive · confirm first
Remove line {line_id} from order {order_id} in store {store_id}.
Delete order line item {line_id} on order {order_id} at store {store_id}.
Ask an LLM
“Which products from my shop's catalog are synced to Mailchimp?”
“Can I page through every product in a store?”
Tell an agent
List products in store {store_id}.
Show the first {count} products of store {store_id}.
Ask an LLM
“How do I add a product to my store's catalog so it can appear in product recommendations?”
“Does a new product need at least one variant when I create it?”
Tell an agent
Add product {id} titled {title} with variants {variants} to store {store_id}.
Create a new product in store {store_id} from vendor {vendor} with image {image_url}.
Ask an LLM
“What details, variants and images does a specific product have?”
“Can I look up one product in my store by its ID?”
Tell an agent
Show product {product_id} in store {store_id}.
Get the title and URL of product {product_id} at store {store_id}.
PATCH
/ecommerce/stores/{store_id}/products/{product_id}
Update an existing product · Update product
#
Ask an LLM
“Can I change just a product's description or image without resending the whole product?”
“How do I rename an existing product in my store?”
Tell an agent
Change the title of existing product {product_id} in store {store_id} to {title}.
Update the description of product {product_id} at store {store_id} to {description}.
PUT
/ecommerce/stores/{store_id}/products/{product_id}
Create or replace a product (upsert) · Create or update product
#
Ask an LLM
“Is there a call that creates a product if missing or overwrites it if it's there?”
“Can I upsert a product by ID when syncing my catalog?”
Tell an agent
Upsert product {product_id} in store {store_id} with id {id}.
Create or replace product {product_id} at store {store_id} with title {title}.
Ask an LLM
“Can I remove a discontinued product from my store's catalog?”
“What's the way to delete a product from a connected store?”
Tell an agent destructive · confirm first
Delete product {product_id} from store {store_id}.
Remove discontinued product {product_id} in store {store_id}.
GET
/ecommerce/stores/{store_id}/products/{product_id}/variants
List a product's variants · List product variants
#
Ask an LLM
“Which sizes, colors or other variants does a product have?”
“Can I list every variant of a product with its SKU and stock?”
Tell an agent
List the variants of product {product_id} in store {store_id}.
Show all SKUs for product {product_id} at store {store_id}.
POST
/ecommerce/stores/{store_id}/products/{product_id}/variants
Add a variant to a product · Add product variant
#
Ask an LLM
“How do I add a new size or color variant to an existing product?”
“Can I set a SKU, price and inventory quantity when adding a variant?”
Tell an agent
Add variant {id} titled {title} to product {product_id} in store {store_id}.
Create a variant with SKU {sku} priced {price} on product {product_id} at store {store_id}.
GET
/ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}
Get one product variant · Get product variant info
#
Ask an LLM
“How much stock is left for a specific product variant?”
“Can I look up a single variant's price and SKU?”
Tell an agent
Show variant {variant_id} of product {product_id} in store {store_id}.
Get the inventory quantity for variant {variant_id} of product {product_id}, store {store_id}.
PUT
/ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}
Create or replace a product variant (upsert) · Add or update product variant
#
Ask an LLM
“Is there one call that adds a variant if it's new and overwrites it if it exists?”
“Can I upsert a product variant by ID during a catalog sync?”
Tell an agent
Upsert variant {variant_id} titled {title} with id {id} on product {product_id} in store {store_id}.
Add or replace variant {variant_id} of product {product_id} at store {store_id}.
PATCH
/ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}
Update an existing product variant · Update product variant
#
Ask an LLM
“Can I update a variant's stock level or price without resending the whole variant?”
“How do I mark an existing variant as allowing backorders?”
Tell an agent
Set inventory of existing variant {variant_id} of product {product_id} in store {store_id} to {inventory_quantity}.
Change the price of variant {variant_id} on product {product_id} at store {store_id} to {price}.
DELETE
/ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}
Delete a product variant · Delete product variant
#
Ask an LLM
“Can I remove one variant from a product while keeping the product?”
“What's the way to delete a discontinued size or color of a product?”
Tell an agent destructive · confirm first
Delete variant {variant_id} of product {product_id} in store {store_id}.
Remove product variant {variant_id} from product {product_id} at store {store_id}.
GET
/ecommerce/stores/{store_id}/products/{product_id}/images
List a product's images · List product images
#
Ask an LLM
“Which images are attached to a product in my store?”
“Can I list all photos for a product along with the variants they apply to?”
Tell an agent
List the images of product {product_id} in store {store_id}.
Show all photos for product {product_id} at store {store_id}.
POST
/ecommerce/stores/{store_id}/products/{product_id}/images
Add an image to a product · Add product image
#
Ask an LLM
“How do I attach another photo to a product?”
“Can I tie a new product image to specific variants?”
Tell an agent
Add image {id} from {url} to product {product_id} in store {store_id}.
Attach a new image to product {product_id} at store {store_id} for variants {variant_ids}.
GET
/ecommerce/stores/{store_id}/products/{product_id}/images/{image_id}
Get one product image · Get product image info
#
Ask an LLM
“What URL and variants does a specific product image have?”
“Can I fetch a single product photo's details by its ID?”
Tell an agent
Show image {image_id} of product {product_id} in store {store_id}.
Get the URL of product image {image_id} for product {product_id}, store {store_id}.
PATCH
/ecommerce/stores/{store_id}/products/{product_id}/images/{image_id}
Update a product image · Update product image
#
Ask an LLM
“Can I swap the URL of an existing product image?”
“How do I change which variants an existing product photo applies to?”
Tell an agent
Point image {image_id} of product {product_id} in store {store_id} at URL {url}.
Assign existing product image {image_id} on product {product_id}, store {store_id}, to variants {variant_ids}.
DELETE
/ecommerce/stores/{store_id}/products/{product_id}/images/{image_id}
Delete a product image · Delete product image
#
Ask an LLM
“Can I remove an outdated photo from a product?”
“What's the call to delete one image from a product in my store?”
Tell an agent destructive · confirm first
Delete image {image_id} from product {product_id} in store {store_id}.
Remove product photo {image_id} on product {product_id} at store {store_id}.
DELETE
/3.0/ecommerce/stores/{store_id}/products/{product_id}/images/{image_id}
Delete product image
#
GET
/3.0/ecommerce/stores/{store_id}/products/{product_id}/images/{image_id}
Get product image info
#
PATCH
/3.0/ecommerce/stores/{store_id}/products/{product_id}/images/{image_id}
Update product image
#
DELETE
/3.0/ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}
Delete product variant
#
GET
/3.0/ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}
Get product variant info
#
PATCH
/3.0/ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}
Update product variant
#
PUT
/3.0/ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}
Add or update product variant
#
DELETE
/3.0/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id}
Delete promo code
#
GET
/3.0/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id}
Get promo code
#
PATCH
/3.0/ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id}
Update promo code
#
Documentation
📖
Documentation
https://mailchimp.com/developer/marketing/docs/fundamentals/
📖
APIReference
https://mailchimp.com/developer/marketing/api/
📖
GettingStarted
https://mailchimp.com/developer/marketing/guides/quick-start/
📖
Authentication
https://mailchimp.com/developer/marketing/guides/access-user-data-oauth-2/
📖
Documentation
https://mailchimp.com/developer/transactional/docs/fundamentals/
📖
GettingStarted
https://mailchimp.com/developer/transactional/guides/quick-start/
📖
Authentication
https://mailchimp.com/developer/transactional/docs/authentication-delivery/
📖
APIReference
https://mailchimp.com/developer/transactional/api/
📖
GettingStarted
https://mailchimp.com/developer/transactional/guides/send-first-email/
Specifications
⚙
OpenAPI
https://artifacts.apis.io/mailchimp/openapi/mailchimp-ecommerce-api-openapi.yml
⚙
AsyncAPI
https://artifacts.apis.io/mailchimp/asyncapi/mailchimp-marketing-webhooks-asyncapi.yml
Schemas & Data
📊
JSONSchema
https://artifacts.apis.io/mailchimp/json-schema/campaign.json
📊
JSONSchema
https://artifacts.apis.io/mailchimp/json-schema/audience.json
📊
JSONSchema
https://artifacts.apis.io/mailchimp/json-schema/member.json
📊
JSONSchema
https://artifacts.apis.io/mailchimp/json-schema/template.json
Other Resources
🔗
JSONLD
https://artifacts.apis.io/mailchimp/json-ld/context.jsonld
🔗
Integrations
https://mailchimp.com/developer/marketing/docs/integrations/
🔗
ErrorCodes
https://mailchimp.com/developer/marketing/docs/errors/
🔗
E-Commerce
https://mailchimp.com/developer/marketing/docs/e-commerce/
🔗
Methods and Parameters
https://mailchimp.com/developer/marketing/docs/methods-parameters/
🔗
Webhooks
https://mailchimp.com/developer/transactional/docs/webhooks/
🔗
Outbound Email
https://mailchimp.com/developer/transactional/docs/outbound-email/
🔗
Tags and Metadata
https://mailchimp.com/developer/transactional/docs/tags-metadata/