Skip to content
docs
Guides
ES
CatalogProducts
catalog:read

Count products for agent tools

GET/v1/agent-read/catalog/products/count

Count products for agent tools. A successful request returns HTTP 200 with the documented response body.

Authorization

bearerAuth
AuthorizationBearer <token>

OAuth2 access token issued by Ecomiq Auth.

In: header

Query Parameters

search?string

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

brand?string
category?string
status?string

Only items in these statuses.

Value in

  • "draft"
  • "active"
  • "inactive"
  • "outOfStock"
  • "discontinued"
  • "archived"
includeArchived?boolean

Include archived items.

sourceIds?array<string>

Only items imported from these sources.

limit?integer

Maximum number of results to return.

Formatint32

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/agent-read/catalog/products/count" \  -H "x-Store-Id: <store-id>" \  -H "Authorization: Bearer <token>"
{  "total": 1,  "precision": "exact",  "limit": 1,  "matched": {    "kind": "example",    "name": "Example resource",    "from": "example"  },  "note": "Example note."}