API Evangelist conversational phrasing for Shopify Card 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 Card API
  version: 1.0.0
extends: openapi/shopify-card-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/gift_cards.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Issue a new gift card (2020-01)
      effect: write
      questions:
      - How do I issue a new gift card with API version 2020-01?
      - Can an app create gift cards on the 2020-01 version?
      instructions:
      - text: Create a new gift card using API version 2020-01.
      - text: Issue a gift card through the 2020-01 gift card endpoint.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/gift_cards/{gift_card_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a gift card by ID (2020-01)
      effect: read
      questions:
      - Can I look up a single gift card by its ID on API version 2020-01?
      - What does the 2020-01 version return for one gift card?
      instructions:
      - text: Retrieve gift card {gift_card_id} using API version 2020-01.
        slots:
          gift_card_id: path.gift_card_id
      - text: Show the 2020-01 record for gift card {gift_card_id}.
        slots:
          gift_card_id: path.gift_card_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/gift_cards/{gift_card_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a gift card (2020-01)
      effect: write
      questions:
      - Can I change an existing gift card through API version 2020-01?
      - Which 2020-01 call edits a gift card that was already issued?
      instructions:
      - text: Update gift card {gift_card_id} using API version 2020-01.
        slots:
          gift_card_id: path.gift_card_id
      - text: Edit issued gift card {gift_card_id} on the 2020-01 version.
        slots:
          gift_card_id: path.gift_card_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/gift_cards/{gift_card_id}/disable.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Disable a gift card (2020-01)
      effect: destructive
      questions:
      - How do I disable a gift card so it can no longer be used, on 2020-01?
      - Can I deactivate a lost or compromised gift card with the 2020-01 version?
      instructions:
      - text: Disable gift card {gift_card_id} using API version 2020-01.
        slots:
          gift_card_id: path.gift_card_id
      - text: Deactivate gift card {gift_card_id} on the 2020-01 version.
        slots:
          gift_card_id: path.gift_card_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/gift_cards.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a gift card (2020-04)
      effect: write
      questions:
      - Can I create a gift card programmatically with the 2020-04 release?
      - Which 2020-04 endpoint makes a brand-new gift card?
      instructions:
      - text: Make a brand-new gift card with the 2020-04 release.
      - text: Using release 2020-04, create a gift card.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/gift_cards/{gift_card_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a gift card's details (2020-04)
      effect: read
      questions:
      - Where do I read one gift card's details on the 2020-04 release?
      - Can release 2020-04 fetch a gift card if I have its ID?
      instructions:
      - text: Fetch gift card {gift_card_id} with the 2020-04 release.
        slots:
          gift_card_id: path.gift_card_id
      - text: Using release 2020-04, pull up gift card {gift_card_id}.
        slots:
          gift_card_id: path.gift_card_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/gift_cards/{gift_card_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Modify an existing gift card (2020-04)
      effect: write
      questions:
      - Can release 2020-04 modify a gift card after it has been issued?
      - What's the 2020-04 call to save changes to a gift card?
      instructions:
      - text: Modify gift card {gift_card_id} through release 2020-04.
        slots:
          gift_card_id: path.gift_card_id
      - text: Using release 2020-04, save changes to gift card {gift_card_id}.
        slots:
          gift_card_id: path.gift_card_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/gift_cards/{gift_card_id}/disable.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Deactivate a gift card (2020-04)
      effect: destructive
      questions:
      - Which 2020-04 call stops a gift card from being redeemed?
      - Can I shut off a gift card with release 2020-04?
      instructions:
      - text: Shut off gift card {gift_card_id} with release 2020-04.
        slots:
          gift_card_id: path.gift_card_id
      - text: Using release 2020-04, disable gift card {gift_card_id} so it cannot be redeemed.
        slots:
          gift_card_id: path.gift_card_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/gift_cards.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Issue a gift card (2020-07)
      effect: write
      questions:
      - Does the 2020-07 API let my app issue gift cards?
      - What's involved in issuing a gift card on the 2020-07 API?
      instructions:
      - text: Issue one new gift card on the 2020-07 API.
      - text: For the 2020-07 API, create a gift card for my store.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/gift_cards/{gift_card_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one gift card (2020-07)
      effect: read
      questions:
      - What information comes back for a single gift card on the 2020-07 API?
      - Can I look at a specific gift card by ID with 2020-07?
      instructions:
      - text: Get the details of gift card {gift_card_id} from API 2020-07.
        slots:
          gift_card_id: path.gift_card_id
      - text: Look up gift card {gift_card_id} on the 2020-07 API.
        slots:
          gift_card_id: path.gift_card_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/gift_cards/{gift_card_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a gift card (2020-07)
      effect: write
      questions:
      - Does the 2020-07 API allow editing a gift card that already exists?
      - Can I adjust an issued gift card through 2020-07?
      instructions:
      - text: Apply changes to gift card {gift_card_id}, API 2020-07.
        slots:
          gift_card_id: path.gift_card_id
      - text: Edit gift card {gift_card_id} with the 2020-07 API.
        slots:
          gift_card_id: path.gift_card_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/gift_cards/{gift_card_id}/disable.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Disable a gift card (2020-07)
      effect: destructive
      questions:
      - Is disabling a gift card supported on the 2020-07 API?
      - How would I block a gift card from further use on 2020-07?
      instructions:
      - text: Block gift card {gift_card_id} from further use on the 2020-07 API.
        slots:
          gift_card_id: path.gift_card_id
      - text: Disable gift card {gift_card_id} (API 2020-07).
        slots:
          gift_card_id: path.gift_card_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/gift_cards.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a gift card (2020-10, current version)
      effect: write
      questions:
      - How do I create a gift card on the current 2020-10 version?
      - Can the non-deprecated 2020-10 API issue a gift card?
      instructions:
      - text: Create a gift card on 2020-10.
      - text: Issue a new gift card using the non-deprecated 2020-10 API.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/gift_cards/{gift_card_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a gift card (2020-10)
      effect: read
      questions:
      - Can I retrieve a gift card by ID with the non-deprecated 2020-10 API?
      - Which gift card details does the current 2020-10 version return?
      instructions:
      - text: Retrieve gift card {gift_card_id} on 2020-10.
        slots:
          gift_card_id: path.gift_card_id
      - text: Show gift card {gift_card_id}, current 2020-10 version.
        slots:
          gift_card_id: path.gift_card_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/gift_cards/{gift_card_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a gift card (2020-10)
      effect: write
      questions:
      - What's the way to update an existing gift card with the current 2020-10 version?
      - Can a gift card be changed via 2020-10 after it is issued?
      instructions:
      - text: Update gift card {gift_card_id} on 2020-10.
        slots:
          gift_card_id: path.gift_card_id
      - text: Change gift card {gift_card_id} with the non-deprecated 2020-10 API.
        slots:
          gift_card_id: path.gift_card_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/gift_cards/{gift_card_id}/disable.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Disable a gift card (2020-10)
      effect: destructive
      questions:
      - Can I disable a gift card with the non-deprecated 2020-10 API?
      - Which 2020-10 call makes a gift card unusable?
      instructions:
      - text: Disable gift card {gift_card_id} on 2020-10.
        slots:
          gift_card_id: path.gift_card_id
      - text: Make gift card {gift_card_id} unusable using the current 2020-10 version.
        slots:
          gift_card_id: path.gift_card_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/gift_cards.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a gift card (2021-01)
      effect: write
      questions:
      - Is creating a gift card possible with version 2021-01?
      - What's the 2021-01 endpoint for making a new gift card?
      instructions:
      - text: With version 2021-01, create a gift card.
      - text: Set up a new gift card via the 2021-01 version.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/gift_cards/{gift_card_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch a gift card (2021-01)
      effect: read
      questions:
      - Can version 2021-01 return a single gift card by its ID?
      - What does a gift card look like when fetched through 2021-01?
      instructions:
      - text: With version 2021-01, fetch gift card {gift_card_id}.
        slots:
          gift_card_id: path.gift_card_id
      - text: Display gift card {gift_card_id} from the 2021-01 version.
        slots:
          gift_card_id: path.gift_card_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/gift_cards/{gift_card_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Modify a gift card (2021-01)
      effect: write
      questions:
      - Can I modify an existing gift card in version 2021-01?
      - Which 2021-01 call updates a gift card?
      instructions:
      - text: With version 2021-01, update gift card {gift_card_id}.
        slots:
          gift_card_id: path.gift_card_id
      - text: Revise gift card {gift_card_id} through the 2021-01 version.
        slots:
          gift_card_id: path.gift_card_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/gift_cards/{gift_card_id}/disable.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Disable a gift card (2021-01)
      effect: destructive
      questions:
      - Is it possible to disable a gift card through version 2021-01?
      - Which 2021-01 endpoint turns off a gift card?
      instructions:
      - text: With version 2021-01, disable gift card {gift_card_id}.
        slots:
          gift_card_id: path.gift_card_id
      - text: Turn off gift card {gift_card_id} via the 2021-01 version.
        slots:
          gift_card_id: path.gift_card_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/gift_cards.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a gift card (unstable version)
      effect: write
      questions:
      - Can I test creating a gift card against the unstable API version?
      - What does the unstable version expect when issuing a gift card?
      instructions:
      - text: On the unstable API version, create a gift card.
      - text: Try issuing a gift card using the unstable version.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/gift_cards/{gift_card_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a gift card (unstable version)
      effect: read
      questions:
      - Can I read a single gift card from the unstable API version?
      - What does the unstable version return for one gift card?
      instructions:
      - text: On the unstable API version, retrieve gift card {gift_card_id}.
        slots:
          gift_card_id: path.gift_card_id
      - text: Try fetching gift card {gift_card_id} with the unstable version.
        slots:
          gift_card_id: path.gift_card_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/gift_cards/{gift_card_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a gift card (unstable version)
      effect: write
      questions:
      - Can I update an existing gift card against the unstable API version?
      - How does the unstable version handle edits to a gift card?
      instructions:
      - text: On the unstable API version, update gift card {gift_card_id}.
        slots:
          gift_card_id: path.gift_card_id
      - text: Try editing gift card {gift_card_id} using the unstable version.
        slots:
          gift_card_id: path.gift_card_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/gift_cards/{gift_card_id}/disable.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Disable a gift card (unstable version)
      effect: destructive
      questions:
      - Can I disable a gift card through the unstable API version?
      - Does the unstable version support deactivating a gift card?
      instructions:
      - text: On the unstable API version, disable gift card {gift_card_id}.
        slots:
          gift_card_id: path.gift_card_id
      - text: Try deactivating gift card {gift_card_id} with the unstable version.
        slots:
          gift_card_id: path.gift_card_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/checkouts/{token}/payments.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Pay for a checkout with a card vault session (2020-01)
      effect: write
      questions:
      - How does a sales channel take payment on a checkout from a card vault session in 2020-01?
      - Does the 2020-01 checkout payment call need a unique idempotency token?
      instructions:
      - text: Create a payment on checkout {token} with API version 2020-01.
        slots:
          token: path.token
      - text: Charge checkout {token} from its card vault session, version 2020-01.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/checkouts/{token}/payments.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a checkout payment (2020-04)
      effect: write
      questions:
      - Can a sales channel app charge a checkout using a card vault session ID on release 2020-04?
      - What does release 2020-04 need to record a payment against a checkout?
      instructions:
      - text: Record a payment against checkout {token} through release 2020-04.
        slots:
          token: path.token
      - text: Using release 2020-04, pay for checkout {token} with the vaulted card session.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/checkouts/{token}/payments.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Charge a checkout via card vault session (2020-07)
      effect: write
      questions:
      - Is taking a card vault payment on a checkout supported by the 2020-07 API?
      - Which 2020-07 call completes payment for a checkout token?
      instructions:
      - text: Take payment on checkout {token} using the 2020-07 API.
        slots:
          token: path.token
      - text: For the 2020-07 API, create a card vault payment for checkout {token}.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/checkouts/{token}/payments.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a checkout payment (2020-10, current version)
      effect: write
      questions:
      - How do I create a payment on a checkout with a card vault session on the current 2020-10 version?
      - Can the non-deprecated 2020-10 API accept a vaulted card payment for a checkout?
      instructions:
      - text: Create a payment on checkout {token} on 2020-10.
        slots:
          token: path.token
      - text: Charge checkout {token} with its vaulted card using the non-deprecated 2020-10 API.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/checkouts/{token}/payments.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a checkout payment (2021-01)
      effect: write
      questions:
      - Can version 2021-01 create a payment on a checkout from a card vault session?
      - Which 2021-01 call pays a checkout with a vaulted card?
      instructions:
      - text: With version 2021-01, create a payment for checkout {token}.
        slots:
          token: path.token
      - text: Pay checkout {token} from its card vault session via the 2021-01 version.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/checkouts/{token}/payments.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a checkout payment (unstable version)
      effect: write
      questions:
      - Can I test a card vault checkout payment against the unstable API version?
      - Does the unstable version accept payments on a checkout by token?
      instructions:
      - text: On the unstable API version, create a payment on checkout {token}.
        slots:
          token: path.token
      - text: Try charging checkout {token} with a card vault session using the unstable version.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'