A search results page. `term` is the URL-encoded search term.

GET /search/query/{term}

Authentication

None.

Parameters

Name	In	Type	Description
`term` required	path	string
`take` required	query	string	Page size, 1-50. The bundle never sends page/pageNumber.
`skip` required	query	string	Offset, >= 0.
`sort`	query	string
`query`	query	string	JSON-encoded QueryClause[].
`bypassToken`	query	string
`currency`	query	string
`grid_config`	query	`"1"`	"1" to include grid_config in the response. Never "false".

Responses

200 OK application/json

Type: PageResponse

Response of the collection and search routes.

Field Type Description

id optional string | number

title optional string

handle optional string

body_html optional string

image optional any

metafields optional

{ [key]: any }

Fields

Field	Type	Description
`[key: string]`	any	Any further keys.

sort_order optional string

config optional

{ [key]: any }

Fields

Field	Type	Description
`[key: string]`	any	Any further keys.

campaign optional null | Campaign

facets Facets

products (Product | MissingProduct)[]

query optional

QueryClause[]

Echo of the parsed query clauses.

search optional

string

The search term executed (search route).

suggested optional string[]

redirect optional string | null

grid_config optional null | GridConfig

Example response (illustrative)

{
  "id": 7712345678901,
  "title": "Linen shirt",
  "handle": "linen-shirt",
  "body_html": "<p>Breathable linen.</p>",
  "image": null,
  "metafields": {
    "custom": null
  },
  "sort_order": "newest",
  "config": {
    "key": null
  },
  "campaign": {
    "id": 7712345678901,
    "title": "Linen shirt",
    "blocks": [
      {}
    ]
  },
  "facets": {
    "count": 12,
    "vendors": [
      {
        "vendor": "Mercury Apparel"
      }
    ],
    "types": [
      {
        "type": "Shirts"
      }
    ],
    "tags": [
      {
        "value": "string"
      }
    ]
  },
  "products": [
    {
      "handle": "linen-shirt",
      "id": 7712345678901,
      "title": "Linen shirt",
      "vendor": "Mercury Apparel",
      "type": "Shirts",
      "on_sale": false,
      "total_stock": 12,
      "created_date": "2026-11-01T00:00:00.000Z",
      "tags": [
        "summer"
      ],
      "image": "https://cdn.shopify.com/s/files/1/0000/0001/files/linen-shirt.jpg",
      "images": [
        "https://cdn.shopify.com/s/files/1/0000/0001/files/linen-shirt.jpg"
      ],
      "variants": [
        {
          "id": 7712345678901,
          "title": "Linen shirt",
          "price": 89
        }
      ],
      "prices": {
        "AUD": {
          "price": 89
        }
      }
    }
  ],
  "query": [
    {
      "type": "Shirts",
      "operator": "string",
      "condition": "string",
      "value": [
        "string"
      ],
      "disjunctive": false
    }
  ],
  "search": "linen",
  "suggested": [
    "linen"
  ],
  "redirect": "string",
  "grid_config": {
    "grid": {
      "key": null
    },
    "currency": "AUD",
    "locale": "string",
    "delimiter": "string",
    "sizeMapping": null,
    "colourMapping": {
      "key": "#1f6feb"
    },
    "imageMapping": {
      "key": "string"
    },
    "facetMapping": null
  }
}

Errors use the standard envelope; see errors and status codes.

Example request