Kroger

Kroger Search Suggestions API

The Kroger, QFC or Fred Meyer search-box suggestions for a partial query (2+ characters): suggestions (text, type) and the store they were asked for. Pass store_id for one store; without it, the banner's store nearest a representative ZIP is used (Kroger 45202 Cincinnati, QFC 98101 Seattle, Fred Meyer 97201 Portland). Costs 1 credit per request.

POST/api/v1/kroger/suggestions

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

querystringrequired

What a shopper has typed so far, 2-100 characters.

Example: almond mi

bannerenum<string>

The store banner. Optional with store_id: QFC ids start with 705, Fred Meyer ids with 701, anything else is kroger. A banner that contradicts the id is a 400.

Example: qfc

kroger — Kroger (kroger.com). The default.
qfc — QFC (qfc.com): Washington and Oregon.
fred_meyer — Fred Meyer (fredmeyer.com): the Pacific Northwest and Alaska, grocery plus general merchandise, apparel and home.

store_idstring

A store's 8-digit location_id. Optional: without it the banner's store nearest a representative ZIP is used (Kroger 45202, QFC 98101, Fred Meyer 97201).

Example: 70500847

Request

from scavio import ScavioClient

client = ScavioClient(api_key="sk_live_your_key")

# Expand a seed term, then size each completion with search totals.
s = client.kroger.suggestions("almond mi", banner="qfc")["data"]
for sug in s["suggestions"]:
    total = client.kroger.search(sug["text"], banner="qfc")["data"]["total"]
    print(sug["text"], total)

Response

"query": "almond mi",

"banner": "qfc",

"count": 5,

"response_time": 3232

}

from scavio import ScavioClient client = ScavioClient(api_key="sk_live_your_key") # Expand a seed term, then size each completion with search totals. s = client.kroger.suggestions("almond mi", banner="qfc")["data"] for sug in s["suggestions"]: total = client.kroger.search(sug["text"], banner="qfc")["data"]["total"] print(sug["text"], total)