Generated by API Evangelist
Written by API Evangelist tooling for Mirakl's API. It is a proposal applied on top of the contract, not a document Mirakl publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Mirakl Promotions API
version: 1.0.0
extends: openapi/mirakl-promotions-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/api/promotions'].get
update:
x-apievangelist-phrasing:
intent: List promotions
effect: read
questions:
- Which promotions are running on the marketplace right now?
- Can I find promotions triggered by a specific offer?
- What promotions end after a given date?
instructions:
- text: List promotions in state {states}.
slots:
states: query.states
- text: Show promotions for shops {shop_ids}.
slots:
shop_ids: query.shop_ids
- text: List promotions triggered by offers {trigger_offer_ids}.
slots:
trigger_offer_ids: query.trigger_offer_ids
method: generated
generated: '2026-09-26'
- target: $.paths['/api/promotions'].post
update:
x-apievangelist-phrasing:
intent: Create a promotion
effect: write
questions:
- How do I set up a new promotion for my shop?
- Can I limit a new promotion to certain customer groups or channels?
instructions:
- text: Create promotion {internal_id} starting {start_date} with trigger {trigger} and reward {reward}, described as {internal_description}.
slots:
internal_id: requestBody.internal_id
start_date: requestBody.start_date
trigger: requestBody.trigger
reward: requestBody.reward
internal_description: requestBody.internal_description
- text: Launch promotion {internal_id} ({internal_description}) from {start_date} to {end_date} with trigger {trigger} and reward {reward}.
slots:
internal_id: requestBody.internal_id
internal_description: requestBody.internal_description
start_date: requestBody.start_date
end_date: requestBody.end_date
trigger: requestBody.trigger
reward: requestBody.reward
method: generated
generated: '2026-09-26'
- target: $.paths['/api/promotions/{promotion_internal_id}'].put
update:
x-apievangelist-phrasing:
intent: Update a promotion
effect: write
questions:
- How do I change the dates or reward of an existing promotion?
- Can I extend a promotion I already created?
instructions:
- text: Update promotion {promotion_internal_id} to start {start_date} with trigger {trigger}, reward {reward}, description {internal_description}.
slots:
promotion_internal_id: path.promotion_internal_id
start_date: requestBody.start_date
trigger: requestBody.trigger
reward: requestBody.reward
internal_description: requestBody.internal_description
- text: Extend promotion {promotion_internal_id} to end {end_date}.
slots:
promotion_internal_id: path.promotion_internal_id
end_date: requestBody.end_date
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.