Skip to content
docs
Guides
ES
CatalogProducts
catalog:read

List products

Returns a paginated product list using the supplied catalog filters.

GET/v1/catalog/products

Returns a paginated product list using the supplied catalog filters.

Authorization

bearerAuth
AuthorizationBearer <token>

OAuth2 access token issued by Ecomiq Auth.

In: header

Query Parameters

limit?integer

Maximum number of results to return.

Formatint32
cursor?string

Opaque cursor from the previous response. Omit it on the first page.

search?string

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

sortBy?string

Field to sort by. Accepted values depend on the resource.

sortDirection?string

Sort direction: asc or desc.

Value in

  • "asc"
  • "desc"
productIds?array<ResourceId>

Only these products.

status?array<>

Only items in these statuses.

excludeStatus?array<>

Leave out items in these statuses.

includeArchived?boolean

Include archived items.

categoryIds?array<ResourceId>

Only items in these categories.

excludeCategoryIds?array<ResourceId>

Leave out items in these categories.

brandIds?array<ResourceId>

Only items of these brands.

excludeBrandIds?array<ResourceId>

Leave out items of these brands.

storeIds?array<ResourceId>

Only items of these stores.

sellerIds?array<ResourceId>

Only items of these sellers.

excludeSellerIds?array<ResourceId>

Leave out items of these sellers.

skuIds?array<ResourceId>

Filter by variant identifiers.

skus?array<string>

Filter by SKU codes.

types?array<>

Only these product types.

excludeTypes?array<>

Leave out these product types.

isFeatured?boolean

Only featured items.

ean?string

Filter by EAN barcode.

minPrice?number

Lowest price to include, in the store currency.

Formatdouble
maxPrice?number

Highest price to include, in the store currency.

Formatdouble
minOnHand?integer

Minimum stock on hand.

Formatint32
maxOnHand?integer

Maximum stock on hand.

Formatint32
minAvailable?integer

Minimum stock available to sell.

Formatint32
tags?array<string>

Only items with any of these tags.

excludeTags?array<string>

Leave out items with any of these tags.

includeVariants?boolean

Include each product's variants in the response.

includeTotalCount?boolean

Include the total number of matches. Slower on large catalogs.

projection?string

How much of each item to return.

Value in

  • "summary"
  • "full"
  • "spreadsheet"
channelId?string

Identifier of the sales channel.

sourceIds?array<ResourceId>

Only items imported from these sources.

Header Parameters

x-Store-Id?string

Store the request acts on. Not needed when the token is bound to a store.

Authorization*string

OAuth 2.0 bearer token.

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/catalog/products" \  -H "x-Store-Id: <store-id>" \  -H "Authorization: Bearer <token>"
{  "data": [    {      "id": "7204558912004325301",      "sku": "SKU-001",      "storeId": "7204558912004325301",      "sellerId": "7204558912004325301",      "type": "product",      "name": "Example resource",      "description": "Example description.",      "slug": "example-resource",      "currency": "PEN",      "taxRate": 1,      "taxIncluded": false,      "brand": "example",      "price": 1,      "compareAtPrice": 1,      "costPrice": 1,      "totalOnHand": 1,      "available": 1,      "committed": 1,      "totalVariants": 1,      "activeVariants": 1,      "tracksInventory": false,      "vendor": "example",      "tags": [        "example"      ],      "specifications": [        {          "name": "Example resource",          "key": "example",          "value": "example"        }      ],      "images": [        {          "id": "7204558912004325301",          "url": "https://example.com/resource",          "name": "Example resource",          "width": 1,          "height": 1,          "isPrimary": false,          "order": 1        }      ],      "category": "example",      "packageId": "7204558912004325301",      "shippingProfileId": "7204558912004325301",      "status": "draft",      "metaTitle": "Example title",      "metaDescription": "Example description.",      "metaKeywords": [        "example"      ],      "featuredUntil": "2026-08-01T15:30:00Z",      "isFeatured": false,      "minOrderQuantity": 1,      "maxOrderQuantity": 1,      "isDigital": false,      "hasVariants": false,      "hasActivity": false,      "hasPriceLists": false,      "hasReviews": false,      "hasSizeGuide": false,      "variants": [        {          "id": "7204558912004325301",          "storeId": "7204558912004325301",          "productId": "7204558912004325301",          "version": 1,          "packageId": "7204558912004325301",          "name": "Example resource",          "sku": "SKU-001",          "barcode": "7751234567890",          "countryOfOrigin": "example",          "hsCode": "example_code",          "order": 1,          "isDefault": false,          "price": 1,          "compareAtPrice": 1,          "costPrice": 1,          "currency": "PEN",          "isDigital": false,          "trackInventory": false,          "allowBackorders": false,          "lowStockThreshold": 1,          "weight": 1,          "width": 1,          "height": 1,          "length": 1,          "unitOfMeasure": "kilogram",          "onHand": 1,          "committed": 1,          "available": 1,          "options": [            {              "name": "Example resource",              "key": "example",              "value": "example"            }          ],          "images": [            {              "imageId": "7204558912004325301",              "order": 1,              "isPrimary": false            }          ],          "inventories": [            {              "id": "7204558912004325301",              "locationId": "7204558912004325301",              "onHand": 1,              "committed": 1,              "available": 1,              "incoming": 1,              "unavailable": 1,              "version": 1,              "createdOn": "2026-08-01T15:30:00Z",              "updatedOn": "2026-08-01T15:30:00Z"            }          ],          "status": "outOfStock",          "createdOn": "2026-08-01T15:30:00Z",          "updatedOn": "2026-08-01T15:30:00Z"        }      ],      "views": 1,      "salesCount": 1,      "reviewsCount": 1,      "createdOn": "2026-08-01T15:30:00Z",      "updatedOn": "2026-08-01T15:30:00Z",      "lastActivityOn": "2026-08-01T15:30:00Z"    }  ],  "hasNextPage": false,  "nextCursor": "example",  "totalCount": 1}