Core APIs
...
Results
Core Requests

Product

2min

Product Results

When making a request with the type parameter set to type=product BlueCart API will return product details for the product specified in either the item_id or the url parameter.

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

Walmart Product Page
Walmart Product Page


An example of the JSON object returned from an Product request is shown below:

JSON


BlueCart API returns the following properties for Product requests:

Property

Type

Description

product

object

An object containing details of the primary product shown on the product page.

  • title
  • string
  • The product name.



  • item_id
  • string
  • The Walmart item ID for the product.



  • product_id
  • string
  • The Walmart product ID for the product.



  • item_number
  • string
  • The Walmart item number for the product.



  • upc
  • string
  • The UPC of the product, if shown.



  • model
  • string
  • The model name/number of the product, if shown.



  • link
  • string
  • The product page link.



  • description
  • string
  • The short or summary product description, as plain text (if shown).



  • description_html
  • string
  • The short or summary product description, preserving HTML formatting (if shown).



  • description_full
  • string
  • The full product description, as plain text (if shown).



  • description_full_html
  • string
  • The full product description, as preserving HTML formatting (if shown).



  • breadcrumbs
  • array
  • Breadcrumbs Array An array containing details of the category breadcrumbs in the title section the page (if shown). Each object in the breadcrumbs array contains the following properties:
    • 
      1. name
      2. string
      3. The name of the category.
    • 
      1. link
      2. string
      3. A link to the category.



  • main_image
  • object
  • Main Image Object The main image object contains primary image shown when the product page was loaded.
    • 
      1. link
      2. string
      3. A link to the main image.



  • images
  • array
  • Images Array The images property contains an array of image objects containing the other available product images, excluding the main image. The image object has the following properties:
    • 
      1. link
      2. string
      3. A link to the image.
    • 
      1. id
      2. string
      3. A ID to the image.
    • 
      1. zoomable
      2. boolean
      3. True/false whether the image is zoomable, or not.



  • specifications
  • array
  • Specifications Array The specifications array contains details of the product specifications as shown in the specifications tables.
    • 
      1. name
      2. string
      3. The name of the specification i.e. "Batteries".
    • 
      1. value
      2. string
      3. The value of the specification i.e. "2 AA Batteries".



  • variants
  • array
  • Variants Array The variants array contains details of variants of the current product as shown on the product page.
    • 
      1. item_id
      2. string
      3. The Item ID of the variant product. Can be passed in to a subsequent type=product request in the item_id parameter to retrieve product details of the variant.
    • 
      1. product_id
      2. string
      3. The Product ID of the variant product.
    • 
      1. link
      2. string
      3. The URL to the product page of the variant product. Can be passed in to a subsequent type=product request in the url parameter in URL-encoded form to retrieve product details of the variant.
    • 
      1. images
      2. array
      3. An array of objects containing a link property being an image url link to the product variant image.
    • 
      1. criteria
      2. array
      3. An array of objects containing name and value properties describing the variant criteria, for example name=shoe_size and value=8 .



  • promotions
  • object
  • Promotions Object An object containing details of the promotions displayed with this product:
    • 
      1. rollback
      2. boolean
      3. True/false whether this product is flagged as a Rollback, or not.
    • 
      1. popular_pick
      2. boolean
      3. True/false whether this product is flagged as a Popular Pick, or not.



  • rating
  • number
  • The overall rating of the product, out of 5.



  • ratings_total
  • number
  • The total number of customer ratings the product has received.



  • brand
  • string
  • The product brand name (if available).



  • brand_link
  • string
  • A link to the product's brand landing page (if available).



  • manufacturer
  • string
  • The product manufacturer name (if available).



  • aisle
  • string
  • The product in-store aisle location (if available). You can determine which store the results are taken from using the customer_zipcode request parameter.



  • color
  • string
  • The product color, if shown.



  • dimensions
  • string
  • The product dimensions (if available).



  • buybox_winner
  • object
  • Buybox Winner Object The "buybox" describes the winning offer for the product. The buybox_winner object contains details of the winning offer and has the following properties:
    • 
      1. price
      2. number
      3. The price of the buybox winning offer.
    • 
      1. was_price
      2. number
      3. The was/strikethrough price of the buybox winning offer.
    • 
      1. unit
      2. string
      3. The unit of measure of the buybox winning offer (i.e. "each").
    • 
      1. unit_price
      2. number
      3. The per-unit price of the buybox winning offer.
    • 
      1. unit_price_text
      2. string
      3. The raw text of the unit price of the buybox winning offer, i.e. "(9.7 cents/EA)".
    • 
      1. currency_symbol
      2. string
      3. The currency symbol of the buybox winning offer.
    • 
      1. id
      2. string
      3. The offer ID of the offer from the buybox winning seller.
    • 
      1. offers_total
      2. number
      3. The total number of seller offers this product has. For full details issue a new type=offers request with this products item_id . You should issue a new type=offers request to retrieve all offers for a product.
    • 
      1. offers_from_price
      2. object
      3. An object representing the price shown in the "More seller options" section.
      4. 

        Document image
        



  • 
  • 
  • Availability Object The availability object contains details the buybox-winning product availability method. It has the following properties:
    • 
      1. raw
      2. string
      3. The raw availability text as shown on the product page.
    • 
      1. in_stock
      2. boolean
      3. True/false determining whether the product is in stock and available for purchase.
    • 
      1. preorder
      2. boolean
      3. True/false determining whether the product is available for pre-order.
    • 
      1. preorder_date
      2. date
      3. The parsed date, in ISO 8601 format that the pre-order item becomes available for purchase.



  • 
  • 
  • Fulfillment Object The fulfillment object contains details the buybox-winning product offer fulfillment method. It has the following properties:
    • 
      1. pickup
      2. boolean
      3. True if the product is available to be fulfilled via in-store pickup.
    • 
      1. pickup_message
      2. string
      3. The pickup message, if shown.
    • 
      1. delivery_from_store
      2. boolean
      3. True if the product is available to be fulfilled via delivery from store.
    • 
      1. delivery_from_store_message
      2. string
      3. The delivery from store message, if shown.
    • 
      1. shipping
      2. boolean
      3. True if the product is available to be fulfilled via home shipping.
    • 
      1. shipping_message
      2. string
      3. The shipping message, if shown.
    • 
      1. message
      2. string
      3. The first shipping message shown on the product page.
    • 
      1. zipcode
      2. string
      3. The shipping/delivery zipcode, if shown.



  • 
  • 
  • Seller Object The seller object contains details the seller of the buybox-winning offer. It has the following properties:
    • 
      1. name
      2. string
      3. The name of the seller of the buybox winning offer.
    • 
      1. id
      2. string
      3. The ID of the seller. Can be used in a type=seller_profile request to retrieve data on the seller from the seller landing page. Only applicable for marketplace sellers.
    • 
      1. id_secondary
      2. string
      3. The secondary ID of the seller.
    • 
      1. link
      2. string
      3. A link to the seller landing page (if shown). Only applicable for marketplace sellers.



  • protection_plans
  • object
  • Protection Plans Object The protection plans object is present when protection plans are shown in the buybox section of the product page.
    • 
      1. title
      2. string
      3. The title of the protection plan.
    • 
      1. item_id
      2. string
      3. The Item ID of the protection plan.
    • 
      1. id
      2. string
      3. The internal ID of the protection plan.
    • 
      1. description
      2. string
      3. The description of the protection plan (note the description may contain HTML tags).
    • 
      1. image
      2. string
      3. The image URL of the protection plan, if shown.
    • 
      1. is_walmart_protection_plan
      2. boolean
      3. Set to true if the protection plan is branded as a Walmart Protection Plan, absent otherwise.
    • 
      1. price
      2. object
      3. An object representing the price and currency of the protection plan.



  • home_service_plans
  • object
  • Home Service Plans Object The home service plans object is present when home service plans are shown in the buybox section of the product page.
    • 
      1. title
      2. string
      3. The title of the home service plan.
    • 
      1. item_id
      2. string
      3. The Item ID of the home service plan.
    • 
      1. id
      2. string
      3. The internal ID of the home service plan.
    • 
      1. description
      2. string
      3. The description of the home service plan (note the description may contain HTML tags).
    • 
      1. image
      2. string
      3. The image URL of the home service plan, if shown.
    • 
      1. price
      2. object
      3. An object representing the price and currency of the home service plan.

location_info

object

Location Info Object An object containing details of the location in which the request was run.

  • city
  • string
  • The city the request was run in.



  • state
  • string
  • The state the request was run in.



  • zipcode
  • string
  • The zipcode the request was run in.



  • store_id
  • string
  • The ID of the store that the request was run from.


Next Steps      Product Parameters

Updated 06 Aug 2024
Did this page help you?