Mirakl · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Operator Connector Mapping API

3 actions 3 updates phrasing extends openapi/mirakl-mapping-api-openapi.yml

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.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/api/mapping/returns/{orderId}'].get

$.paths['/api/mapping/transactions/{orderId}'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Shopify Operator Connector Mapping API
  version: 1.0.0
extends: openapi/mirakl-mapping-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['/api/mapping/returns/{orderId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List Mirakl returns for a Shopify order
      effect: read
      questions:
      - Which marketplace returns are linked to a Shopify order?
      - Can I see the Mirakl returns tracked for an order, newest first?
      instructions:
      - text: List Mirakl returns for Shopify order {orderId}.
        slots:
          orderId: path.orderId
      - text: Show return mappings of order {orderId}.
        slots:
          orderId: path.orderId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/mapping/transactions/{orderId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List Mirakl transactions for a Shopify order
      effect: read
      questions:
      - What debits, refunds and cancellations has Mirakl recorded for a Shopify order?
      - Can I see the payment transactions tied to one Shopify order?
      instructions:
      - text: List Mirakl transactions for Shopify order {orderId}.
        slots:
          orderId: path.orderId
      - text: Show refunds and debits recorded for order {orderId}.
        slots:
          orderId: path.orderId
      method: generated
      generated: '2026-09-26'

Work with this as data

Every overlay 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 openapi overlays

4 MCP tools reach this

find_overlaysBrowse and filter every overlay in the catalog.
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 overlay

curl "https://apis.io/api/v1/overlays/mirakl-mapping-api-phrasing-overlay"

All openapi overlays

curl "https://apis.io/api/v1/overlays?limit=25"

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.

GitHub Google LinkedIn

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