Mirakl · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mirakl Connect Channel Platform Carriers API

2 actions 2 updates phrasing extends openapi/mirakl-carriers-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['/v1/orders/channels/{channel_id}/carriers'].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 Mirakl Connect Channel Platform Carriers API
  version: 1.0.0
extends: openapi/mirakl-carriers-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['/v1/orders/channels/{channel_id}/carriers'].post
  update:
    x-apievangelist-phrasing:
      intent: Sync a channel's allowed carriers
      effect: write
      questions:
      - How do I share my channel's allowed carrier list with Mirakl Connect?
      - What happens to carriers I leave out of the carrier sync?
      instructions:
      - text: Upsert carriers {carriers} for channel {channel_id}.
        slots:
          carriers: requestBody.carriers
          channel_id: path.channel_id
      - text: Replace the carrier list of channel {channel_id} with {carriers}.
        slots:
          channel_id: path.channel_id
          carriers: requestBody.carriers
      method: generated
      generated: '2026-09-26'