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

POST /execute Shared execution endpoint

Input parameters

count integer optional

Products per page. Defaults to 24.

Example 24
facet string required

Opaque category facet id from tesco.categories.list, e.g. b;RnJlc2glMjBGb29kJTdDRnJlc2glMjBGcnVpdA== (Fresh Fruit).

Example b;RnJlc2glMjBGb29kJTdDRnJlc2glMjBGcnVpdA==
page integer optional

1-based shelf page. Defaults to 1.

Example 1
sort_by string optional

Upstream sort key. Observed values: relevance (default), price-ascending, price-descending.

Example relevance
Available values relevanceprice-ascendingprice-descending

Response

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

Illustrative sample The full redacted fixture is shown in the response panel.

Illustrative output fields

Derived from the sample above for orientation only. These observed fields are not a fixed response schema.

PathObserved typeExample
items array 3 items
items array 3 items
page object 8 fields
page.count integer 24
page.matchType null null
page.offset integer 0
page.pageId null null
page.pageNo integer 1
page.pageSize integer 24
page.query object 3 fields
page.totalCount integer 185
raw object 2 fields
raw.data object 1 fields
raw.status integer 200
total_count integer 185

Execution behavior

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