Mirakl · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Operator Connector Public API

3 actions 3 updates phrasing extends openapi/mirakl-public-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/public/checkout-data'].post
$.paths['/api/public/shipping-fees'].post

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 Public API
  version: 1.0.0
extends: openapi/mirakl-public-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/public/checkout-data'].post
  update:
    x-apievangelist-phrasing:
      intent: Get marketplace data for checkout
      effect: read
      questions:
      - What marketplace information should I show at checkout for a cart?
      - Can I apply promotion codes when fetching checkout data?
      instructions:
      - text: Get checkout data for cart lines {cartLines}.
        slots:
          cartLines: requestBody.cartLines
      - text: Get checkout data for {cartLines} with promo codes {promotionCodes}.
        slots:
          cartLines: requestBody.cartLines
          promotionCodes: requestBody.promotionCodes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/public/shipping-fees'].post
  update:
    x-apievangelist-phrasing:
      intent: Get shipping fees per seller at checkout
      effect: read
      questions:
      - Which shipping methods and fees does each seller offer for my cart?
      - Can shipping fees be calculated for a specific delivery address?
      instructions:
      - text: Get shipping fees for cart lines {cart_lines}.
        slots:
          cart_lines: requestBody.cart_lines
      - text: Get shipping options for {cart_lines} shipped to {shipping_address}.
        slots:
          cart_lines: requestBody.cart_lines
          shipping_address: requestBody.shipping_address
      method: generated
      generated: '2026-09-26'