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 Store API
version: 1.0.0
extends: openapi/mirakl-store-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: 2
- target: $.paths['/v1/users/stores'].post
update:
x-apievangelist-phrasing:
intent: Create stores for a user
effect: write
questions:
- How does a connector create stores and link them to a seller user?
- Can I create several stores for a user in one call?
instructions:
- text: Create stores {stores} for the user with token {token}.
slots:
stores: requestBody.stores
token: query.token
- text: Link new stores {stores} to user token {token}.
slots:
stores: requestBody.stores
token: query.token
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/channels/{channel_id}/stores/{channel_store_id}'].put
update:
x-apievangelist-phrasing:
intent: Update a channel store
effect: write
questions:
- How do I rename or suspend a store on a channel?
- Can I set an access expiration date on a store?
instructions:
- text: 'Update store {channel_store_id} on channel {channel_id}: name {name}, state {state}.'
slots:
channel_store_id: path.channel_store_id
channel_id: path.channel_id
name: requestBody.name
state: requestBody.state
- text: Suspend store {channel_store_id} on channel {channel_id} with type {suspension_type}, keeping name {name} and state {state}.
slots:
channel_store_id: path.channel_store_id
channel_id: path.channel_id
suspension_type: requestBody.suspension_type
name: requestBody.name
state: requestBody.state
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.