Skip to documentation
Browse documentation

Promotions list

List current Asda rollbacks, price drops, and multi-buy offers, with each multi-buy's ID, name, UTC dates, and quantity deal parsed where the name states one.

Capability ID asda.promotions.list
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 10
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. Default: `1`.

Example 1
promotion_type string optional

Promotion class to return Allowed values: `all`, `rollback`, `price_drop`, `multibuy`. Default: `all`.

Example all
Available values allrollbackprice_dropmultibuy
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.hits_per_page integer 10
page.nb_hits integer 12454
page.nb_pages integer 1246
page.page integer 1
page.source_counts object 3 fields
raw object 2 fields
raw.count_queries object 3 fields
raw.result_queries object 1 fields

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