---
title: "Price a shopping list in every branch of a city — the 5 cheapest branches with coverage"
method: POST
path: "/basket"
---

# Price a shopping list in every branch of a city — the 5 cheapest branches with coverage

`POST /basket`

## Request

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

Items are free-text Hebrew product names (optionally with a quantity: "2 חלב 3%", "במבה x3") or barcodes, up to 40. Each is matched to one product (returned in items[].matched). Branches carrying at least 85% of the matched items are ranked by effective_total; the rest follow by coverage. Each branch has effective_total (= total), shelf_total and club_total. Also limited to 30 baskets/hour per IP.

## Request body

- object
  - `items` string[], required
  - `city` string, required: City in Hebrew or English, or its slug

## Response `200`

Cheapest branches

- object
  - `as_of` string, date, nullable, required: Date of the latest price files in the dataset.
  - `source` string, required
  - `source_en` string
  - `page` string, uri, nullable: The human page that shows the same numbers — link it when quoting (also attribution.link).
  - `price_fields` string: What shelf / effective / club mean.
  - `coverage` object, nullable: What the dataset covers on as_of: chains, stores and barcoded products (the same counts as the site).
    - `chains` integer
    - `stores` integer
    - `products` integer
  - `attribution` Attribution, required
    - `required` boolean
    - `text` string
    - `text_en` string
    - `link` string, uri
    - `rule` string
    - `terms` string, uri
  - `data` Basket, required
    - `city` object
      - `city_slug` string
      - `city_name` string
      - `city_name_en` string, nullable
      - `url` string, uri
    - `method` string
    - `items` object[]
      - `input` string
      - `qty` number
      - `matched` object, nullable
        - `code` string
        - `name` string
        - `median_shelf` number, nullable
        - `min_effective` number, nullable
        - `url` string, uri
    - `matched_items` integer
    - `unmatched` string[]
    - `stores_in_city_with_items` integer
    - `cheapest_stores` object[]
      - `rank` integer
      - `chain_key` string
      - `chain_name` string
      - `store_id` string
      - `store_name` string, nullable
      - `address` string, nullable
      - `total` number: Same as effective_total
      - `effective_total` number: Σ effective price × qty. ILS. 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.
      - `shelf_total` number, nullable: Σ shelf price × qty. ILS. shelf — the regular price the chain publishes for the store, without any promotion.
      - `club_total` number, nullable: Σ (club price where the store has one, else effective) × qty. ILS. club — a promotion limited to the chain's loyalty-club members or card holders. Never folded into effective; shown separately.
      - `found` integer
      - `of` integer
      - `coverage` number
      - `full_coverage_ranked` boolean
      - `missing` string[]
      - `url` string, uri
      - `order_online_url` string, uri, nullable: Opens the chain’s own online store (Stor.ai storefronts) with the list in its cart popup, on this store’s online branch when known; null when the chain has none. The person adds to cart, logs in and pays there.

## Other responses

- `400`: Error
- `401`: API key missing, invalid or revoked. Free sign-up: https://wizbi.store/developers#register
- `404`: Error
- `429`: Limit reached (1000/day or 60/minute per key). See Retry-After.
- `503`: Error

---

[API](https://skmtc.dev/wizbi/apis/wizstore-public-api-israeli-supermarket-price-comparison-in.md) · [All operations](https://skmtc.dev/wizbi/apis/wizstore-public-api-israeli-supermarket-price-comparison-in/llms.txt) · [OpenAPI document](https://skmtc.dev/wizbi/apis/wizstore-public-api-israeli-supermarket-price-comparison-in/revisions/f59f5e5e44a4?raw)