Mirakl · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Operator Connector Checkout API

2 actions 2 updates phrasing extends openapi/mirakl-checkout-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 2

$.info
$.paths['/api/storefront/custom-carrier'].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 Checkout API
  version: 1.0.0
extends: openapi/mirakl-checkout-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: 1
- target: $.paths['/api/storefront/custom-carrier'].post
  update:
    x-apievangelist-phrasing:
      intent: Get Mirakl carrier rates for checkout
      effect: read
      questions:
      - How do I show the Mirakl shipping method as a custom carrier rate at checkout?
      - What rates does the Mirakl custom carrier return for a cart?
      instructions:
      - text: Get custom carrier rates for {rate}.
        slots:
          rate: requestBody.rate
      - text: Calculate the Mirakl shipping rate for this checkout.
      method: generated
      generated: '2026-09-26'