Mirakl · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mirakl Connect Shipments API

3 actions 3 updates phrasing extends openapi/mirakl-shipments-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['/orders/{order_id}/shipments'].post
$.paths['/v2/orders/{order_id}/shipments'].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 Shipments API
  version: 1.0.0
extends: openapi/mirakl-shipments-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['/orders/{order_id}/shipments'].post
  update:
    x-apievangelist-phrasing:
      intent: Ship items of a Connect order (original)
      effect: write
      questions:
      - How do I ship items of a Connect order in one package with the original shipment call?
      - Can I add a return tracking number when shipping Connect order items the first-version way?
      instructions:
      - text: With the original endpoint, ship items {items} of Connect order {order_id} with tracking {tracking_number}.
        slots:
          items: requestBody.items
          order_id: path.order_id
          tracking_number: requestBody.tracking_number
      - text: Create a v1 shipment for Connect order {order_id} via carrier {carrier}.
        slots:
          order_id: path.order_id
          carrier: requestBody.carrier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/orders/{order_id}/shipments'].post
  update:
    x-apievangelist-phrasing:
      intent: Ship items of a Connect order (v2)
      effect: write
      questions:
      - How do I ship Connect order items from a specific warehouse?
      - What does the v2 Connect shipment call add over the original?
      instructions:
      - text: Ship items {items} of Connect order {order_id} from warehouse {warehouse_id}.
        slots:
          items: requestBody.items
          order_id: path.order_id
          warehouse_id: requestBody.warehouse_id
      - text: Create a v2 shipment for Connect order {order_id} with tracking URL {tracking_url}.
        slots:
          order_id: path.order_id
          tracking_url: requestBody.tracking_url
      method: generated
      generated: '2026-09-26'