Skip to documentation
Browse documentation

Category Products List

List paginated products from an exact Asda category, department, or aisle returned by the category taxonomy capability.

Capability ID asda.category.products.list
Cost 1 credit per request
Maximum runtime 30 seconds
View raw

POST /execute Shared execution endpoint

Input parameters

aisle string optional

Optional exact aisle name; department is required when aisle is set

Example Fresh Milk
category string required

Exact top-level category name returned by asda.categories.list

Example Chilled Food
department string optional

Optional exact department name within the category

Example Milk, Butter, Cream & Eggs
hits_per_page integer optional

No additional description is provided for this parameter.

Example 5
page integer optional

1-based results page

Example 1
store_id string optional

Asda store id used for stock boosting and in_stock flags

Example 4565

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 5 fields
page.algolia_page integer 0
page.hits_per_page integer 5
page.nb_hits integer 115
page.nb_pages integer 23
page.page integer 1
raw object 15 fields
raw.exhaustive object 2 fields
raw.exhaustiveNbHits boolean true
raw.exhaustiveTypo boolean true
raw.extensions object 1 fields
raw.hits array 3 items
raw.hitsPerPage integer 5
raw.nbHits integer 115
raw.nbPages integer 23
raw.page integer 0
raw.params string attributesToRetrieve=%5B%22STATUS%22%2C%22BRAND%22%2C%22CIN%22%2C%22NAM…
raw.processingTimeMS integer 17
raw.processingTimingsMS object 4 fields
raw.query string
raw.renderingContent object 0 fields
raw.serverTimeMS integer 18

Execution behavior

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