Commerce Layer

Commerce Layer promotions API

resource type

GitHub OpenAPI

Operations 2

GET /promotions List all promotions #
GET /promotions/{promotionId} Retrieve a promotion #

Documentation

📖
Documentation
https://docs.commercelayer.io/core/
📖
Documentation
https://docs.commercelayer.io/core-api-reference/
📖
Documentation
https://docs.commercelayer.io/core/api-specification
📖
Authentication
https://docs.commercelayer.io/core/authentication
📖
RateLimits
https://docs.commercelayer.io/core/rate-limits
📖
Documentation
https://docs.commercelayer.io/core/event-stream-hub
📖
Documentation
https://docs.commercelayer.io/provisioning
📖
Documentation
https://docs.commercelayer.io/provisioning-api-reference/
📖
Documentation
https://docs.commercelayer.io/metrics/welcome
📖
Documentation
https://docs.commercelayer.io/metrics/getting-started/api-specification

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/commerce-layer/refs/heads/main/openapi/commerce-layer-promotions-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/commerce-layer/refs/heads/main/json-schema/commerce-layer-order-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/commerce-layer/refs/heads/main/json-schema/commerce-layer-sku-schema.json

Other Resources

🔗
Webhooks
https://docs.commercelayer.io/core/real-time-webhooks
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/commerce-layer/refs/heads/main/json-ld/commerce-layer-context.jsonld
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/commerce-layer/refs/heads/main/graphql/commerce-layer-graphql.md

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/commerce-layer-promotions-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

commerce-layer-promotions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Commerce Layer Promotions 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: promotions
  description: resource type
paths:
  /promotions:
    get:
      operationId: GET/promotions
      summary: List all promotions
      description: List all promotions
      tags:
      - promotions
      responses:
        '200':
          description: A list of promotion objects
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/promotionResponseList'
  /promotions/{promotionId}:
    get:
      operationId: GET/promotions/promotionId
      summary: Retrieve a promotion
      description: Retrieve a promotion
      tags:
      - promotions
      parameters:
      - name: promotionId
        in: path
        schema:
          type: string
        required: true
        description: The resource's id
      responses:
        '200':
          description: The promotion object
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/promotionResponse'
components:
  schemas:
    promotionResponseList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/promotionResponse/properties/data'
    promotionResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            id:
              type: string
              description: Unique identifier for the resource (hash).
              example: XAyRWNUzyN
            type:
              type: string
              description: The resource's type
              enum:
              - promotions
            links:
              type: object
              properties:
                self:
                  type: string
                  description: URL
            attributes:
              $ref: '#/components/schemas/promotion/properties/data/properties/attributes'
            relationships:
              type: object
              properties:
                market:
                  type: object
                  properties:
                    links:
                      type: object
                      properties:
                        self:
                          type: string
                          description: URL
                        related:
                          type: string
                          description: URL
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - market
                        id:
                          type: string
                          description: The resource ID
                promotion_rules:
                  type: object
                  properties:
                    links:
                      type: object
                      properties:
                        self:
                          type: string
                          description: URL
                        related:
                          type: string
                          description: URL
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - promotion_rules
                        id:
                          type: string
                          description: The resource ID
                order_amount_promotion_rule:
                  type: object
                  properties:
                    links:
                      type: object
                      properties:
                        self:
                          type: string
                          description: URL
                        related:
                          type: string
                          description: URL
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - order_amount_promotion_rule
                        id:
                          type: string
                          description: The resource ID
                sku_list_promotion_rule:
                  type: object
                  properties:
                    links:
                      type: object
                      properties:
                        self:
                          type: string
                          description: URL
                        related:
                          type: string
                          description: URL
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - sku_list_promotion_rule
                        id:
                          type: string
                          description: The resource ID
                coupon_codes_promotion_rule:
                  type: object
                  properties:
                    links:
                      type: object
                      properties:
                        self:
                          type: string
                          description: URL
                        related:
                          type: string
                          description: URL
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - coupon_codes_promotion_rule
                        id:
                          type: string
                          description: The resource ID
                custom_promotion_rule:
                  type: object
                  properties:
                    links:
                      type: object
                      properties:
                        self:
                          type: string
                          description: URL
                        related:
                          type: string
                          description: URL
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - custom_promotion_rule
                        id:
                          type: string
                          description: The resource ID
                sku_list:
                  type: object
                  properties:
                    links:
                      type: object
                      properties:
                        self:
                          type: string
                          description: URL
                        related:
                          type: string
                          description: URL
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - sku_list
                        id:
                          type: string
                          description: The resource ID
                coupons:
                  type: object
                  properties:
                    links:
                      type: object
                      properties:
                        self:
                          type: string
                          description: URL
                        related:
                          type: string
                          description: URL
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - coupons
                        id:
                          type: string
                          description: The resource ID
                attachments:
                  type: object
                  properties:
                    links:
                      type: object
                      properties:
                        self:
                          type: string
                          description: URL
                        related:
                          type: string
                          description: URL
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - attachments
                        id:
                          type: string
                          description: The resource ID
                events:
                  type: object
                  properties:
                    links:
                      type: object
                      properties:
                        self:
                          type: string
                          description: URL
                        related:
                          type: string
                          description: URL
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - events
                        id:
                          type: string
                          description: The resource ID
                tags:
                  type: object
                  properties:
                    links:
                      type: object
                      properties:
                        self:
                          type: string
                          description: URL
                        related:
                          type: string
                          description: URL
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - tags
                        id:
                          type: string
                          description: The resource ID
                event_stores:
                  type: object
                  properties:
                    links:
                      type: object
                      properties:
                        self:
                          type: string
                          description: URL
                        related:
                          type: string
                          description: URL
                    data:
                      type: object
                      properties:
                        type:
                          type: string
                          description: The resource's type
                          enum:
                          - event_stores
                        id:
                          type: string
                          description: The resource ID
    promotion:
      type: object
      properties:
        data:
          type: object
          required:
          - type
          - attributes
          properties:
            type:
              type: string
              description: The resource's type
              enum:
              - 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
            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
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT