Walmart

Walmart Category API

Browse a Walmart category and get its products as JSON, in exactly the same product shape as Walmart Search - id, title, price, rating, seller, availability, fulfillment and variants - plus the category breadcrumb. Costs 1 credit on domain com or ca, and 2 credits on com.mx: the price is a function of the request body, not a constant for the route.

POST/api/v1/walmart/category

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

category_idstringrequired

Walmart category id. Both forms are accepted: the leaf id on its own, or the full underscore-joined browse path from a /browse/ URL.

Example: 3944_133251_1095191

domainenum<string>default:com

Marketplace to browse. This is the price-bearing parameter: com and ca cost 1 credit, com.mx costs 2. It also sets the currency and the product URLs in the response.

com — walmart.com (US). 1 credit.
ca — walmart.ca (Canada). 1 credit.
com.mx — walmart.com.mx (Mexico). 2 credits.

pageinteger

Results page, 1-based. One page per call. The response reports max_page - page against that; has_more_pages is passed through from Walmart unchanged and comes back null on category pages.

Example: 2

limitinteger

Trim the returned products to at most this many. Applied after the page is fetched, so it makes the response smaller but never reduces the credit cost.

Example: 10

sort_byenum<string>default:best_match

Result sort order.

best_match — Walmart relevance ranking (default).
price_low — Price, low to high.
price_high — Price, high to low.
best_seller — Best selling first.
rating_high — Highest customer rating first.
new — Newest arrivals first.

min_pricenumber

Minimum price filter in the marketplace's own currency. Decimals are accepted.

Example: 19.99

max_pricenumber

Maximum price filter in the marketplace's own currency. Decimals are accepted.

Example: 199.5

fulfillment_speedenum<string>

Delivery-speed filter. There is no 2_days value (Walmart's own facet leaks 3-4 day items into it) and no anytime value - for anytime, omit the parameter.

today — Deliverable today.
tomorrow — Deliverable by tomorrow.

Request

from scavio import ScavioClient

client = ScavioClient(api_key="sk_live_your_key")
results = client.walmart.category("3944_133251_1095191", page=1, sort_by="best_seller")
print(results)

Response

"query": null,

"title": "Results for "Headphones"",

"url": "https://www.walmart.com/browse/3944_133251_1095191",

"page": 1,

"total_results": 82717,

"max_page": 25,

"has_more_pages": null,

"products_count": 20,

"count": 20,

"related_searches": []

"response_time": 5516,

"credits_used": 1,

"credits_remaining": 999

}