swagger: '2.0' info: version: 3.0.55 title: Mailchimp Marketing Abuse Ecommerce API contact: name: Mailchimp API Support email: apihelp@mailchimp.com x-permalink: https://github.com/mailchimp/mailchimp-client-lib-codegen/blob/main/spec/marketing.json description: ' The Mailchimp Marketing API provides programmatic access to Mailchimp data and functionality, allowing developers to build custom features to do things like sync email activity and campaign analytics with their database, manage audiences and campaigns, and more.' host: server.api.mailchimp.com basePath: /3.0 schemes: - https consumes: - application/json produces: - application/json - application/problem+json security: - basicAuth: [] tags: - name: Ecommerce paths: /reports/{campaign_id}/ecommerce-product-activity: get: description: Get breakdown of product activity for a campaign parameters: - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: count x-title: Count in: query description: The number of records to return. Default value is 10. Maximum value is 1000 required: false default: 10 maximum: 1000 type: integer example: example_value - name: offset x-title: Offset in: query description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. required: false default: 0 type: integer example: example_value - in: path name: campaign_id x-title: Campaign ID type: string required: true description: The unique id for the campaign. example: '500123' - name: sort_field x-title: Sort By Field description: Returns files sorted by the specified field. in: query required: false type: string enum: - title - total_revenue - total_purchased example: example_value responses: '200': description: Ecommerce Product Activity Instance schema: type: object description: A collection of ecommerce products. properties: products: type: array items: type: object properties: title: type: string sku: type: string image_url: type: string total_revenue: type: number total_purchased: type: number currency_code: type: string recommendation_total: type: integer recommendation_purchased: type: integer total_items: type: integer title: Item Count description: The total number of items matching the query regardless of pagination. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 tags: - Ecommerce x-custom-config: methodNameSnake: get_ecommerce_product_activity_for_campaign methodNameCamel: getEcommerceProductActivityForCampaign summary: Mailchimp List Campaign Product Activity operationId: getReportsIdEcommerceProductActivity x-microcks-operation: delay: 0 dispatcher: FALLBACK /ecommerce/stores/{store_id}: get: summary: Mailchimp Get Store Info description: Get information about a specific store. operationId: getEcommerceStoresId parameters: - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: E-commerce Store description: An individual store in an account. properties: id: type: string title: Store Foreign ID description: The unique identifier for the store. readOnly: true example: example_store list_id: type: string title: List ID description: The unique identifier for the list that's associated with the store. The `list_id` for a specific store can't change. readOnly: true example: 1a2df69511 name: type: string title: Store Name description: The name of the store. example: Freddie's Cat Hat Emporium platform: type: string title: Platform description: The e-commerce platform of the store. domain: type: string title: Domain description: The store domain. The store domain must be unique within a user account. example: example.com is_syncing: type: boolean title: Is Syncing description: Whether to disable automations because the store is currently [syncing](https://mailchimp.com/developer/marketing/docs/e-commerce/#pausing-store-automations). email_address: type: string title: Email Address description: The email address for the store. example: freddie@mailchimp.com currency_code: type: string title: Currency description: The three-letter ISO 4217 code for the currency that the store accepts. example: USD money_format: type: string title: Money Format description: 'The currency format for the store. For example: `$`, ``, etc.' example: $ primary_locale: type: string title: Primary Locale description: 'The primary locale for the store. For example: `en`, `de`, etc.' example: fr timezone: type: string title: Timezone description: The timezone for the store. example: Eastern phone: type: string title: Phone description: The store phone number. example: 404-444-4444 address: type: object title: Address description: The store address. properties: address1: type: string title: Address Field 1 description: The store's mailing address. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: An additional field for the store's mailing address. example: Suite 5000 city: type: string title: 'City ' description: The city the store is located in. example: Atlanta province: type: string title: Province description: The store's state name or normalized province. example: Georgia province_code: type: string title: Province Code description: The two-letter code for the store's province or state. example: GA postal_code: type: string title: Postal Code description: The store's postal or zip code. example: '30308' country: type: string title: Country Code description: The store's country. example: United States country_code: type: string title: Country Code description: The two-letter code for to the store's country. example: US longitude: type: number title: Longitude description: The longitude of the store location. example: -75.68903 latitude: type: number title: Latitude description: The latitude of the store location. example: 45.427408 connected_site: type: object title: Connected Site description: The Connected Site associated with the store. readOnly: true properties: site_foreign_id: type: string title: Connected Site Foreign ID description: The unique identifier for the connected site. readOnly: true example: a180c384d7db88b if created in-app, MC001 if created via API site_script: type: object title: Script description: The script used to connect your site with Mailchimp. readOnly: true properties: url: type: string title: Script URL description: The URL used for any integrations that offer built-in support for connected sites. readOnly: true example: https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js fragment: type: string title: Script Fragment description: A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp. readOnly: true example: automations: type: object title: Automations description: Details for the automations attached to this store. readOnly: true properties: abandoned_cart: type: object title: Abandoned Cart Automation description: abandonedCart automation details. readOnly: true properties: is_supported: type: boolean title: Is Supported description: Whether this store supports the abandonedCart automation. readOnly: true example: false id: type: string title: ID description: Unique ID of automation parent campaign. readOnly: true example: 355a72bfc3 status: type: string title: Status description: Status of the abandonedCart automation. enum: - save - sending - paused readOnly: true example: sending abandoned_browse: type: object title: Abandoned Browse Automation description: abandonedBrowse automation details. abandonedBrowse is also known as Product Retargeting Email or Retarget Site Visitors on the web. readOnly: true properties: is_supported: type: boolean title: Is Supported description: Whether this store supports the abandonedBrowse automation. readOnly: true example: false id: type: string title: ID description: Unique ID of automation parent campaign. readOnly: true example: 355a72bfc3 status: type: string title: Status description: Status of the abandonedBrowse automation. enum: - save - sending - paused readOnly: true example: sending list_is_active: type: boolean title: List Status description: The status of the list connected to the store, namely if it's deleted or disabled. readOnly: true created_at: type: string title: Creation Time format: date-time description: The date and time the store was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: The date and time the store was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Ecommerce x-custom-config: methodNameSnake: get_store methodNameCamel: getStore x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update Store description: Update a store. operationId: patchEcommerceStoresId parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: body in: body description: '' required: true schema: type: object title: E-commerce Store description: An individual store in an account. properties: name: type: string title: Store Name description: The name of the store. example: Freddie's Cat Hat Emporium platform: type: string title: Platform description: The e-commerce platform of the store. domain: type: string title: Domain description: The store domain. example: example.com is_syncing: type: boolean title: Is Syncing description: Whether to disable automations because the store is currently [syncing](https://mailchimp.com/developer/marketing/docs/e-commerce/#pausing-store-automations). email_address: type: string title: Email Address description: The email address for the store. example: freddie@mailchimp.com currency_code: type: string title: Currency description: The three-letter ISO 4217 code for the currency that the store accepts. example: USD money_format: type: string title: Money Format description: 'The currency format for the store. For example: `$`, ``, etc.' example: $ primary_locale: type: string title: Primary Locale description: 'The primary locale for the store. For example: `en`, `de`, etc.' example: fr timezone: type: string title: Timezone description: The timezone for the store. example: Eastern phone: type: string title: Phone description: The store phone number. example: 404-444-4444 address: type: object title: Address description: The store address. properties: address1: type: string title: Address Field 1 description: The store's mailing address. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: An additional field for the store's mailing address. example: Suite 5000 city: type: string title: 'City ' description: The city the store is located in. example: Atlanta province: type: string title: Province description: The store's state name or normalized province. example: Georgia province_code: type: string title: Province Code description: The two-letter code for the store's province or state. example: GA postal_code: type: string title: Postal Code description: The store's postal or zip code. example: '30308' country: type: string title: Country Code description: The store's country. example: United States country_code: type: string title: Country Code description: The two-letter code for to the store's country. example: US longitude: type: number title: Longitude description: The longitude of the store location. example: -75.68903 latitude: type: number title: Latitude description: The latitude of the store location. example: 45.427408 example: example_value responses: '200': description: '' schema: type: object title: E-commerce Store description: An individual store in an account. properties: id: type: string title: Store Foreign ID description: The unique identifier for the store. readOnly: true example: example_store list_id: type: string title: List ID description: The unique identifier for the list that's associated with the store. The `list_id` for a specific store can't change. readOnly: true example: 1a2df69511 name: type: string title: Store Name description: The name of the store. example: Freddie's Cat Hat Emporium platform: type: string title: Platform description: The e-commerce platform of the store. domain: type: string title: Domain description: The store domain. The store domain must be unique within a user account. example: example.com is_syncing: type: boolean title: Is Syncing description: Whether to disable automations because the store is currently [syncing](https://mailchimp.com/developer/marketing/docs/e-commerce/#pausing-store-automations). email_address: type: string title: Email Address description: The email address for the store. example: freddie@mailchimp.com currency_code: type: string title: Currency description: The three-letter ISO 4217 code for the currency that the store accepts. example: USD money_format: type: string title: Money Format description: 'The currency format for the store. For example: `$`, ``, etc.' example: $ primary_locale: type: string title: Primary Locale description: 'The primary locale for the store. For example: `en`, `de`, etc.' example: fr timezone: type: string title: Timezone description: The timezone for the store. example: Eastern phone: type: string title: Phone description: The store phone number. example: 404-444-4444 address: type: object title: Address description: The store address. properties: address1: type: string title: Address Field 1 description: The store's mailing address. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: An additional field for the store's mailing address. example: Suite 5000 city: type: string title: 'City ' description: The city the store is located in. example: Atlanta province: type: string title: Province description: The store's state name or normalized province. example: Georgia province_code: type: string title: Province Code description: The two-letter code for the store's province or state. example: GA postal_code: type: string title: Postal Code description: The store's postal or zip code. example: '30308' country: type: string title: Country Code description: The store's country. example: United States country_code: type: string title: Country Code description: The two-letter code for to the store's country. example: US longitude: type: number title: Longitude description: The longitude of the store location. example: -75.68903 latitude: type: number title: Latitude description: The latitude of the store location. example: 45.427408 connected_site: type: object title: Connected Site description: The Connected Site associated with the store. readOnly: true properties: site_foreign_id: type: string title: Connected Site Foreign ID description: The unique identifier for the connected site. readOnly: true example: a180c384d7db88b if created in-app, MC001 if created via API site_script: type: object title: Script description: The script used to connect your site with Mailchimp. readOnly: true properties: url: type: string title: Script URL description: The URL used for any integrations that offer built-in support for connected sites. readOnly: true example: https://chimpstatic.com/mcjs-connected/js/users/{user-hash}/{site-hash}.js fragment: type: string title: Script Fragment description: A pre-built script that you can copy-and-paste into your site to integrate it with Mailchimp. readOnly: true example: automations: type: object title: Automations description: Details for the automations attached to this store. readOnly: true properties: abandoned_cart: type: object title: Abandoned Cart Automation description: abandonedCart automation details. readOnly: true properties: is_supported: type: boolean title: Is Supported description: Whether this store supports the abandonedCart automation. readOnly: true example: false id: type: string title: ID description: Unique ID of automation parent campaign. readOnly: true example: 355a72bfc3 status: type: string title: Status description: Status of the abandonedCart automation. enum: - save - sending - paused readOnly: true example: sending abandoned_browse: type: object title: Abandoned Browse Automation description: abandonedBrowse automation details. abandonedBrowse is also known as Product Retargeting Email or Retarget Site Visitors on the web. readOnly: true properties: is_supported: type: boolean title: Is Supported description: Whether this store supports the abandonedBrowse automation. readOnly: true example: false id: type: string title: ID description: Unique ID of automation parent campaign. readOnly: true example: 355a72bfc3 status: type: string title: Status description: Status of the abandonedBrowse automation. enum: - save - sending - paused readOnly: true example: sending list_is_active: type: boolean title: List Status description: The status of the list connected to the store, namely if it's deleted or disabled. readOnly: true created_at: type: string title: Creation Time format: date-time description: The date and time the store was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: The date and time the store was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Ecommerce x-custom-config: methodNameSnake: update_store methodNameCamel: updateStore x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Store description: Delete a store. Deleting a store will also delete any associated subresources, including Customers, Orders, Products, and Carts. operationId: deleteEcommerceStoresId parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' responses: '204': description: Empty Response schema: description: Empty Response default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Ecommerce x-custom-config: methodNameSnake: delete_store methodNameCamel: deleteStore x-microcks-operation: delay: 0 dispatcher: FALLBACK /ecommerce/stores/{store_id}/carts/{cart_id}: get: summary: Mailchimp Get Cart Info description: Get information about a specific cart. operationId: getEcommerceStoresIdCartsId parameters: - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: cart_id x-title: Cart ID description: The id for the cart. in: path required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: E-commerce Cart description: Information about a specific cart. properties: id: type: string title: Cart Foreign ID description: A unique identifier for the cart. readOnly: true customer: type: object title: E-commerce Customer description: Information about a specific customer. properties: id: type: string title: Customer Foreign ID description: A unique identifier for the customer. readOnly: true email_address: type: string title: Email Address description: The customer's email address. readOnly: true opt_in_status: type: boolean title: Opt-in Status description: The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers). company: type: string title: Company description: The customer's company. first_name: type: string title: First Name description: The customer's first name. last_name: type: string title: Last Name description: The customer's last name. orders_count: type: integer title: Orders Count description: The customer's total order count. readOnly: true example: 4 total_spent: type: number title: Total Spent description: The total amount the customer has spent. readOnly: true example: 100 address: type: object title: Address description: The customer's address. properties: address1: type: string title: Address Field 1 description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: An additional field for the customer's mailing address. example: Suite 5000 city: type: string title: 'City ' description: The city the customer is located in. example: Atlanta province: type: string title: Province description: The customer's state name or normalized province. example: Georgia province_code: type: string title: Province Code description: The two-letter code for the customer's province or state. example: GA postal_code: type: string title: Postal Code description: The customer's postal or zip code. example: '30308' country: type: string title: Country Code description: The customer's country. example: United States country_code: type: string title: Country Code description: The two-letter code for the customer's country. example: US created_at: type: string title: Creation Time format: date-time description: The date and time the customer was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: The date and time the customer was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true campaign_id: type: string title: Campaign ID description: A string that uniquely identifies the campaign associated with a cart. example: 839488a60b checkout_url: type: string title: Checkout URL description: The URL for the cart. This parameter is required for [Abandoned Cart](https://mailchimp.com/help/create-an-abandoned-cart-email/) automations. currency_code: type: string title: Currency Code description: The three-letter ISO 4217 code for the currency that the cart uses. order_total: type: number title: Order Total description: The order total for the cart. tax_total: type: number title: Tax Total description: The total tax for the cart. lines: type: array title: Cart Line Items description: An array of the cart's line items. items: type: object title: E-commerce Cart Line Item description: Information about a specific cart line item. properties: id: type: string title: Cart Line Item Foreign ID description: A unique identifier for the cart line item. readOnly: true product_id: type: string title: Cart Line Product Foreign ID description: A unique identifier for the product associated with the cart line item. product_title: type: string title: Cart Line Product Title description: The name of the product for the cart line item. readOnly: true product_variant_id: type: string title: Cart Line Product Variant Foreign ID description: A unique identifier for the product variant associated with the cart line item. product_variant_title: type: string title: Cart Line Product Variant Title description: The name of the product variant for the cart line item. readOnly: true quantity: type: integer title: Quantity description: The quantity of a cart line item. price: type: number title: Price description: The price of a cart line item. _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true created_at: type: string title: Creation Time format: date-time description: The date and time the cart was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: The date and time the cart was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Ecommerce x-custom-config: methodNameSnake: get_store_cart methodNameCamel: getStoreCart x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update Cart description: Update a specific cart. operationId: patchEcommerceStoresIdCartsId parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: cart_id x-title: Cart ID description: The id for the cart. in: path required: true type: string example: '500123' - name: body in: body description: '' required: true schema: type: object title: E-commerce Cart description: Information about a specific cart. properties: customer: type: object title: E-commerce Customer description: Information about a specific customer. Orders for existing customers should include only the `id` parameter in the `customer` object body. properties: opt_in_status: type: boolean title: Opt-in Status description: The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers). company: type: string title: Company description: The customer's company. first_name: type: string title: First Name description: The customer's first name. last_name: type: string title: Last Name description: The customer's last name. address: type: object title: Address description: The customer's address. properties: address1: type: string title: Address Field 1 description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: An additional field for the customer's mailing address. example: Suite 5000 city: type: string title: 'City ' description: The city the customer is located in. example: Atlanta province: type: string title: Province description: The customer's state name or normalized province. example: Georgia province_code: type: string title: Province Code description: The two-letter code for the customer's province or state. example: GA postal_code: type: string title: Postal Code description: The customer's postal or zip code. example: '30308' country: type: string title: Country Code description: The customer's country. example: United States country_code: type: string title: Country Code description: The two-letter code for the customer's country. example: US campaign_id: type: string title: Campaign ID description: A string that uniquely identifies the campaign associated with a cart. example: 839488a60b checkout_url: type: string title: Checkout URL description: The URL for the cart. This parameter is required for [Abandoned Cart](https://mailchimp.com/help/create-an-abandoned-cart-email/) automations. currency_code: type: string title: Currency Code description: The three-letter ISO 4217 code for the currency that the cart uses. order_total: type: number title: Order Total description: The order total for the cart. tax_total: type: number title: Tax Total description: The total tax for the cart. lines: type: array title: Cart Line Items description: An array of the cart's line items. items: type: object title: E-commerce Cart Line Item description: Information about a specific cart line item. properties: product_id: type: string title: Cart Line Product Foreign ID description: A unique identifier for the product associated with the cart line item. product_variant_id: type: string title: Cart Line Product Variant Foreign ID description: A unique identifier for the product variant associated with the cart line item. quantity: type: integer title: Quantity description: The quantity of a cart line item. price: type: number title: Price description: The price of a cart line item. example: example_value responses: '200': description: '' schema: type: object title: E-commerce Cart description: Information about a specific cart. properties: id: type: string title: Cart Foreign ID description: A unique identifier for the cart. readOnly: true customer: type: object title: E-commerce Customer description: Information about a specific customer. properties: id: type: string title: Customer Foreign ID description: A unique identifier for the customer. readOnly: true email_address: type: string title: Email Address description: The customer's email address. readOnly: true opt_in_status: type: boolean title: Opt-in Status description: The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers). company: type: string title: Company description: The customer's company. first_name: type: string title: First Name description: The customer's first name. last_name: type: string title: Last Name description: The customer's last name. orders_count: type: integer title: Orders Count description: The customer's total order count. readOnly: true example: 4 total_spent: type: number title: Total Spent description: The total amount the customer has spent. readOnly: true example: 100 address: type: object title: Address description: The customer's address. properties: address1: type: string title: Address Field 1 description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: An additional field for the customer's mailing address. example: Suite 5000 city: type: string title: 'City ' description: The city the customer is located in. example: Atlanta province: type: string title: Province description: The customer's state name or normalized province. example: Georgia province_code: type: string title: Province Code description: The two-letter code for the customer's province or state. example: GA postal_code: type: string title: Postal Code description: The customer's postal or zip code. example: '30308' country: type: string title: Country Code description: The customer's country. example: United States country_code: type: string title: Country Code description: The two-letter code for the customer's country. example: US created_at: type: string title: Creation Time format: date-time description: The date and time the customer was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: The date and time the customer was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true campaign_id: type: string title: Campaign ID description: A string that uniquely identifies the campaign associated with a cart. example: 839488a60b checkout_url: type: string title: Checkout URL description: The URL for the cart. This parameter is required for [Abandoned Cart](https://mailchimp.com/help/create-an-abandoned-cart-email/) automations. currency_code: type: string title: Currency Code description: The three-letter ISO 4217 code for the currency that the cart uses. order_total: type: number title: Order Total description: The order total for the cart. tax_total: type: number title: Tax Total description: The total tax for the cart. lines: type: array title: Cart Line Items description: An array of the cart's line items. items: type: object title: E-commerce Cart Line Item description: Information about a specific cart line item. properties: id: type: string title: Cart Line Item Foreign ID description: A unique identifier for the cart line item. readOnly: true product_id: type: string title: Cart Line Product Foreign ID description: A unique identifier for the product associated with the cart line item. product_title: type: string title: Cart Line Product Title description: The name of the product for the cart line item. readOnly: true product_variant_id: type: string title: Cart Line Product Variant Foreign ID description: A unique identifier for the product variant associated with the cart line item. product_variant_title: type: string title: Cart Line Product Variant Title description: The name of the product variant for the cart line item. readOnly: true quantity: type: integer title: Quantity description: The quantity of a cart line item. price: type: number title: Price description: The price of a cart line item. _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true created_at: type: string title: Creation Time format: date-time description: The date and time the cart was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: The date and time the cart was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Ecommerce x-custom-config: methodNameSnake: update_store_cart methodNameCamel: updateStoreCart x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Cart description: Delete a cart. operationId: deleteEcommerceStoresIdCartsId parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: cart_id x-title: Cart ID description: The id for the cart. in: path required: true type: string example: '500123' responses: '204': description: Empty Response default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Ecommerce x-custom-config: methodNameSnake: delete_store_cart methodNameCamel: deleteStoreCart x-microcks-operation: delay: 0 dispatcher: FALLBACK /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id}: get: summary: Mailchimp Get Cart Line Item description: Get information about a specific cart line item. operationId: getEcommerceStoresIdCartsIdLinesId parameters: - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: cart_id x-title: Cart ID description: The id for the cart. in: path required: true type: string example: '500123' - name: line_id x-title: Cart Line ID description: The id for the line item of a cart. in: path required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: E-commerce Cart Line Item description: Information about a specific cart line item. properties: id: type: string title: Cart Line Item Foreign ID description: A unique identifier for the cart line item. readOnly: true product_id: type: string title: Cart Line Product Foreign ID description: A unique identifier for the product associated with the cart line item. product_title: type: string title: Cart Line Product Title description: The name of the product for the cart line item. readOnly: true product_variant_id: type: string title: Cart Line Product Variant Foreign ID description: A unique identifier for the product variant associated with the cart line item. product_variant_title: type: string title: Cart Line Product Variant Title description: The name of the product variant for the cart line item. readOnly: true quantity: type: integer title: Quantity description: The quantity of a cart line item. price: type: number title: Price description: The price of a cart line item. _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Ecommerce x-custom-config: methodNameSnake: get_cart_line_item methodNameCamel: getCartLineItem x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update Cart Line Item description: Update a specific cart line item. operationId: patchEcommerceStoresIdCartsIdLinesId parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: cart_id x-title: Cart ID description: The id for the cart. in: path required: true type: string example: '500123' - name: line_id x-title: Cart Line ID description: The id for the line item of a cart. in: path required: true type: string example: '500123' - name: body in: body description: '' required: true schema: type: object title: E-commerce Cart Line Item description: Information about a specific cart line item. properties: product_id: type: string title: Cart Line Product Foreign ID description: A unique identifier for the product associated with the cart line item. product_variant_id: type: string title: Cart Line Product Variant Foreign ID description: A unique identifier for the product variant associated with the cart line item. quantity: type: integer title: Quantity description: The quantity of a cart line item. price: type: number title: Price description: The price of a cart line item. example: example_value responses: '200': description: '' schema: type: object title: E-commerce Cart Line Item description: Information about a specific cart line item. properties: id: type: string title: Cart Line Item Foreign ID description: A unique identifier for the cart line item. readOnly: true product_id: type: string title: Cart Line Product Foreign ID description: A unique identifier for the product associated with the cart line item. product_title: type: string title: Cart Line Product Title description: The name of the product for the cart line item. readOnly: true product_variant_id: type: string title: Cart Line Product Variant Foreign ID description: A unique identifier for the product variant associated with the cart line item. product_variant_title: type: string title: Cart Line Product Variant Title description: The name of the product variant for the cart line item. readOnly: true quantity: type: integer title: Quantity description: The quantity of a cart line item. price: type: number title: Price description: The price of a cart line item. _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Ecommerce x-custom-config: methodNameSnake: update_cart_line_item methodNameCamel: updateCartLineItem x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Cart Line Item description: Delete a specific cart line item. operationId: deleteEcommerceStoresIdCartsLinesId parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: cart_id x-title: Cart ID description: The id for the cart. in: path required: true type: string example: '500123' - name: line_id x-title: Cart Line ID description: The id for the line item of a cart. in: path required: true type: string example: '500123' responses: '204': description: Empty Response default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Ecommerce x-custom-config: methodNameSnake: delete_cart_line_item methodNameCamel: deleteCartLineItem x-microcks-operation: delay: 0 dispatcher: FALLBACK /ecommerce/stores/{store_id}/customers/{customer_id}: get: summary: Mailchimp Get Customer Info description: Get information about a specific customer. operationId: getEcommerceStoresIdCustomersId parameters: - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: customer_id x-title: Customer ID description: The id for the customer of a store. in: path required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: E-commerce Customer description: Information about a specific customer. properties: id: type: string title: Customer Foreign ID description: A unique identifier for the customer. readOnly: true email_address: type: string title: Email Address description: The customer's email address. readOnly: true opt_in_status: type: boolean title: Opt-in Status description: The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers). company: type: string title: Company description: The customer's company. first_name: type: string title: First Name description: The customer's first name. last_name: type: string title: Last Name description: The customer's last name. orders_count: type: integer title: Orders Count description: The customer's total order count. readOnly: true example: 4 total_spent: type: number title: Total Spent description: The total amount the customer has spent. readOnly: true example: 100 address: type: object title: Address description: The customer's address. properties: address1: type: string title: Address Field 1 description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: An additional field for the customer's mailing address. example: Suite 5000 city: type: string title: 'City ' description: The city the customer is located in. example: Atlanta province: type: string title: Province description: The customer's state name or normalized province. example: Georgia province_code: type: string title: Province Code description: The two-letter code for the customer's province or state. example: GA postal_code: type: string title: Postal Code description: The customer's postal or zip code. example: '30308' country: type: string title: Country Code description: The customer's country. example: United States country_code: type: string title: Country Code description: The two-letter code for the customer's country. example: US created_at: type: string title: Creation Time format: date-time description: The date and time the customer was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: The date and time the customer was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Ecommerce x-custom-config: methodNameSnake: get_store_customer methodNameCamel: getStoreCustomer x-microcks-operation: delay: 0 dispatcher: FALLBACK put: summary: Mailchimp Add or Update Customer description: Add or update a customer. operationId: putEcommerceStoresIdCustomersId parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: customer_id x-title: Customer ID description: The id for the customer of a store. in: path required: true type: string example: '500123' - name: body in: body description: '' required: true schema: type: object title: E-commerce Customer description: Information about a specific customer. Orders for existing customers should include only the `id` parameter in the `customer` object body. required: - id - email_address - opt_in_status properties: id: type: string title: Customer Foreign ID description: A unique identifier for the customer. Limited to 50 characters. maxLength: 50 email_address: type: string title: Email Address description: The customer's email address. opt_in_status: type: boolean title: Opt-in Status description: The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers). company: type: string title: Company description: The customer's company. first_name: type: string title: First Name description: The customer's first name. last_name: type: string title: Last Name description: The customer's last name. address: type: object title: Address description: The customer's address. properties: address1: type: string title: Address Field 1 description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: An additional field for the customer's mailing address. example: Suite 5000 city: type: string title: 'City ' description: The city the customer is located in. example: Atlanta province: type: string title: Province description: The customer's state name or normalized province. example: Georgia province_code: type: string title: Province Code description: The two-letter code for the customer's province or state. example: GA postal_code: type: string title: Postal Code description: The customer's postal or zip code. example: '30308' country: type: string title: Country Code description: The customer's country. example: United States country_code: type: string title: Country Code description: The two-letter code for the customer's country. example: US example: example_value responses: '200': description: '' schema: type: object title: E-commerce Customer description: Information about a specific customer. properties: id: type: string title: Customer Foreign ID description: A unique identifier for the customer. readOnly: true email_address: type: string title: Email Address description: The customer's email address. readOnly: true opt_in_status: type: boolean title: Opt-in Status description: The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers). company: type: string title: Company description: The customer's company. first_name: type: string title: First Name description: The customer's first name. last_name: type: string title: Last Name description: The customer's last name. orders_count: type: integer title: Orders Count description: The customer's total order count. readOnly: true example: 4 total_spent: type: number title: Total Spent description: The total amount the customer has spent. readOnly: true example: 100 address: type: object title: Address description: The customer's address. properties: address1: type: string title: Address Field 1 description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: An additional field for the customer's mailing address. example: Suite 5000 city: type: string title: 'City ' description: The city the customer is located in. example: Atlanta province: type: string title: Province description: The customer's state name or normalized province. example: Georgia province_code: type: string title: Province Code description: The two-letter code for the customer's province or state. example: GA postal_code: type: string title: Postal Code description: The customer's postal or zip code. example: '30308' country: type: string title: Country Code description: The customer's country. example: United States country_code: type: string title: Country Code description: The two-letter code for the customer's country. example: US created_at: type: string title: Creation Time format: date-time description: The date and time the customer was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: The date and time the customer was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Ecommerce x-custom-config: methodNameSnake: set_store_customer methodNameCamel: setStoreCustomer x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update Customer description: Update a customer. operationId: patchEcommerceStoresIdCustomersId parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: customer_id x-title: Customer ID description: The id for the customer of a store. in: path required: true type: string example: '500123' - name: body in: body description: '' required: true schema: type: object title: E-commerce Customer description: Information about a specific customer. Orders for existing customers should include only the `id` parameter in the `customer` object body. properties: opt_in_status: type: boolean title: Opt-in Status description: The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers). company: type: string title: Company description: The customer's company. first_name: type: string title: First Name description: The customer's first name. last_name: type: string title: Last Name description: The customer's last name. address: type: object title: Address description: The customer's address. properties: address1: type: string title: Address Field 1 description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: An additional field for the customer's mailing address. example: Suite 5000 city: type: string title: 'City ' description: The city the customer is located in. example: Atlanta province: type: string title: Province description: The customer's state name or normalized province. example: Georgia province_code: type: string title: Province Code description: The two-letter code for the customer's province or state. example: GA postal_code: type: string title: Postal Code description: The customer's postal or zip code. example: '30308' country: type: string title: Country Code description: The customer's country. example: United States country_code: type: string title: Country Code description: The two-letter code for the customer's country. example: US example: example_value responses: '200': description: '' schema: type: object title: E-commerce Customer description: Information about a specific customer. properties: id: type: string title: Customer Foreign ID description: A unique identifier for the customer. readOnly: true email_address: type: string title: Email Address description: The customer's email address. readOnly: true opt_in_status: type: boolean title: Opt-in Status description: The customer's opt-in status. This value will never overwrite the opt-in status of a pre-existing Mailchimp list member, but will apply to list members that are added through the e-commerce API endpoints. Customers who don't opt in to your Mailchimp list [will be added as `Transactional` members](https://mailchimp.com/developer/marketing/docs/e-commerce/#customers). company: type: string title: Company description: The customer's company. first_name: type: string title: First Name description: The customer's first name. last_name: type: string title: Last Name description: The customer's last name. orders_count: type: integer title: Orders Count description: The customer's total order count. readOnly: true example: 4 total_spent: type: number title: Total Spent description: The total amount the customer has spent. readOnly: true example: 100 address: type: object title: Address description: The customer's address. properties: address1: type: string title: Address Field 1 description: The mailing address of the customer. example: 675 Ponce de Leon Ave NE address2: type: string title: Address Field 2 description: An additional field for the customer's mailing address. example: Suite 5000 city: type: string title: 'City ' description: The city the customer is located in. example: Atlanta province: type: string title: Province description: The customer's state name or normalized province. example: Georgia province_code: type: string title: Province Code description: The two-letter code for the customer's province or state. example: GA postal_code: type: string title: Postal Code description: The customer's postal or zip code. example: '30308' country: type: string title: Country Code description: The customer's country. example: United States country_code: type: string title: Country Code description: The two-letter code for the customer's country. example: US created_at: type: string title: Creation Time format: date-time description: The date and time the customer was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: The date and time the customer was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Ecommerce x-custom-config: methodNameSnake: update_store_customer methodNameCamel: updateStoreCustomer x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Customer description: Delete a customer from a store. operationId: deleteEcommerceStoresIdCustomersId parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: customer_id x-title: Customer ID description: The id for the customer of a store. in: path required: true type: string example: '500123' responses: '204': description: Empty Response default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Ecommerce x-custom-config: methodNameSnake: delete_store_customer methodNameCamel: deleteStoreCustomer x-microcks-operation: delay: 0 dispatcher: FALLBACK /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}: get: summary: Mailchimp Get Promo Rule description: Get information about a specific promo rule. operationId: getEcommerceStoresIdPromorulesId parameters: - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: promo_rule_id x-title: Promo Rule ID description: The id for the promo rule of a store. in: path required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: E-commerce Promo Rule description: Information about an Ecommerce Store's specific Promo Rule properties: id: type: string title: Promo Rule Foreign ID description: A unique identifier for the promo rule. If Ecommerce platform does not support promo rule, use promo code id as promo rule id. Restricted to UTF-8 characters with max length 50. readOnly: true title: type: string title: Title description: The title that will show up in promotion campaign. Restricted to UTF-8 characters with max length of 100 bytes. example: 50% off Total Order description: type: string title: Description description: The description of a promotion restricted to UTF-8 characters with max length 255. example: Save BIG during our summer sale! starts_at: type: string format: date-time title: Promo Start Time description: The date and time when the promotion is in effect in ISO 8601 format. ends_at: type: string format: Promo date-time title: End Time description: The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format. amount: type: number title: Amount format: float description: The amount of the promo code discount. If 'type' is 'fixed', the amount is treated as a monetary value. If 'type' is 'percentage', amount must be a decimal value between 0.0 and 1.0, inclusive. example: 0.5 type: type: string title: Type description: Type of discount. For free shipping set type to fixed. enum: - fixed - percentage target: type: string title: Target description: The target that the discount applies to. enum: - per_item - total - shipping enabled: type: boolean title: Enabled description: Whether the promo rule is currently enabled. example: 'true' created_at_foreign: type: string format: date-time title: Foreign Create Time description: The date and time the promotion was created in ISO 8601 format. updated_at_foreign: type: string format: date-time title: Foreign Update Time description: The date and time the promotion was updated in ISO 8601 format. _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Ecommerce x-custom-config: methodNameSnake: get_promo_rule methodNameCamel: getPromoRule x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update Promo Rule description: Update a promo rule. operationId: patchEcommerceStoresIdPromorulesId parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: promo_rule_id x-title: Promo Rule ID description: The id for the promo rule of a store. in: path required: true type: string example: '500123' - name: body in: body description: '' required: true schema: type: object title: E-commerce Promo Rule description: Information about an Ecommerce Store's specific Promo Rule. properties: title: type: string title: Title description: The title that will show up in promotion campaign. Restricted to UTF-8 characters with max length of 100 bytes. example: 50% off Total Order description: type: string title: Description description: The description of a promotion restricted to UTF-8 characters with max length 255. example: Save BIG during our summer sale! starts_at: type: string format: date-time title: Promo Start Time description: The date and time when the promotion is in effect in ISO 8601 format. ends_at: type: string format: Promo date-time title: End Time description: The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format. amount: type: number title: Amount format: float description: The amount of the promo code discount. If 'type' is 'fixed', the amount is treated as a monetary value. If 'type' is 'percentage', amount must be a decimal value between 0.0 and 1.0, inclusive. example: 0.5 type: type: string title: Type description: Type of discount. For free shipping set type to fixed. enum: - fixed - percentage target: type: string title: Target description: The target that the discount applies to. enum: - per_item - total - shipping enabled: type: boolean title: Enabled description: Whether the promo rule is currently enabled. example: 'true' created_at_foreign: type: string format: date-time title: Foreign Create Time description: The date and time the promotion was created in ISO 8601 format. updated_at_foreign: type: string format: date-time title: Foreign Update Time description: The date and time the promotion was updated in ISO 8601 format. example: example_value responses: '200': description: '' schema: type: object title: E-commerce Promo Rule description: Information about an Ecommerce Store's specific Promo Rule properties: id: type: string title: Promo Rule Foreign ID description: A unique identifier for the promo rule. If Ecommerce platform does not support promo rule, use promo code id as promo rule id. Restricted to UTF-8 characters with max length 50. readOnly: true title: type: string title: Title description: The title that will show up in promotion campaign. Restricted to UTF-8 characters with max length of 100 bytes. example: 50% off Total Order description: type: string title: Description description: The description of a promotion restricted to UTF-8 characters with max length 255. example: Save BIG during our summer sale! starts_at: type: string format: date-time title: Promo Start Time description: The date and time when the promotion is in effect in ISO 8601 format. ends_at: type: string format: Promo date-time title: End Time description: The date and time when the promotion ends. Must be after starts_at and in ISO 8601 format. amount: type: number title: Amount format: float description: The amount of the promo code discount. If 'type' is 'fixed', the amount is treated as a monetary value. If 'type' is 'percentage', amount must be a decimal value between 0.0 and 1.0, inclusive. example: 0.5 type: type: string title: Type description: Type of discount. For free shipping set type to fixed. enum: - fixed - percentage target: type: string title: Target description: The target that the discount applies to. enum: - per_item - total - shipping enabled: type: boolean title: Enabled description: Whether the promo rule is currently enabled. example: 'true' created_at_foreign: type: string format: date-time title: Foreign Create Time description: The date and time the promotion was created in ISO 8601 format. updated_at_foreign: type: string format: date-time title: Foreign Update Time description: The date and time the promotion was updated in ISO 8601 format. _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Ecommerce x-custom-config: methodNameSnake: update_promo_rule methodNameCamel: updatePromoRule x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Promo Rule description: Delete a promo rule from a store. operationId: deleteEcommerceStoresIdPromorulesId parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: promo_rule_id x-title: Promo Rule ID description: The id for the promo rule of a store. in: path required: true type: string example: '500123' responses: '204': description: Empty Response default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Ecommerce x-custom-config: methodNameSnake: delete_promo_rule methodNameCamel: deletePromoRule x-microcks-operation: delay: 0 dispatcher: FALLBACK /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes: get: summary: Mailchimp List Promo Codes description: Get information about a store's promo codes. operationId: getEcommerceStoresIdPromocodes parameters: - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: count x-title: Count in: query description: The number of records to return. Default value is 10. Maximum value is 1000 required: false default: 10 maximum: 1000 type: integer example: example_value - name: offset x-title: Offset in: query description: Used for [pagination](https://mailchimp.com/developer/marketing/docs/methods-parameters/#pagination), this it the number of records from a collection to skip. Default value is 0. required: false default: 0 type: integer example: example_value - name: promo_rule_id x-title: Promo Rule ID description: The id for the promo rule of a store. in: path required: true type: string example: '500123' - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: Promo Codes description: A collection of the store's promo codes. properties: store_id: type: string title: Store ID description: The store id. promo_codes: type: array title: Promo Codes description: An array of objects, each representing promo codes defined for a store. items: type: object title: E-commerce Promo Code description: Information about an Ecommerce Store's specific Promo Code properties: id: type: string title: Promo Code Foreign ID description: A unique identifier for the promo Code. readOnly: true code: type: string title: Promo Code description: The discount code. Restricted to UTF-8 characters with max length 50. example: summersale redemption_url: type: string title: Redemption Url description: The url that should be used in the promotion campaign restricted to UTF-8 characters with max length 2000. example: A url that applies promo code directly at checkout or a url that points to sale page or store url usage_count: type: integer title: Promo Code Usage Count description: Number of times promo code has been used. enabled: type: boolean title: Enabled description: Whether the promo code is currently enabled. example: 'true' created_at_foreign: type: string format: date-time title: Foreign Create Time description: The date and time the promotion was created in ISO 8601 format. updated_at_foreign: type: string format: date-time title: Foreign Update Time description: The date and time the promotion was updated in ISO 8601 format. _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true total_items: type: integer title: Item Count description: The total number of items matching the query regardless of pagination. readOnly: true _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Ecommerce x-custom-config: methodNameSnake: get_promo_codes methodNameCamel: getPromoCodes x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Mailchimp Add Promo Code description: Add a new promo code to a store. operationId: postEcommerceStoresIdPromocodes parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: promo_rule_id x-title: Promo Rule ID description: The id for the promo rule of a store. in: path required: true type: string example: '500123' - name: body in: body description: '' required: true schema: type: object title: E-commerce Promo Code description: Information about an Ecommerce Store's specific Promo Code. required: - id - code - redemption_url properties: id: type: string title: Promo Code Foreign ID description: A unique identifier for the promo code. Restricted to UTF-8 characters with max length 50. code: type: string title: Promo Code description: The discount code. Restricted to UTF-8 characters with max length 50. example: summersale redemption_url: type: string title: Redemption Url description: The url that should be used in the promotion campaign restricted to UTF-8 characters with max length 2000. example: A url that applies promo code directly at checkout or a url that points to sale page or store url usage_count: type: integer title: Promo Code Usage Count description: Number of times promo code has been used. enabled: type: boolean title: Enabled description: Whether the promo code is currently enabled. example: 'true' created_at_foreign: type: string format: date-time title: Foreign Create Time description: The date and time the promotion was created in ISO 8601 format. updated_at_foreign: type: string format: date-time title: Foreign Update Time description: The date and time the promotion was updated in ISO 8601 format. example: example_value responses: '200': description: '' schema: type: object title: E-commerce Promo Code description: Information about an Ecommerce Store's specific Promo Code properties: id: type: string title: Promo Code Foreign ID description: A unique identifier for the promo Code. readOnly: true code: type: string title: Promo Code description: The discount code. Restricted to UTF-8 characters with max length 50. example: summersale redemption_url: type: string title: Redemption Url description: The url that should be used in the promotion campaign restricted to UTF-8 characters with max length 2000. example: A url that applies promo code directly at checkout or a url that points to sale page or store url usage_count: type: integer title: Promo Code Usage Count description: Number of times promo code has been used. enabled: type: boolean title: Enabled description: Whether the promo code is currently enabled. example: 'true' created_at_foreign: type: string format: date-time title: Foreign Create Time description: The date and time the promotion was created in ISO 8601 format. updated_at_foreign: type: string format: date-time title: Foreign Update Time description: The date and time the promotion was updated in ISO 8601 format. _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Ecommerce x-custom-config: methodNameSnake: add_promo_code methodNameCamel: addPromoCode x-microcks-operation: delay: 0 dispatcher: FALLBACK /ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id}: get: summary: Mailchimp Get Order Line Item description: Get information about a specific order line item. operationId: getEcommerceStoresIdOrdersIdLinesId parameters: - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: order_id x-title: Order ID description: The id for the order in a store. in: path required: true type: string example: '500123' - name: line_id x-title: Order Line ID description: The id for the line item of an order. in: path required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: E-commerce Order Line Item description: Information about a specific order line. properties: id: type: string title: Order Line Item Foreign ID description: A unique identifier for an order line item. readOnly: true product_id: type: string title: Order Line Item Product Foreign ID description: A unique identifier for the product associated with an order line item. product_title: type: string title: Order Line Item Product Title description: The name of the product for an order line item. readOnly: true product_variant_id: type: string title: Order Line Item Product Variant Foreign ID description: A unique identifier for the product variant associated with an order line item. product_variant_title: type: string title: Order Line Item Product Variant Title description: The name of the product variant for an order line item. readOnly: true image_url: type: string title: Product Image URL description: The image URL for a product. readOnly: true quantity: type: integer title: Quantity description: The order line item quantity. price: type: number title: Price description: The order line item price. discount: type: number title: Discount description: The total discount amount applied to a line item. _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Ecommerce x-custom-config: methodNameSnake: get_order_line_item methodNameCamel: getOrderLineItem x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update Order Line Item description: Update a specific order line item. operationId: patchEcommerceStoresIdOrdersIdLinesId parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: order_id x-title: Order ID description: The id for the order in a store. in: path required: true type: string example: '500123' - name: line_id x-title: Order Line ID description: The id for the line item of an order. in: path required: true type: string example: '500123' - name: body in: body description: '' required: true schema: type: object title: E-commerce Order Line Item description: Information about a specific order line. properties: product_id: type: string title: Order Line Item Product Foreign ID description: A unique identifier for the product associated with the order line item. product_variant_id: type: string title: Order Line Item Product Variant Foreign ID description: A unique identifier for the product variant associated with the order line item. quantity: type: integer title: Quantity description: The quantity of an order line item. price: type: number title: Price description: The price of an order line item. discount: type: number title: Discount description: The total discount amount applied to this line item. example: example_value responses: '200': description: '' schema: type: object title: E-commerce Order Line Item description: Information about a specific order line. properties: id: type: string title: Order Line Item Foreign ID description: A unique identifier for an order line item. readOnly: true product_id: type: string title: Order Line Item Product Foreign ID description: A unique identifier for the product associated with an order line item. product_title: type: string title: Order Line Item Product Title description: The name of the product for an order line item. readOnly: true product_variant_id: type: string title: Order Line Item Product Variant Foreign ID description: A unique identifier for the product variant associated with an order line item. product_variant_title: type: string title: Order Line Item Product Variant Title description: The name of the product variant for an order line item. readOnly: true image_url: type: string title: Product Image URL description: The image URL for a product. readOnly: true quantity: type: integer title: Quantity description: The order line item quantity. price: type: number title: Price description: The order line item price. discount: type: number title: Discount description: The total discount amount applied to a line item. _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Ecommerce x-custom-config: methodNameSnake: update_order_line_item methodNameCamel: updateOrderLineItem x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Order Line Item description: Delete a specific order line item. operationId: deleteEcommerceStoresIdOrdersIdLinesId parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: order_id x-title: Order ID description: The id for the order in a store. in: path required: true type: string example: '500123' - name: line_id x-title: Order Line ID description: The id for the line item of an order. in: path required: true type: string example: '500123' responses: '204': description: Empty Response default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Ecommerce x-custom-config: methodNameSnake: delete_order_line_item methodNameCamel: deleteOrderLineItem x-microcks-operation: delay: 0 dispatcher: FALLBACK /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id}: get: summary: Mailchimp Get Product Variant Info description: Get information about a specific product variant. operationId: getEcommerceStoresIdProductsIdVariantsId parameters: - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: product_id x-title: Product ID description: The id for the product of a store. in: path required: true type: string example: '500123' - name: variant_id x-title: Product Variant ID description: The id for the product variant. in: path required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: E-commerce Product Variant description: Information about a specific product variant. properties: id: type: string title: Product Variant Foreign ID description: A unique identifier for the product variant. readOnly: true title: type: string title: Title description: The title of a product variant. example: Cat Hat url: type: string title: URL description: The URL for a product variant. sku: type: string title: SKU description: The stock keeping unit (SKU) of a product variant. price: type: number title: Price description: The price of a product variant. inventory_quantity: type: integer title: Inventory Quantity description: The inventory quantity of a product variant. image_url: type: string title: Image URL description: The image URL for a product variant. backorders: type: string title: Backorders description: The backorders of a product variant. visibility: type: string title: Visibility description: The visibility of a product variant. created_at: type: string title: Creation Time format: date-time description: The date and time the product was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: The date and time the product was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Ecommerce x-custom-config: methodNameSnake: get_product_variant methodNameCamel: getProductVariant x-microcks-operation: delay: 0 dispatcher: FALLBACK put: summary: Mailchimp Add or Update Product Variant description: Add or update a product variant. operationId: putEcommerceStoresIdProductsIdVariantsId parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: product_id x-title: Product ID description: The id for the product of a store. in: path required: true type: string example: '500123' - name: variant_id x-title: Product Variant ID description: The id for the product variant. in: path required: true type: string example: '500123' - name: body in: body description: '' required: true schema: type: object title: E-commerce Product Variant description: Information about a specific product variant. required: - id - title properties: id: type: string title: Product Variant Foreign ID description: A unique identifier for the product variant. title: type: string title: Title description: The title of a product variant. example: Cat Hat url: type: string title: URL description: The URL for a product variant. sku: type: string title: SKU description: The stock keeping unit (SKU) of a product variant. price: type: number title: Price description: The price of a product variant. inventory_quantity: type: integer title: Inventory Quantity description: The inventory quantity of a product variant. image_url: type: string title: Image URL description: The image URL for a product variant. backorders: type: string title: Backorders description: The backorders of a product variant. visibility: type: string title: Visibility description: The visibility of a product variant. example: example_value responses: '200': description: '' schema: type: object title: E-commerce Product Variant description: Information about a specific product variant. properties: id: type: string title: Product Variant Foreign ID description: A unique identifier for the product variant. readOnly: true title: type: string title: Title description: The title of a product variant. example: Cat Hat url: type: string title: URL description: The URL for a product variant. sku: type: string title: SKU description: The stock keeping unit (SKU) of a product variant. price: type: number title: Price description: The price of a product variant. inventory_quantity: type: integer title: Inventory Quantity description: The inventory quantity of a product variant. image_url: type: string title: Image URL description: The image URL for a product variant. backorders: type: string title: Backorders description: The backorders of a product variant. visibility: type: string title: Visibility description: The visibility of a product variant. created_at: type: string title: Creation Time format: date-time description: The date and time the product was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: The date and time the product was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Ecommerce x-custom-config: methodNameSnake: add_product_variant methodNameCamel: addProductVariant x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update Product Variant description: Update a product variant. operationId: patchEcommerceStoresIdProductsIdVariantsId parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: product_id x-title: Product ID description: The id for the product of a store. in: path required: true type: string example: '500123' - name: variant_id x-title: Product Variant ID description: The id for the product variant. in: path required: true type: string example: '500123' - name: body in: body description: '' required: true schema: type: object title: E-commerce Product Variant description: Information about a specific product variant. properties: title: type: string title: Title description: The title of a product variant. example: Cat Hat url: type: string title: URL description: The URL for a product variant. sku: type: string title: SKU description: The stock keeping unit (SKU) of a product variant. price: type: number title: Price description: The price of a product variant. inventory_quantity: type: integer title: Inventory Quantity description: The inventory quantity of a product variant. image_url: type: string title: Image URL description: The image URL for a product variant. backorders: type: string title: Backorders description: The backorders of a product variant. visibility: type: string title: Visibility description: The visibility of a product variant. example: example_value responses: '200': description: '' schema: type: object title: E-commerce Product Variant description: Information about a specific product variant. properties: id: type: string title: Product Variant Foreign ID description: A unique identifier for the product variant. readOnly: true title: type: string title: Title description: The title of a product variant. example: Cat Hat url: type: string title: URL description: The URL for a product variant. sku: type: string title: SKU description: The stock keeping unit (SKU) of a product variant. price: type: number title: Price description: The price of a product variant. inventory_quantity: type: integer title: Inventory Quantity description: The inventory quantity of a product variant. image_url: type: string title: Image URL description: The image URL for a product variant. backorders: type: string title: Backorders description: The backorders of a product variant. visibility: type: string title: Visibility description: The visibility of a product variant. created_at: type: string title: Creation Time format: date-time description: The date and time the product was created in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' updated_at: type: string title: Update Time format: date-time description: The date and time the product was last updated in ISO 8601 format. readOnly: true example: '2015-07-15T19:28:00+00:00' _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Ecommerce x-custom-config: methodNameSnake: update_product_variant methodNameCamel: updateProductVariant x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Product Variant description: Delete a product variant. operationId: deleteEcommerceStoresIdProductsIdVariantsId parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: product_id x-title: Product ID description: The id for the product of a store. in: path required: true type: string example: '500123' - name: variant_id x-title: Product Variant ID description: The id for the product variant. in: path required: true type: string example: '500123' responses: '204': description: Empty Response default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Ecommerce x-custom-config: methodNameSnake: delete_product_variant methodNameCamel: deleteProductVariant x-microcks-operation: delay: 0 dispatcher: FALLBACK /ecommerce/stores/{store_id}/products/{product_id}/images/{image_id}: get: summary: Mailchimp Get Product Image Info description: Get information about a specific product image. operationId: getEcommerceStoresIdProductsIdImagesId parameters: - name: fields x-title: Fields in: query description: A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: exclude_fields x-title: Exclude Fields in: query description: A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. required: false type: array collectionFormat: csv items: type: string example: example_value - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: product_id x-title: Product ID description: The id for the product of a store. in: path required: true type: string example: '500123' - name: image_id x-title: Product Image ID description: The id for the product image. in: path required: true type: string example: '500123' responses: '200': description: '' schema: type: object title: E-commerce Product Image description: Information about a specific product image. properties: id: type: string title: Image Foreign ID description: A unique identifier for the product image. url: type: string title: URL description: The URL for a product image. variant_ids: type: array title: Product Variants description: The list of product variants using the image. items: type: string _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Ecommerce x-custom-config: methodNameSnake: get_product_image methodNameCamel: getProductImage x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: summary: Mailchimp Update Product Image description: Update a product image. operationId: patchEcommerceStoresIdProductsIdImagesId parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: product_id x-title: Product ID description: The id for the product of a store. in: path required: true type: string example: '500123' - name: image_id x-title: Product Image ID description: The id for the product image. in: path required: true type: string example: '500123' - name: body in: body description: '' required: true schema: type: object title: E-commerce Product Image description: Information about a specific product image. properties: id: type: string title: Image Foreign ID description: A unique identifier for the product image. url: type: string title: URL description: The URL for a product image. variant_ids: type: array title: Product Variants description: The list of product variants using the image. items: type: string example: example_value responses: '200': description: '' schema: type: object title: E-commerce Product Image description: Information about a specific product image. properties: id: type: string title: Image Foreign ID description: A unique identifier for the product image. url: type: string title: URL description: The URL for a product image. variant_ids: type: array title: Product Variants description: The list of product variants using the image. items: type: string _links: title: Links description: A list of link types and descriptions for the API schema documents. type: array items: type: object title: Resource Link description: This object represents a link from the resource where it is found to another resource or action that may be performed. properties: rel: type: string title: Rel description: As with an HTML 'rel' attribute, this describes the type of link. readOnly: true href: type: string title: Href description: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. readOnly: true method: type: string title: Method description: The HTTP method that should be used when accessing the URL defined in 'href'. enum: - GET - POST - PUT - PATCH - DELETE - OPTIONS - HEAD readOnly: true targetSchema: type: string title: Target Schema description: For GETs, this is a URL representing the schema that the response should conform to. readOnly: true schema: type: string title: Schema description: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. readOnly: true readOnly: true default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Ecommerce x-custom-config: methodNameSnake: update_product_image methodNameCamel: updateProductImage x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Mailchimp Delete Product Image description: Delete a product image. operationId: deleteEcommerceStoresIdProductsIdImagesId parameters: - name: store_id x-title: Store ID description: The store id. in: path required: true type: string example: '500123' - name: product_id x-title: Product ID description: The id for the product of a store. in: path required: true type: string example: '500123' - name: image_id x-title: Product Image ID description: The id for the product image. in: path required: true type: string example: '500123' responses: '204': description: Empty Response default: description: An error generated by the Mailchimp API. schema: type: object title: Problem Detail Document description: An error generated by the Mailchimp API. Conforms to IETF draft 'draft-nottingham-http-problem-06'. required: - type - title - status - detail - instance properties: type: type: string title: Problem Type description: An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. example: https://mailchimp.com/developer/marketing/docs/errors/ title: type: string title: Error Title description: A short, human-readable summary of the problem type. It shouldn't change based on the occurrence of the problem, except for purposes of localization. example: Resource Not Found status: type: integer title: HTTP Status Code description: The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. example: 404 detail: type: string title: Error Message description: A human-readable explanation specific to this occurrence of the problem. [Learn more about errors](/developer/guides/get-started-with-mailchimp-api-3/#Errors). example: The requested resource could not be found. instance: type: string title: Instance ID description: A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. example: 995c5cb0-3280-4a6e-808b-3b096d0bb219 deprecated: false tags: - Ecommerce x-custom-config: methodNameSnake: delete_product_image methodNameCamel: deleteProductImage x-microcks-operation: delay: 0 dispatcher: FALLBACK securityDefinitions: basicAuth: type: basic externalDocs: description: Learn more with the full Mailchimp API documentation. url: https://mailchimp.com/developer/marketing/ x-doc-structure: resources: root: title: API Root description: The API root resource links to all other resources available in the API. Calling the root directory also returns details about the Mailchimp user account. paths: - / subResources: [] chimp-chatter: title: Chimp Chatter Activity description: Get the latest Chimp Chatter activity from your account. paths: - /activity-feed/chimp-chatter authorized-apps: title: Authorized Apps description: Manage registered, connected apps for your Mailchimp account with the Authorized Apps endpoints. paths: - /authorized-apps - /authorized-apps/{app_id} automation: title: Automations description: Mailchimp's classic automations feature lets you build a series of emails that send to subscribers when triggered by a specific date, activity, or event. Use the API to manage Automation workflows, emails, and queues. Does not include Customer Journeys. paths: - /automations - /automations/{workflow_id} - /automations/{workflow_id}/actions/start-all-emails - /automations/{workflow_id}/actions/pause-all-emails - /automations/{workflow_id}/actions/archive subResources: - automation-email - automation-removed-subscribers automation-email: title: Emails description: Manage individual emails in a classic automation workflow. paths: - /automations/{workflow_id}/emails - /automations/{workflow_id}/emails/{workflow_email_id} - /automations/{workflow_id}/emails/{workflow_email_id}/actions/pause - /automations/{workflow_id}/emails/{workflow_email_id}/actions/start subResources: - automation-email-queue automation-email-queue: title: Queue description: Manage list member queues for classic automation emails. paths: - /automations/{workflow_id}/emails/{workflow_email_id}/queue - /automations/{workflow_id}/emails/{workflow_email_id}/queue/{subscriber_hash} subResources: [] automation-removed-subscribers: title: Removed Subscribers description: Remove subscribers from a classic automation workflow. paths: - /automations/{workflow_id}/removed-subscribers - /automations/{workflow_id}/removed-subscribers/{subscriber_hash} subResources: [] batch-operations: title: Batch Operations description: Use batch operations to complete multiple operations with a single call. paths: - /batches - /batches/{batch_id} batch-webhooks: title: Batch Webhooks description: 'Manage webhooks for batch operations. ' paths: - /batch-webhooks - /batch-webhooks/{batch_webhook_id} account-exports: title: Account Exports description: Generate a new export or download a finished export. paths: - /account-exports - /account-exports/{export_id} campaigns: title: Campaigns description: Campaigns are how you send emails to your Mailchimp list. Use the Campaigns API calls to manage campaigns in your Mailchimp account. paths: - /campaigns - /campaigns/{campaign_id} - /campaigns/{campaign_id}/actions/cancel-send - /campaigns/{campaign_id}/actions/send - /campaigns/{campaign_id}/actions/schedule - /campaigns/{campaign_id}/actions/unschedule - /campaigns/{campaign_id}/actions/pause - /campaigns/{campaign_id}/actions/resume - /campaigns/{campaign_id}/actions/replicate - /campaigns/{campaign_id}/actions/test - /campaigns/{campaign_id}/actions/create-resend subResources: - campaign-feedback - campaign-checklist - campaign-content campaign-feedback: title: Feedback description: Post comments, reply to team feedback, and send test emails while you're working together on a Mailchimp campaign. paths: - /campaigns/{campaign_id}/feedback - /campaigns/{campaign_id}/feedback/{feedback_id} campaign-checklist: title: Send Checklist description: Review the send checklist for your campaign, and resolve any issues before sending. paths: - /campaigns/{campaign_id}/send-checklist campaign-content: title: Content description: Manage the HTML, plain-text, and template content for your Mailchimp campaigns. paths: - /campaigns/{campaign_id}/content connected-sites: title: Connected Sites description: Manage sites you've connected to your Mailchimp account. paths: - /connected-sites - /connected-sites/{connected_site_id} - /connected-sites/{connected_site_id}/actions/verify-script-installation conversations: title: Conversations description: Conversation tracking lets you view subscribers' replies to your campaigns in your Mailchimp account. paths: - /conversations - /conversations/{conversation_id} subResources: - conversation-messages conversation-messages: title: Messages description: Manage messages in a specific campaign conversation. paths: - /conversations/{conversation_id}/messages - /conversations/{conversation_id}/messages/{message_id} customer-journeys-journeys-steps-actions: title: Customer Journeys description: Manage Customer Journey automated workflows paths: - /customer-journeys/journeys/{journey_id}/steps/{step_id}/actions/trigger subResources: [] file-manager: title: File Manager description: Manage files for your Mailchimp account. The File Manager is a place to store images, documents, and other files you include or link to in your campaigns, templates, or signup forms. paths: [] subResources: - file-manager-folders - file-manager-files file-manager-folders: title: File Manager Folders description: Manage specific folders in the File Manager for your Mailchimp account. paths: - /file-manager/folders - /file-manager/folders/{folder_id} subResources: - file-manager-folders-files file-manager-files: title: File Manager Files description: Manage specific files in the File Manager for your Mailchimp account. paths: - /file-manager/files - /file-manager/files/{file_id} file-manager-folders-files: title: Files in Folder description: Manage specific files in a folder. paths: - /file-manager/folders/{folder_id}/files landing-pages: title: Landing Pages description: Manage your Landing Pages, including publishing and unpublishing. paths: - /landing-pages - /landing-pages/{page_id} - /landing-pages/{page_id}/actions/publish - /landing-pages/{page_id}/actions/unpublish subResources: - landing-pages_content landing-pages_content: title: Content description: The HTML content for your Mailchimp landing pages. paths: - /landing-pages/{page_id}/content lists: title: Lists/Audiences description: Your Mailchimp list, also known as your audience, is where you store and manage all of your contacts. paths: - /lists - /lists/{list_id} subResources: - interest-categories - list-segments - abuse-reports - list-activity - list-clients - list-growth-history - list-imports - list-members - list-merges - list-webhooks - list-signup-forms - list-locations - lists-tags-search - prebuilt-segments - list-preview-segment - list-surveys - list-sms-program list-members: title: Members description: Manage members of a specific Mailchimp list, including currently subscribed, unsubscribed, and bounced members. paths: - /lists/{list_id}/members - /lists/{list_id}/members/{subscriber_hash} - /lists/{list_id}/members/{subscriber_hash}/actions/delete-permanent subResources: - list-member-activity - list-member-activity-feed - list-member-goal - list-member-notes - list-member-tags - list-member-events list-merges: title: Merge Fields description: Manage merge fields for an audience. See [Merge Field documentation](https://mailchimp.com/developer/marketing/docs/merge-fields/) for more. paths: - /lists/{list_id}/merge-fields - /lists/{list_id}/merge-fields/{merge_id} subResources: [] abuse-reports: title: Abuse Reports description: Manage abuse complaints for a specific list. An abuse complaint occurs when your recipient reports an email as spam in their mail program. paths: - /lists/{list_id}/abuse-reports - /lists/{list_id}/abuse-reports/{report_id} list-activity: title: Activity description: Get recent daily, aggregated activity stats for your list. For example, view unsubscribes, signups, total emails sent, opens, clicks, and more, for up to 180 days. paths: - /lists/{list_id}/activity list-clients: title: Clients description: Get information about the most popular email clients for subscribers in a specific Mailchimp list. paths: - /lists/{list_id}/clients list-growth-history: title: Growth History description: View a summary of the month-by-month growth activity for a specific list. paths: - /lists/{list_id}/growth-history - /lists/{list_id}/growth-history/{month} list-webhooks: title: Webhooks description: Manage webhooks for a specific Mailchimp list. paths: - /lists/{list_id}/webhooks - /lists/{list_id}/webhooks/{webhook_id} list-surveys: title: Surveys description: Get survey data for this audience. paths: - /lists/{list_id}/surveys - /lists/{list_id}/surveys/{survey_id} - /lists/{list_id}/surveys/{survey_id}/actions/publish - /lists/{list_id}/surveys/{survey_id}/actions/unpublish - /lists/{list_id}/surveys/{survey_id}/actions/create-email interest-categories: title: Interest Categories description: Manage interest categories for a specific list. Interest categories organize interests, which are used to group subscribers based on their preferences. These correspond to 'group titles' in the Mailchimp application. paths: - /lists/{list_id}/interest-categories - /lists/{list_id}/interest-categories/{interest_category_id} subResources: - interests interests: title: Interests description: Manage interests for a specific Mailchimp list. Assign subscribers to interests to group them together. Interests are referred to as 'group names' in the Mailchimp application. paths: - /lists/{list_id}/interest-categories/{interest_category_id}/interests - /lists/{list_id}/interest-categories/{interest_category_id}/interests/{interest_id} lists-tags-search: title: Tag Search description: Search for tags on a list by name. paths: - /lists/{list_id}/tag-search list-segments: title: Segments description: Manage segments and tags for a specific Mailchimp list. A segment is a section of your list that includes only those subscribers who share specific common field information. Tags are labels you create to help organize your contacts. paths: - /lists/{list_id}/segments - /lists/{list_id}/segments/{segment_id} subResources: - list-segment-members list-segment-members: title: Segment Members description: Manage list members in a saved segment. paths: - /lists/{list_id}/segments/{segment_id}/members - /lists/{list_id}/segments/{segment_id}/members/{subscriber_hash} list-member-activity: title: Member Activity description: Get details about a subscriber's recent activity. Use the new activity-feed endpoint to access more events for a given contact. paths: - /lists/{list_id}/members/{subscriber_hash}/activity list-member-activity-feed: title: Member Activity Feed description: Get details about a subscriber's recent activity. paths: - /lists/{list_id}/members/{subscriber_hash}/activity-feed list-member-goal: title: Member Goals description: Get information about recent goal events for a specific list member. paths: - /lists/{list_id}/members/{subscriber_hash}/goals list-member-notes: title: Member Notes description: Retrieve recent notes for a specific list member. paths: - /lists/{list_id}/members/{subscriber_hash}/notes - /lists/{list_id}/members/{subscriber_hash}/notes/{note_id} list-member-tags: title: Member Tags description: Manage all the tags that have been assigned to a contact. paths: - /lists/{list_id}/members/{subscriber_hash}/tags list-member-events: title: Events description: 'Use the Events endpoint to collect website or in-app actions and trigger targeted automations. ' paths: - /lists/{list_id}/members/{subscriber_hash}/events list-signup-forms: title: Signup Forms description: Manage list signup forms. paths: - /lists/{list_id}/signup-forms list-locations: title: Locations description: Get the locations (countries) that the list's subscribers have been tagged to based on geocoding their IP address. paths: - /lists/{list_id}/locations reports: title: Reports description: 'Manage campaign reports for your Mailchimp account. All Reports endpoints are read-only. Mailchimp''s campaign and automation reports analyze clicks, opens, subscribers'' social activity, e-commerce data, and more. Note: Campaign IDs for A/B Testing Campaigns are available through the Campaign API Endpoint''s Read method.' paths: - /reports - /reports/{campaign_id} subResources: - campaign-abuse - campaign-advice - click-reports - domain-performance-reports - eepurl-reports - email-activity-reports - location-reports - sent-to-reports - sub-reports - unsub-reports - open-reports - campaign-ecommerce-product-activity campaign-abuse: title: Campaign Abuse description: Get information about campaign abuse complaints. paths: - /reports/{campaign_id}/abuse-reports - /reports/{campaign_id}/abuse-reports/{report_id} campaign-advice: title: Campaign Advice description: Get recent feedback based on a campaign's statistics. paths: - /reports/{campaign_id}/advice open-reports: title: Campaign Open Reports description: 'Get a detailed report about any emails in a specific campaign that were opened by the recipient. ' paths: - /reports/{campaign_id}/open-details - /reports/{campaign_id}/open-details/{subscriber_hash} click-reports: title: Click Reports description: Get detailed information about links clicked in campaigns. paths: - /reports/{campaign_id}/click-details - /reports/{campaign_id}/click-details/{link_id} subResources: - link-clickers campaign-ecommerce-product-activity: title: Ecommerce Product Activity description: Ecommerce product activity report for a campaign. paths: - /reports/{campaign_id}/ecommerce-product-activity link-clickers: title: Click Reports Members description: Get information about specific subscribers who clicked on links in a campaign. paths: - /reports/{campaign_id}/click-details/{link_id}/members - /reports/{campaign_id}/click-details/{link_id}/members/{subscriber_hash} domain-performance-reports: title: Domain Performance description: Get statistics for the top-performing domains from a campaign. paths: - /reports/{campaign_id}/domain-performance eepurl-reports: title: EepURL Reports description: Get a summary of social activity for the campaign, tracked by EepURL. paths: - /reports/{campaign_id}/eepurl email-activity-reports: title: Email Activity description: Get list member activity for a specific campaign. paths: - /reports/{campaign_id}/email-activity - /reports/{campaign_id}/email-activity/{subscriber_hash} location-reports: title: Location description: Get top open locations for a specific campaign. paths: - /reports/{campaign_id}/locations sent-to-reports: title: Sent To description: Get details about campaign recipients. paths: - /reports/{campaign_id}/sent-to - /reports/{campaign_id}/sent-to/{subscriber_hash} sub-reports: title: Sub-Reports description: A list of reports for child campaigns of a specific parent campaign. For example, use this endpoint to view Multivariate, RSS, and A/B Testing Campaign reports. paths: - /reports/{campaign_id}/sub-reports unsub-reports: title: Unsubscribes description: Get information about list members who unsubscribed from a specific campaign. paths: - /reports/{campaign_id}/unsubscribed - /reports/{campaign_id}/unsubscribed/{subscriber_hash} templates: title: Templates description: 'Manage your Mailchimp templates. A template is an HTML file used to create the layout and basic design for a campaign. ' paths: - /templates - /templates/{template_id} subResources: - template-default-content template-default-content: title: Default Content description: Manage the default content for a Mailchimp template. paths: - /templates/{template_id}/default-content template-folders: title: Template Folders description: Organize your templates using folders. paths: - /template-folders - /template-folders/{folder_id} campaign-folders: title: Campaign Folders description: Organize your campaigns using folders. paths: - /campaign-folders - /campaign-folders/{folder_id} ecommerce-stores: title: E-commerce Stores description: Connect your E-commerce Store to Mailchimp to take advantage of powerful reporting and personalization features and to learn more about your customers. paths: - /ecommerce/stores - /ecommerce/stores/{store_id} subResources: - ecommerce-customers - ecommerce-orders - ecommerce-products - ecommerce-carts - ecommerce-promo-rules ecommerce-customers: title: Customers description: Add Customers to your Store to track their orders and to view E-Commerce Data for your Mailchimp lists and campaigns. Each Customer is connected to a Mailchimp list member, so adding a Customer can also add or update a list member. paths: - /ecommerce/stores/{store_id}/customers - /ecommerce/stores/{store_id}/customers/{customer_id} ecommerce-promo-rules: title: Promo Rules description: Promo Rules help you create promo codes for your campaigns. Promo Rules define generic information about promo codes like expiration time, start time, amount of discount being offered etc. For a given promo rule you can define if it's a percentage discount or a fixed amount and if it applies for the order as a whole or if it's per item or free shipping. You can then create promo codes for this price rule. Promo codes contain the actual code that is applied at checkout along with some other information. Price Rules have one to many relationship with promo codes. paths: - /ecommerce/stores/{store_id}/promo-rules - /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id} subResources: - ecommerce-promo-codes ecommerce-promo-codes: title: Promo Codes description: Promo codes can be created for a given price rule. All the promo codes under a price rule share the generic information defined for that rule like the amount, type, expiration date etc. Promo code defines the more specific information about a promo code like the actual code, redemption_url, usage_count, etc that's unique to a code. Promo Code must be defined under a promo rule. paths: - /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes - /ecommerce/stores/{store_id}/promo-rules/{promo_rule_id}/promo-codes/{promo_code_id} ecommerce-orders: title: Orders description: Orders represent successful e-commerce transactions, and this data can be used to provide more detailed campaign reports, track sales, and personalize emails to your targeted consumers, and view other e-commerce data in your Mailchimp account. paths: - /ecommerce/orders - /ecommerce/stores/{store_id}/orders - /ecommerce/stores/{store_id}/orders/{order_id} subResources: - ecommerce-order-lines ecommerce-order-lines: title: Order Lines description: Each Order contains one or more Order Lines, which represent a specific Product Variant that a Customer purchases. paths: - /ecommerce/stores/{store_id}/orders/{order_id}/lines - /ecommerce/stores/{store_id}/orders/{order_id}/lines/{line_id} ecommerce-products: title: Products description: E-commerce items for sale in your store need to be created as Products so you can add the items to a Cart or an Order. Each Product requires at least one Product Variant. paths: - /ecommerce/stores/{store_id}/products - /ecommerce/stores/{store_id}/products/{product_id} subResources: - ecommerce-product-variants - ecommerce-product-images ecommerce-product-variants: title: Product Variants description: A Product Variant represents a specific item for purchase, and is contained within a parent Product. At least one Product Variant is required for each Product. paths: - /ecommerce/stores/{store_id}/products/{product_id}/variants - /ecommerce/stores/{store_id}/products/{product_id}/variants/{variant_id} ecommerce-product-images: title: Product Images description: A Product Image represents a specific product image. paths: - /ecommerce/stores/{store_id}/products/{product_id}/images - /ecommerce/stores/{store_id}/products/{product_id}/images/{image_id} ecommerce-carts: title: Carts description: Use Carts to represent unfinished e-commerce transactions. This can be used to create an Abandoned Cart workflow, or to save a consumers shopping cart pending a successful Order. paths: - /ecommerce/stores/{store_id}/carts - /ecommerce/stores/{store_id}/carts/{cart_id} subResources: - ecommerce-cart-lines ecommerce-cart-lines: title: Cart Lines description: Each Cart contains one or more Cart Lines, which represent a specific Product Variant that a Customer has added to their shopping cart. paths: - /ecommerce/stores/{store_id}/carts/{cart_id}/lines - /ecommerce/stores/{store_id}/carts/{cart_id}/lines/{line_id} facebook-ads: title: Facebook Ads description: Get information about Facebook Ads. paths: - /facebook-ads - /facebook-ads/{outreach_id} ping: title: Ping description: A health check endpoint for Mailchimp API 3.0. paths: - /ping reporting: title: Reporting description: Reporting for various campaign types. paths: [] subResources: - reporting-facebook-ads - reporting-google-ads - reporting-landing-pages - reporting-postcards - reporting-social-posts - reporting-surveys - reporting-websites reporting-facebook-ads: title: Facebook Ads description: 'Get information about Facebook Ad reports. ' paths: - /reporting/facebook-ads - /reporting/facebook-ads/{outreach_id} - /reporting/facebook-ads/{outreach_id}/ecommerce-product-activity reporting-landing-pages: title: Landing Pages description: Get information about Landing Page reports. paths: - /reporting/landing-pages - /reporting/landing-pages/{outreach_id} reporting-surveys: title: Surveys description: Get an overall report for a [hosted survey](https://mailchimp.com/help/create-a-survey/). paths: - /reporting/surveys - /reporting/surveys/{survey_id} subResources: - reporting-surveys-questions - reporting-surveys-responses reporting-surveys-questions: title: Survey Questions description: Get reports by question on a [hosted survey](https://mailchimp.com/help/create-a-survey/). paths: - /reporting/surveys/{survey_id}/questions - /reporting/surveys/{survey_id}/questions/{question_id} subResources: - reporting-surveys-questions-answers reporting-surveys-questions-answers: title: Survey Question Answers description: Answers to specific questions on a [hosted survey](https://mailchimp.com/help/create-a-survey/). paths: - /reporting/surveys/{survey_id}/questions/{question_id}/answers reporting-surveys-responses: title: Survey Responses description: Get survey response reports for a [hosted survey](https://mailchimp.com/help/create-a-survey/). paths: - /reporting/surveys/{survey_id}/responses - /reporting/surveys/{survey_id}/responses/{response_id} search-campaigns: title: Search Campaigns description: Search all of an account's campaigns for the specified query terms. paths: - /search-campaigns search-members: title: Search Members description: Search the account or a specific list for members that match the specified query terms. paths: - /search-members verified-domains: x-hidden: false title: Verified Domains description: Manage the domains on your account that can be used for sending email campaigns. paths: - /verified-domains - /verified-domains/{domain_name} - /verified-domains/{domain_name}/actions/verify subresources: []