Walmart via Scavio
Search Walmart, read a product in full, page its customer reviews, list a category, look up the buy-box offer on an item, read a marketplace seller's storefront and catalog, and find Walmart stores near a ZIP or postal code so search and product results can be targeted at one store. All endpoints return structured JSON.
When to trigger
Use this skill when the user asks to:
- Search Walmart for products by keyword, price band or sort order
- Look up a Walmart item by its item id (usItemId)
- Read customer reviews and the rating breakdown for a Walmart product
- List the products inside a Walmart category
- Check who holds the buy box on a Walmart listing and at what price
- Look up a Walmart marketplace seller: rating, review count, Pro Seller badge
- See what a Walmart marketplace seller lists
- Compare Walmart pricing against another retailer (pair with scavio-amazon, scavio-ebay or scavio-target)
- Search the Canadian (walmart.ca) or Mexican (walmart.com.mx) marketplace
- Find the Walmart stores near a US ZIP or Canadian postal code
- See what a specific Walmart store carries, or a product's availability at that store (walmart.com and walmart.ca)
Setup
Get a free API key at scavio.dev (50 free credits to get started, no card required):
export SCAVIO_API_KEY=sk_live_your_key
If you do not have a key yet
An agent running this skill without SCAVIO_API_KEY set will get 401 on every
call below. The whole path from nothing to a working key is self-serve:
- Sign up at dashboard.scavio.dev - email or Google, no card required.
- A key is created for the account automatically at signup. It is on the dashboard under API Keys, ready to copy.
- A new account starts with 50 credits. Endpoints in this skill cost 1 credit each unless the table below says otherwise.
When the balance runs out the API answers 402 with a JSON body carrying
billing_url. Topping up needs no code change - the same key keeps working.
The smallest purchase is 2,500 credits for $25, and monthly plans work out
cheaper per credit if the usage is steady rather than one-off.
Every request is a POST with a JSON body and:
Authorization: Bearer $SCAVIO_API_KEY
Endpoints
Base URL: https://api.scavio.dev.
| Endpoint | Credits | Description |
|---|---|---|
POST /api/v1/walmart/search |
1, or 2 when domain is com.mx or the request targets a store |
Keyword search: products[], products_count, location |
POST /api/v1/walmart/product |
1, or 2 when the request targets a store | Full product detail by item id |
POST /api/v1/walmart/reviews |
1 | Customer reviews plus the rating breakdown |
POST /api/v1/walmart/category |
1, or 2 when domain is com.mx |
Products in a category, same shape as search |
POST /api/v1/walmart/offers |
1 | The buy-box seller for an item |
POST /api/v1/walmart/seller |
1 | Marketplace seller storefront |
POST /api/v1/walmart/seller-products |
1 | A seller's catalog (path is hyphenated) |
POST /api/v1/walmart/stores |
1 | Stores near a US ZIP or Canadian postal code, nearest first, with store_id |
Cost rule
Cost is a function of the request body, not a constant. Two things change it:
domain: "com"(US, the default) costs 1 creditdomain: "ca"(Canada) costs 1 creditdomain: "com.mx"(Mexico) costs 2 credits, on/searchand/category- A store-targeted request (
store_id+delivery_zip) on/searchor/productcosts 2 credits, on walmart.com or walmart.ca
So /search can cost 2 through either rule, /category only through com.mx, and /product only through store targeting. /reviews, /offers, /seller, /seller-products and /stores are always 1 credit. Never quote a flat price for search, category or product without stating the rule.
Workflow
- Find items: call
/walmart/searchwithquery. The item id isidon each row ofdata.products[]— that is the value the other endpoints take asproduct_id. - Read an item: call
/walmart/productwithproduct_id. - Reviews: call
/walmart/reviewswith the sameproduct_id, paging withpage(10 reviews per page). - Browse a category: call
/walmart/categorywithcategory_id. - Buy box: call
/walmart/offerswithproduct_idto see who currently wins the buy box and at what price. - Sellers: a product, search or offers response carries
seller_catalog_id. Pass that numeric id asseller_idto/walmart/sellerfor the storefront and to/walmart/seller-productsfor the catalog. - Target a store: call
/walmart/storeswithzipcode(add"domain": "ca"for a Canadian postal code). Pick astore_idfromdata.stores[], then send it withdelivery_zip(and the samedomain) to/walmart/searchor/walmart/product. The results reflect that store's assortment and availability, anddata.locationconfirms the store that was used. Store-targeted calls take 10-60 seconds.
search, reviews and category paginate with page (1-based). product, offers, seller, seller-products and stores do not paginate at all — there is no page or cursor parameter on them.
Parameters
Search (/search)
| Parameter | Type | Default | Description |
|---|---|---|---|
query |
string | required | Search query (1-500 chars) |
page |
integer >= 1 | -- | Results page, 1-based |
start_page |
integer >= 1 | -- | Deprecated alias for page. Prefer page |
sort_by |
string | best_match |
best_match, price_low, price_high, best_seller, rating_high, new |
min_price |
number | -- | Minimum price filter |
max_price |
number | -- | Maximum price filter |
fulfillment_speed |
string | -- | today or tomorrow only |
fulfillment_type |
string | -- | in_store for in-store pickup |
domain |
string | com |
com (1 credit), ca (1 credit), com.mx (2 credits) |
delivery_zip |
string | -- | Shopper's 5-digit US ZIP, or Canadian postal code with domain: "ca". Send together with store_id |
store_id |
string | -- | Store from /walmart/stores on the same domain. Send together with delivery_zip. 2 credits; com and ca only |
Product (/product)
| Parameter | Type | Default | Description |
|---|---|---|---|
product_id |
string | required | Walmart item id (usItemId), e.g. 13544111159 |
delivery_zip |
string | -- | Same as on search. Send together with store_id |
store_id |
string | -- | Same as on search. 2 credits |
domain |
string | com |
ca is accepted only together with store_id + delivery_zip |
Reviews (/reviews)
| Parameter | Type | Default | Description |
|---|---|---|---|
product_id |
string | required | Walmart item id (usItemId) |
page |
integer >= 1 | -- | Reviews page, 1-based. 10 reviews per page |
sort |
string | -- | relevancy, submission-desc, submission-asc, rating-desc, rating-asc, helpful-desc |
Category (/category)
| Parameter | Type | Default | Description |
|---|---|---|---|
category_id |
string | required | Leaf id (1095191) or full underscore path (3944_133251_1095191) |
limit |
integer >= 1 | -- | Trims the returned products. Applied after fetching, so it does NOT reduce cost |
page |
integer >= 1 | -- | Results page, 1-based |
sort_by |
string | best_match |
Same six values as search |
min_price |
number | -- | Minimum price filter |
max_price |
number | -- | Maximum price filter |
fulfillment_speed |
string | -- | today or tomorrow only |
domain |
string | com |
com (1 credit), ca (1 credit), com.mx (2 credits) |
Offers (/offers)
| Parameter | Type | Default | Description |
|---|---|---|---|
product_id |
string | required | Walmart item id (usItemId), e.g. 2979510112 |
Seller (/seller) and seller products (/seller-products)
| Parameter | Type | Default | Description |
|---|---|---|---|
seller_id |
string | required | NUMERIC catalog seller id, as returned in seller_catalog_id. Example 101480084 |
Stores (/stores)
| Parameter | Type | Default | Description |
|---|---|---|---|
zipcode |
string | required | 5-digit US ZIP (50036), or a Canadian postal code (M5V 2T6, with or without the space) with domain: "ca" |
domain |
string | com |
com (walmart.com) or ca (walmart.ca) |
Examples
import requests
BASE = "https://api.scavio.dev"
# Your key from https://scavio.dev. Load it from your environment or secret
# store in real code - keep it out of source control.
API_KEY = "sk_your_key_here"
HEADERS = {"Authorization": f"Bearer {API_KEY}"}
# 1. Search (1 credit on the default com domain)
results = requests.post(f"{BASE}/api/v1/walmart/search", headers=HEADERS,
json={"query": "wireless headphones", "sort_by": "price_low", "max_price": 100}).json()
product_id = results["data"]["products"][0]["id"] # search rows carry `id`, not `product_id`
# 2. Full product detail
product = requests.post(f"{BASE}/api/v1/walmart/product", headers=HEADERS,
json={"product_id": product_id}).json()
# 3. Reviews, page 2 (10 per page)
reviews = requests.post(f"{BASE}/api/v1/walmart/reviews", headers=HEADERS,
json={"product_id": product_id, "page": 2, "sort": "rating-desc"}).json()
# 4. Buy box for an item
offers = requests.post(f"{BASE}/api/v1/walmart/offers", headers=HEADERS,
json={"product_id": "2979510112"}).json()
# 5. Seller storefront, then their catalog (numeric seller_catalog_id)
seller = requests.post(f"{BASE}/api/v1/walmart/seller", headers=HEADERS,
json={"seller_id": "101480084"}).json()
catalog = requests.post(f"{BASE}/api/v1/walmart/seller-products", headers=HEADERS,
json={"seller_id": "101480084"}).json()
# 6. Mexican marketplace search: this call costs 2 credits, not 1
mx = requests.post(f"{BASE}/api/v1/walmart/search", headers=HEADERS,
json={"query": "audifonos", "domain": "com.mx"}).json()
# 7. Stores near a ZIP, then one store's search results (2 credits, 10-60s)
stores = requests.post(f"{BASE}/api/v1/walmart/stores", headers=HEADERS,
json={"zipcode": "50036"}).json()
store_id = stores["data"]["stores"][0]["store_id"] # nearest first, e.g. "1389"
local = requests.post(f"{BASE}/api/v1/walmart/search", headers=HEADERS, timeout=120,
json={"query": "whole milk", "delivery_zip": "50036", "store_id": store_id}).json()
print(local["data"]["location"]) # the store the results were served against
# 8. Same on walmart.ca: postal code + domain "ca" on both calls
ca_stores = requests.post(f"{BASE}/api/v1/walmart/stores", headers=HEADERS,
json={"zipcode": "M5V 2T6", "domain": "ca"}).json()
Response
Every response uses the envelope { data, response_time, credits_used, credits_remaining }, plus an optional warnings[] array of strings when part of the request was ignored (a retired parameter, zipcode sent to search or product, or store parameters sent to an endpoint that does not take them).
- search puts the rows in
data.products[]withdata.products_count, and reports the Walmart store the results were served against indata.location. category returns the same product shape as search. - product returns price, rating, images, specifications, availability and seller.
- reviews returns the review bodies with ratings, text, author and date, plus the rating breakdown.
- offers returns price, seller, condition and the buy-box flag.
- seller returns store name, rating, review count, Pro Seller badge and business details.
- seller-products returns the seller's catalog with
total_count. - stores returns
data.stores[]nearest first:store_id,name,type,distance_miles,address,latitude,longitude,open_24_hours,hoursandpickup_types, pluszipcode,domainandcount.
Read credits_used on the response rather than assuming a cost, since search, category and product are body-priced.
Changed in 3.1.0
- New
/walmart/storesendpoint: stores near a US ZIP or Canadian postal code. delivery_zipandstore_idwork again on/searchand/product, sent together, on walmart.com and walmart.ca. They target one store's assortment and availability and cost 2 credits./productacceptsdomain: "ca"with them.deviceis now the only retired parameter.
Changed in 3.0.0
If you have an older version of this skill installed, stop sending these. The API answers device with a warnings[] entry rather than an error, which means a request that looks successful was silently unfiltered:
deviceis gone. Desktop, mobile and tablet return identical page data, so the response would not change.fulfillment_speed: "2_days"is gone. It leaked items 3-4 days out.fulfillment_speed: "anytime"is gone. It was a no-op. To mean "anytime", omit the parameter entirely.
domain is NOT retired. It is live, it can change the price, and it is the only way to reach walmart.ca and walmart.com.mx.
New since 2.x: /reviews, /category, /offers, /seller and /seller-products. sort_by gained rating_high and new. search and product both changed response shape.
Guardrails
- Never fabricate product names, prices, item ids, ratings or availability. Only return data the API returned.
/offersreturns the BUY-BOX SELLER ONLY. It is not the full offer list, and must never be described as one. If the user wants every seller on an item, say that this API cannot enumerate them./seller-productsreturns roughly the first 40 items, server-rendered. There is no pagination on it.total_countreports the seller's real catalog size, so the two numbers will disagree and that is expected. Do not invent apageparameter.seller_idmust be the NUMERIC catalog seller id fromseller_catalog_id. The GUID form ofseller_idreturns 404.domainis accepted on/search,/categoryand/stores, and on/productonly as"ca"together with a store target. The other id-keyed endpoints are US-only.delivery_zipandstore_idmust be sent together, and only on/searchand/product. One alone is a400. Getstore_idfrom/walmart/storeson the same domain; astore_idthat does not exist is a400. Store targeting works on walmart.com and walmart.ca, not walmart.com.mx.store_iddecides the store. Always readdata.locationto confirm which store the results came from, and tell the user.- A store-targeted product can return
404when that store does not carry the item, even if it exists elsewhere. Say so rather than retrying. - Store-targeted calls take 10-60 seconds. Use a client timeout of at least 120 seconds.
limiton/categorytrims the response after fetching. It does not reduce the credit cost.category_idaccepts either the leaf id or the full underscore-joined path.sort_by,fulfillment_speed,fulfillment_typeanddomainare closed enums - a value outside them is a400. Send only the values listed above; in particularfulfillment_speedno longer accepts2_daysoranytime, and to mean "anytime" you omit the parameter.- Always include the product URL so the user can verify and complete the purchase.
Failure handling
400means an invalid or missing parameter. Fix and retry. On a store-targeted call it can also meanstore_idis not a real store, or only one ofdelivery_zip/store_idwas sent.401means the API key is invalid or missing. CheckSCAVIO_API_KEY.404on/selleror/seller-productsalmost always means a GUID was sent instead of the numericseller_catalog_id. On a store-targeted/productit means the store does not carry the item.429means a rate or usage limit was exceeded. Wait before retrying. See rate limits.502/503mean the upstream is temporarily unavailable. Transient 502s happen on Walmart; wait a few seconds and retry once before reporting failure.- If a response carries
warnings[], surface it to the user. It means part of their request was ignored. - If search returns nothing, relax the filters (drop
fulfillment_speed, widenmin_price/max_price) and retry. - If
SCAVIO_API_KEYis not set, prompt the user to export it before continuing.
