Shopify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Ajax Predictive Search API

2 actions 2 updates phrasing extends openapi/shopify-predictive-search-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['/search/suggest.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 Ajax Predictive Search API
  version: 1.0.0
extends: openapi/shopify-predictive-search-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['/search/suggest.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get search-as-you-type suggestions
      effect: read
      questions:
      - How do I show live search suggestions as shoppers type in my storefront?
      - Can predictive search return only products and collections, not pages or articles?
      - What fields can predictive search match on, like SKU or vendor?
      instructions:
      - text: Get predictive search results for {q}.
        slots:
          q: query.q
      - text: Suggest up to {limit} {types} results for {q}.
        slots:
          limit: query.resources[limit]
          types: query.resources[type]
          q: query.q
      - text: Search {q} only within the fields {fields}.
        slots:
          q: query.q
          fields: query.resources[options][fields]
      method: generated
      generated: '2026-09-24'