List products
list_productsList a product model's catalog with stock and variant details, paginated and filterable by status, price, search, and stock state. Fetches storefront URLs for each record.
Instructions
List a product model's catalog with stock and variant info (onHand/reserved/available per record and variant). A product is a record of a model whose product capability is enabled (get_model shows product.enabled and the field roles): create one with create_record on that model and change it with update_record; set_product_tiers and the bulk_* product tools work on the same records. Paginated: while hasMore is true, pass nextCursor back as cursor while it is set; if hasMore is true but nextCursor is null, page with the offset instead, and past offset 10000 narrow the filter. Each record carries url: its live storefront link, built by the server from the model's urlPattern and the site's public site URL. Use it whenever you link to a record and never build a storefront URL yourself (not from a slug, not from the site address). When url is null or missing, say why instead of guessing: the model has no urlPattern (set it with update_model), the model is not delivered (deliveryAccess none, or it is the login model), the site has no public site URL, or the record - or one it links to - is unpublished.
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": {
"modelId": "<modelId>"
},
"name": "list_products"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | '<fieldKey>_asc' or '<fieldKey>_desc', e.g. createdAt_desc, price_asc. Built-in keys: createdAt, updatedAt, status; any other key must be a field of the model. Omitted: the model's default sort, else newest first. | |
| limit | No | ||
| cursor | No | nextCursor from the previous page. The page continues after it in the same filter and sort; leave the skip/offset at 0 when you pass it | |
| filter | No | ||
| offset | No | How many rows to skip, at most 10000; page past that with cursor | |
| modelId | Yes | The product model's id or slug (from list_models) |