Item Response Groups

Response groups are used by the API to control the set of fields returned for an item depending on the specific use-case. 

Full Response

Full Response contains a large number of attributes that describe an item. This response group is used for Product Lookup API and Data Feed API. The fields returned are as below.

itemId A positive integer that uniquely identifies an item
parentItemId Item Id of the base version for this item. This is present only if item is a variant of the base version, such as a different color or size.
name Standard name of the item
msrp Manufacturer suggested retail price
salePrice Selling price for the item in USD
upc Unique Product Code
categoryPath Breadcrumb for the item. This string describes the category level hierarchy that the item falls under.
categoryNode Category id for the category of this item. This value can be passed to APIs to pull this item's category level information.
shortDescription Short description for the item. Contains escaped html formatting tags.
longDescription Long description for the item. Contains escaped html formatting tags.
brandName Item's brand
thumbnailImage Small size image for the item in jpeg format with dimensions 100 x 100 pixels
mediumImage Medium size image for the item in jpeg format with dimensions 180 x 180 pixels
largeImage Large size image for the item in jpeg format with dimensions 450 x 450 pixels
productTrackingUrl Deep linked URL that directly links to the product page of this item on walmart.com, and uniquely identifies the affiliate sending this request via a impact radius tracking id |PUBID|. The PUBID parameter needs to be replaced with your impact radius tracking id, and is used by us to correctly attribute the sales from your channel on walmart.com. Actual commission numbers will be made available through your impact radius account.
ninetySevenCentShipping Whether the item qualifies for 97 cent shipping.
standardShipRate Shipping rate for this item for standard shipping (3 to 5 business days)
twoThreeDayShippingRate Expedited shipping rate for this item (2 to 3 business days)
size Size attribute for the item
color Color attribute for the item
marketplace Whether this item is from one of the Walmart marketplace sellers. In this case, the item cannot be returned back to Walmart stores or walmart.com. It must be returned to the marketplace seller in accordance with their returns policy.
sellerInfo Name of the marketplace seller, applicable only for marketplace items
shipToStore Whether the item can be shipped to the nearest Walmart store.
freeShipToStore Whether the item qualifies for free shipping to the nearest Walmart store.
modelNumber Model number attribute for the item
productUrl Walmart.com url for the item
availableOnline Whether the item is currently available for sale on Walmart.com
stock Indicative quantity of the item available online. Possible values are [Available, Limited Supply, Last few items, Not available]. Limited supply: can go out of stock in the near future, so needs to be refreshed for availability more frequently. Last few items: can go out of stock very quickly, so could be avoided in case you only need to show available items to your users.
customerRating Average customer rating out of 5
customerRatingImage Customer Rating Image
numReviews Number of customer reviews available on this item on Walmart.com
clearance Whether the item is on clearance on Walmart.com
preOrder Whether this item is available on pre-order on Walmart.com
preOrderShipsOn Date the item will ship on if it is a pre-order item
offerType Indicates whether the item is sold ONLINE_ONLY , ONLINE_AND_STORE, STORE_ONLY
rhid Indicates the offer category id for this item
bundle Indicates if the item is a bundle
attributes Various attributes for the item
addToCartUrl Walmart.com cart page Url with the item added to cart
affiliateAddToCartUrl Impact Radius tracking url to add the item on Walmart.com cart page and uniquely identifies the affiliate via a impact radius tracking id. The impact radius tracking id  is used by us to correctly attribute the sales from your channel on walmart.com. Actual commission numbers will be made available through your impact radius account.
freeShippingOver35Dollars Indicates if the item is eligible for free shipping over 35 dollars
gender Indicates the gender for the item
age Indicates the age range for the item
imageEntities Primary and secondary images of the item on Walmart.com. Each image are in thumbnail, medium and large sizes
isTwoDayShippingEligible Indicates whether the item is eligible for two day shipping
customerRatingImage Image of average customer rating
giftOptions Indicates the gift options of the item, whether gift wrap, gift message, gift receipt are allowed
bestMarketplacePrice Information about best price on marketplace, including price, sellerInfo,standardShipRate, twoThreeDayShippingRate, availableOnline, clearance and offerType
variants the itemIds of the item's variants, if variants exist

 

Base Response

Base Response is a smaller response that describes basic attributes for an item. It has been designed for low latency and small size of the response. This is the default response type for Search API. Fields returned by this response group are as below.

itemId A positive integer that uniquely identifies an item
name Standard name of the item
msrp Manufacturer suggested retail price
salePrice Selling price for the item in USD
upc Unique Product Code
categoryPath Breadcrumb for the item. This string describes the category level hierarchy that the item falls under.
longDescription Long description for the item. Contains escaped html formatting tags.
thumbnailImage Small size image for the item in jpeg format with dimensions 100 x 100 pixels
productTrackingUrl Deep linked URL that directly links to the product page of this item on walmart.com, and uniquely identifies the affiliate sending this request via a impact radius tracking id |PUBID|. The PUBID parameter needs to be replaced with your impact radius tracking id, and is used by us to correctly attribute the sales from your channel on walmart.com. Actual commission numbers will be made available through your impact radius account.
standardShipRate Shipping rate for this item for standard shipping (3 to 5 business days)
marketplace Whether this item is from one of the Walmart marketplace sellers. In this case, the item cannot be returned back to Walmart stores or walmart.com. It must be returned to the marketplace seller in accordance with their returns policy.
productUrl Walmart.com url for the item
availableOnline

Whether the item is currently available for sale on Walmart.com
offerType

Indicates whether the item is sold ONLINE_ONLY , ONLINE_AND_STORE, STORE_ONLY
isTwoDayShippingEligible

Indicates whether the item is eligible for two day shipping
imageEntities Primary and secondary images of the item on Walmart.com. Each image are in thumbnail, medium and large sizes
giftOptions Indicates the gift options of the item, whether gift wrap, gift message, gift receipt are allowed

version 3 as of 9 months ago by Denzuko