Skip to content
Guides
CatalogProducts
catalog:read

Count products

Returns how many products match a filter, without returning them. Cheaper than paging through a listing when you only need the number.

GET/v1/catalog/products/count

Returns how many products match a filter, without returning them. Cheaper than paging through a listing when you only need the number.

Authorization

bearerAuth
AuthorizationBearer <token>

OAuth2 access token issued by Ecomiq Auth.

In: header

Query Parameters

productIds?array<ResourceId>

Only these products.

sourceIds?array<ResourceId>

Only items imported from these sources.

search?string

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

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.

limit?integer

Maximum number of results to return.

Formatint32
exact?boolean
savedViewId?string

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/count" \  -H "x-Store-Id: <store-id>" \  -H "Authorization: Bearer <token>"
{  "total": 1,  "precision": "exact",  "limit": 1}