Skip to content
Guides
ES
API reference
stable

Search storefront 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

SellerId?null|string
Search?string
Category?string
categories?array<string>
Brand?string
brands?array<string>
Collection?string
collections?array<string>
CollectionId?null|string
ProductType?string
productTypes?array<string>
Tag?string
tags?array<string>
filters?array<string>
LocationId?null|string
InStock?boolean
MinPrice?number
Formatdouble
MaxPrice?number
Formatdouble
Page*integer
Formatint32
PageSize*integer
Formatint32
Sort?string

Response Body

application/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=0&PageSize=0"
{  "pageIndex": 0,  "pageSize": 0,  "totalCount": 0,  "totalPages": 0,  "products": [    {      "id": "string",      "name": "string",      "slug": "string",      "productType": "string",      "imageUrl": "string",      "price": 0.1,      "compareAtPrice": null,      "variantCount": 0,      "isAvailable": true,      "totalInventory": 0,      "bundleItemsCount": 0,      "brand": "string",      "category": "string",      "status": "string",      "collections": [        "string"      ],      "tags": [        "string"      ]    }  ],  "filters": [    {      "id": "string",      "label": "string",      "type": "string",      "values": [        {          "value": "string",          "count": 0,          "label": null,          "selected": false        }      ],      "min": null,      "max": null,      "selectedMin": null,      "selectedMax": null    }  ]}