Mailchimp Variants API

swagger: '2.0'
info:
  version: 3.0.55
  title: Mailchimp Marketing Abuse Variants 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: Variants
paths:
  /ecommerce/stores/{store_id}/products/{product_id}/variants:
    get:
      summary: Mailchimp List Product Variants
      description: Get information about a product's variants.
      operationId: getEcommerceStoresIdProductsIdVariants
      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'
      - name: product_id
        x-title: Product ID
        description: The id for the product of a store.
        in: path
        required: true
        type: string
        example: '500123'
      responses:
        '200':
          description: ''
          schema:
            type: object
            title: Ecommerce Product Variants
            description: A collection of a product's variants.
            properties:
              store_id:
                type: string
                title: Store ID
                description: The store id.
              product_id:
                type: string
                title: Product ID
                description: The product id.
              variants:
                type: array
                title: Ecommerce Product Variants
                description: An array of objects, each representing a product's 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
              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:
      - Variants
      x-custom-config:
        methodNameSnake: get_product_variants
        methodNameCamel: getProductVariants
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      summary: Mailchimp Add Product Variant
      description: Add a new variant to the product.
      operationId: postEcommerceStoresIdProductsIdVariants
      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: 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:
      - Variants
      x-custom-config:
        methodNameSnake: add_product_variants
        methodNameCamel: addProductVariants
      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:
      - Variants
      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:
               

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