Mailchimp Products API

swagger: '2.0'
info:
  version: 3.0.55
  title: Mailchimp Marketing Abuse Products 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: Products
paths:
  /ecommerce/stores/{store_id}/products:
    get:
      summary: Mailchimp List Product
      description: Get information about a store's products.
      operationId: getEcommerceStoresIdProducts
      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: 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: Products
            description: A collection of a store's products.
            properties:
              store_id:
                type: string
                title: Store ID
                description: The store id.
              products:
                type: array
                title: Products
                description: An array of objects, each representing a store product.
                items:
                  type: object
                  title: E-commerce Product
                  description: Information about a specific product.
                  properties:
                    id:
                      type: string
                      title: Product Foreign ID
                      description: A unique identifier for the product.
                      readOnly: true
                    currency_code:
                      type: string
                      title: Currency Code
                      description: The currency code
                      readOnly: true
                    title:
                      type: string
                      title: Title
                      description: The title of a product.
                      example: Cat Hat
                    handle:
                      type: string
                      title: Handle
                      description: The handle of a product.
                      example: cat-hat
                    url:
                      type: string
                      title: Product URL
                      description: The URL for a product.
                    description:
                      type: string
                      title: Description
                      description: The description of a product.
                      example: This is a cat hat.
                    type:
                      type: string
                      title: Type
                      description: The type of product.
                      example: Accessories
                    vendor:
                      type: string
                      title: Vendor
                      description: The vendor for a product.
                    image_url:
                      type: string
                      title: Product Image URL
                      description: The image URL for a product.
                    variants:
                      type: array
                      title: Product Variants
                      description: Returns up to 50 of the product's variants. To retrieve all variants use [Product Variants](https://mailchimp.com/developer/marketing/api/ecommerce-product-variants/).
                      items:
                        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
                    images:
                      type: array
                      title: Product Images
                      description: An array of the product's images.
                      items:
                        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
                    published_at_foreign:
                      type: string
                      title: Foreign Publish Time
                      format: date-time
                      description: The date and time the product was published in ISO 8601 format.
                      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
              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:
      - Products
      x-custom-config:
        methodNameSnake: get_all_store_products
        methodNameCamel: getAllStoreProducts
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      summary: Mailchimp Add Product
      description: Add a new product to a store.
      operationId: postEcommerceStoresIdProducts
      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 Product
          description: Information about a specific product.
          required:
          - id
          - title
          - variants
          properties:
            id:
              type: string
              title: Product Foreign ID
              description: A unique identifier for the product.
            title:
              type: string
              title: Title
              description: The title of a product.
              example: Cat Hat
            handle:
              type: string
              title: Handle
              description: The handle of a product.
              example: cat-hat
            url:
              type: string
              title: Product URL
              description: The URL for a product.
            description:
              type: string
              title: Description
              description: The description of a product.
              example: This is a cat hat.
            type:
              type: string
              title: Type
              description: The type of product.
              example: Accessories
            vendor:
              type: string
              title: Vendor
              description: The vendor for a product.
            image_url:
              type: string
              title: Product Image URL
              description: The image URL for a product.
            variants:
              type: array
              title: Product Variants
              description: An array of the product's variants. At least one variant is required for each product. A variant can use the same `id` and `title` as the parent product.
              items:
                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.
            images:
              type: array
              title: Product Images
              description: An array of the product's images.
              items:
                type: object
                title: E-commerce Product Image
                description: Information about a specific product image.
                required:
                - id
                - url
                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
            published_at_foreign:
              type: string
              title: Foreign Publish Time
              format: date-time
              description: The date and time the product was published.
              example: '2015-07-15T19:28:00+00:00'
        example: example_value
      responses:
        '200':
          description: ''
          schema:
            type: object
            title: E-commerce Product
            description: Information about a specific product.
            properties:
              id:
                type: string
                title: Product Foreign ID
                description: A unique identifier for the product.
                readOnly: true
              currency_code:
                type: string
                title: Currency Code
                description: The currency code
                readOnly: true
              title:
                type: string
                title: Title
                description: The title of a product.
                example: Cat Hat
              handle:
                type: string
                title: Handle
                description: The handle of a product.
                example: cat-hat
              url:
                type: string
                title: Product URL
                description: The URL for a product.
              description:
                type: string
                title: Description
                description: The description of a product.
                example: This is a cat hat.
              type:
                type: string
                title: Type
                description: The type of product.
                example: Accessories
              vendor:
                type: string
                title: Vendor
                description: The vendor for a product.
              image_url:
                type: string
                title: Product Image URL
                description: The image URL for a product.
              variants:
                type: array
                title: Product Variants
                description: Returns up to 50 of the product's variants. To retrieve all variants use [Product Variants](https://mailchimp.com/developer/marketing/api/ecommerce-product-variants/).
                items:
                  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
      

# --- truncated at 32 KB (184 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mailchimp/refs/heads/main/openapi/mailchimp-products-api-openapi.yml