list_products
Updated May 21, 20261 min read
List products for a merchant with paging, sorting, search, and exact-match product filters. This uses the same middleware product listing surface as the dashboard. Use select with json-mask syntax to trim the returned payload.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
merchant | string | Yes | — |
tenantId | string | Yes | — |
barcode | oneOf | No | — |
page | oneOf | No | — |
page_size | oneOf | No | — |
product_id | oneOf | No | — |
product_ref | oneOf | No | — |
search_mode | string | No | Values: fuzzy, exact. |
search_string | string | No | — |
select | string | No | json-mask expression to filter response fields. |
sku | oneOf | No | — |
sort_by | string | No | Values: barcode, description, hs_code, manufacturer_id, product_ref, sku. |
sort_direction | string | No | Values: asc, desc. |
status | oneOf | No | — |
Example agent prompt
"Show me the recent products."
list_products(
tenantId="…",
merchant="acme"
)