Skip to documentation
Docs
Sign in Get an API key API key
Browse documentation
For AI agents

Connect your agent to live platform data.

Open in
Asda API Capability

Products search

Search Asda Groceries UK products by keyword, with store-aware stock boosting and normalized price, offer, unit price, rating, GTIN, and taxonomy fields.

Capability ID asda.products.search
Maximum runtime 30 seconds
View raw

POST /execute Shared execution endpoint

Input parameters

active_only boolean optional

Return only products ASDA lists as active (STATUS "A"). Default false keeps delisted products (STATUS "I") so listings are complete. Default: `false`.

hits_per_page integer optional

Number of results per page. From 1 to 60. Default: `24`.

Example 5
include_raw boolean optional

Include ASDA's unprocessed Algolia response under `raw` (large: ~150 KB per 60 products). Set false for normalized fields only. Default: `true`.

page integer optional

1-based results page At least 1.

Example 1
query string required

Search query.

Example milk
store_id string optional

Asda store id used for stock boosting and in_stock flags Default: `4565`.

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 example response is shown in the response panel.

Illustrative output fields

Values illustrate one response. Read the guidance above for missing values and limits; fields can vary with the requested operation and the data available.

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 409
page.nb_pages integer 82
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 409
raw.nbPages integer 82
raw.page integer 0
raw.params string attributesToRetrieve=%5B%22STATUS%22%2C%22BRAND%22%2C%22CIN%22%2C%22NAM…
raw.processingTimeMS integer 3
raw.processingTimingsMS object 4 fields
raw.query string milk
raw.renderingContent object 0 fields
raw.serverTimeMS integer 4

Execution behavior

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

Overview, pricing and sample data for every endpoint: Asda API