How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Mirakl Promotions API

The Promotions API from Mirakl — 2 operation(s) for promotions.

Mirakl Promotions API is one of 34 APIs that Mirakl publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Promotions. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 3 operations across 2 paths, and defines 24 schemas. It is described by OpenAPI 3.2.0.

Requests are made against a single base URL, https://your-instance.mirakl.net.

3 operations 2 paths 24 schemas 1 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
Base URL
https://your-instance.mirakl.net
Authentication
HTTP Bearer, OAuth 2.0, HTTP Bearer, HTTP Bearer, API Key, API Key
Resource Areas
1

Authentication & Security 6

Mirakl Promotions API declares 6 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (Front-Bearer-Token). It supports OAuth 2.0 (OAuth-2) using the authorizationCode flow. It accepts HTTP bearer tokens (JWT) (Operator-Bearer-Token). It accepts HTTP bearer tokens (JWT) (operator_bearer_token). An API key is passed in the header as Authorization (Shop-API-Key). An API key is passed in the header as Authorization (shop_api_key).

  • OAuth-2 — For more information, see our [Authentication System documentation](https://help.mirakl.com/docs/customers/page/topics/Mirakl/partnersintegration/authenticatio…

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 1 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Promotions 3
GET
/api/promotions
PR01 - List promotions
PR01 14 params → 200
POST
/api/promotions
PR03 - Create a promotion
PR03 1 param body → 201
PUT
/api/promotions/{promotion_internal_id}
PR04 - Update a promotion
PR04 2 params body → 200

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are PR01_Response_200_Promotions (25 properties), PR01_Response_200_Promotions_2 (24 properties), PR03_Request (11 properties), PR04_Request (10 properties). Each schema is shown below with its type and property counts.

PR01_Response_200
object
2 properties 2 required
PR01_Response_200_Promotions_Campaign
object
1 property 1 required
PR01_Response_200_Promotions
object
25 properties 15 required
PR01_Response_200_Promotions_Medias
object
2 properties 2 required
PR01_Response_200_Promotions_Triggers
object
4 properties 1 required
PR01_Response_200_Promotions_ApplicationToCart
object
1 property
PR01_Response_200_Promotions_PublicDescriptions
object
2 properties 2 required
PR01_Response_200_Promotions_Channels
object
2 properties 2 required
PR04_Request_Trigger_Selection
object
The product assortment triggering the promotion
1 property 1 required
PR04_Request_Reward_Selection
object
The product assortment receiving the reward
1 property 1 required
PR03_Request_ApplicationToCart
object
If applicable, promo code to associate to the promotion
1 property 1 required
PR03_Request_Trigger_Selection
object
1 property 1 required
PR04_Request_PublicDescriptions
object
The public descriptions of the promotion, with the locales they apply to
2 properties 2 required
PR04_Request_Trigger
object
Trigger of the promotion
1 property 1 required
PR03_Request_Reward_Selection
object
1 property 1 required
PR04_Request_ApplicationToCart
object
If applicable, promo code associated to the promotion. Only editable if promotion is upcoming.
1 property 1 required
PR03_Request_Reward
object
Defines the reward applied when promotion is triggered
2 properties 2 required
PR03_Request_PublicDescriptions
object
The public descriptions of the promotion, with the locales they apply to
2 properties 2 required
PR04_Request
object
10 properties 4 required
PR03_Request
object
11 properties 5 required
PR03_Request_Trigger
object
Trigger of the promotion
2 properties 1 required
PR04_Request_Reward
object
Defines the reward applied when promotion is triggered
1 property 1 required
PR01_Response_200_2
object
2 properties 2 required
PR01_Response_200_Promotions_2
object
24 properties 14 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mirakl-promotions-api-openapi.yml Raw ↑

Other APIs Mirakl publishes across the network.

Mirakl Carriers API
Mirakl Catalog Configuration API
Mirakl Incidents API
Mirakl Invoicing and Accounting API
Mirakl Messages API
Mirakl Multiple shipments API
Mirakl Offers API
Mirakl Orders API
Mirakl Picklists API
Mirakl Platform Settings API
Mirakl Product Feedback API
Mirakl Products API
Where this information came from

This is an independent, third-party profile of Mirakl Promotions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.