Price a shopping list or receipt
price_basketPrice a whole shopping list, or every line of a grocery receipt (up to 100 lines in one call), at Aldi, Tesco, SuperValu, Dunnes Stores and Lidl: each item matched to the same product at every store, the cheapest store for each item, each store's basket total, and a cheaper product of the same kind (often own-label) where one exists.
Each line takes name (plain words with brand and size, e.g. "avonmore fresh milk 2l"; receipt abbreviations such as "AVNMR FRSH MLK 2L" match poorly) and optionally sku (the retailer's item number as printed on its receipts; the name is used when the number is not found), barcode, store, quantity, and paid (the line total, which gives the saving against what was paid). Irish product names say "low fat milk" for what the UK calls "semi skimmed". Bags, deposits, discounts and totals are not products.
Returns, per line, the match and matched_by (sku, barcode or name), the cheapest store and price, a cheaper alternative with its pack size and, for a receipt, price_at_store_bought; then each store's total with its items_missing, cheapest_complete_store, mix_and_match_total and not_found. A store's total covers only the lines found in its online range, so a total with items_missing is a smaller basket, not a cheaper shop. Prices are each retailer's online shelf price from the overnight collection; in-store prices can differ. Member prices (Tesco Clubcard, SuperValu Real Rewards, Lidl Plus) are reported separately. Each matched item costs one credit; items not found are free.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"items": "<items>"
},
"name": "price_basket"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| items | Yes | The lines, up to 100, e.g. [{'name': 'avonmore fresh milk 2l', 'quantity': 2}, {'name': 'brennans wholemeal bread'}]; for a receipt add sku and paid: {'sku': '100685955', 'name': 'dunnes baked beans', 'quantity': 2, 'paid': 1.30}. | |
| store | No | The shop the receipt is from (aldi, tesco, supervalu, dunnes or lidl), used for any line that names none. Leave it out for a shopping list. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | No | ||
| as_of | No | Price date, YYYY-MM-DD | |
| items | No | ||
| credits | No | What this answer cost the person's BasketWatch account and what is left. Missing on a free answer | |
| not_found | No | Items with no match | |
| paid_total | No | ||
| different_pack | No | Items priced at another pack size than the one asked for, so not like for like | |
| saving_vs_paid | No | ||
| lidl_plus_total | No | Lidl total using Lidl Plus prices where Lidl has one | |
| totals_by_store | No | ||
| mix_and_match_total | No | Each item bought at its cheapest store | |
| tesco_clubcard_total | No | Tesco total using Clubcard prices where Tesco has one | |
| cheapest_complete_store | No | The cheapest store among those with every matched item found in its online range today | |
| with_alternatives_total | No | As mix_and_match_total, taking each cheaper alternative where there is one | |
| supervalu_real_rewards_total | No | SuperValu total using Real Rewards prices where SuperValu has one |