RenderedSearch
Response of GET search/query/:term (rendered search).
Spread order (pinned by libs/controllers/src/search.controller.spec.ts):
suggested from autocomplete first, then the search-result keys (which can
OVERRIDE suggested), then optionally grid_config.
Type: object
| Field | Type | Description |
|---|---|---|
suggested | string[] | Autocomplete suggestions for the term ([] when the dictionary errors). |
facets | SearchFacets | |
products | RenderedProduct[] | |
query | FilterOperator[] | Echo of the parsed |
search | string | The cleaned search term actually executed. |
redirect optional | string | null | Present when a search-term redirect is configured for the term. |
grid_config optional | GridConfig | Present when |
Example (illustrative)
{
"suggested": [
"linen"
],
"facets": {
"vendors": [
{
"vendor": "Mercury Apparel",
"count": 12
}
],
"types": [
{
"type": "Shirts",
"count": 12
}
],
"tags": [
{
"value": "string",
"count": 12
}
],
"count": 12
},
"products": [
{
"id": "7712345678901",
"title": "Linen shirt",
"implode": 1,
"handle": "linen-shirt",
"min_price": 89,
"compare_at_min_price": 89,
"vendor": "Mercury Apparel",
"type": "Shirts",
"on_sale": false,
"total_stock": 12,
"variants": [
{
"title": "Linen shirt",
"id": 7712345678901,
"inventory": 12,
"price": "89.00",
"compare_at_price": "89.00"
}
],
"prices": {
"AUD": {
"price": 89
}
},
"created_date": "2026-11-01T00:00:00.000Z",
"options": null,
"normalised_stock": 12,
"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"
],
"related": "string",
"imploded": [
{
"id": "7712345678901",
"title": "Linen shirt",
"implode": 1,
"handle": "linen-shirt",
"min_price": 89,
"max_price": 89,
"compare_at_min_price": 89,
"compare_at_max_price": 89,
"vendor": "Mercury Apparel",
"type": "Shirts",
"on_sale": false,
"total_stock": 12,
"variants": [
{
"title": "Linen shirt",
"id": 7712345678901,
"inventory": 12,
"price": "89.00",
"compare_at_price": "89.00"
}
],
"prices": {
"AUD": {
"price": null
}
},
"created_date": "2026-11-01T00:00:00.000Z",
"tags": [
"summer"
]
}
],
"meta": {
"key": null
}
}
],
"query": [
{
"type": "Shirts",
"condition": "string",
"value": null
}
],
"search": "linen",
"redirect": "string",
"grid_config": {
"grid": {
"elements": {
"key": null
},
"core": {
"key": null
},
"breakpoints": [
{
"index": 1,
"label": "string",
"minwidth": 1,
"columns": 1,
"format": "string"
}
],
"currentBreakpoint": {
"key": null
},
"styles": "string"
},
"currency": "AUD",
"locale": "string",
"delimiter": "string",
"sizeMapping": null,
"colourMapping": {
"key": "#1f6feb"
},
"imageMapping": {
"key": "string"
},
"facetMapping": null,
"integrations": null,
"skuSearch": null
}
}Used by
Declared in api-types/src/storefront/models.ts.