Whole Foods

Whole Foods Deals API

Every product on sale at one Whole Foods Market store, store-wide or in one category: regular, sale and Prime member price, multi-buy quantities, sale start and end dates, ASIN, brand and image, with total_results and facets. Costs 1 credit per request.

POST/api/v1/wholefoods/deals

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your Scavio API key (e.g. Bearer sk_live_your_key).

Body

application/json

store_idstring

5-digit Whole Foods store id. Prices are that store's in-store (shelf) prices. Defaults to 10145 (Lamar, Austin TX). Find ids with /api/v1/wholefoods/stores.

Example: 10160

categorystring

Category slug, e.g. produce or dairy-eggs. Defaults to all-products (every sale item at the store). Slugs are in the category facet of any search.

Example: produce

sortstring

featured (default), popular, price_asc, price_desc, brand_az or brand_za.

dietstring

Only products with this dietary attribute: vegan, gluten-free, organic, dairy-free or vegetarian.

limitinteger

Products per page, 1-60. Defaults to 60.

Example: 60

offsetinteger

Products to skip, for paging (60 = page 2 at the default limit), 0-10000. Defaults to 0.

Example: 0

Request

from scavio import ScavioClient

client = ScavioClient(api_key="sk_live_your_key")

res = client.whole_foods.deals(store_id="10160")["data"]

print(res["total_results"], "items on sale")
for p in res["products"]:
    print(p["name"], p["regular_price"], "->", p["sale_quantity"], "for", p["sale_price"],
          "Prime:", p["prime_quantity"], "for", p["prime_price"], "until", p["sale_end_date"])

Response

"category": "all-products",

"store_id": "10160",

"sort": "featured",

"on_sale": true,

"diet": null,

"offset": 0,

"limit": 60,

"total_results": 2022,

"count": 60,

"response_time": 1001

}

from scavio import ScavioClient client = ScavioClient(api_key="sk_live_your_key") res = client.whole_foods.deals(store_id="10160")["data"] print(res["total_results"], "items on sale") for p in res["products"]: print(p["name"], p["regular_price"], "->", p["sale_quantity"], "for", p["sale_price"], "Prime:", p["prime_quantity"], "for", p["prime_price"], "until", p["sale_end_date"])