Shopify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Admin REST Smart Collections API

2 actions 2 updates phrasing extends openapi/shopify-smart-collections-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 2

$.info

$.paths['/smart_collections.json'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Shopify Admin REST Smart Collections API
  version: 1.0.0
extends: openapi/shopify-smart-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: 1
- target: $.paths['/smart_collections.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List smart (automated) collections
      effect: read
      questions:
      - How do I see all the automated collections in my store?
      - Which smart collections include a particular product?
      - Can I page through smart collections 250 at a time?
      instructions:
      - text: List my smart collections.
      - text: Find smart collections titled {title}.
        slots:
          title: query.title
      - text: Show the smart collections that contain product {product}.
        slots:
          product: query.product_id
      - text: List up to {limit} smart collections after ID {since_id}, returning only {fields}.
        slots:
          limit: query.limit
          since_id: query.since_id
          fields: query.fields
      method: generated
      generated: '2026-09-24'