ghl_product_store_get_stats
Fetches product store statistics, including total, included, and excluded product counts, for a specific store to support catalog review and filtering analysis.
Instructions
Fetch Product Store Stats API to fetch the total number of products, included in the store, and excluded from the store and other stats Endpoint: GET /products/store/{storeId}/stats (Version header: v3; source: v3/products-v3.json) Requires a Sub-Account (location) token. OAuth scopes: products.readonly
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"storeId": "<storeId>",
"altId": "<altId>",
"altType": "<altType>"
},
"name": "ghl_product_store_get_stats"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| altId | Yes | Location Id or Agency Id | |
| search | No | The name of the product for searching. | |
| altType | Yes | ||
| storeId | Yes | Products related to the store | |
| collectionIds | No | Filter by product collection Ids. Supports comma separated values |