API Evangelist conversational phrasing for Shopify Order API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Shopify Order API
  version: 1.0.0
extends: openapi/shopify-order-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: 16
- target: $.paths['/admin/api/2020-01/orders.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an order (API 2020-01)
      effect: write
      questions:
      - How do I create a new order through the 2020-01 Admin API?
      - Can an app add an order to the store on API version 2020-01?
      instructions:
      - text: Create a new order in the store via the 2020-01 API.
      - text: Using version 2020-01, add an order record to my shop.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/orders/{order_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve one order (API 2020-01)
      effect: read
      questions:
      - What does a single order look like when fetched by ID on the 2020-01 API?
      - Can I limit which fields come back when I pull one order under 2020-01?
      instructions:
      - text: Fetch order {order_id} with the 2020-01 API.
        slots:
          order_id: path.order_id
      - text: Using version 2020-01, show only {fields} for order {order_id}.
        slots:
          fields: query.fields
          order_id: path.order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/orders/{order_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an order (API 2020-01)
      effect: write
      questions:
      - Which 2020-01 endpoint changes an existing order?
      - Is editing an order I already have allowed in API version 2020-01?
      instructions:
      - text: Update order {order_id} through the 2020-01 API.
        slots:
          order_id: path.order_id
      - text: On version 2020-01, save edits to existing order {order_id}.
        slots:
          order_id: path.order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/orders/{order_id}/close.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Close an order (API 2020-01)
      effect: destructive
      questions:
      - How do I close an order once it is complete, using 2020-01?
      - Can I mark an order as closed with the 2020-01 Admin API?
      instructions:
      - text: Close order {order_id} via API version 2020-01.
        slots:
          order_id: path.order_id
      - text: Using 2020-01, mark finished order {order_id} closed.
        slots:
          order_id: path.order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/orders/{order_id}/open.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Re-open a closed order (API 2020-01)
      effect: write
      questions:
      - Can a closed order be re-opened on the 2020-01 API?
      - What 2020-01 call brings a closed order back to open?
      instructions:
      - text: Re-open closed order {order_id} with the 2020-01 API.
        slots:
          order_id: path.order_id
      - text: On version 2020-01, bring order {order_id} back from closed to open.
        slots:
          order_id: path.order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/orders.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an order (API 2020-04)
      effect: write
      questions:
      - Which April 2020 (2020-04) endpoint places a new order in my shop?
      - Is order creation available to apps in the 2020-04 release?
      instructions:
      - text: Place a new order in my shop on the 2020-04 release.
      - text: With the April 2020 endpoint, create an order.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/orders/{order_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve one order (API 2020-04)
      effect: read
      questions:
      - Where do I look up a specific order by its ID in the April 2020 (2020-04) API?
      - Can the 2020-04 order lookup return just the fields I pick?
      instructions:
      - text: Look up order {order_id} on the 2020-04 release.
        slots:
          order_id: path.order_id
      - text: Return fields {fields} of order {order_id} with the April 2020 endpoint.
        slots:
          fields: query.fields
          order_id: path.order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/orders/{order_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an order (API 2020-04)
      effect: write
      questions:
      - Which April 2020 endpoint modifies an order that already exists?
      - Are order edits supported in the 2020-04 release of the Admin API?
      instructions:
      - text: Modify order {order_id} on the 2020-04 release.
        slots:
          order_id: path.order_id
      - text: Apply changes to order {order_id} using the April 2020 endpoint.
        slots:
          order_id: path.order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/orders/{order_id}/close.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Close an order (API 2020-04)
      effect: destructive
      questions:
      - What closes out a completed order in the April 2020 (2020-04) API?
      - Can orders be closed from an app on the 2020-04 release?
      instructions:
      - text: Close out order {order_id} on the 2020-04 release.
        slots:
          order_id: path.order_id
      - text: With the April 2020 endpoint, set order {order_id} to closed.
        slots:
          order_id: path.order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/orders/{order_id}/open.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Re-open a closed order (API 2020-04)
      effect: write
      questions:
      - Which April 2020 (2020-04) endpoint re-opens an order I closed?
      - Is it possible to undo closing an order in the 2020-04 release?
      instructions:
      - text: Undo the close on order {order_id} using the 2020-04 release.
        slots:
          order_id: path.order_id
      - text: Re-open order {order_id} with the April 2020 endpoint.
        slots:
          order_id: path.order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/orders/{order_id}/risks.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a fraud risk on an order (API 2020-01)
      effect: write
      questions:
      - How do I flag an order as risky with the 2020-01 order risk endpoint?
      - Can my fraud app attach a risk assessment to an order on 2020-01?
      instructions:
      - text: Create an order risk on order {order_id} via the 2020-01 API.
        slots:
          order_id: path.order_id
      - text: Using version 2020-01, attach a fraud risk assessment to order {order_id}.
        slots:
          order_id: path.order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/orders/{order_id}/risks.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a fraud risk on an order (API 2020-04)
      effect: write
      questions:
      - Which April 2020 (2020-04) endpoint adds an order risk to an order?
      - Is recording fraud risk for an order supported in the 2020-04 release?
      instructions:
      - text: On the 2020-04 release, add an order risk to order {order_id}.
        slots:
          order_id: path.order_id
      - text: Record fraud risk for order {order_id} with the April 2020 endpoint.
        slots:
          order_id: path.order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/orders/{order_id}/risks.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a fraud risk on an order (API 2020-07)
      effect: write
      questions:
      - My fraud tool targets 2020-07; what creates an order risk there?
      - Can the July 2020 API store a risk signal against a suspicious order?
      instructions:
      - text: Store a risk signal on suspicious order {order_id} using July 2020 (2020-07).
        slots:
          order_id: path.order_id
      - text: With API 2020-07, create a risk record for order {order_id}.
        slots:
          order_id: path.order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/orders/{order_id}/risks.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a fraud risk on an order (API 2020-10)
      effect: write
      questions:
      - What is the 2020-10 call for adding an order risk?
      - Does the October 2020 API let me warn merchants that an order may be fraudulent?
      instructions:
      - text: Warn that order {order_id} may be fraudulent by adding a risk on the October 2020 version.
        slots:
          order_id: path.order_id
      - text: Add a 2020-10 order risk to order {order_id}.
        slots:
          order_id: path.order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/orders/{order_id}/risks.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a fraud risk on an order (API 2021-01)
      effect: write
      questions:
      - Under the 2021-01 API, where do I create an order risk?
      - Can I mark an order as high risk with the January 2021 API version?
      instructions:
      - text: Mark order {order_id} with a risk through API version 2021-01.
        slots:
          order_id: path.order_id
      - text: Log a fraud risk entry on order {order_id} against January 2021.
        slots:
          order_id: path.order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/orders/{order_id}/risks.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a fraud risk on an order (unstable API)
      effect: write
      questions:
      - Is there an unstable-channel endpoint for creating an order risk?
      - Can I test order risk creation against the unstable API version?
      instructions:
      - text: Create an order risk for order {order_id} on the unstable API.
        slots:
          order_id: path.order_id
      - text: Against the unstable version, test flagging order {order_id} as risky.
        slots:
          order_id: path.order_id
      method: generated
      generated: '2026-09-24'