# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Overview Orders API
  version: 1.0.0
extends: openapi/aftership-orders-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: 8
- target: $.paths['/orders'].get
  update:
    x-apievangelist-phrasing:
      intent: List orders in a store
      effect: read
      questions:
      - How do I pull a list of orders from my store?
      - Can I fetch several specific orders at once by their IDs?
      instructions:
      - text: List orders in store {store}.
        slots:
          store: header.as-store-id
      - text: Get orders {ids} sorted by {sort}.
        slots:
          ids: query.ids[]
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orders'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an order
      effect: write
      questions:
      - How do I push a new order into AfterShip for tracking and returns?
      - What fields are required when I create an order?
      instructions:
      - text: Create order number {number} in {currency} totaling {order_total} with items {items}.
        slots:
          number: requestBody.number
          currency: requestBody.currency
          order_total: requestBody.order_total
          items: requestBody.items
      - text: Add order {number} to store {store} with delivery method {delivery_method}.
        slots:
          number: requestBody.number
          store: header.as-store-id
          delivery_method: requestBody.delivery_method
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orders/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an order by ID
      effect: read
      questions:
      - What are the details of a specific order?
      - Can I look up one order by its ID?
      instructions:
      - text: Show order {id} from store {store}.
        slots:
          id: path.id
          store: header.as-store-id
      - text: Get order {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orders/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an order's details or status
      effect: write
      questions:
      - Can I change the shipping address on an order I already created?
      - How do I update an order's financial or fulfillment status?
      instructions:
      - text: Update the shipping address of order {id} to {shipping_address}.
        slots:
          id: path.id
          shipping_address: requestBody.shipping_address
      - text: Set order {id} fulfillment status to {fulfillment_status}.
        slots:
          id: path.id
          fulfillment_status: requestBody.fulfillment_status
      - text: Add note {note} to order {id}.
        slots:
          note: requestBody.note
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orders/{id}/items'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a line item to an order
      effect: write
      questions:
      - How do I add another product line to an existing order?
      - Can I include an HS code and origin country on a new order item?
      instructions:
      - text: Add {quantity} of {product_title} to order {id} as item {item_id}.
        slots:
          quantity: requestBody.quantity
          product_title: requestBody.product_title
          id: path.id
          item_id: requestBody.id
      - text: Create item {item_id} with SKU {sku} on order {id}.
        slots:
          item_id: requestBody.id
          sku: requestBody.sku
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orders/{id}/items/{item_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one line item from an order
      effect: read
      questions:
      - What are the details of a single item within an order?
      - Can I look up one order line item by its ID?
      instructions:
      - text: Show item {item_id} on order {id}.
        slots:
          item_id: path.item_id
          id: path.id
      - text: Get order {id} line item {item_id} from store {store}.
        slots:
          id: path.id
          item_id: path.item_id
          store: header.as-store-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orders/{id}/items/{item_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a line item from an order
      effect: destructive
      questions:
      - How do I remove a product line from an order?
      - Can I delete a single item without deleting the whole order?
      instructions:
      - text: Delete item {item_id} from order {id}.
        slots:
          item_id: path.item_id
          id: path.id
      - text: Remove line {item_id} from order {id} in store {store}.
        slots:
          item_id: path.item_id
          id: path.id
          store: header.as-store-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orders/{id}/items/{item_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an order line item
      effect: write
      questions:
      - Can I change the quantity of an item on an order?
      - How do I correct the price or SKU of an order line?
      instructions:
      - text: Change the quantity of item {item_id} on order {id} to {quantity}.
        slots:
          item_id: path.item_id
          id: path.id
          quantity: requestBody.quantity
      - text: Set the unit price of order {id} item {item_id} to {unit_price}.
        slots:
          id: path.id
          item_id: path.item_id
          unit_price: requestBody.unit_price
      method: generated
      generated: '2026-09-26'