Skip to content
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. Set includeFilters=false for product shelves that do not display a filter panel.

GET/v1/products
No token

Query Parameters

includeFilters?boolean
productIds?array<ResourceId>

Only these products.

slugs?array<string>

Product slugs to return, in this order. Use it for hand-picked or recently viewed products.

search?string

Free-text search.

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

Identifier of the collection.

categoryId?string

Identifier of the category.

productTypes?array<>

Value in

  • "product"
  • "service"
  • "bundle"
tags?array<string>

Only items with any of these tags.

filters?array<string>

Filters as option:name:value or attribute:name:value, copied from the filters in the response. One value per option.

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

Value in

  • "default"
  • "priceAsc"
  • "priceDesc"
  • "newest"
  • "nameAsc"
  • "nameDesc"
  • "oldest"
  • "bestSelling"

Header Parameters

x-Store-Domain*string

Slug of the store or one of its configured domains, such as my-store.

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://storefront.ecomiq.pe/v1/products" \  -H "x-Store-Domain: my-store"
{  "pageIndex": 1,  "pageSize": 25,  "totalCount": 24,  "totalPages": 1,  "products": [    {      "id": "7204558912004322039",      "name": "Polo de algodón",      "slug": "polo-de-algodon",      "url": "https://mi-tienda.ecomiq.app/products/polo-de-algodon",      "productType": "product",      "imageUrl": "https://mi-tienda.ecomiq.app/images/polo-de-algodon.webp",      "price": 89,      "compareAtPrice": 99,      "variantCount": 24,      "isAvailable": true,      "totalInventory": 24,      "bundleItemsCount": 24,      "brand": "Andina",      "category": "Polos",      "status": "active",      "collections": [        "Polo de algodón"      ],      "tags": [        "algodón"      ],      "seller": {        "id": "7204558912004322039",        "name": "Polo de algodón",        "slug": "polo-de-algodon"      },      "options": [        {          "key": "color",          "name": "Polo de algodón",          "type": "Polo de algodón",          "values": [            {              "key": "color",              "name": "Polo de algodón",              "value": "Mi tienda",              "valueId": "7204558912004324721",              "valueName": "Polo de algodón",              "type": "Mi tienda",              "color": "Azul",              "imageUrl": "https://mi-tienda.ecomiq.app/images/polo-de-algodon.webp",              "unit": "Mi tienda"            }          ]        }      ],      "images": [        {          "url": "https://mi-tienda.ecomiq.app/images/polo-de-algodon.webp",          "name": "polo-de-algodon.webp",          "order": 1,          "type": "image"        }      ],      "availableVariantId": "7204558912004322596"    }  ],  "filters": [    {      "id": "option:color",      "label": "Color",      "type": "option",      "values": [        {          "value": "Mi tienda",          "count": 24,          "label": "Mi tienda",          "selected": false        }      ],      "min": 1,      "max": 1,      "selectedMin": 1,      "selectedMax": 1    }  ]}