What a basket cost on an earlier date
price_basket_over_timeRead-onlyIdempotent
How the cost of the same basket changed between two dates, at the store it was bought from: each product's price on both dates, whether it was on promotion, the basket total on each date, and the products that moved it. BasketWatch has recorded every product's price every night since May 2026. Up to 100 lines per call; each line takes name, sku (the retailer's printed item number, with the line's words in name), barcode, store and quantity.
change_pct is the change in what the basket cost (promotions included);
shelf_change_pct is regular prices only, so the gap between the two is
promotions starting or ending, not price rises. biggest_rises and
biggest_falls list the lines that moved most; pack_changed marks a product
whose pack size changed, confirmed over three days of records (a smaller
pack at the same price is a hidden rise). Lines in not_compared were not
found, or not sold on one of the dates.
Each product compared costs one credit.
Args:
items: e.g. [{"sku": "100858349", "quantity": 2}, {"name": "brennans wholemeal bread"}].
from_date: the earlier date, YYYY-MM-DD, e.g. "2026-08-06".
to_date: the later date, YYYY-MM-DD; defaults to today.
store: the receipt's supermarket (aldi, tesco, supervalu or dunnes).
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| items | Yes | ||
| store | No | ||
| to_date | No | ||
| from_date | Yes |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | No | ||
| items | No | ||
| change | No | total_now minus total_then, euro | |
| to_date | No | ||
| from_date | No | ||
| total_now | No | ||
| change_pct | No | ||
| total_then | No | ||
| not_compared | No | Lines not found, or not sold on one date | |
| biggest_falls | No | ||
| biggest_rises | No | ||
| items_unchanged | No | ||
| shelf_total_now | No | ||
| shelf_change_pct | No | Change in regular prices only: real price moves, without promotions | |
| shelf_total_then | No |