A shopping list compared across chains (no city): shelf / effective / club totals per chain

shelf_total = sum of each chain's median shelf price; effective_total = its lowest price after promotions open to everyone; club_total = the same including club-only promotions. effective/club take each item's lowest price in any of the chain's branches (a best case); the ranking is by shelf_total — use /basket for real branches in one city. POST {"items": [...]} also works.

get/basket/chains

Request

  • Base URL: https://wizbi.store/api/v1
  • URL: https://wizbi.store/api/v1/basket/chains
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer
    • API key in query parameter key

Query parameters

itemsstring required

Items separated by "|", up to 40.

Response

Totals per chain

as_ofstring date nullable required

Date of the latest price files in the dataset.

sourcestring required
source_enstring
pagestring uri nullable

The human page that shows the same numbers — link it when quoting (also attribution.link).

price_fieldsstring

What shelf / effective / club mean.

Example response

{
  "source": "WizStore (wizbi.store) — על בסיס קובצי המחירים והמבצעים שרשתות השיווק מחויבות לפרסם לפי חוק קידום התחרות בענף המזון",
  "source_en": "WizStore (wizbi.store) — based on the price and promotion files Israeli retail chains are required to publish under the Promotion of Competition in the Food Sector Law, 2014",
  "price_fields": "Prices are in ILS. shelf — the regular price the chain publishes for the store, without any promotion. effective — the lower of the shelf price and a promotion open to every shopper, per unit (\"3 for 30\" = 10 per unit). This is the price the site compares by default. club — a promotion limited to the chain's loyalty-club members or card holders. Never folded into effective; shown separately. Field names: *_shelf = shelf, *_effective = effective, *club* = club. Prices are as published by the chains; the price at the register may differ."
}

Changes

No recorded changes to this operation across all 1 revision of this API.