Walmart

Walmart.com search results priced and stocked for a chosen store or zip code, and product catalog records by item id.

Call these actions with your String API key; see Authentication. Every call answers with the envelope described in Responses & errors, whose data holds the rows below.

Site: walmart
Version: 1.0.0
Reads from: walmart.com

Action	Description	Listed price
`search`	Search walmart.com by keyword or category, 40 results a page, with each result's price, stock status and fulfillment at one store: chosen by store number, or the nearest to a zip code. Also returns rating, reviews, seller, category, image and whether the placement is sponsored.	Billed per request at your plan's rates
`products`	Read walmart.com product records by item id or URL: name, brand, description, images, rating, review count and order limit, 40 items per request. With a store number or zip code, each item's price, stock status and fulfillment at that store too, at one more request per item.	Billed per request at your plan's rates

`search`

Search walmart.com by keyword or category, 40 results a page, with each result's price, stock status and fulfillment at one store: chosen by store number, or the nearest to a zip code. Also returns rating, reviews, seller, category, image and whether the placement is sponsored.

POST https://request.usestring.ai/v1/integrations/walmart/search

Input

Unknown fields are rejected.

Field	Type	Description
`query`	string	Search terms, as typed in walmart.com's search box. One of query or categoryId is required.
`categoryId`	string	A walmart.com category id, such as 976759_976794_4879140 from a /browse/ URL.
`storeId`	string	The Walmart store number to price and stock results for. One of storeId or zipcode is required. Matches `^\d{1,6}$`.
`zipcode`	string	A US zip code; results are priced and stocked for the nearest Walmart store, which each row names. Matches `^\d{5}$`.
`sort`	`best_match` `price_low` `price_high` `rating_high` `new`	best_match (the default), price_low, price_high, rating_high or new.
`pages`	integer	How many pages of 40 results to read, from 1 to 25. From 1 to 25.

Output

data is an array of rows, one per result. Each row has:

Field	Type	Description
`itemId`	string	—
`url`	string \| null	—
`name`	string \| null	—
`brand`	string \| null	Often null in search results, for grocery especially; the products action names it.
`gtin`	string \| null	The GTIN, when Walmart sends one, which it often does not.
`price`	number \| null	The selling price at the store, in USD.
`wasPrice`	number \| null	—
`unitPrice`	string \| null	The price per unit as Walmart shows it, such as $46.26/lb.
`rating`	number \| null	—
`reviewCount`	integer \| null	—
`availability`	string \| null	Walmart's stock status at the store, such as IN_STOCK or OUT_OF_STOCK.
`fulfillment`	string[]	How the store offers the item, such as PICKUP or DELIVERY.
`sellerName`	string \| null	—
`category`	string \| null	The category path, such as Home Page/Food/Coffee/Ground Coffee.
`imageUrl`	string \| null	—
`isSponsored`	boolean	—
`storeId`	string	The requested store; warnings report pages whose fulfillment does not confirm it.
`storeName`	string \| null	The store's name, when a zip code was resolved to it.
`page`	integer	—
`position`	integer	The result's position across the pages read, from 1.

Example

curl https://request.usestring.ai/v1/integrations/walmart/search \
  -H "Authorization: Bearer $STRING_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "milk",
    "storeId": "3520"
  }'

data starts with these rows:

[
  {
    "itemId": "10450114",
    "url": "https://www.walmart.com/ip/Great-Value-Whole-Vitamin-D-Milk-Gallon-Plastic-Jug-128-Fl-Oz/10450114",
    "name": "Great Value Whole Vitamin D Milk, Gallon",
    "brand": null,
    "gtin": null,
    "price": 4.25,
    "wasPrice": null,
    "unitPrice": "$1.06/qt",
    "rating": 4.6,
    "reviewCount": 413860,
    "availability": "IN_STOCK",
    "fulfillment": ["DELIVERY", "PICKUP"],
    "sellerName": "Walmart.com",
    "category": "Home Page/Food/Dairy & Eggs/Milk/Dairy Milk/Whole Milk",
    "imageUrl": "https://i5.walmartimages.com/seo/Great-Value-Whole-Vitamin-D-Milk-Gallon-Plastic-Jug-128-Fl-Oz_6a7b09b4-f51d-4bea-a01c-85767f1b481a.86876244397d83ce6cdedb030abe6e4a.jpeg",
    "isSponsored": false,
    "storeId": "3520",
    "storeName": null,
    "page": 1,
    "position": 1
  },
  {
    "itemId": "10450118",
    "url": "https://www.walmart.com/ip/Great-Value-Milk-Whole-Vitamin-D-Half-Gallon-Plastic-Jug-64oz/10450118",
    "name": "Great Value Milk Whole Vitamin D, Half Gallon, 64 fl oz",
    "brand": null,
    "gtin": null,
    "price": 2.57,
    "wasPrice": null,
    "unitPrice": "$1.29/qt",
    "rating": 4.6,
    "reviewCount": 124423,
    "availability": "IN_STOCK",
    "fulfillment": ["DELIVERY", "PICKUP"],
    "sellerName": "Walmart.com",
    "category": "Home Page/Food/Dairy & Eggs/Milk/Dairy Milk/Whole Milk",
    "imageUrl": "https://i5.walmartimages.com/seo/Great-Value-Milk-Whole-Vitamin-D-Half-Gallon-Plastic-Jug-64oz_52ec45c4-586d-42c0-a42c-93218631e277.ec8d19bdf634f97445cbf455eac874a8.jpeg",
    "isSponsored": false,
    "storeId": "3520",
    "storeName": null,
    "page": 1,
    "position": 2
  }
]

Requests and billing

Requests: 1–3 Web Access requests per result page, plus up to 1 setup request per call.
Billing: passthrough. Each request the action makes bills at its own rate on your plan; there is no separate charge for the action. See Pricing.

`products`

Read walmart.com product records by item id or URL: name, brand, description, images, rating, review count and order limit, 40 items per request. With a store number or zip code, each item's price, stock status and fulfillment at that store too, at one more request per item.

POST https://request.usestring.ai/v1/integrations/walmart/products