List Products
sirv_list_productsSearch and list Studio catalogue products by name, SKU, status, source, or ranked query to find product IDs; optionally include linked assets and counts.
Instructions
List or search the products in the Studio catalogue (PIM). Three modes:
Default: list products, filtered by
search(name or SKU),statusandexternalSource, and sorted bysortBy.With
q: ranked search over product names, SKUs and other product text, best match first. Onlylimitandoffsetapply.With
includeAssets: list products with their linked assets and asset counts, filtered bysearchandhideEmpty.sortBycan be assetCount.
Use it to find a product id. For one product's full details, use sirv_get_product.
Read-only. Returns product ids, names, SKUs and status, and the total with the offset for the next page.
Credits: free.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "sirv_list_products"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Words to search for. Switches to ranked search over names, SKUs and other product text. Only limit and offset work with it | |
| limit | No | Products per page, 1 to 100. Default: 20 | |
| orgId | No | Workspace id from sirv_list_organizations. Default: the workspace you signed in to | |
| offset | No | Number of products to skip, for the next page. Default: 0 | |
| search | No | Show products whose name or SKU contains this text. Not with q | |
| sortBy | No | Sort field. Default: createdAt, or name with includeAssets. sku and updatedAt work only without includeAssets; assetCount only with it | |
| status | No | Default mode only: show products with this status | |
| hideEmpty | No | With includeAssets only: true hides products with no linked assets. Default: true | |
| sortOrder | No | Sort direction. Default: desc, or asc with includeAssets | |
| includeAssets | No | true: list products with their linked assets and asset counts. Default: false | |
| externalSource | No | Default mode only: show products from this source |