get_product

Updated May 21, 20261 min read

Get a single product by product ID or product reference. Use query_by=ref to fetch by product_ref; otherwise it fetches by product ID. Use select with json-mask syntax to return only required fields.

Parameters

NameTypeRequiredDescription
merchantstringYes
tenantIdstringYes
valuestringYesProduct ID or product_ref value.
query_bystringNoValues: id, ref.
selectstringNojson-mask expression to filter response fields.

Example agent prompt

"Look up the product for me."

get_product(
  tenantId="…",
  merchant="acme",
  value="PROD-1234"
)