API Evangelist conversational phrasing for Shopify Identifiers 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 Identifiers API
  version: 1.0.0
extends: openapi/shopify-identifiers-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: 30
- target: $.paths['/admin/api/2020-01/inventory_items/{inventory_item_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up an inventory item on API 2020-01
      effect: read
      questions:
      - How can I see one inventory item's details, like SKU and cost, on the 2020-01 API?
      - Can I fetch a single inventory item by its ID with version 2020-01?
      instructions:
      - text: Get inventory item {inventory_item_id} using version 2020-01.
        slots:
          inventory_item_id: path.inventory_item_id
      - text: Show me the 2020-01 record for inventory item {inventory_item_id}.
        slots:
          inventory_item_id: path.inventory_item_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/inventory_items/{inventory_item_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up an inventory item on API 2020-04
      effect: read
      questions:
      - What does a single inventory item look like on API version 2020-04?
      - Is it possible to check whether one inventory item is tracked, using 2020-04?
      instructions:
      - text: Retrieve inventory item {inventory_item_id} from the 2020-04 Admin API.
        slots:
          inventory_item_id: path.inventory_item_id
      - text: On 2020-04, pull the details of inventory item {inventory_item_id}.
        slots:
          inventory_item_id: path.inventory_item_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/inventory_items/{inventory_item_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up an inventory item on API 2020-07
      effect: read
      questions:
      - Using the 2020-07 release, where do I read one inventory item by ID?
      - Does 2020-07 return a single inventory item record?
      instructions:
      - text: Fetch inventory item {inventory_item_id} via 2020-07.
        slots:
          inventory_item_id: path.inventory_item_id
      - text: Look up the 2020-07 inventory item with ID {inventory_item_id}.
        slots:
          inventory_item_id: path.inventory_item_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/inventory_items/{inventory_item_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up an inventory item (current 2020-10)
      effect: read
      questions:
      - Which call reads a single inventory item on the current 2020-10 version?
      - Can I get one inventory item's SKU and cost from the non-deprecated API?
      instructions:
      - text: Get inventory item {inventory_item_id} with the non-deprecated 2020-10 API.
        slots:
          inventory_item_id: path.inventory_item_id
      - text: Using 2020-10, show inventory item {inventory_item_id}.
        slots:
          inventory_item_id: path.inventory_item_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/inventory_items/{inventory_item_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up an inventory item on API 2021-01
      effect: read
      questions:
      - Can I still retrieve an inventory item by ID on the deprecated 2021-01 version?
      - What fields come back for one inventory item in 2021-01?
      instructions:
      - text: Retrieve inventory item {inventory_item_id} through API version 2021-01.
        slots:
          inventory_item_id: path.inventory_item_id
      - text: Pull inventory item {inventory_item_id} via 2021-01.
        slots:
          inventory_item_id: path.inventory_item_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/inventory_items/{inventory_item_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up an inventory item on unstable API
      effect: read
      questions:
      - How can I read a single inventory item on the unstable Admin API?
      - Is fetching one inventory item supported in the unstable version?
      instructions:
      - text: Get inventory item {inventory_item_id} on the unstable version.
        slots:
          inventory_item_id: path.inventory_item_id
      - text: Show the unstable-version inventory item {inventory_item_id}.
        slots:
          inventory_item_id: path.inventory_item_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/locations/{location_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one store location on API 2020-01
      effect: read
      questions:
      - How can I see the address and details of one store location on the 2020-01 API?
      - Can I fetch a single location by its ID with version 2020-01?
      instructions:
      - text: Get location {location_id} using version 2020-01.
        slots:
          location_id: path.location_id
      - text: Show me the 2020-01 details for location {location_id}.
        slots:
          location_id: path.location_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/locations/{location_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one store location on API 2020-04
      effect: read
      questions:
      - What does a single location record contain on API version 2020-04?
      - Is it possible to check whether one warehouse location is active, using 2020-04?
      instructions:
      - text: Retrieve location {location_id} from the 2020-04 Admin API.
        slots:
          location_id: path.location_id
      - text: On 2020-04, pull the record for store location {location_id}.
        slots:
          location_id: path.location_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/locations/{location_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one store location on API 2020-07
      effect: read
      questions:
      - Using the 2020-07 release, where do I read one location by ID?
      - Does 2020-07 return a single location's details?
      instructions:
      - text: Fetch location {location_id} via 2020-07.
        slots:
          location_id: path.location_id
      - text: Look up the 2020-07 location with ID {location_id}.
        slots:
          location_id: path.location_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/locations/{location_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one store location (current 2020-10)
      effect: read
      questions:
      - Which call reads a single location on the current 2020-10 version?
      - Can I get one location's address from the non-deprecated API?
      instructions:
      - text: Get location {location_id} with the non-deprecated 2020-10 API.
        slots:
          location_id: path.location_id
      - text: Using 2020-10, show store location {location_id}.
        slots:
          location_id: path.location_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/locations/{location_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one store location on API 2021-01
      effect: read
      questions:
      - Can I still retrieve a location by ID on the deprecated 2021-01 version?
      - What comes back for one location in 2021-01?
      instructions:
      - text: Retrieve location {location_id} through API version 2021-01.
        slots:
          location_id: path.location_id
      - text: Pull store location {location_id} via 2021-01.
        slots:
          location_id: path.location_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/locations/{location_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one store location on unstable API
      effect: read
      questions:
      - How can I read a single location on the unstable Admin API?
      - Is fetching one location supported in the unstable version?
      instructions:
      - text: Get location {location_id} on the unstable version.
        slots:
          location_id: path.location_id
      - text: Show the unstable-version location {location_id}.
        slots:
          location_id: path.location_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/metafields/{metafield_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one metafield by ID on API 2020-01
      effect: read
      questions:
      - How can I read a single metafield's value on the 2020-01 API?
      - Can I return only some fields of one metafield with version 2020-01?
      instructions:
      - text: Get metafield {metafield_id} using version 2020-01.
        slots:
          metafield_id: path.metafield_id
      - text: Show only {fields} of metafield {metafield_id} on 2020-01.
        slots:
          fields: query.fields
          metafield_id: path.metafield_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/metafields/{metafield_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one metafield by ID on API 2020-04
      effect: read
      questions:
      - What does one metafield record contain on API version 2020-04?
      - Is it possible to look up a metafield's namespace and key by ID using 2020-04?
      instructions:
      - text: Retrieve metafield {metafield_id} from the 2020-04 Admin API.
        slots:
          metafield_id: path.metafield_id
      - text: On 2020-04, pull metafield {metafield_id} with just the fields {fields}.
        slots:
          metafield_id: path.metafield_id
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/metafields/{metafield_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one metafield by ID on API 2020-07
      effect: read
      questions:
      - On the 2020-07 release, which endpoint returns a custom metafield value by its ID?
      - Does 2020-07 let me trim a metafield response to chosen fields?
      instructions:
      - text: Fetch metafield {metafield_id} via 2020-07.
        slots:
          metafield_id: path.metafield_id
      - text: Look up the 2020-07 metafield with ID {metafield_id}.
        slots:
          metafield_id: path.metafield_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/metafields/{metafield_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one metafield by ID (current 2020-10)
      effect: read
      questions:
      - Which call reads a single metafield on the current 2020-10 version?
      - Can I get one metafield's value from the non-deprecated API?
      instructions:
      - text: Get metafield {metafield_id} with the non-deprecated 2020-10 API.
        slots:
          metafield_id: path.metafield_id
      - text: Using 2020-10, return fields {fields} for metafield {metafield_id}.
        slots:
          fields: query.fields
          metafield_id: path.metafield_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/metafields/{metafield_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one metafield by ID on API 2021-01
      effect: read
      questions:
      - Is reading a stored metafield value still possible on the deprecated 2021-01 version?
      - What comes back for one metafield in 2021-01?
      instructions:
      - text: Retrieve metafield {metafield_id} through API version 2021-01.
        slots:
          metafield_id: path.metafield_id
      - text: Pull metafield {metafield_id} via 2021-01.
        slots:
          metafield_id: path.metafield_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/metafields/{metafield_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one metafield by ID on unstable API
      effect: read
      questions:
      - How can I read a single metafield on the unstable Admin API?
      - Is fetching one metafield supported in the unstable version?
      instructions:
      - text: Get metafield {metafield_id} on the unstable version.
        slots:
          metafield_id: path.metafield_id
      - text: Show the unstable-version metafield {metafield_id}.
        slots:
          metafield_id: path.metafield_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/orders/{order_id}/risks/{risk_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one fraud risk on an order (API 2020-01)
      effect: read
      questions:
      - How can I see a single fraud risk assessment on an order with the 2020-01 API?
      - Can I read one order risk by its ID on 2020-01?
      instructions:
      - text: Get risk {risk_id} on order {order_id} using version 2020-01.
        slots:
          risk_id: path.risk_id
          order_id: path.order_id
      - text: Show me the 2020-01 fraud risk {risk_id} for order {order_id}.
        slots:
          risk_id: path.risk_id
          order_id: path.order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/orders/{order_id}/risks/{risk_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one fraud risk on an order (API 2020-04)
      effect: read
      questions:
      - What does a single order risk record say on API version 2020-04?
      - Is it possible to check why one order was flagged as risky, using 2020-04?
      instructions:
      - text: Retrieve order risk {risk_id} of order {order_id} from the 2020-04 Admin API.
        slots:
          risk_id: path.risk_id
          order_id: path.order_id
      - text: On 2020-04, pull the risk assessment {risk_id} attached to order {order_id}.
        slots:
          risk_id: path.risk_id
          order_id: path.order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/orders/{order_id}/risks/{risk_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one fraud risk on an order (API 2020-07)
      effect: read
      questions:
      - Using the 2020-07 release, where do I read one risk on an order?
      - Does 2020-07 return a single fraud risk for an order?
      instructions:
      - text: Fetch risk {risk_id} for order {order_id} via 2020-07.
        slots:
          risk_id: path.risk_id
          order_id: path.order_id
      - text: Look up the 2020-07 order risk {risk_id} on order {order_id}.
        slots:
          risk_id: path.risk_id
          order_id: path.order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/orders/{order_id}/risks/{risk_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one fraud risk on an order (current 2020-10)
      effect: read
      questions:
      - Which call reads a single order risk on the current 2020-10 version?
      - Can I get the recommendation from one fraud risk on an order via the non-deprecated API?
      instructions:
      - text: Get risk {risk_id} of order {order_id} with the non-deprecated 2020-10 API.
        slots:
          risk_id: path.risk_id
          order_id: path.order_id
      - text: Using 2020-10, show fraud risk {risk_id} on order {order_id}.
        slots:
          risk_id: path.risk_id
          order_id: path.order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/orders/{order_id}/risks/{risk_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one fraud risk on an order (API 2021-01)
      effect: read
      questions:
      - Can I still retrieve an order risk by ID on the deprecated 2021-01 version?
      - What comes back for one order risk in 2021-01?
      instructions:
      - text: Retrieve order risk {risk_id} for order {order_id} through API version 2021-01.
        slots:
          risk_id: path.risk_id
          order_id: path.order_id
      - text: Pull risk {risk_id} from order {order_id} via 2021-01.
        slots:
          risk_id: path.risk_id
          order_id: path.order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/orders/{order_id}/risks/{risk_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one fraud risk on an order (unstable API)
      effect: read
      questions:
      - How can I read a single order risk on the unstable Admin API?
      - Is fetching one fraud risk for an order supported in the unstable version?
      instructions:
      - text: Get risk {risk_id} on order {order_id} on the unstable version.
        slots:
          risk_id: path.risk_id
          order_id: path.order_id
      - text: Show the unstable-version order risk {risk_id} for {order_id}.
        slots:
          risk_id: path.risk_id
          order_id: path.order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/shopify_payments/payouts/{payout_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one Shopify Payments payout (API 2020-01)
      effect: read
      questions:
      - How can I see the amount and status of one Shopify Payments payout on the 2020-01 API?
      - Can version 2020-01 tell me when a specific payout was deposited?
      instructions:
      - text: Get payout {payout_id} using version 2020-01.
        slots:
          payout_id: path.payout_id
      - text: Show me the 2020-01 details for payout {payout_id}.
        slots:
          payout_id: path.payout_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/shopify_payments/payouts/{payout_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one Shopify Payments payout (API 2020-04)
      effect: read
      questions:
      - What does a single payout record contain on API version 2020-04?
      - Is it possible to check whether one bank payout has been paid, using 2020-04?
      instructions:
      - text: Retrieve payout {payout_id} from the 2020-04 Admin API.
        slots:
          payout_id: path.payout_id
      - text: On 2020-04, pull the Shopify Payments payout {payout_id}.
        slots:
          payout_id: path.payout_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/shopify_payments/payouts/{payout_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one Shopify Payments payout (API 2020-07)
      effect: read
      questions:
      - On the 2020-07 release, which endpoint shows what a given payout paid out to my bank?
      - Does 2020-07 return a single payout's details?
      instructions:
      - text: Fetch payout {payout_id} via 2020-07.
        slots:
          payout_id: path.payout_id
      - text: Look up the 2020-07 payout with ID {payout_id}.
        slots:
          payout_id: path.payout_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/shopify_payments/payouts/{payout_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one Shopify Payments payout (current 2020-10)
      effect: read
      questions:
      - Which call reads a single payout on the current 2020-10 version?
      - Can I get one payout's amount from the non-deprecated API?
      instructions:
      - text: Get payout {payout_id} with the non-deprecated 2020-10 API.
        slots:
          payout_id: path.payout_id
      - text: Using 2020-10, show Shopify Payments payout {payout_id}.
        slots:
          payout_id: path.payout_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/shopify_payments/payouts/{payout_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one Shopify Payments payout (API 2021-01)
      effect: read
      questions:
      - Is checking a Shopify Payments payout still possible on the deprecated 2021-01 version?
      - What comes back for one payout in 2021-01?
      instructions:
      - text: Retrieve payout {payout_id} through API version 2021-01.
        slots:
          payout_id: path.payout_id
      - text: Pull Shopify Payments payout {payout_id} via 2021-01.
        slots:
          payout_id: path.payout_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/shopify_payments/payouts/{payout_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one Shopify Payments payout (unstable API)
      effect: read
      questions:
      - How can I read a single payout on the unstable Admin API?
      - Is fetching one payout supported in the unstable version?
      instructions:
      - text: Get payout {payout_id} on the unstable version.
        slots:
          payout_id: path.payout_id
      - text: Show the unstable-version payout {payout_id}.
        slots:
          payout_id: path.payout_id
      method: generated
      generated: '2026-09-24'