# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Mirakl Multiple shipments API
  version: 1.0.0
extends: openapi/mirakl-multiple-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: 9
- target: $.paths['/api/shipments'].get
  update:
    x-apievangelist-phrasing:
      intent: List shipments
      effect: read
      questions:
      - How do I list the shipments for an order?
      - Can I filter shipments by state or last update date?
      instructions:
      - text: List shipments for order {order_id}.
        slots:
          order_id: query.order_id
      - text: List shipments in state {shipment_state_code}.
        slots:
          shipment_state_code: query.shipment_state_code
      - text: List shipments updated between {last_updated_from} and {last_updated_to}.
        slots:
          last_updated_from: query.last_updated_from
          last_updated_to: query.last_updated_to
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/shipments'].put
  update:
    x-apievangelist-phrasing:
      intent: Update the ship-from origin of shipments
      effect: write
      questions:
      - How do I change the shipping origin on existing shipments?
      - How many shipments can I update the origin for at once?
      instructions:
      - text: Update the shipping origin on shipments {shipments}.
        slots:
          shipments: requestBody.shipments
      - text: Change ship-from details for shipments {shipments} of shop {shop_id}.
        slots:
          shipments: requestBody.shipments
          shop_id: query.shop_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/shipments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create shipments
      effect: write
      questions:
      - How do I split an order into several shipments?
      - What's the maximum number of shipments I can create in one request?
      instructions:
      - text: 'Create these shipments: {shipments}.'
        slots:
          shipments: requestBody.shipments
      - text: Create shipments {shipments} for the items I'm sending.
        slots:
          shipments: requestBody.shipments
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/shipments/delete'].put
  update:
    x-apievangelist-phrasing:
      intent: Delete shipments
      effect: destructive
      questions:
      - Can I delete shipments I created by mistake?
      - How many shipments can be deleted in one call?
      instructions:
      - text: Delete shipments {shipments}.
        slots:
          shipments: requestBody.shipments
      - text: Remove the shipments {shipments} I created in error.
        slots:
          shipments: requestBody.shipments
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/shipments/items_to_ship'].get
  update:
    x-apievangelist-phrasing:
      intent: List items still to ship
      effect: read
      questions:
      - Which order items still need to be shipped?
      - Can I see items to ship for one fulfillment center or date range?
      instructions:
      - text: List items to ship for order {order_id}.
        slots:
          order_id: query.order_id
      - text: List items to ship from fulfillment center {fulfillment_center_code}.
        slots:
          fulfillment_center_code: query.fulfillment_center_code
      - text: List items due to ship between {shipping_date_from} and {shipping_date_to}.
        slots:
          shipping_date_from: query.shipping_date_from
          shipping_date_to: query.shipping_date_to
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/shipments/tracking'].post
  update:
    x-apievangelist-phrasing:
      intent: Set carrier tracking on shipments
      effect: write
      questions:
      - How do I add tracking numbers to multiple shipments at once?
      - Can I give a full tracking URL for an unregistered carrier on a shipment?
      instructions:
      - text: Update carrier tracking on shipments {shipments}.
        slots:
          shipments: requestBody.shipments
      - text: 'Add tracking info to these shipments: {shipments}.'
        slots:
          shipments: requestBody.shipments
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/shipments/ship'].put
  update:
    x-apievangelist-phrasing:
      intent: Mark shipments as shipped
      effect: write
      questions:
      - How do I confirm that several shipments have left the warehouse?
      - Can I validate up to a thousand shipments as shipped at once?
      instructions:
      - text: Mark shipments {shipments} as shipped.
        slots:
          shipments: requestBody.shipments
      - text: Validate shipments {shipments} as sent.
        slots:
          shipments: requestBody.shipments
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/shipments/ready_for_pick_up'].put
  update:
    x-apievangelist-phrasing:
      intent: Mark shipments ready for pickup
      effect: write
      questions:
      - How do I tell the customer their shipment is ready to collect?
      - Can I flag several click-and-collect shipments as ready for pickup?
      instructions:
      - text: Mark shipments {shipments} as ready for pickup.
        slots:
          shipments: requestBody.shipments
      - text: Validate shipments {shipments} as ready to pick up.
        slots:
          shipments: requestBody.shipments
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/shipments/additional_information'].put
  update:
    x-apievangelist-phrasing:
      intent: Update shipment additional information
      effect: write
      questions:
      - How do I add extra custom information to shipments?
      - How many shipments can I update additional information for in one request?
      instructions:
      - text: Update additional information on shipments {shipments}.
        slots:
          shipments: requestBody.shipments
      - text: Set custom shipment details {shipments} for shop {shop_id}.
        slots:
          shipments: requestBody.shipments
          shop_id: query.shop_id
      method: generated
      generated: '2026-09-26'