# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Shopify Published API
  version: 1.0.0
extends: openapi/shopify-published-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: 6
- target: $.paths['/admin/api/2020-01/collection_listings/{collection_listing_id}/product_ids.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List product IDs in a collection listing (2020-01)
      effect: read
      questions:
      - Which product IDs are published to a collection listing, in API 2020-01?
      - How many product IDs can one January 2020 request return for a collection listing?
      instructions:
      - text: List product IDs published to collection listing {collection_listing} via 2020-01.
        slots:
          collection_listing: path.collection_listing_id
      - text: On January 2020, get up to {limit} product IDs in collection listing {collection_listing}.
        slots:
          limit: query.limit
          collection_listing: path.collection_listing_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/collection_listings/{collection_listing_id}/product_ids.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List product IDs in a collection listing (2020-04)
      effect: read
      questions:
      - How do I see which products my sales channel has in a collection listing, on 2020-04?
      - In April 2020, what's the maximum page size for collection listing product IDs?
      instructions:
      - text: Get product IDs for collection listing {collection_listing} using 2020-04.
        slots:
          collection_listing: path.collection_listing_id
      - text: Using April 2020, return {limit} product IDs from collection listing {collection_listing}.
        slots:
          limit: query.limit
          collection_listing: path.collection_listing_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/collection_listings/{collection_listing_id}/product_ids.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List product IDs in a collection listing (2020-07)
      effect: read
      questions:
      - What call returns a collection listing's published product IDs in 2020-07?
      - Can I raise the result limit past 50 when fetching July 2020 collection product IDs?
      instructions:
      - text: Show published product IDs of collection listing {collection_listing} with 2020-07.
        slots:
          collection_listing: path.collection_listing_id
      - text: Via July 2020, fetch {limit} product IDs for collection listing {collection_listing}.
        slots:
          limit: query.limit
          collection_listing: path.collection_listing_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/collection_listings/{collection_listing_id}/product_ids.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List product IDs published to a collection listing
      effect: read
      questions:
      - Which products in this collection are published to my channel, on 2020-10?
      - Where in October 2020 do I list product IDs for a collection listing?
      instructions:
      - text: List product IDs published to collection listing {collection_listing} (API 2020-10).
        slots:
          collection_listing: path.collection_listing_id
      - text: With October 2020, pull {limit} product IDs from collection listing {collection_listing}.
        slots:
          limit: query.limit
          collection_listing: path.collection_listing_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/collection_listings/{collection_listing_id}/product_ids.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List product IDs in a collection listing (2021-01)
      effect: read
      questions:
      - On 2021-01, how can I get product IDs published to a collection listing?
      - Does January 2021 cap product IDs per collection listing request at 1000?
      instructions:
      - text: Retrieve product IDs in collection listing {collection_listing} using 2021-01.
        slots:
          collection_listing: path.collection_listing_id
      - text: Using January 2021, list {limit} published product IDs for {collection_listing}.
        slots:
          limit: query.limit
          collection_listing: path.collection_listing_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/collection_listings/{collection_listing_id}/product_ids.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List product IDs in a collection listing (unstable)
      effect: read
      questions:
      - Can I list a collection listing's product IDs on the unstable API?
      - Which unstable-version endpoint returns product IDs published to a collection?
      instructions:
      - text: Get product IDs for collection listing {collection_listing} on unstable.
        slots:
          collection_listing: path.collection_listing_id
      - text: Using the unstable endpoint, return {limit} product IDs from {collection_listing}.
        slots:
          limit: query.limit
          collection_listing: path.collection_listing_id
      method: generated
      generated: '2026-09-24'