Mirakl · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Operator Connector Product Bindings API

5 actions 5 updates phrasing extends openapi/mirakl-product-bindings-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 5

$.info

$.paths['/api/product-bindings/delete'].post

$.paths['/api/product-bindings'].get

$.paths['/api/product-bindings'].post

$.paths['/api/product-bindings'].patch

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 Product Bindings API
  version: 1.0.0
extends: openapi/mirakl-product-bindings-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: 4
- target: $.paths['/api/product-bindings/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete product bindings
      effect: destructive
      questions:
      - How do I unlink a Shopify product from its Mirakl product?
      - Can I delete several product bindings in one request?
      instructions:
      - text: Delete product bindings {entries}.
        slots:
          entries: requestBody.entries
      - text: Remove the Shopify-to-Mirakl links for {entries}.
        slots:
          entries: requestBody.entries
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/product-bindings'].get
  update:
    x-apievangelist-phrasing:
      intent: List product bindings
      effect: read
      questions:
      - Which Mirakl product is a Shopify product linked to?
      - Can I look up bindings by SKU or variant group?
      instructions:
      - text: List bindings for SKU {sku}.
        slots:
          sku: query.sku
      - text: Find the binding for Shopify product {shopifyGid}.
        slots:
          shopifyGid: query.shopifyGid
      - text: Show bindings for Mirakl product {miraklProductId}.
        slots:
          miraklProductId: query.miraklProductId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/product-bindings'].post
  update:
    x-apievangelist-phrasing:
      intent: Create product bindings
      effect: write
      questions:
      - How do I link existing Shopify products to Mirakl products?
      - Can I import bindings for many products at once?
      instructions:
      - text: Import product bindings for {products}.
        slots:
          products: requestBody.products
      - text: 'Create new bindings linking these products: {products}.'
        slots:
          products: requestBody.products
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/product-bindings'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update product bindings
      effect: write
      questions:
      - Can I change an existing product binding instead of recreating it?
      - How do I update variant bindings between Shopify and Mirakl?
      instructions:
      - text: Update existing bindings for products {products}.
        slots:
          products: requestBody.products
      - text: Update variant bindings {variants}.
        slots:
          variants: requestBody.variants
      method: generated
      generated: '2026-09-26'