# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Shopify Cards API
  version: 1.0.0
extends: openapi/shopify-cards-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: 18
- target: $.paths['/admin/api/2020-01/gift_cards.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List gift cards (API 2020-01)
      effect: read
      questions:
      - Which gift cards has my Shopify Plus store issued, per API 2020-01?
      - Can I list only the enabled gift cards with version 2020-01?
      instructions:
      - text: List 2020-01 gift cards with status {status}.
        slots:
          status: query.status
      - text: Show gift cards after {since_id} using API 2020-01.
        slots:
          since_id: query.since_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/gift_cards/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count gift cards (API 2020-01)
      effect: read
      questions:
      - How many gift cards exist in my store according to API 2020-01?
      - Can the 2020-01 count split gift cards by enabled or disabled status?
      instructions:
      - text: Count gift cards with API 2020-01.
      - text: Count 2020-01 gift cards whose status is {status}.
        slots:
          status: query.status
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/gift_cards/search.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Search gift cards (API 2020-01)
      effect: read
      questions:
      - Can I search gift cards by code or balance with the 2020-01 API?
      - What gift cards match a search query under version 2020-01?
      instructions:
      - text: Search 2020-01 gift cards for {query}.
        slots:
          query: query.query
      - text: Find gift cards matching {query} on API 2020-01, sorted by {order}.
        slots:
          query: query.query
          order: query.order
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/gift_cards.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List gift cards (API 2020-04)
      effect: read
      questions:
      - What gift cards does version 2020-04 list for my shop?
      - Is there a page size limit on the 2020-04 gift card list?
      instructions:
      - text: Get {limit} gift cards per page from the 2020-04 endpoint.
        slots:
          limit: query.limit
      - text: List disabled or enabled gift cards, status {status}, via API 2020-04.
        slots:
          status: query.status
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/gift_cards/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count gift cards (API 2020-04)
      effect: read
      questions:
      - What is the total number of gift cards on my store with version 2020-04?
      - Can I count only disabled gift cards on API 2020-04?
      instructions:
      - text: Give me the gift card total from the 2020-04 count endpoint.
      - text: Tally 2020-04 gift cards with status {status}.
        slots:
          status: query.status
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/gift_cards/search.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Search gift cards (API 2020-04)
      effect: read
      questions:
      - Is there a 2020-04 search that finds a gift card from part of its code?
      - Can I cap how many results the 2020-04 gift card search returns?
      instructions:
      - text: Search gift cards on API 2020-04 using query {query}.
        slots:
          query: query.query
      - text: Return the top {limit} 2020-04 gift card search hits for {query}.
        slots:
          limit: query.limit
          query: query.query
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/gift_cards.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List gift cards (API 2020-07)
      effect: read
      questions:
      - Can I list every gift card in my store with API 2020-07?
      - Can the 2020-07 gift card list return just a few fields?
      instructions:
      - text: List gift cards on version 2020-07.
      - text: Return {fields} for each gift card with API 2020-07.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/gift_cards/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count gift cards (API 2020-07)
      effect: read
      questions:
      - How many enabled gift cards does my shop have on API 2020-07?
      - Does version 2020-07 offer a quick gift card count?
      instructions:
      - text: Count gift cards via the 2020-07 API.
      - text: Count gift cards in status {status} with version 2020-07.
        slots:
          status: query.status
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/gift_cards/search.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Search gift cards (API 2020-07)
      effect: read
      questions:
      - Which gift cards turn up when I search on version 2020-07?
      - Can I sort 2020-07 gift card search results by a field like balance?
      instructions:
      - text: Search 2020-07 gift cards for {query} ordered by {order}.
        slots:
          query: query.query
          order: query.order
      - text: Look up gift cards matching {query} via API 2020-07, showing {fields}.
        slots:
          query: query.query
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/gift_cards.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List gift cards (API 2020-10)
      effect: read
      questions:
      - What gift cards has my Shopify store issued, using API 2020-10?
      - Can I page through gift cards on 2020-10 from the last ID I saw?
      instructions:
      - text: List all gift cards using API version 2020-10.
      - text: Continue the 2020-10 gift card list after {since_id}, {limit} at a time.
        slots:
          since_id: query.since_id
          limit: query.limit
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/gift_cards/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count gift cards (API 2020-10)
      effect: read
      questions:
      - How many gift cards does my store have on API 2020-10?
      - Can the 2020-10 count include only enabled gift cards?
      instructions:
      - text: Count my gift cards with API version 2020-10.
      - text: Count 2020-10 gift cards having status {status}.
        slots:
          status: query.status
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/gift_cards/search.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Search gift cards (API 2020-10)
      effect: read
      questions:
      - Can I find a customer's gift card by searching with API 2020-10?
      - What does a 2020-10 gift card search return for a partial code?
      instructions:
      - text: Search gift cards for {query} using API version 2020-10.
        slots:
          query: query.query
      - text: Run a 2020-10 gift card search for {query}, {limit} results sorted by {order}.
        slots:
          query: query.query
          limit: query.limit
          order: query.order
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/gift_cards.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List gift cards (API 2021-01)
      effect: read
      questions:
      - Does the 2021-01 API still list my store's gift cards?
      - Which disabled gift cards exist according to version 2021-01?
      instructions:
      - text: Retrieve gift cards through the 2021-01 API.
      - text: List 2021-01 gift cards with status {status}, showing only {fields}.
        slots:
          status: query.status
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/gift_cards/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count gift cards (API 2021-01)
      effect: read
      questions:
      - What is my gift card count according to version 2021-01?
      - Can I get a 2021-01 count of gift cards filtered by status?
      instructions:
      - text: Count gift cards via the 2021-01 count endpoint.
      - text: Count 2021-01 gift cards in status {status}.
        slots:
          status: query.status
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/gift_cards/search.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Search gift cards (API 2021-01)
      effect: read
      questions:
      - Does version 2021-01 support searching gift cards with a query?
      - Can I trim 2021-01 gift card search results down to a few fields?
      instructions:
      - text: Search gift cards with query {query} on API 2021-01.
        slots:
          query: query.query
      - text: Find 2021-01 gift cards matching {query}, limited to {limit}.
        slots:
          query: query.query
          limit: query.limit
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/gift_cards.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List gift cards (unstable API)
      effect: read
      questions:
      - Can I list gift cards on the unstable API version?
      - Which gift cards does the unstable endpoint return after a given ID?
      instructions:
      - text: List gift cards on the unstable API version.
      - text: Get unstable-version gift cards after {since_id}.
        slots:
          since_id: query.since_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/gift_cards/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count gift cards (unstable API)
      effect: read
      questions:
      - Can I count gift cards on the unstable API version?
      - How many gift cards of one status does the unstable count report?
      instructions:
      - text: Count gift cards on the unstable API version.
      - text: Count unstable-version gift cards with status {status}.
        slots:
          status: query.status
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/gift_cards/search.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Search gift cards (unstable API)
      effect: read
      questions:
      - Can I search gift cards on the unstable API version?
      - What gift cards does the unstable search return for my query?
      instructions:
      - text: Search gift cards for {query} on the unstable version.
        slots:
          query: query.query
      - text: Search unstable-version gift cards for {query} sorted by {order}.
        slots:
          query: query.query
          order: query.order
      method: generated
      generated: '2026-09-24'