Shopify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Another API

19 actions 19 updates phrasing extends openapi/shopify-another-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Shopify's API. It is a proposal applied on top of the contract, not a document Shopify publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 19 · first 16 shown; the file carries all of them

$.info
$.paths['/admin/api/2020-01/orders/{order_id}/risks/{risk_id}.json'].put
$.paths['/admin/api/2020-01/orders/{order_id}/risks/{risk_id}.json'].delete
$.paths['/admin/api/2020-04/orders/{order_id}/risks/{risk_id}.json'].put
$.paths['/admin/api/2020-04/orders/{order_id}/risks/{risk_id}.json'].delete
$.paths['/admin/api/2020-07/orders/{order_id}/risks/{risk_id}.json'].put
$.paths['/admin/api/2020-07/orders/{order_id}/risks/{risk_id}.json'].delete
$.paths['/admin/api/2020-10/orders/{order_id}/risks/{risk_id}.json'].put
$.paths['/admin/api/2020-10/orders/{order_id}/risks/{risk_id}.json'].delete
$.paths['/admin/api/2021-01/orders/{order_id}/risks/{risk_id}.json'].put
$.paths['/admin/api/2021-01/orders/{order_id}/risks/{risk_id}.json'].delete
$.paths['/admin/api/unstable/orders/{order_id}/risks/{risk_id}.json'].put
$.paths['/admin/api/unstable/orders/{order_id}/risks/{risk_id}.json'].delete
$.paths['/admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/move.json'].post
$.paths['/admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/move.json'].post
$.paths['/admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/move.json'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Shopify Another API
  version: 1.0.0
extends: openapi/shopify-another-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: 18
- target: $.paths['/admin/api/2020-01/orders/{order_id}/risks/{risk_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an order risk (2020-01 API)
      effect: write
      questions:
      - How do I change a fraud risk assessment my app recorded on an order, on 2020-01?
      - Can I edit an order risk that some other app created, in the 2020-01 API?
      instructions:
      - text: Update risk {risk} on order {order} using the 2020-01 API.
        slots:
          order: path.order_id
          risk: path.risk_id
      - text: Revise the fraud risk {risk} my app added to order {order}, version 2020-01.
        slots:
          order: path.order_id
          risk: path.risk_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/orders/{order_id}/risks/{risk_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an order risk (2020-01 API)
      effect: destructive
      questions:
      - How do I remove a fraud risk my app placed on an order, on the 2020-01 API?
      - Can I delete an order risk created by a different app in 2020-01?
      instructions:
      - text: Delete risk {risk} from order {order} using the 2020-01 API.
        slots:
          order: path.order_id
          risk: path.risk_id
      - text: Remove the fraud risk {risk} my app put on order {order}, version 2020-01.
        slots:
          order: path.order_id
          risk: path.risk_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/orders/{order_id}/risks/{risk_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an order risk (2020-04 API)
      effect: write
      questions:
      - Which 2020-04 call modifies an existing order risk?
      - Are there order risks I'm not allowed to modify under the 2020-04 release?
      instructions:
      - text: Change order risk {risk} for order {order} on 2020-04.
        slots:
          order: path.order_id
          risk: path.risk_id
      - text: Edit the risk assessment {risk} attached to order {order} via the 2020-04 release.
        slots:
          order: path.order_id
          risk: path.risk_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/orders/{order_id}/risks/{risk_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an order risk (2020-04 API)
      effect: destructive
      questions:
      - Which 2020-04 endpoint deletes an order risk?
      - Are some order risks protected from deletion under the 2020-04 release?
      instructions:
      - text: Remove order risk {risk} from order {order} on 2020-04.
        slots:
          order: path.order_id
          risk: path.risk_id
      - text: Drop the risk assessment {risk} off order {order} via the 2020-04 release.
        slots:
          order: path.order_id
          risk: path.risk_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/orders/{order_id}/risks/{risk_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an order risk (2020-07 API)
      effect: write
      questions:
      - Where do I update an order's risk entry in version 2020-07?
      - What restrictions apply when editing an order risk in 2020-07?
      instructions:
      - text: Modify risk {risk} of order {order} through the 2020-07 version.
        slots:
          order: path.order_id
          risk: path.risk_id
      - text: Adjust the fraud assessment {risk} on order {order} with 2020-07.
        slots:
          order: path.order_id
          risk: path.risk_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/orders/{order_id}/risks/{risk_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an order risk (2020-07 API)
      effect: destructive
      questions:
      - Where is the 2020-07 call that throws away a risk flagged on an order?
      - What limits apply to deleting an order risk in 2020-07?
      instructions:
      - text: Delete risk {risk} of order {order} through the 2020-07 version.
        slots:
          order: path.order_id
          risk: path.risk_id
      - text: Erase fraud assessment {risk} from order {order} with 2020-07.
        slots:
          order: path.order_id
          risk: path.risk_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/orders/{order_id}/risks/{risk_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an order risk (2020-10 API)
      effect: write
      questions:
      - How can my fraud app revise the risk it flagged on an order using the 2020-10 API?
      - Does the 2020-10 Admin API let me change an existing order risk?
      instructions:
      - text: Update order {order}'s risk {risk} on the 2020-10 API.
        slots:
          order: path.order_id
          risk: path.risk_id
      - text: Correct the order risk {risk} my app set on order {order}, API 2020-10.
        slots:
          order: path.order_id
          risk: path.risk_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/orders/{order_id}/risks/{risk_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an order risk (2020-10 API)
      effect: destructive
      questions:
      - How can I clear a risk flag my app raised on an order with the 2020-10 API?
      - Does the 2020-10 Admin API let me delete an order risk?
      instructions:
      - text: Remove risk {risk} from order {order} with the 2020-10 API.
        slots:
          order: path.order_id
          risk: path.risk_id
      - text: Delete the order risk {risk} my app recorded on order {order}, API 2020-10.
        slots:
          order: path.order_id
          risk: path.risk_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/orders/{order_id}/risks/{risk_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an order risk (2021-01 API)
      effect: write
      questions:
      - Can I update an order risk using the 2021-01 release?
      - Which 2021-01 endpoint edits a risk recorded against an order?
      instructions:
      - text: With the 2021-01 release, edit risk {risk} on order {order}.
        slots:
          order: path.order_id
          risk: path.risk_id
      - text: Overwrite fraud risk {risk} for order {order} using 2021-01.
        slots:
          order: path.order_id
          risk: path.risk_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/orders/{order_id}/risks/{risk_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an order risk (2021-01 API)
      effect: destructive
      questions:
      - Can I delete an order risk using the 2021-01 release?
      - Which 2021-01 call removes a risk from an order?
      instructions:
      - text: Using 2021-01, delete risk {risk} on order {order}.
        slots:
          order: path.order_id
          risk: path.risk_id
      - text: Take fraud risk {risk} off order {order} on the 2021-01 release.
        slots:
          order: path.order_id
          risk: path.risk_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/orders/{order_id}/risks/{risk_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an order risk (unstable API)
      effect: write
      questions:
      - Is there an unstable-version call to update an order risk?
      - How would I modify an order risk on the unstable Admin API?
      instructions:
      - text: Update risk {risk} on order {order} on the unstable version.
        slots:
          order: path.order_id
          risk: path.risk_id
      - text: Via the unstable API, change order {order}'s risk {risk}.
        slots:
          order: path.order_id
          risk: path.risk_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/orders/{order_id}/risks/{risk_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an order risk (unstable API)
      effect: destructive
      questions:
      - Is deleting an order risk possible on the unstable API version?
      - How would I remove an order risk against the unstable release?
      instructions:
      - text: Delete risk {risk} from order {order} on the unstable API.
        slots:
          order: path.order_id
          risk: path.risk_id
      - text: On the unstable version, remove order {order}'s risk {risk}.
        slots:
          order: path.order_id
          risk: path.risk_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/move.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Move a fulfillment order to another location (2020-01)
      effect: write
      questions:
      - How do I ship a fulfillment order from a different merchant-managed location on 2020-01?
      - Can I reassign a fulfillment order to another of my locations in the 2020-01 API?
      instructions:
      - text: Move fulfillment order {fo} to location {location} using the 2020-01 API.
        slots:
          fo: path.fulfillment_order_id
          location: query.new_location_id
      - text: Relocate fulfillment order {fo} to a different merchant-managed location, version 2020-01.
        slots:
          fo: path.fulfillment_order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/move.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Move a fulfillment order to another location (2020-04)
      effect: write
      questions:
      - Which 2020-04 call moves a fulfillment order between merchant locations?
      - Is moving a fulfillment order to a new location supported in the 2020-04 release?
      instructions:
      - text: Transfer fulfillment order {fo} to location {location} on 2020-04.
        slots:
          fo: path.fulfillment_order_id
          location: query.new_location_id
      - text: Send fulfillment order {fo} to another warehouse location via the 2020-04 release.
        slots:
          fo: path.fulfillment_order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/move.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Move a fulfillment order to another location (2020-07)
      effect: write
      questions:
      - Where do I change which location fulfills a fulfillment order in version 2020-07?
      - What does moving a fulfillment order do under 2020-07?
      instructions:
      - text: Reroute fulfillment order {fo} to location {location} through the 2020-07 version.
        slots:
          fo: path.fulfillment_order_id
          location: query.new_location_id
      - text: Shift fulfillment order {fo} to a different location with 2020-07.
        slots:
          fo: path.fulfillment_order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/move.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Move a fulfillment order to another location (2020-10)
      effect: write
      questions:
      - How can I fulfill from another store location when the first is out of stock, using 2020-10?
      - Does the 2020-10 Admin API let me move a fulfillment order to a new location?
      instructions:
      - text: Move fulfillment order {fo} to location {location} with the 2020-10 Admin API.
        slots:
          fo: path.fulfillment_order_id
          location: query.new_location_id
      - text: Hand fulfillment order {fo} over to another merchant location, API 2020-10.
        slots:
          fo: path.fulfillment_order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/move.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Move a fulfillment order to another location (2021-01)
      effect: write
      questions:
      - Can I move a fulfillment order to a new location using the 2021-01 release?
      - Which 2021-01 endpoint reassigns a fulfillment order's location?
      instructions:
      - text: Using 2021-01, move fulfillment order {fo} to location {location}.
        slots:
          fo: path.fulfillment_order_id
          location: query.new_location_id
      - text: Reassign fulfillment order {fo} to a new fulfilling location on the 2021-01 release.
        slots:
          fo: path.fulfillment_order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/move.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Move a fulfillment order to another location (unstable)
      effect: write
      questions:
      - Is moving a fulfillment order available on the unstable API?
      - How would I relocate a fulfillment order against the unstable version?
      instructions:
      - text: Move fulfillment order {fo} to location {location} on the unstable API.
        slots:
          fo: path.fulfillment_order_id
          location: query.new_location_id
      - text: On the unstable release, relocate fulfillment order {fo} to another location.
        slots:
          fo: path.fulfillment_order_id
      method: generated
      generated: '2026-09-24'