Skip to content
docs
Guides
ES
Content & StorefrontProducts

Search products

Returns one page of the published catalog together with the facets that apply to it, so a filter panel needs no second call. Every filter is optional and they combine.

GET/v1/products

Returns one page of the published catalog together with the facets that apply to it, so a filter panel needs no second call. Every filter is optional and they combine.

Query Parameters

productIds?array<ResourceId>

Only these products.

search?string

Free-text filter. Which fields it covers depends on the resource.

categories?array<string>
brands?array<string>
sellers?array<string>
collections?array<string>
collectionId?string

Identifier of the collection.

productTypes?array<>
tags?array<string>

Only items with any of these tags.

filters?array<string>
inStock?boolean
minPrice?number

Lowest price to include, in the store currency.

Formatdouble
maxPrice?number

Highest price to include, in the store currency.

Formatdouble
page*integer

One-based page number.

Formatint32
pageSize*integer
Formatint32
sort?string

Header Parameters

x-Store-Domain*string

Store slug or configured domain that selects the store context at the central Storefront gateway.

Length1 <= length <= 253

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/products?page=1&pageSize=1" \  -H "x-Store-Domain: my-store"
{  "pageIndex": 1,  "pageSize": 1,  "totalCount": 1,  "totalPages": 1,  "products": [    {      "id": "7204558912004325301",      "name": "Example resource",      "slug": "example-resource",      "productType": "example",      "imageUrl": "https://example.com/resource",      "price": 1,      "compareAtPrice": 1,      "variantCount": 1,      "isAvailable": false,      "totalInventory": 1,      "bundleItemsCount": 1,      "brand": "example",      "category": "example",      "status": "example",      "collections": [        "example"      ],      "tags": [        "example"      ],      "seller": {        "id": "7204558912004325301",        "name": "Example resource",        "slug": "example-resource"      }    }  ],  "filters": [    {      "id": "7204558912004325301",      "label": "example",      "type": "example",      "values": [        {          "value": "example",          "count": 1,          "label": "example",          "selected": false        }      ],      "min": 1,      "max": 1,      "selectedMin": 1,      "selectedMax": 1    }  ]}