# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Salla Merchant Orders API
  version: 1.0.0
extends: openapi/salla-orders-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: 7
- target: $.paths['/orders'].get
  update:
    x-apievangelist-phrasing:
      intent: List store orders
      effect: read
      questions:
      - Which orders did my Salla store receive this month?
      - Can I filter orders by status or a date range?
      instructions:
      - text: List orders with status {status}.
        slots:
          status: query.status
      - text: Show orders placed between {from_date} and {to_date}.
        slots:
          from_date: query.from_date
          to_date: query.to_date
      - text: List page {page} of orders, {per_page} per page.
        slots:
          page: query.page
          per_page: query.per_page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orders/{order_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an order's details
      effect: read
      questions:
      - What is in a specific order, including its customer and shipments?
      - Can I fetch a lighter version of an order without items and shipments?
      instructions:
      - text: Show me order {order_id}.
        slots:
          order_id: path.order_id
      - text: Get order {order_id} in {format} format.
        slots:
          order_id: path.order_id
          format: query.format
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orders/{order_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an order
      effect: write
      questions:
      - How do I edit the details of an existing order?
      - Can I modify an order after it was placed?
      instructions:
      - text: Update order {order_id}.
        slots:
          order_id: path.order_id
      - text: Edit the details of order {order_id}.
        slots:
          order_id: path.order_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orders/{order_id}/status'].post
  update:
    x-apievangelist-phrasing:
      intent: Change an order's status
      effect: write
      questions:
      - How do I mark an order as shipped or completed?
      - Can I add a note when I change an order's status?
      instructions:
      - text: Set the status of order {order_id} to {slug}.
        slots:
          order_id: path.order_id
          slug: requestBody.slug
      - text: Move order {order_id} to status {slug} with note {note}.
        slots:
          order_id: path.order_id
          slug: requestBody.slug
          note: requestBody.note
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orders/{order_id}/histories'].get
  update:
    x-apievangelist-phrasing:
      intent: List an order's status history
      effect: read
      questions:
      - What status changes has a specific order gone through?
      - Can I see the timeline of updates on an order?
      instructions:
      - text: Show the history of order {order_id}.
        slots:
          order_id: path.order_id
      - text: List status changes for order {order_id}.
        slots:
          order_id: path.order_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orders/{order_id}/invoices'].get
  update:
    x-apievangelist-phrasing:
      intent: List an order's invoices
      effect: read
      questions:
      - Which invoices were issued for a particular order?
      - Can I pull the invoice for an order?
      instructions:
      - text: List invoices for order {order_id}.
        slots:
          order_id: path.order_id
      - text: Get the invoices issued on order {order_id}.
        slots:
          order_id: path.order_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orders/{order_id}/items'].get
  update:
    x-apievangelist-phrasing:
      intent: List the items in an order
      effect: read
      questions:
      - What products did the customer buy in a given order?
      - Can I get just the line items of an order?
      instructions:
      - text: List the items in order {order_id}.
        slots:
          order_id: path.order_id
      - text: Show the products purchased in order {order_id}.
        slots:
          order_id: path.order_id
      method: generated
      generated: '2026-10-01'