Skip to content
Guides
API reference
stablecatalog: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<any>
search?string

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

status?array<>
excludeStatus?array<>
includeArchived?boolean
categoryIds?array<any>
excludeCategoryIds?array<any>
brandIds?array<any>
excludeBrandIds?array<any>
storeIds?array<any>
sellerIds?array<any>
excludeSellerIds?array<any>
skuIds?array<any>
skus?array<string>
types?array<>
excludeTypes?array<>
isFeatured?boolean
ean?string
minPrice?number
Formatdouble
maxPrice?number
Formatdouble
minOnHand?integer
Formatint32
maxOnHand?integer
Formatint32
minAvailable?integer
Formatint32
tags?array<string>
excludeTags?array<string>
limit?string

Maximum number of results to return.

savedViewId?null|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/catalog/products/count"
{  "total": 0,  "precision": "exact",  "limit": null}