Core APIs
...
Parameters
Core Requests

Product

3min

Product Parameters

GET /request

The Product Parameters are applicable when making a request with type=product to retrieve details of a single product on Walmart - the product is specified using either the item_id parameter or the url parameter (where the url parameter contains a link to a Walmart product page). The parameters should be appended as querystring parameters to the Walmart Product Data API GET HTTP request.

Product details are retrieved from the product page for a single product on Walmart.

Product Page
Product Page


For example, to request details a product with item_id=782866746 in the zipcode 77001 on walmart.com the request would be:

HTTP
Curl
Node.js
Python
PHP



Product Parameters

The following parameters are available for all requests made when type=product .

Parameter

Required

Description

item_id

optional

The Walmart Item ID to retrieve product details for.

gtin

optional

The GTIN/ISBN/UPC code to look up a matching product on Walmart for. If the gtin parameter is supplied then the item_id parameter is ignored. GTIN-based requests work by looking up the GTIN/ISBN/UPC on Walmart first, then retrieving the product details for the first matching item_id .

url

optional

The Walmart product-page URL to retrieve product details from.

Note : If the url parameter is supplied then the item_id and gtin parameters are ignored (the url overrides other parameters).

include_html

optional

Determines whether raw HTML is included in the response (this can increase the size of the response). Can be set to true or false (the default).

Note When adding requests with include_html=true to a Collection the maximum number of requests is lower (100) because including the HTML within the response makes the Collection Result Sets much larger. The limit is in place to ensure Result Set files are of a manageable size. If you have need to run a large number of requests all with include_html=true then simply split the requests across multiple 100-request Collections.



Next Steps      Product Results

Updated 08 Aug 2024
Did this page help you?