Shopify

Shopify Predictive Search API

Search suggestions for products, collections, pages, and articles

Documentation GitHub OpenAPI

Operations 1

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /search/suggest.json Get search-as-you-type suggestions · Shopify Get predictive search results #

Ask an LLM

“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?”

Tell an agent

Get predictive search results for {q}.

Suggest up to {limit} {types} results for {q}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/shopify:shopify-predictive-search-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Shopify Ajax Predictive Search API
  description: The Shopify Ajax API provides lightweight REST endpoints for Shopify theme development. It is an unauthenticated API used to manage the shopping cart, retrieve product data, get product recommendations, and provide predictive search within Shopify-hosted storefronts. All responses return JSON.
  version: 2025-01
  contact:
    name: Shopify
    url: https://shopify.dev/docs/api/ajax
    email: api@shopify.com
  license:
    name: Shopify API Terms
    url: https://www.shopify.com/legal/api-terms
  x-date: '2026-03-04'
servers:
- url: https://{store}.myshopify.com
  description: Shopify storefront
  variables:
    store:
      default: my-store
      description: The Shopify store subdomain
tags:
- name: Predictive Search
  description: Search suggestions for products, collections, pages, and articles
paths:
  /search/suggest.json:
    get:
      operationId: getPredictiveSearchResults
      summary: Shopify Get predictive search results
      description: Retrieves predictive search results for a query string. Returns matching products, collections, pages, articles, and query suggestions. Used for search-as-you-type experiences.
      tags:
      - Predictive Search
      parameters:
      - name: q
        in: query
        required: true
        description: The search query
        schema:
          type: string
      - name: resources[type]
        in: query
        description: Comma-separated resource types to search (product, page, article, collection, query)
        schema:
          type: string
          default: query,product,collection,page
      - name: resources[limit]
        in: query
        description: Number of results per type (1-10, default 10)
        schema:
          type: integer
          minimum: 1
          maximum: 10
          default: 10
      - name: resources[limit_scope]
        in: query
        description: 'How the limit is distributed: all (shared across types) or each (per type)'
        schema:
          type: string
          enum:
          - all
          - each
          default: all
      - name: resources[options][unavailable_products]
        in: query
        description: How to handle unavailable products
        schema:
          type: string
          enum:
          - show
          - hide
          - last
          default: last
      - name: resources[options][fields]
        in: query
        description: Comma-separated fields to search within (title, product_type, vendor, tag, variants.title, variants.sku, body)
        schema:
          type: string
      responses:
        '200':
          description: Predictive search results
          content:
            application/json:
              schema:
                type: object
                properties:
                  resources:
                    type: object
                    properties:
                      results:
                        type: object
                        properties:
                          queries:
                            type: array
                            items:
                              type: object
                              properties:
                                text:
                                  type: string
                                styled_text:
                                  type: string
                          products:
                            type: array
                            items:
                              $ref: '#/components/schemas/StorefrontProduct'
                          collections:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                title:
                                  type: string
                                handle:
                                  type: string
                                url:
                                  type: string
                                published_at:
                                  type: string
                                  format: date-time
                                body:
                                  type: string
                                image:
                                  type: object
                                  properties:
                                    url:
                                      type: string
                                      format: uri
                                    alt:
                                      type: string
                                    width:
                                      type: integer
                                    height:
                                      type: integer
                          pages:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                title:
                                  type: string
                                handle:
                                  type: string
                                url:
                                  type: string
                                body:
                                  type: string
                          articles:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                title:
                                  type: string
                                handle:
                                  type: string
                                url:
                                  type: string
                                body:
                                  type: string
                                published_at:
                                  type: string
                                  format: date-time
                                image:
                                  type: object
                                  properties:
                                    url:
                                      type: string
                                      format: uri
                                    alt:
                                      type: string
                                    width:
                                      type: integer
                                    height:
                                      type: integer
        '422':
          description: Invalid parameter
        '429':
          description: Rate limited
components:
  schemas:
    StorefrontProduct:
      type: object
      description: A product as returned by the storefront Ajax API
      properties:
        id:
          type: integer
        title:
          type: string
        handle:
          type: string
        description:
          type: string
        published_at:
          type: string
          format: date-time
        created_at:
          type: string
          format: date-time
        vendor:
          type: string
        type:
          type: string
        tags:
          type: array
          items:
            type: string
        price:
          type: integer
          description: Price in cents
        price_min:
          type: integer
        price_max:
          type: integer
        available:
          type: boolean
        price_varies:
          type: boolean
        compare_at_price:
          type:
          - integer
          - 'null'
        compare_at_price_min:
          type: integer
        compare_at_price_max:
          type: integer
        compare_at_price_varies:
          type: boolean
        variants:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
              title:
                type: string
              option1:
                type:
                - string
                - 'null'
              option2:
                type:
                - string
                - 'null'
              option3:
                type:
                - string
                - 'null'
              sku:
                type:
                - string
                - 'null'
              requires_shipping:
                type: boolean
              taxable:
                type: boolean
              featured_image:
                type:
                - object
                - 'null'
              available:
                type: boolean
              name:
                type: string
              public_title:
                type:
                - string
                - 'null'
              price:
                type: integer
              weight:
                type: integer
              compare_at_price:
                type:
                - integer
                - 'null'
              barcode:
                type:
                - string
                - 'null'
        images:
          type: array
          items:
            type: string
            format: uri
        featured_image:
          type: string
          format: uri
        options:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              position:
                type: integer
              values:
                type: array
                items:
                  type: string
        url:
          type: string
        media:
          type: array
          items:
            type: object
            properties:
              alt:
                type:
                - string
                - 'null'
              id:
                type: integer
              position:
                type: integer
              media_type:
                type: string
              src:
                type: string
                format: uri
              width:
                type: integer
              height:
                type: integer

Shopify Predictive Search API

Operations 1

Documentation

Specifications

Schemas & Data

Other Resources