Skip to documentation
Browse documentation

Category Products List

List one page of a Tesco category shelf for a taxonomy facet id, with prices, promotions, ratings, and GTINs.

Capability ID tesco.category.products.list
Cost 1 credit per request
Maximum runtime 30 seconds
View raw Get an API key

POST /execute Shared execution endpoint

Input parameters

FieldTypeRequiredDescription
count integer Optional Products per page. Defaults to 24.
facet string Required Opaque category facet id from tesco.categories.list, e.g. b;RnJlc2glMjBGb29kJTdDRnJlc2glMjBGcnVpdA== (Fresh Fruit).
page integer Optional 1-based shelf page. Defaults to 1.
sort_by string Optional Upstream sort key. Observed values: relevance (default), price-ascending, price-descending.

Response

Successful output is returned in results[0].data. Raw platform output is intentionally open-ended and may evolve with the upstream source.

No committed sample output is available for this capability yet.

Execution behavior

A 200 response completed inline. A 202 response was queued; poll GET /jobs/:id until the job reaches completed or failed.

Resources