API Evangelist conversational phrasing for Shopify Existing 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 Existing API
  version: 1.0.0
extends: openapi/shopify-existing-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'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an inventory item (API 2020-01)
      effect: write
      questions:
      - How do I change an existing inventory item using the 2020-01 Admin API?
      - Can I edit the inventory item behind a variant on API version 2020-01?
      instructions:
      - text: Update inventory item {inventory_item_id} via the 2020-01 API.
        slots:
          inventory_item_id: path.inventory_item_id
      - text: Using version 2020-01, save edits to stock 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'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an inventory item (API 2020-04)
      effect: write
      questions:
      - Which April 2020 (2020-04) endpoint modifies an inventory item?
      - Is editing an existing inventory item supported in the 2020-04 release?
      instructions:
      - text: On the 2020-04 release, modify inventory item {inventory_item_id}.
        slots:
          inventory_item_id: path.inventory_item_id
      - text: Apply changes to the stock record {inventory_item_id} with the April 2020 endpoint.
        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'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an inventory item (API 2020-07)
      effect: write
      questions:
      - My inventory app targets 2020-07; what updates an inventory item there?
      - Can the July 2020 API revise an inventory item I already track?
      instructions:
      - text: Revise tracked inventory item {inventory_item_id} using July 2020 (2020-07).
        slots:
          inventory_item_id: path.inventory_item_id
      - text: With API 2020-07, write updates to inventory item {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'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an inventory item (API 2020-10)
      effect: write
      questions:
      - What is the 2020-10 call for updating an inventory item?
      - Does the October 2020 API let me correct an existing inventory item?
      instructions:
      - text: Correct inventory item {inventory_item_id} on the October 2020 version.
        slots:
          inventory_item_id: path.inventory_item_id
      - text: Update the 2020-10 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'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an inventory item (API 2021-01)
      effect: write
      questions:
      - Under the 2021-01 API, where do I update an inventory item?
      - Can I amend an inventory item with the January 2021 API version?
      instructions:
      - text: Amend inventory item {inventory_item_id} through API version 2021-01.
        slots:
          inventory_item_id: path.inventory_item_id
      - text: Push an update for stock item {inventory_item_id} against January 2021.
        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'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an inventory item (unstable API)
      effect: write
      questions:
      - Is there an unstable-channel endpoint for updating an inventory item?
      - Can I test inventory item edits against the unstable API version?
      instructions:
      - text: Update inventory item {inventory_item_id} on the unstable API.
        slots:
          inventory_item_id: path.inventory_item_id
      - text: Against the unstable version, test editing stock item {inventory_item_id}.
        slots:
          inventory_item_id: path.inventory_item_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/redirects/{redirect_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a URL redirect (API 2020-01)
      effect: write
      questions:
      - How do I change an existing URL redirect on my online store with the 2020-01 API?
      - Can I fix a redirect that points old links to the wrong page, on version 2020-01?
      instructions:
      - text: Update redirect {redirect_id} via the 2020-01 API.
        slots:
          redirect_id: path.redirect_id
      - text: Using version 2020-01, fix URL redirect {redirect_id}.
        slots:
          redirect_id: path.redirect_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/redirects/{redirect_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a URL redirect (API 2020-04)
      effect: write
      questions:
      - Which April 2020 (2020-04) endpoint modifies a URL redirect?
      - Is editing an existing storefront redirect supported in the 2020-04 release?
      instructions:
      - text: On the 2020-04 release, modify redirect {redirect_id}.
        slots:
          redirect_id: path.redirect_id
      - text: Change where storefront redirect {redirect_id} goes with the April 2020 endpoint.
        slots:
          redirect_id: path.redirect_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/redirects/{redirect_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a URL redirect (API 2020-07)
      effect: write
      questions:
      - My SEO app targets 2020-07; what updates a redirect there?
      - Can the July 2020 API repoint an old URL redirect?
      instructions:
      - text: Repoint old URL redirect {redirect_id} using July 2020 (2020-07).
        slots:
          redirect_id: path.redirect_id
      - text: With API 2020-07, write changes to redirect {redirect_id}.
        slots:
          redirect_id: path.redirect_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/redirects/{redirect_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a URL redirect (API 2020-10)
      effect: write
      questions:
      - What is the 2020-10 call for editing a URL redirect?
      - Does the October 2020 API let me correct a redirect's target?
      instructions:
      - text: Correct the target of redirect {redirect_id} on the October 2020 version.
        slots:
          redirect_id: path.redirect_id
      - text: Update the 2020-10 URL redirect {redirect_id}.
        slots:
          redirect_id: path.redirect_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/redirects/{redirect_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a URL redirect (API 2021-01)
      effect: write
      questions:
      - Under the 2021-01 API, where do I update a URL redirect?
      - Can I amend a store redirect with the January 2021 API version?
      instructions:
      - text: Amend redirect {redirect_id} through API version 2021-01.
        slots:
          redirect_id: path.redirect_id
      - text: Push an update for store redirect {redirect_id} against January 2021.
        slots:
          redirect_id: path.redirect_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/redirects/{redirect_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a URL redirect (unstable API)
      effect: write
      questions:
      - Is there an unstable-channel endpoint for updating a URL redirect?
      - Can I test redirect edits against the unstable API version?
      instructions:
      - text: Update redirect {redirect_id} on the unstable API.
        slots:
          redirect_id: path.redirect_id
      - text: Against the unstable version, test editing URL redirect {redirect_id}.
        slots:
          redirect_id: path.redirect_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/themes/{theme_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a theme (API 2020-01)
      effect: write
      questions:
      - How do I change an existing online store theme using the 2020-01 API?
      - Can I edit a theme's settings record on API version 2020-01?
      instructions:
      - text: Update theme {theme_id} via the 2020-01 API.
        slots:
          theme_id: path.theme_id
      - text: Using version 2020-01, save edits to online store theme {theme_id}.
        slots:
          theme_id: path.theme_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/themes/{theme_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a theme (API 2020-04)
      effect: write
      questions:
      - Which April 2020 (2020-04) endpoint modifies a theme?
      - Is editing an existing storefront theme supported in the 2020-04 release?
      instructions:
      - text: On the 2020-04 release, modify theme {theme_id}.
        slots:
          theme_id: path.theme_id
      - text: Apply changes to storefront theme {theme_id} with the April 2020 endpoint.
        slots:
          theme_id: path.theme_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/themes/{theme_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a theme (API 2020-07)
      effect: write
      questions:
      - My theme app targets 2020-07; what updates a theme there?
      - Can the July 2020 API revise a theme that is already installed?
      instructions:
      - text: Revise installed theme {theme_id} using July 2020 (2020-07).
        slots:
          theme_id: path.theme_id
      - text: With API 2020-07, write updates to theme {theme_id}.
        slots:
          theme_id: path.theme_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/themes/{theme_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a theme (API 2020-10)
      effect: write
      questions:
      - What is the 2020-10 call for updating a theme?
      - Does the October 2020 API let me change an existing theme record?
      instructions:
      - text: Change the theme record {theme_id} on the October 2020 version.
        slots:
          theme_id: path.theme_id
      - text: Update the 2020-10 theme {theme_id}.
        slots:
          theme_id: path.theme_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/themes/{theme_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a theme (API 2021-01)
      effect: write
      questions:
      - Under the 2021-01 API, where do I update a theme?
      - Can I amend a store theme with the January 2021 API version?
      instructions:
      - text: Amend theme {theme_id} through API version 2021-01.
        slots:
          theme_id: path.theme_id
      - text: Push an update for store theme {theme_id} against January 2021.
        slots:
          theme_id: path.theme_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/themes/{theme_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a theme (unstable API)
      effect: write
      questions:
      - Is there an unstable-channel endpoint for updating a theme?
      - Can I test theme edits against the unstable API version?
      instructions:
      - text: Update theme {theme_id} on the unstable API.
        slots:
          theme_id: path.theme_id
      - text: Against the unstable version, test editing online store theme {theme_id}.
        slots:
          theme_id: path.theme_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/products/{product_id}/images/{image_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Modify a product image (API 2020-01)
      effect: write
      questions:
      - How do I edit an image already attached to a product with the 2020-01 API?
      - Can I change a product photo's record on API version 2020-01?
      instructions:
      - text: Update image {image_id} on product {product_id} via the 2020-01 API.
        slots:
          image_id: path.image_id
          product_id: path.product_id
      - text: Using version 2020-01, modify product {product_id}'s photo {image_id}.
        slots:
          product_id: path.product_id
          image_id: path.image_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/products/{product_id}/images/{image_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Modify a product image (API 2020-04)
      effect: write
      questions:
      - Which April 2020 (2020-04) endpoint modifies a product image?
      - Is editing an existing product picture supported in the 2020-04 release?
      instructions:
      - text: On the 2020-04 release, modify image {image_id} of product {product_id}.
        slots:
          image_id: path.image_id
          product_id: path.product_id
      - text: Apply changes to picture {image_id} on product {product_id} with the April 2020 endpoint.
        slots:
          image_id: path.image_id
          product_id: path.product_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/products/{product_id}/images/{image_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Modify a product image (API 2020-07)
      effect: write
      questions:
      - My catalog app targets 2020-07; what updates a product image there?
      - Can the July 2020 API revise an image already on a product listing?
      instructions:
      - text: Revise listing image {image_id} for product {product_id} using July 2020 (2020-07).
        slots:
          image_id: path.image_id
          product_id: path.product_id
      - text: With API 2020-07, write updates to product {product_id} image {image_id}.
        slots:
          product_id: path.product_id
          image_id: path.image_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/products/{product_id}/images/{image_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Modify a product image (API 2020-10)
      effect: write
      questions:
      - What is the 2020-10 call for modifying a product image?
      - Does the October 2020 API let me change an existing product photo?
      instructions:
      - text: Change photo {image_id} of product {product_id} on the October 2020 version.
        slots:
          image_id: path.image_id
          product_id: path.product_id
      - text: Update the 2020-10 product image {image_id} for product {product_id}.
        slots:
          image_id: path.image_id
          product_id: path.product_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/products/{product_id}/images/{image_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Modify a product image (API 2021-01)
      effect: write
      questions:
      - Under the 2021-01 API, where do I update a product image?
      - Can I amend a product's picture with the January 2021 API version?
      instructions:
      - text: Amend image {image_id} of product {product_id} through API version 2021-01.
        slots:
          image_id: path.image_id
          product_id: path.product_id
      - text: Push an update for product {product_id} picture {image_id} against January 2021.
        slots:
          product_id: path.product_id
          image_id: path.image_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/products/{product_id}/images/{image_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Modify a product image (unstable API)
      effect: write
      questions:
      - Is there an unstable-channel endpoint for modifying a product image?
      - Can I test product image edits against the unstable API version?
      instructions:
      - text: Update image {image_id} on product {product_id} on the unstable API.
        slots:
          image_id: path.image_id
          product_id: path.product_id
      - text: Against the unstable version, test editing product {product_id} photo {image_id}.
        slots:
          product_id: path.product_id
          image_id: path.image_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/checkouts/{token}/payments/{payment_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a checkout payment (API 2020-01)
      effect: read
      questions:
      - How do I get the payment information for one payment on a checkout with the 2020-01 API?
      - Can a sales channel check the status of a checkout payment on version 2020-01?
      instructions:
      - text: Get payment {payment_id} on checkout {token} via the 2020-01 API.
        slots:
          payment_id: path.payment_id
          token: path.token
      - text: Using version 2020-01, show payment details for {payment_id} in checkout {token}.
        slots:
          payment_id: path.payment_id
          token: path.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/checkouts/{token}/payments/{payment_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a checkout payment (API 2020-04)
      effect: read
      questions:
      - Which April 2020 (2020-04) endpoint returns a single checkout payment?
      - Is reading payment info for a checkout supported in the 2020-04 release?
      instructions:
      - text: On the 2020-04 release, fetch payment {payment_id} for checkout {token}.
        slots:
          payment_id: path.payment_id
          token: path.token
      - text: Pull checkout {token}'s payment {payment_id} with the April 2020 endpoint.
        slots:
          token: path.token
          payment_id: path.payment_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/checkouts/{token}/payments/{payment_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a checkout payment (API 2020-07)
      effect: read
      questions:
      - My sales channel targets 2020-07; what reads a checkout payment there?
      - Can the July 2020 API tell me whether a checkout payment went through?
      instructions:
      - text: Tell me if payment {payment_id} on checkout {token} went through, using July 2020 (2020-07).
        slots:
          payment_id: path.payment_id
          token: path.token
      - text: With API 2020-07, read payment {payment_id} of checkout {token}.
        slots:
          payment_id: path.payment_id
          token: path.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/checkouts/{token}/payments/{payment_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a checkout payment (API 2020-10)
      effect: read
      questions:
      - What is the 2020-10 call for retrieving a payment made on a checkout?
      - Does the October 2020 API show the result of one checkout payment?
      instructions:
      - text: Show the result of payment {payment_id} for checkout {token} on the October 2020 version.
        slots:
          payment_id: path.payment_id
          token: path.token
      - text: Retrieve the 2020-10 checkout {token} payment {payment_id}.
        slots:
          token: path.token
          payment_id: path.payment_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/checkouts/{token}/payments/{payment_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a checkout payment (API 2021-01)
      effect: read
      questions:
      - Under the 2021-01 API, where do I inspect a checkout payment?
      - Can I verify one checkout payment with the January 2021 API version?
      instructions:
      - text: Inspect payment {payment_id} on checkout {token} through API version 2021-01.
        slots:
          payment_id: path.payment_id
          token: path.token
      - text: Verify checkout {token} payment {payment_id} against January 2021.
        slots:
          token: path.token
          payment_id: path.payment_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/checkouts/{token}/payments/{payment_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a checkout payment (unstable API)
      effect: read
      questions:
      - Is there an unstable-channel endpoint for reading a checkout payment?
      - Can I test checkout payment lookups against the unstable API version?
      instructions:
      - text: Get payment {payment_id} for checkout {token} on the unstable API.
        slots:
          payment_id: path.payment_id
          token: path.token
      - text: Against the unstable version, test fetching checkout {token} payment {payment_id}.
        slots:
          token: path.token
          payment_id: path.payment_id
      method: generated
      generated: '2026-09-24'