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

Raw ↑ 
# 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'