API Evangelist conversational phrasing for Shopify Collections 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 Collections API
  version: 1.0.0
extends: openapi/shopify-collections-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: 26
- target: $.paths['/collections/{collection_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a collection by ID
      effect: read
      questions:
      - What details and metadata does Shopify hold for one of my collections?
      - Can I look up a single collection when I only know its ID?
      instructions:
      - text: Get collection {collection_id}.
        slots:
          collection_id: path.collection_id
      - text: Show only {fields} for collection {collection_id}.
        slots:
          fields: query.fields
          collection_id: path.collection_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/collections/{collection_id}/products.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List the products in a collection
      effect: read
      questions:
      - Which products belong to one of my collections?
      - Can I cap how many products come back when I list what's inside a collection?
      instructions:
      - text: List the products inside collection {collection_id}.
        slots:
          collection_id: path.collection_id
      - text: Show the first {limit} products in collection {collection_id}.
        slots:
          limit: query.limit
          collection_id: path.collection_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/custom_collections.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom collections (API 2020-01)
      effect: read
      questions:
      - Which manual (custom) collections does my shop have under API 2020-01?
      - Can I find the custom collections that contain a given product with version 2020-01?
      instructions:
      - text: List 2020-01 custom collections containing product {product_id}.
        slots:
          product_id: query.product_id
      - text: Show custom collections titled {title} on API 2020-01.
        slots:
          title: query.title
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/custom_collections/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count custom collections (API 2020-01)
      effect: read
      questions:
      - How many manual collections are in my store according to API 2020-01?
      - Can the 2020-01 API count only the published custom collections?
      instructions:
      - text: Count custom collections with API 2020-01.
      - text: Tell me how many 2020-01 custom collections have published status {published_status}.
        slots:
          published_status: query.published_status
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/custom_collections.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom collections (API 2020-04)
      effect: read
      questions:
      - Can I look up a custom collection by its handle using API 2020-04?
      - Which hand-picked collections changed recently, per version 2020-04?
      instructions:
      - text: Find the 2020-04 custom collection with handle {handle}.
        slots:
          handle: query.handle
      - text: List custom collections updated since {updated_at_min} via API 2020-04.
        slots:
          updated_at_min: query.updated_at_min
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/custom_collections/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count custom collections (API 2020-04)
      effect: read
      questions:
      - What is the total number of custom collections in my shop on version 2020-04?
      - Can I count the 2020-04 custom collections that include one product?
      instructions:
      - text: Count 2020-04 custom collections that contain product {product_id}.
        slots:
          product_id: query.product_id
      - text: Give me the custom collection total from the 2020-04 count endpoint.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/custom_collections.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom collections (API 2020-07)
      effect: read
      questions:
      - Can I list custom collections published within a date range on API 2020-07?
      - Is there a page size limit on the 2020-07 custom collections list?
      instructions:
      - text: List custom collections published between {published_at_min} and {published_at_max} with version 2020-07.
        slots:
          published_at_min: query.published_at_min
          published_at_max: query.published_at_max
      - text: Get {limit} custom collections per page on API 2020-07.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/custom_collections/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count custom collections (API 2020-07)
      effect: read
      questions:
      - How many custom collections were updated in a window, per the 2020-07 count?
      - Can I count custom collections by title with version 2020-07?
      instructions:
      - text: Count custom collections updated between {updated_at_min} and {updated_at_max} on API 2020-07.
        slots:
          updated_at_min: query.updated_at_min
          updated_at_max: query.updated_at_max
      - text: Count 2020-07 custom collections titled {title}.
        slots:
          title: query.title
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/custom_collections.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom collections (API 2020-10)
      effect: read
      questions:
      - What manually curated collections does my Shopify store have on API 2020-10?
      - Can I fetch specific custom collections by ID with version 2020-10?
      instructions:
      - text: List all custom collections using API version 2020-10.
      - text: Get custom collections {ids} from the 2020-10 list.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/custom_collections/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count custom collections (API 2020-10)
      effect: read
      questions:
      - How many custom collections does my shop have on API 2020-10?
      - Can the 2020-10 count tell me how many manual collections were published after a date?
      instructions:
      - text: Count my custom collections with API version 2020-10.
      - text: Count 2020-10 custom collections published after {published_at_min}.
        slots:
          published_at_min: query.published_at_min
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/custom_collections.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom collections (API 2021-01)
      effect: read
      questions:
      - Does the 2021-01 API let me list only unpublished custom collections?
      - Can I page through custom collections after a known ID on version 2021-01?
      instructions:
      - text: List 2021-01 custom collections with published status {published_status}.
        slots:
          published_status: query.published_status
      - text: Show custom collections after {since_id} via API 2021-01.
        slots:
          since_id: query.since_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/custom_collections/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count custom collections (API 2021-01)
      effect: read
      questions:
      - What is my custom collection count according to version 2021-01?
      - Can the 2021-01 count be limited to collections published before a date?
      instructions:
      - text: Count custom collections via the 2021-01 API.
      - text: Count 2021-01 custom collections published before {published_at_max}.
        slots:
          published_at_max: query.published_at_max
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/custom_collections.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom collections (unstable API)
      effect: read
      questions:
      - Can I list custom collections on the unstable API version?
      - Which custom collections does the unstable endpoint return with trimmed fields?
      instructions:
      - text: List custom collections on the unstable API version.
      - text: Fetch unstable-version custom collections showing only {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/custom_collections/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count custom collections (unstable API)
      effect: read
      questions:
      - Can I count custom collections on the unstable API version?
      - How many custom collections changed before a date, per the unstable count?
      instructions:
      - text: Count custom collections on the unstable API version.
      - text: Count unstable-version custom collections updated before {updated_at_max}.
        slots:
          updated_at_max: query.updated_at_max
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/smart_collections.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List smart collections (API 2020-01)
      effect: read
      questions:
      - Which automated (smart) collections does my shop have under API 2020-01?
      - Can I find smart collections that include a certain product with version 2020-01?
      instructions:
      - text: List 2020-01 smart collections containing product {product_id}.
        slots:
          product_id: query.product_id
      - text: Show smart collections titled {title} on API 2020-01.
        slots:
          title: query.title
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/smart_collections/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count smart collections (API 2020-01)
      effect: read
      questions:
      - How many rule-based collections are in my store according to API 2020-01?
      - Can the 2020-01 API count only published smart collections?
      instructions:
      - text: Count smart collections with API 2020-01.
      - text: Tell me how many 2020-01 smart collections have published status {published_status}.
        slots:
          published_status: query.published_status
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/smart_collections.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List smart collections (API 2020-04)
      effect: read
      questions:
      - Is there a 2020-04 way to find an automated collection from its URL handle?
      - Which automated collections changed recently, per version 2020-04?
      instructions:
      - text: Find the 2020-04 smart collection with handle {handle}.
        slots:
          handle: query.handle
      - text: List smart collections updated since {updated_at_min} via API 2020-04.
        slots:
          updated_at_min: query.updated_at_min
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/smart_collections/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count smart collections (API 2020-04)
      effect: read
      questions:
      - How big is my set of rule-based collections, counted with version 2020-04?
      - Can I count the 2020-04 smart collections that pick up one product?
      instructions:
      - text: Count 2020-04 smart collections that contain product {product_id}.
        slots:
          product_id: query.product_id
      - text: Give me the smart collection total from the 2020-04 count endpoint.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/smart_collections.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List smart collections (API 2020-07)
      effect: read
      questions:
      - Can I list smart collections published in a date range on API 2020-07?
      - How many smart collections will the 2020-07 list hand back per request?
      instructions:
      - text: List smart collections published between {published_at_min} and {published_at_max} with version 2020-07.
        slots:
          published_at_min: query.published_at_min
          published_at_max: query.published_at_max
      - text: Get {limit} smart collections per page on API 2020-07.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/smart_collections/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count smart collections (API 2020-07)
      effect: read
      questions:
      - Can the 2020-07 API tally the automated collections edited between two dates?
      - Can I count smart collections by title with version 2020-07?
      instructions:
      - text: Count smart collections updated between {updated_at_min} and {updated_at_max} on API 2020-07.
        slots:
          updated_at_min: query.updated_at_min
          updated_at_max: query.updated_at_max
      - text: Count 2020-07 smart collections titled {title}.
        slots:
          title: query.title
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/smart_collections.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List smart collections (API 2020-10)
      effect: read
      questions:
      - What rule-driven collections does my Shopify store have on API 2020-10?
      - Can I fetch specific smart collections by ID with version 2020-10?
      instructions:
      - text: List all smart collections using API version 2020-10.
      - text: Get smart collections {ids} from the 2020-10 list.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/smart_collections/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count smart collections (API 2020-10)
      effect: read
      questions:
      - How many smart collections does my shop have on API 2020-10?
      - What number of smart collections went live after a given date, per version 2020-10?
      instructions:
      - text: Count my smart collections with API version 2020-10.
      - text: Count 2020-10 smart collections published after {published_at_min}.
        slots:
          published_at_min: query.published_at_min
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/smart_collections.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List smart collections (API 2021-01)
      effect: read
      questions:
      - Does the 2021-01 API let me list only unpublished smart collections?
      - Is it possible to resume a 2021-01 smart collection listing from the last ID returned?
      instructions:
      - text: List 2021-01 smart collections with published status {published_status}.
        slots:
          published_status: query.published_status
      - text: Show smart collections after {since_id} via API 2021-01.
        slots:
          since_id: query.since_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/smart_collections/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count smart collections (API 2021-01)
      effect: read
      questions:
      - What is my smart collection count according to version 2021-01?
      - How many automated collections were published before some date, per the 2021-01 count?
      instructions:
      - text: Count smart collections via the 2021-01 API.
      - text: Count 2021-01 smart collections published before {published_at_max}.
        slots:
          published_at_max: query.published_at_max
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/smart_collections.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List smart collections (unstable API)
      effect: read
      questions:
      - Can I list smart collections on the unstable API version?
      - Which smart collections does the unstable endpoint return with trimmed fields?
      instructions:
      - text: List smart collections on the unstable API version.
      - text: Fetch unstable-version smart collections showing only {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/smart_collections/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count smart collections (unstable API)
      effect: read
      questions:
      - Can I count smart collections on the unstable API version?
      - How many smart collections changed before a date, per the unstable count?
      instructions:
      - text: Count smart collections on the unstable API version.
      - text: Count unstable-version smart collections updated before {updated_at_max}.
        slots:
          updated_at_max: query.updated_at_max
      method: generated
      generated: '2026-09-24'