Shopify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Access API

20 actions 20 updates phrasing extends openapi/shopify-access-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 20 · first 16 shown; the file carries all of them

$.info
$.paths['/admin/oauth/access_scopes.json'].get
$.paths['/admin/api/2020-01/storefront_access_tokens.json'].get
$.paths['/admin/api/2020-01/storefront_access_tokens.json'].post
$.paths['/admin/api/2020-01/storefront_access_tokens/{storefront_access_token_id}.json'].delete
$.paths['/admin/api/2020-04/storefront_access_tokens.json'].get
$.paths['/admin/api/2020-04/storefront_access_tokens.json'].post
$.paths['/admin/api/2020-04/storefront_access_tokens/{storefront_access_token_id}.json'].delete
$.paths['/admin/api/2020-07/storefront_access_tokens.json'].get
$.paths['/admin/api/2020-07/storefront_access_tokens.json'].post
$.paths['/admin/api/2020-07/storefront_access_tokens/{storefront_access_token_id}.json'].delete
$.paths['/admin/api/2020-10/storefront_access_tokens.json'].get
$.paths['/admin/api/2020-10/storefront_access_tokens.json'].post
$.paths['/admin/api/2020-10/storefront_access_tokens/{storefront_access_token_id}.json'].delete
$.paths['/admin/api/2021-01/storefront_access_tokens.json'].get
$.paths['/admin/api/2021-01/storefront_access_tokens.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 Access API
  version: 1.0.0
extends: openapi/shopify-access-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: 19
- target: $.paths['/admin/oauth/access_scopes.json'].get
  update:
    x-apievangelist-phrasing:
      intent: See which access scopes my token has
      effect: read
      questions:
      - Which permissions has the merchant actually granted my app's access token?
      - Can I confirm my token carries a specific scope before calling endpoints that need it?
      instructions:
      - text: List the access scopes on my current access token.
      - text: Show me every OAuth scope this app installation was granted.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/storefront_access_tokens.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List Storefront access tokens (API 2020-01)
      effect: read
      questions:
      - Which Storefront API tokens has my app issued, according to the 2020-01 Admin API?
      - Can I see all existing storefront access tokens with version 2020-01?
      instructions:
      - text: List the storefront access tokens issued so far using 2020-01.
      - text: Show my app's Storefront API tokens on version 2020-01.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/storefront_access_tokens.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Issue a Storefront access token (API 2020-01)
      effect: write
      questions:
      - How can I generate a new Storefront API token through the 2020-01 Admin API?
      - Can version 2020-01 mint an extra storefront access token for a headless storefront?
      instructions:
      - text: Create a new storefront access token with API version 2020-01.
      - text: Issue one more Storefront API token via 2020-01.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/storefront_access_tokens/{storefront_access_token_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke a Storefront access token (API 2020-01)
      effect: destructive
      questions:
      - How can I revoke a leaked Storefront API token on the 2020-01 Admin API?
      - Does deleting a storefront access token on 2020-01 cut off storefronts still using it?
      instructions:
      - text: Delete storefront access token {storefront_access_token_id} using 2020-01.
        slots:
          storefront_access_token_id: path.storefront_access_token_id
      - text: Revoke Storefront API token {storefront_access_token_id} on version 2020-01.
        slots:
          storefront_access_token_id: path.storefront_access_token_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/storefront_access_tokens.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List Storefront access tokens (API 2020-04)
      effect: read
      questions:
      - What storefront access tokens exist for my app on API version 2020-04?
      - Is there a 2020-04 call that lists every Storefront API token I've created?
      instructions:
      - text: Retrieve all storefront access tokens from the 2020-04 Admin API.
      - text: On 2020-04, show the Storefront API tokens my app holds.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/storefront_access_tokens.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Issue a Storefront access token (API 2020-04)
      effect: write
      questions:
      - What's the 2020-04 call for creating a Storefront API access token?
      - Is it possible to add a fresh storefront token for a new sales channel on 2020-04?
      instructions:
      - text: Generate a storefront access token through the 2020-04 Admin API.
      - text: On 2020-04, mint a new token for the Storefront API.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/storefront_access_tokens/{storefront_access_token_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke a Storefront access token (API 2020-04)
      effect: destructive
      questions:
      - What's the 2020-04 way to remove a storefront access token I no longer use?
      - Is revoking a Storefront API token on 2020-04 permanent?
      instructions:
      - text: Remove storefront access token {storefront_access_token_id} from the 2020-04 Admin API.
        slots:
          storefront_access_token_id: path.storefront_access_token_id
      - text: On 2020-04, revoke the Storefront API token {storefront_access_token_id}.
        slots:
          storefront_access_token_id: path.storefront_access_token_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/storefront_access_tokens.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List Storefront access tokens (API 2020-07)
      effect: read
      questions:
      - Using the 2020-07 release, which Storefront API tokens are active for my app?
      - Does 2020-07 let me enumerate issued storefront access tokens?
      instructions:
      - text: Fetch the list of storefront access tokens via 2020-07.
      - text: Enumerate my app's Storefront API tokens on the 2020-07 release.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/storefront_access_tokens.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Issue a Storefront access token (API 2020-07)
      effect: write
      questions:
      - Using the 2020-07 release, can my app create its own Storefront API token?
      - Does 2020-07 support issuing additional storefront access tokens?
      instructions:
      - text: Create a Storefront API token via the 2020-07 release.
      - text: Add a fresh storefront access token through 2020-07.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/storefront_access_tokens/{storefront_access_token_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke a Storefront access token (API 2020-07)
      effect: destructive
      questions:
      - Using the 2020-07 release, can I invalidate one storefront access token?
      - Does 2020-07 support deleting Storefront API tokens by ID?
      instructions:
      - text: Invalidate storefront access token {storefront_access_token_id} via 2020-07.
        slots:
          storefront_access_token_id: path.storefront_access_token_id
      - text: Delete the 2020-07 Storefront API token with ID {storefront_access_token_id}.
        slots:
          storefront_access_token_id: path.storefront_access_token_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/storefront_access_tokens.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List Storefront access tokens (current 2020-10)
      effect: read
      questions:
      - Which Storefront API tokens exist for my app on the current 2020-10 version?
      - Can I list issued storefront access tokens with the non-deprecated API?
      instructions:
      - text: List storefront access tokens with the non-deprecated 2020-10 API.
      - text: Using 2020-10, show every Storefront API token I've issued.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/storefront_access_tokens.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Issue a Storefront access token (current 2020-10)
      effect: write
      questions:
      - Which call creates a Storefront API token on the current 2020-10 version?
      - Can the non-deprecated API issue a new storefront access token for my custom storefront?
      instructions:
      - text: Create a storefront access token with the non-deprecated 2020-10 API.
      - text: Using 2020-10, issue a new Storefront API token for my app.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/storefront_access_tokens/{storefront_access_token_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke a Storefront access token (current 2020-10)
      effect: destructive
      questions:
      - On the current 2020-10 version, what permanently cuts off a storefront token I've stopped using?
      - Can I delete a compromised storefront access token using the non-deprecated API?
      instructions:
      - text: Delete storefront access token {storefront_access_token_id} with the non-deprecated 2020-10 API.
        slots:
          storefront_access_token_id: path.storefront_access_token_id
      - text: Using 2020-10, revoke Storefront API token {storefront_access_token_id}.
        slots:
          storefront_access_token_id: path.storefront_access_token_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/storefront_access_tokens.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List Storefront access tokens (API 2021-01)
      effect: read
      questions:
      - Can I still list storefront access tokens on the deprecated 2021-01 version?
      - What does the 2021-01 storefront token list return?
      instructions:
      - text: Return all storefront access tokens from API version 2021-01.
      - text: Show issued Storefront API tokens via 2021-01.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/storefront_access_tokens.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Issue a Storefront access token (API 2021-01)
      effect: write
      questions:
      - Can I still create a Storefront API token on the deprecated 2021-01 version?
      - What does the 2021-01 token creation call hand back?
      instructions:
      - text: Issue a storefront access token through API version 2021-01.
      - text: Mint a Storefront API token via 2021-01.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/storefront_access_tokens/{storefront_access_token_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke a Storefront access token (API 2021-01)
      effect: destructive
      questions:
      - Can I still revoke a storefront access token on the deprecated 2021-01 version?
      - What happens when I delete a Storefront API token through 2021-01?
      instructions:
      - text: Revoke storefront access token {storefront_access_token_id} through API version 2021-01.
        slots:
          storefront_access_token_id: path.storefront_access_token_id
      - text: Remove Storefront API token {storefront_access_token_id} via 2021-01.
        slots:
          storefront_access_token_id: path.storefront_access_token_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/storefront_access_tokens.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List Storefront access tokens (unstable API)
      effect: read
      questions:
      - How can I list storefront access tokens on the unstable Admin API?
      - Is listing Storefront API tokens available in the unstable version?
      instructions:
      - text: List storefront access tokens on the unstable version.
      - text: Show the unstable-version list of Storefront API tokens.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/storefront_access_tokens.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Issue a Storefront access token (unstable API)
      effect: write
      questions:
      - How can I create a Storefront API token against the unstable Admin API?
      - Is issuing storefront access tokens supported in the unstable version?
      instructions:
      - text: Create a storefront access token on the unstable version.
      - text: Issue an unstable-version Storefront API token.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/storefront_access_tokens/{storefront_access_token_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke a Storefront access token (unstable API)
      effect: destructive
      questions:
      - How can I revoke a storefront access token on the unstable Admin API?
      - Is deleting Storefront API tokens supported in the unstable version?
      instructions:
      - text: Delete storefront access token {storefront_access_token_id} on the unstable version.
        slots:
          storefront_access_token_id: path.storefront_access_token_id
      - text: Revoke the unstable-version Storefront API token {storefront_access_token_id}.
        slots:
          storefront_access_token_id: path.storefront_access_token_id
      method: generated
      generated: '2026-09-24'