API Evangelist conversational phrasing for Shopify Retrieves 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 Retrieves API
  version: 1.0.0
extends: openapi/shopify-retrieves-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: 24
- target: $.paths['/admin/api/2020-01/webhooks/{webhook_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a webhook subscription (API 2020-01)
      effect: read
      questions:
      - How do I look up one webhook subscription by ID on the 2020-01 API?
      - Can I see the topic and address of a single webhook with API version 2020-01?
      instructions:
      - text: Get webhook subscription {webhook_id} via the 2020-01 API.
        slots:
          webhook_id: path.webhook_id
      - text: Using version 2020-01, show fields {fields} of webhook {webhook_id}.
        slots:
          fields: query.fields
          webhook_id: path.webhook_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/webhooks/{webhook_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a webhook subscription (API 2020-04)
      effect: read
      questions:
      - Which April 2020 (2020-04) endpoint returns a single webhook subscription?
      - Is fetching one webhook by its ID supported in the 2020-04 release?
      instructions:
      - text: On the 2020-04 release, fetch webhook {webhook_id}.
        slots:
          webhook_id: path.webhook_id
      - text: Pull the subscription details for webhook {webhook_id} with the April 2020 endpoint.
        slots:
          webhook_id: path.webhook_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/webhooks/{webhook_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a webhook subscription (API 2020-07)
      effect: read
      questions:
      - My app is pinned to 2020-07; what reads back one webhook subscription there?
      - Can the July 2020 API confirm where a given webhook is delivering?
      instructions:
      - text: Confirm where webhook {webhook_id} delivers using July 2020 (2020-07).
        slots:
          webhook_id: path.webhook_id
      - text: With API 2020-07, read webhook subscription {webhook_id}, returning only {fields}.
        slots:
          webhook_id: path.webhook_id
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/webhooks/{webhook_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a webhook subscription (API 2020-10)
      effect: read
      questions:
      - What is the 2020-10 call for retrieving one webhook subscription?
      - Does the October 2020 API show a single webhook's settings by ID?
      instructions:
      - text: Show the settings of webhook {webhook_id} on the October 2020 version.
        slots:
          webhook_id: path.webhook_id
      - text: Retrieve the 2020-10 webhook subscription {webhook_id}.
        slots:
          webhook_id: path.webhook_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/webhooks/{webhook_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a webhook subscription (API 2021-01)
      effect: read
      questions:
      - Under the 2021-01 API, where do I inspect a single webhook subscription?
      - Can I check one webhook's configuration with the January 2021 API version?
      instructions:
      - text: Inspect webhook {webhook_id} through API version 2021-01.
        slots:
          webhook_id: path.webhook_id
      - text: Check the configuration of webhook subscription {webhook_id} against January 2021.
        slots:
          webhook_id: path.webhook_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/webhooks/{webhook_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a webhook subscription (unstable API)
      effect: read
      questions:
      - Is there an unstable-channel endpoint for reading one webhook subscription?
      - Can I test single-webhook lookups against the unstable API version?
      instructions:
      - text: Get webhook {webhook_id} on the unstable API.
        slots:
          webhook_id: path.webhook_id
      - text: Against the unstable version, test fetching subscription {webhook_id}.
        slots:
          webhook_id: path.webhook_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/script_tags/{script_tag_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a script tag (API 2020-01)
      effect: read
      questions:
      - How do I read a single script tag my app injected into the storefront, on 2020-01?
      - Can I see which script URL one script tag loads with API version 2020-01?
      instructions:
      - text: Get script tag {script_tag_id} via the 2020-01 API.
        slots:
          script_tag_id: path.script_tag_id
      - text: Using version 2020-01, show fields {fields} of storefront script tag {script_tag_id}.
        slots:
          fields: query.fields
          script_tag_id: path.script_tag_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/script_tags/{script_tag_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a script tag (API 2020-04)
      effect: read
      questions:
      - Which April 2020 (2020-04) endpoint returns one script tag by ID?
      - Is looking up a single storefront script tag supported in the 2020-04 release?
      instructions:
      - text: On the 2020-04 release, fetch script tag {script_tag_id}.
        slots:
          script_tag_id: path.script_tag_id
      - text: Pull details of storefront script {script_tag_id} with the April 2020 endpoint.
        slots:
          script_tag_id: path.script_tag_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/script_tags/{script_tag_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a script tag (API 2020-07)
      effect: read
      questions:
      - My app targets 2020-07; what reads back a script tag there?
      - Can the July 2020 API tell me when a given script tag was added?
      instructions:
      - text: Tell me when script tag {script_tag_id} was added using July 2020 (2020-07).
        slots:
          script_tag_id: path.script_tag_id
      - text: With API 2020-07, read script tag {script_tag_id} limited to {fields}.
        slots:
          script_tag_id: path.script_tag_id
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/script_tags/{script_tag_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a script tag (API 2020-10)
      effect: read
      questions:
      - What is the 2020-10 call for retrieving a single script tag?
      - Does the October 2020 API show one injected storefront script by ID?
      instructions:
      - text: Show injected storefront script {script_tag_id} on the October 2020 version.
        slots:
          script_tag_id: path.script_tag_id
      - text: Retrieve the 2020-10 script tag {script_tag_id}.
        slots:
          script_tag_id: path.script_tag_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/script_tags/{script_tag_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a script tag (API 2021-01)
      effect: read
      questions:
      - Under the 2021-01 API, where do I inspect one script tag?
      - Can I verify a script tag's source with the January 2021 API version?
      instructions:
      - text: Inspect script tag {script_tag_id} through API version 2021-01.
        slots:
          script_tag_id: path.script_tag_id
      - text: Verify the source of script tag {script_tag_id} against January 2021.
        slots:
          script_tag_id: path.script_tag_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/script_tags/{script_tag_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a script tag (unstable API)
      effect: read
      questions:
      - Is there an unstable-channel endpoint for reading a single script tag?
      - Can I test script tag lookups against the unstable API version?
      instructions:
      - text: Get script tag {script_tag_id} on the unstable API.
        slots:
          script_tag_id: path.script_tag_id
      - text: Against the unstable version, test fetching storefront script {script_tag_id}.
        slots:
          script_tag_id: path.script_tag_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/themes/{theme_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a theme (API 2020-01)
      effect: read
      questions:
      - How do I get the details of one online store theme on the 2020-01 API?
      - Can I check a single theme's name and role with API version 2020-01?
      instructions:
      - text: Get theme {theme_id} via the 2020-01 API.
        slots:
          theme_id: path.theme_id
      - text: Using version 2020-01, show fields {fields} of store theme {theme_id}.
        slots:
          fields: query.fields
          theme_id: path.theme_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/themes/{theme_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a theme (API 2020-04)
      effect: read
      questions:
      - Which April 2020 (2020-04) endpoint returns a single theme?
      - Is reading one online store theme by ID supported in the 2020-04 release?
      instructions:
      - text: On the 2020-04 release, fetch theme {theme_id}.
        slots:
          theme_id: path.theme_id
      - text: Pull the record for online store 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'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a theme (API 2020-07)
      effect: read
      questions:
      - My app targets 2020-07; what reads back one theme there?
      - Can the July 2020 API tell me whether a theme is the published one?
      instructions:
      - text: Tell me if theme {theme_id} is published using July 2020 (2020-07).
        slots:
          theme_id: path.theme_id
      - text: With API 2020-07, read theme {theme_id} returning only {fields}.
        slots:
          theme_id: path.theme_id
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/themes/{theme_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a theme (API 2020-10)
      effect: read
      questions:
      - What is the 2020-10 call for retrieving a single theme?
      - Does the October 2020 API show one storefront theme by its ID?
      instructions:
      - text: Show storefront theme {theme_id} on the October 2020 version.
        slots:
          theme_id: path.theme_id
      - text: Retrieve 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'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a theme (API 2021-01)
      effect: read
      questions:
      - Under the 2021-01 API, where do I inspect a single theme?
      - Can I check one theme's status with the January 2021 API version?
      instructions:
      - text: Inspect theme {theme_id} through API version 2021-01.
        slots:
          theme_id: path.theme_id
      - text: Check the status of 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'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a theme (unstable API)
      effect: read
      questions:
      - Is there an unstable-channel endpoint for reading a single theme?
      - Can I test theme lookups against the unstable API version?
      instructions:
      - text: Get theme {theme_id} on the unstable API.
        slots:
          theme_id: path.theme_id
      - text: Against the unstable version, test fetching online store theme {theme_id}.
        slots:
          theme_id: path.theme_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/users/{user_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a staff user (API 2020-01)
      effect: read
      questions:
      - How do I look up one staff account on a Shopify Plus store with the 2020-01 API?
      - Can I see a single staff member's details using API version 2020-01?
      instructions:
      - text: Get staff user {user_id} via the 2020-01 API.
        slots:
          user_id: path.user_id
      - text: Using version 2020-01, show the staff account for user {user_id}.
        slots:
          user_id: path.user_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/users/{user_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a staff user (API 2020-04)
      effect: read
      questions:
      - Which April 2020 (2020-04) endpoint returns a single staff user?
      - Is reading one staff member by ID supported in the 2020-04 release?
      instructions:
      - text: On the 2020-04 release, fetch staff user {user_id}.
        slots:
          user_id: path.user_id
      - text: Pull staff member {user_id}'s record with the April 2020 endpoint.
        slots:
          user_id: path.user_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/users/{user_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a staff user (API 2020-07)
      effect: read
      questions:
      - My Plus app targets 2020-07; what reads back one staff user there?
      - Can the July 2020 API tell me who a given staff user ID belongs to?
      instructions:
      - text: Tell me who staff user {user_id} is using July 2020 (2020-07).
        slots:
          user_id: path.user_id
      - text: With API 2020-07, read user {user_id} from the staff list.
        slots:
          user_id: path.user_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/users/{user_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a staff user (API 2020-10)
      effect: read
      questions:
      - What is the 2020-10 call for retrieving a single staff user?
      - Does the October 2020 API show one store employee account by ID?
      instructions:
      - text: Show store employee account {user_id} on the October 2020 version.
        slots:
          user_id: path.user_id
      - text: Retrieve the 2020-10 staff user {user_id}.
        slots:
          user_id: path.user_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/users/{user_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a staff user (API 2021-01)
      effect: read
      questions:
      - Under the 2021-01 API, where do I inspect a single staff user?
      - Can I check one staff member's account with the January 2021 API version?
      instructions:
      - text: Inspect staff user {user_id} through API version 2021-01.
        slots:
          user_id: path.user_id
      - text: Check the account of staff member {user_id} against January 2021.
        slots:
          user_id: path.user_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/users/{user_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a staff user (unstable API)
      effect: read
      questions:
      - Is there an unstable-channel endpoint for reading a single staff user?
      - Can I test staff user lookups against the unstable API version?
      instructions:
      - text: Get staff user {user_id} on the unstable API.
        slots:
          user_id: path.user_id
      - text: Against the unstable version, test fetching staff account {user_id}.
        slots:
          user_id: path.user_id
      method: generated
      generated: '2026-09-24'