Commerce Layer custom_promotion_rules API

openapi: 3.1.0
info:
  title: Commerce Layer addresses custom_promotion_rules API
  version: 7.10.1
  contact:
    name: API Support
    url: https://commercelayer.io
    email: support@commercelayer.io
  description: Headless Commerce for Global Brands.
servers:
- url: https://{your_organization_slug}.commercelayer.io/api
  description: API
- url: https://core.commercelayer.io/users/sign_in
  description: Sign in
- url: https://docs.commercelayer.io/api
  description: API reference
security:
- bearerAuth: []
tags:
- name: custom_promotion_rules
  description: resource type
paths:
  /buy_x_pay_y_promotions/{buyXPayYPromotionId}/custom_promotion_rule:
    get:
      operationId: GET/buyXPayYPromotionId/custom_promotion_rule
      summary: Retrieve the custom promotion rule associated to the buy x pay y promotion
      description: Retrieve the custom promotion rule associated to the buy x pay y promotion
      tags:
      - custom_promotion_rules
      parameters:
      - name: buyXPayYPromotionId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The custom_promotion_rule associated to the buy x pay y promotion
  /custom_promotion_rules:
    get:
      operationId: GET/custom_promotion_rules
      summary: List all custom promotion rules
      description: List all custom promotion rules
      tags:
      - custom_promotion_rules
      responses:
        '200':
          description: A list of custom promotion rule objects
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/customPromotionRuleResponseList'
    post:
      operationId: POST/custom_promotion_rules
      summary: Create a custom promotion rule
      description: Create a custom promotion rule
      tags:
      - custom_promotion_rules
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/customPromotionRuleCreate'
      responses:
        '201':
          description: The created custom promotion rule object
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/customPromotionRuleResponse'
  /custom_promotion_rules/{customPromotionRuleId}:
    get:
      operationId: GET/custom_promotion_rules/customPromotionRuleId
      summary: Retrieve a custom promotion rule
      description: Retrieve a custom promotion rule
      tags:
      - custom_promotion_rules
      parameters:
      - name: customPromotionRuleId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The custom promotion rule object
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/customPromotionRuleResponse'
    patch:
      operationId: PATCH/custom_promotion_rules/customPromotionRuleId
      summary: Update a custom promotion rule
      description: Update a custom promotion rule
      tags:
      - custom_promotion_rules
      parameters:
      - name: customPromotionRuleId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      requestBody:
        required: true
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/customPromotionRuleUpdate'
      responses:
        '200':
          description: The updated custom promotion rule object
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/customPromotionRuleResponse'
    delete:
      operationId: DELETE/custom_promotion_rules/customPromotionRuleId
      summary: Delete a custom promotion rule
      description: Delete a custom promotion rule
      tags:
      - custom_promotion_rules
      parameters:
      - name: customPromotionRuleId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '204':
          description: No content
  /external_promotions/{externalPromotionId}/custom_promotion_rule:
    get:
      operationId: GET/externalPromotionId/custom_promotion_rule
      summary: Retrieve the custom promotion rule associated to the external promotion
      description: Retrieve the custom promotion rule associated to the external promotion
      tags:
      - custom_promotion_rules
      parameters:
      - name: externalPromotionId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The custom_promotion_rule associated to the external promotion
  /fixed_amount_promotions/{fixedAmountPromotionId}/custom_promotion_rule:
    get:
      operationId: GET/fixedAmountPromotionId/custom_promotion_rule
      summary: Retrieve the custom promotion rule associated to the fixed amount promotion
      description: Retrieve the custom promotion rule associated to the fixed amount promotion
      tags:
      - custom_promotion_rules
      parameters:
      - name: fixedAmountPromotionId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The custom_promotion_rule associated to the fixed amount promotion
  /fixed_price_promotions/{fixedPricePromotionId}/custom_promotion_rule:
    get:
      operationId: GET/fixedPricePromotionId/custom_promotion_rule
      summary: Retrieve the custom promotion rule associated to the fixed price promotion
      description: Retrieve the custom promotion rule associated to the fixed price promotion
      tags:
      - custom_promotion_rules
      parameters:
      - name: fixedPricePromotionId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The custom_promotion_rule associated to the fixed price promotion
  /free_gift_promotions/{freeGiftPromotionId}/custom_promotion_rule:
    get:
      operationId: GET/freeGiftPromotionId/custom_promotion_rule
      summary: Retrieve the custom promotion rule associated to the free gift promotion
      description: Retrieve the custom promotion rule associated to the free gift promotion
      tags:
      - custom_promotion_rules
      parameters:
      - name: freeGiftPromotionId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The custom_promotion_rule associated to the free gift promotion
  /free_shipping_promotions/{freeShippingPromotionId}/custom_promotion_rule:
    get:
      operationId: GET/freeShippingPromotionId/custom_promotion_rule
      summary: Retrieve the custom promotion rule associated to the free shipping promotion
      description: Retrieve the custom promotion rule associated to the free shipping promotion
      tags:
      - custom_promotion_rules
      parameters:
      - name: freeShippingPromotionId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The custom_promotion_rule associated to the free shipping promotion
  /percentage_discount_promotions/{percentageDiscountPromotionId}/custom_promotion_rule:
    get:
      operationId: GET/percentageDiscountPromotionId/custom_promotion_rule
      summary: Retrieve the custom promotion rule associated to the percentage discount promotion
      description: Retrieve the custom promotion rule associated to the percentage discount promotion
      tags:
      - custom_promotion_rules
      parameters:
      - name: percentageDiscountPromotionId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The custom_promotion_rule associated to the percentage discount promotion
  /promotions/{promotionId}/custom_promotion_rule:
    get:
      operationId: GET/promotionId/custom_promotion_rule
      summary: Retrieve the custom promotion rule associated to the promotion
      description: Retrieve the custom promotion rule associated to the promotion
      tags:
      - custom_promotion_rules
      parameters:
      - name: promotionId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The custom_promotion_rule associated to the promotion
components:
  schemas:
    flexPromotion:
      type: object
      properties:
        data:
          type: object
          required:
          - type
          - attributes
          properties:
            type:
              type: string
              description: The resource's type
              enum:
              - flex_promotions
            attributes:
              type: object
              properties:
                name:
                  type: string
                  description: The promotion's internal name.
                  example: Personal promotion
                  nullable: false
                type:
                  type: string
                  description: The promotion's type.
                  example: percentage_discount_promotions
                  nullable: false
                  enum:
                  - percentage_discount_promotions
                  - free_shipping_promotions
                  - buy_x_pay_y_promotions
                  - free_gift_promotions
                  - fixed_price_promotions
                  - external_promotions
                  - fixed_amount_promotions
                  - flex_promotions
                exclusive:
                  type: boolean
                  description: Indicates if the promotion will be applied exclusively, based on its priority score.
                  example: true
                  nullable: true
                priority:
                  type: integer
                  description: The priority assigned to the promotion (lower means higher priority).
                  example: 2
                  nullable: true
                starts_at:
                  type: string
                  description: The activation date/time of this promotion.
                  example: '2018-01-01T12:00:00.000Z'
                  nullable: false
                expires_at:
                  type: string
                  description: The expiration date/time of this promotion (must be after starts_at).
                  example: '2018-01-02T12:00:00.000Z'
                  nullable: false
                total_usage_limit:
                  type: integer
                  description: The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times.
                  example: 5
                  nullable: true
                total_usage_count:
                  type: integer
                  description: The number of times this promotion has been applied.
                  example: 2
                  nullable: true
                active:
                  type: boolean
                  description: Indicates if the promotion is active (enabled and not expired).
                  example: true
                  nullable: true
                status:
                  type: string
                  description: The promotion status. One of 'disabled', 'expired', 'pending', 'active', or 'inactive'.
                  example: pending
                  nullable: true
                  enum:
                  - disabled
                  - expired
                  - pending
                  - active
                  - inactive
                rules:
                  type: object
                  description: The discount rule to be applied.
                  example: {}
                  nullable: false
                rule_outcomes:
                  type: object
                  description: The rule outcomes.
                  example: []
                  nullable: true
                disabled_at:
                  type: string
                  description: Time at which this resource was disabled.
                  example: '2018-01-01T12:00:00.000Z'
                  nullable: true
                created_at:
                  type: string
                  description: Time at which the resource was created.
                  example: '2018-01-01T12:00:00.000Z'
                  nullable: false
                updated_at:
                  type: string
                  description: Time at which the resource was last updated.
                  example: '2018-01-01T12:00:00.000Z'
                  nullable: false
                reference:
                  type: string
                  description: A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.
                  example: ANY-EXTERNAL-REFEFERNCE
                  nullable: true
                reference_origin:
                  type: string
                  description: Any identifier of the third party system that defines the reference code.
                  example: ANY-EXTERNAL-REFEFERNCE-ORIGIN
                  nullable: true
                resource_payload:
                  type: object
                  description: The payload used to evaluate the rules.
                  example: {}
                  nullable: true
                metadata:
                  type: object
                  description: Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
                  example:
                    foo: bar
                  nullable: true
            relationships:
              type: object
              properties:
                coupon_codes_promotion_rule:
                  type: object
                  properties:
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - coupon_codes_promotion_rules
                        id:
                          type: string
                          description: Unique identifier for the resource (hash).
                          example: XAyRWNUzyN
                coupons:
                  type: object
                  properties:
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - coupons
                        id:
                          type: string
                          description: Unique identifier for the resource (hash).
                          example: XAyRWNUzyN
                attachments:
                  type: object
                  properties:
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - attachments
                        id:
                          type: string
                          description: Unique identifier for the resource (hash).
                          example: XAyRWNUzyN
                events:
                  type: object
                  properties:
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - events
                        id:
                          type: string
                          description: Unique identifier for the resource (hash).
                          example: XAyRWNUzyN
                tags:
                  type: object
                  properties:
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - tags
                        id:
                          type: string
                          description: Unique identifier for the resource (hash).
                          example: XAyRWNUzyN
                event_stores:
                  type: object
                  properties:
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - event_stores
                        id:
                          type: string
                          description: Unique identifier for the resource (hash).
                          example: XAyRWNUzyN
    customPromotionRuleResponseList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/customPromotionRuleResponse/properties/data'
    percentageDiscountPromotion:
      type: object
      properties:
        data:
          type: object
          required:
          - type
          - attributes
          properties:
            type:
              type: string
              description: The resource's type
              enum:
              - percentage_discount_promotions
            attributes:
              type: object
              properties:
                name:
                  type: string
                  description: The promotion's internal name.
                  example: Personal promotion
                  nullable: false
                type:
                  type: string
                  description: The promotion's type.
                  example: percentage_discount_promotions
                  nullable: false
                  enum:
                  - percentage_discount_promotions
                  - free_shipping_promotions
                  - buy_x_pay_y_promotions
                  - free_gift_promotions
                  - fixed_price_promotions
                  - external_promotions
                  - fixed_amount_promotions
                  - flex_promotions
                currency_code:
                  type: string
                  description: The international 3-letter currency code as defined by the ISO 4217 standard.
                  example: EUR
                  nullable: true
                exclusive:
                  type: boolean
                  description: Indicates if the promotion will be applied exclusively, based on its priority score.
                  example: true
                  nullable: true
                priority:
                  type: integer
                  description: The priority assigned to the promotion (lower means higher priority).
                  example: 2
                  nullable: true
                starts_at:
                  type: string
                  description: The activation date/time of this promotion.
                  example: '2018-01-01T12:00:00.000Z'
                  nullable: false
                expires_at:
                  type: string
                  description: The expiration date/time of this promotion (must be after starts_at).
                  example: '2018-01-02T12:00:00.000Z'
                  nullable: false
                total_usage_limit:
                  type: integer
                  description: The total number of times this promotion can be applied. When 'null' it means promotion can be applied infinite times.
                  example: 5
                  nullable: true
                total_usage_count:
                  type: integer
                  description: The number of times this promotion has been applied.
                  example: 2
                  nullable: true
                total_usage_reached:
                  type: boolean
                  description: Indicates if the promotion has been applied the total number of allowed times.
                  example: false
                  nullable: true
                active:
                  type: boolean
                  description: Indicates if the promotion is active (enabled and not expired).
                  example: true
                  nullable: true
                status:
                  type: string
                  description: The promotion status. One of 'disabled', 'expired', 'pending', 'active', or 'inactive'.
                  example: pending
                  nullable: true
                  enum:
                  - disabled
                  - expired
                  - pending
                  - active
                  - inactive
                weight:
                  type: integer
                  description: The weight of the promotion, computed by exclusivity, priority, type and start time. Determines the order of application, higher weight apply first.
                  example: 112
                  nullable: true
                coupons_count:
                  type: integer
                  description: The total number of coupons created for this promotion.
                  example: 2
                  nullable: true
                disabled_at:
                  type: string
                  description: Time at which this resource was disabled.
                  example: '2018-01-01T12:00:00.000Z'
                  nullable: true
                created_at:
                  type: string
                  description: Time at which the resource was created.
                  example: '2018-01-01T12:00:00.000Z'
                  nullable: false
                updated_at:
                  type: string
                  description: Time at which the resource was last updated.
                  example: '2018-01-01T12:00:00.000Z'
                  nullable: false
                reference:
                  type: string
                  description: A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.
                  example: ANY-EXTERNAL-REFEFERNCE
                  nullable: true
                reference_origin:
                  type: string
                  description: Any identifier of the third party system that defines the reference code.
                  example: ANY-EXTERNAL-REFEFERNCE-ORIGIN
                  nullable: true
                metadata:
                  type: object
                  description: Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
                  example:
                    foo: bar
                  nullable: true
                percentage:
                  type: integer
                  description: The discount percentage to be applied.
                  example: 10
                  nullable: false
            relationships:
              type: object
              properties:
                market:
                  type: object
                  properties:
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - markets
                        id:
                          type: string
                          description: Unique identifier for the resource (hash).
                          example: XAyRWNUzyN
                promotion_rules:
                  type: object
                  properties:
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - promotion_rules
                        id:
                          type: string
                          description: Unique identifier for the resource (hash).
                          example: XAyRWNUzyN
                order_amount_promotion_rule:
                  type: object
                  properties:
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - order_amount_promotion_rules
                        id:
                          type: string
                          description: Unique identifier for the resource (hash).
                          example: XAyRWNUzyN
                sku_list_promotion_rule:
                  type: object
                  properties:
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - sku_list_promotion_rules
                        id:
                          type: string
                          description: Unique identifier for the resource (hash).
                          example: XAyRWNUzyN
                coupon_codes_promotion_rule:
                  type: object
                  properties:
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - coupon_codes_promotion_rules
                        id:
                          type: string
                          description: Unique identifier for the resource (hash).
                          example: XAyRWNUzyN
                custom_promotion_rule:
                  type: object
                  properties:
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - custom_promotion_rules
                        id:
                          type: string
                          description: Unique identifier for the resource (hash).
                          example: XAyRWNUzyN
                sku_list:
                  type: object
                  properties:
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - sku_lists
                        id:
                          type: string
                          description: Unique identifier for the resource (hash).
                          example: XAyRWNUzyN
                coupons:
                  type: object
                  properties:
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - coupons
                        id:
                          type: string
                          description: Unique identifier for the resource (hash).
                          example: XAyRWNUzyN
                attachments:
                  type: object
                  properties:
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - attachments
                        id:
                          type: string
                          description: Unique identifier for the resource (hash).
                          example: XAyRWNUzyN
                events:
                  type: object
                  properties:
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - events
                        id:
                          type: string
                          description: Unique identifier for the resource (hash).
                          example: XAyRWNUzyN
                tags:
                  type: object
                  properties:
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - tags
                        id:
                          type: string
                          description: Unique identifier for the resource (hash).
                          example: XAyRWNUzyN
                event_stores:
                  type: object
                  properties:
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - event_stores
                        id:
                          type: string
                          description: Unique identifier for the resource (hash).
                          example: XAyRWNUzyN
                skus:
                  type: object
                  properties:
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - skus
                        id:
                          type: string
                          description: Unique identifier for the resource (hash).
                          example: XAyRWNUzyN
    fixedPricePromotion:
      type: object
      properties:
        data:
          type: object
          required:
          - type
          - attributes
          properties:
            type:
              type: string
              description: The resource's type
              enum:
              - fixed_price_promotions
            attributes:
              type: object
              properties:
                name:
                  type: string
                  description: The promotion's internal name.
                  example: Personal promotion
                  nullable: false
                type:
                  type: string
                  description: The promotion's type.
                  example: percentage_discount_promotions
                  nullable: false
                  enum:
                  - percentage_discount_promotions
                  

# --- truncated at 32 KB (125 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/commerce-layer/refs/heads/main/openapi/commerce-layer-custom-promotion-rules-api-openapi.yml