# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Salla Shipping and Fulfillment Shipments API
  version: 1.0.0
extends: openapi/salla-shipments-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/shipments'].get
  update:
    x-apievangelist-phrasing:
      intent: List shipments
      effect: read
      questions:
      - Which shipments has my Salla store created?
      - Can I see all outgoing shipments in one list?
      instructions:
      - text: List all shipments.
      - text: Show my store's shipments.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/shipments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a shipment for an order
      effect: write
      questions:
      - How do I create a shipment for an order with a courier?
      - Can I attach a tracking number when creating a shipment?
      instructions:
      - text: Create a shipment for order {order_id} with courier {courier_id}.
        slots:
          order_id: requestBody.order_id
          courier_id: requestBody.courier_id
      - text: Ship order {order_id} via courier {courier_id} with tracking number {tracking_number}.
        slots:
          order_id: requestBody.order_id
          courier_id: requestBody.courier_id
          tracking_number: requestBody.tracking_number
      method: generated
      generated: '2026-10-01'
- target: $.paths['/shipments/{shipment_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a shipment's details
      effect: read
      questions:
      - What is the status and tracking info of a specific shipment?
      - Can I look up one shipment by ID?
      instructions:
      - text: Show me shipment {shipment_id}.
        slots:
          shipment_id: path.shipment_id
      - text: Get the details of shipment {shipment_id}.
        slots:
          shipment_id: path.shipment_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/shipments/{shipment_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a shipment
      effect: write
      questions:
      - How do I edit an existing shipment?
      - Can I change details on a shipment already created?
      instructions:
      - text: Update shipment {shipment_id}.
        slots:
          shipment_id: path.shipment_id
      - text: Edit the details of shipment {shipment_id}.
        slots:
          shipment_id: path.shipment_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/shipments/{shipment_id}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a shipment
      effect: destructive
      questions:
      - How do I cancel a shipment that should not go out?
      - Can I call off a shipment after creating it?
      instructions:
      - text: Cancel shipment {shipment_id}.
        slots:
          shipment_id: path.shipment_id
      - text: Stop shipment {shipment_id} from going out.
        slots:
          shipment_id: path.shipment_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/shipments/{shipment_id}/return'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a return for a shipment
      effect: write
      questions:
      - How do I arrange a return for a delivered shipment?
      - Can I create a return shipment so the customer can send items back?
      instructions:
      - text: Create a return for shipment {shipment_id}.
        slots:
          shipment_id: path.shipment_id
      - text: Set up a return shipment for {shipment_id}.
        slots:
          shipment_id: path.shipment_id
      method: generated
      generated: '2026-10-01'