# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Shopify Refund API
  version: 1.0.0
extends: openapi/shopify-refund-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-24'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/admin/api/2020-01/orders/{order_id}/refunds/{refund_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a refund on an order (2020-01)
      effect: read
      questions:
      - How do I look up a specific refund on an order using API 2020-01?
      - Can the January 2020 refund lookup show amounts in the shop's currency?
      instructions:
      - text: Get refund {refund} on order {order} via 2020-01.
        slots:
          refund: path.refund_id
          order: path.order_id
      - text: On January 2020, show refund {refund} of order {order} with shop-currency amounts set to {in_shop_currency}.
        slots:
          refund: path.refund_id
          order: path.order_id
          in_shop_currency: query.in_shop_currency
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/orders/{order_id}/refunds/{refund_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a refund on an order (2020-04)
      effect: read
      questions:
      - Which 2020-04 endpoint retrieves one refund from an order?
      - In April 2020, can I return only certain fields of a refund?
      instructions:
      - text: Retrieve refund {refund} for order {order} using 2020-04.
        slots:
          refund: path.refund_id
          order: path.order_id
      - text: Using April 2020, fetch only {fields} for refund {refund} on order {order}.
        slots:
          fields: query.fields
          refund: path.refund_id
          order: path.order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/orders/{order_id}/refunds/{refund_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a refund on an order (2020-07)
      effect: read
      questions:
      - What call returns a single refund's details in the 2020-07 API?
      - Is there a July 2020 option to show refund amounts in the store's currency?
      instructions:
      - text: Show refund {refund} from order {order} with 2020-07.
        slots:
          refund: path.refund_id
          order: path.order_id
      - text: Via July 2020, get refund {refund} on order {order} with amounts in shop currency ({in_shop_currency}).
        slots:
          refund: path.refund_id
          order: path.order_id
          in_shop_currency: query.in_shop_currency
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/orders/{order_id}/refunds/{refund_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a refund on an order
      effect: read
      questions:
      - A customer asked about their refund; where do I pull it up on 2020-10?
      - Where in October 2020 do I retrieve a specific refund with selected fields?
      instructions:
      - text: Look up refund {refund} on order {order} (API 2020-10).
        slots:
          refund: path.refund_id
          order: path.order_id
      - text: With October 2020, return {fields} of refund {refund} for order {order}.
        slots:
          fields: query.fields
          refund: path.refund_id
          order: path.order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/orders/{order_id}/refunds/{refund_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a refund on an order (2021-01)
      effect: read
      questions:
      - On 2021-01, how can I fetch a refund by its ID?
      - Does January 2021 let me view a refund's amounts in the shop currency?
      instructions:
      - text: Fetch order {order}'s refund {refund} using 2021-01.
        slots:
          order: path.order_id
          refund: path.refund_id
      - text: Using January 2021, get refund {refund} on order {order}, fields {fields} only.
        slots:
          refund: path.refund_id
          order: path.order_id
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/orders/{order_id}/refunds/{refund_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a refund on an order (unstable)
      effect: read
      questions:
      - Can I retrieve a specific refund on the unstable API?
      - Which unstable-version endpoint returns one refund with optional field filtering?
      instructions:
      - text: Get refund {refund} of order {order} on unstable.
        slots:
          refund: path.refund_id
          order: path.order_id
      - text: Using the unstable endpoint, show refund {refund} on order {order} in shop currency ({in_shop_currency}).
        slots:
          refund: path.refund_id
          order: path.order_id
          in_shop_currency: query.in_shop_currency
      method: generated
      generated: '2026-09-24'