Mailchimp Promo API

swagger: '2.0'
info:
  version: 3.0.55
  title: Mailchimp Marketing Abuse Promo 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: Promo
paths:
  /ecommerce/stores/{store_id}/promo-rules:
    get:
      summary: Mailchimp List Promo Rules
      description: Get information about a store's promo rules.
      operationId: getEcommerceStoresIdPromorules
      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: Promo Rules
            description: A collection of the store's promo rules.
            properties:
              store_id:
                type: string
                title: Store ID
                description: The store id.
              promo_rules:
                type: array
                title: Promo Rules
                description: An array of objects, each representing promo rules defined for a store.
                items:
                  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
              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:
      - Promo
      x-custom-config:
        methodNameSnake: list_promo_rules
        methodNameCamel: listPromoRules
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      summary: Mailchimp Add Promo Rule
      description: Add a new promo rule to a store.
      operationId: postEcommerceStoresIdPromorules
      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 Promo Rule
          description: Information about an Ecommerce Store's specific Promo Rule.
          required:
          - id
          - description
          - amount
          - type
          - target
          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.
            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:
      - Promo
      x-custom-config:
        methodNameSnake: add_promo_rules
        methodNameCamel: addPromoRules
      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:
      - Promo
      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: patchEcommerceS

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