Core APIs
...
Results
Core Requests

Category

2min

Category Results

When making a request with the type parameter set to type=category BlueCart API will return category results from Walmart.

Category results are retrieved from the category results page on Walmart.

Category Results Page
Category Results Page


An example of the JSON object returned from a Category request is shown below:

JSON


BlueCart API returns the following properties for Category requests:

Property

Type

Description

category_results

array

An array of Category Result objects, containing each of the product results shown on the Category Results page. The Category Result object has the following properties:

  • position
  • number
  • The position of the result on the category results page.



Product Object The product object contains details about the product within the category result. The product object has the following properties:

  • title
  • string
  • The product title.



  • link
  • string
  • The URL to the product page.



  • description
  • string
  • The full-text description of the product.



  • brand
  • string
  • The brand name of the product, if shown.



  • item_id
  • string
  • The product item id. Pass the item_id into a type=product request to get product-level data about the product.



  • product_id
  • string
  • The product product id. This is a secondary ID for the product and isn't used when making type=product requests.



  • main_image
  • string
  • The primary image URL associated with the product.



  • images
  • array
  • An array of image URLs for the product.



  • department
  • string
  • The Walmart 'department' the product belongs to.



  • sponsored
  • boolean
  • Set to true when the search result is sponsored.



  • best_seller
  • boolean
  • Set to true when the search result is flagged as a Best Seller.



  • popular_pick
  • boolean
  • Set to true when the search result is flagged as a Popular Pick.



  • rollback
  • boolean
  • Set to true when the search result is flagged as a Rollback.



  • rating
  • number
  • The customer rating of this product, out of 5.



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



  • variants
  • array
  • An array detailing the other variants of this product that are available. Contains an array of variant objects with the following properties: item_id , product_id , title , image and link .



Inventory Object The inventory object contains details about the product stock status and availability. The inventory object has the following properties:

  • in_stock
  • boolean
  • True/false determining whether the product is in stock, or not.



  • preorder
  • boolean
  • True/false determining whether the product is available for pre-order, or not.



Offers Object The offers object contains details about the product offers. The offers object has the following properties:

  • is_marketplace_item
  • boolean
  • True/false determining whether the primary offer is from a marketplace seller.



  • primary
  • object
  • Primary Offer Object The primary offer object contains details about the primary seller offer for the product and has the following properties:
    • 
      1. price
      2. number
      3. The price of the seller offer.
    • 
      1. is_minimum_price_for_variant
      2. boolean
      3. Set to true when the price shown is for the lowest priced variant of the product and not necessarily the price of the displayed variant. Indicated by Walmart showing a "From..." price.
    • 
      1. list_price
      2. number
      3. The un-discounted original list price of the product.
    • 
      1. savings_amount
      2. number
      3. The saving amount offered.
    • 
      1. max_price
      2. number
      3. The maximum price of the seller offer in the case of range pricing (min/max).
    • 
      1. min_price
      2. number
      3. The minimum price of the seller offer in the case of range pricing (min/max).
    • 
      1. currency_symbol
      2. string
      3. The currency symbol of the seller offer.
    • 
      1. id
      2. string
      3. The unique ID of the seller offer.
    • 
      1. seller
      2. object
      3. An object containing a name and id property being the name and ID of the seller.



Fulfillment Object The fulfillment object contains details about the product delivery and pickup options. The fulfillment object has the following properties:

  • pickup
  • boolean
  • True if the product is available to be fulfilled via in-store pickup.



  • delivery_from_store
  • boolean
  • True if the product is available to be fulfilled via delivery from store.



  • shipping
  • boolean
  • True if the product is available to be fulfilled via home shipping.



  • shipping_days
  • number
  • The number of days taken to home-ship the product. Typicall 1 (for next day home shipping), 2 or 3 . Populated when shipping=true .

facets

array

Facet Object An array containing details of any available search facets (refinements) shown on the category result page. You can use the facets returned here to refine your query by supplying facet information into the facets request parameter . Each object in the facets array contains the following properties:

  • name
  • string
  • The name of the facet (can be used in the facets request parameter).



  • display_name
  • string
  • The display name of the facet (i.e. the user-facing name).



  • values
  • array
  • Facet Values Array The facet values array shows the values of the given facet, along with the number of products matching that facet value.
    • 
      1. name
      2. string
      3. The facet value, can be used in the facets request parameter.
    • 
      1. count
      2. number
      3. The count of the number of products that match this facet value in the current search results, if shown (omitted if not shown or zero).
    • 
      1. active
      2. boolean
      3. True/false indicating whether the facet is currently active, or not.
    • 
      1. param_value
      2. string
      3. The example value of a subsequent requests facets parameter to filter the results to this facet value.

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:

  • name
  • string
  • The name of the category.



  • link
  • string
  • The URL of the category (can be used in the url request parameter of a future type=category request).

category_list

array

An array of Category List objects. This property is populated when an "intermediate" category URL is specified in the requests' url parameter (see example ). "Intermediate" category URLs are category landing pages that typically show a branded list of sub-categories.

Note that the categories returned in category_list are retrieved from the category listing page itself, rather than via the Categories API .

The Category List object has the following properties:

  • title
  • string
  • The title of the sub-category linked-to from the intermediate category page.



  • link
  • string
  • A link to the sub-category from the intermediate category page. Could we passed to a subsequent type=category request via the url request parameter to retrieve category listings from that page.



  • image
  • string
  • The image of the sub-category from the intermediate category page, if shown.

category_information

object

An object containing details of the current page of category results.

  • is_landing_page
  • boolean
  • Set to true when the current page is a category landing page (see example ). A category landing page is a higher level summary page. If you encounter one you should iterate to a lower level category, or use the facets request parameter, to traverse down to a category listing page.

pagination

object

Pagination Object An object containing details of the current results page and the total number of pages that are available. To paginate you should specify the page number in your request's page parameter .

  • current
  • object
  • Current Page Object Contains details of the current page
    • 
      1. page
      2. number
      3. The current page number.
    • 
      1. link
      2. string
      3. The current page URL.



  • next
  • object
  • Next Page Object Contains details of the next page
    • 
      1. page
      2. number
      3. The next page number.
    • 
      1. link
      2. string
      3. The next page URL.



  • other_pages
  • array
  • Other Pages Array Contains details of other availale pages, each object in the array contains the following properties:
    • 
      1. page
      2. number
      3. The page number.
    • 
      1. link
      2. string
      3. The URL to the page.



  • total_pages
  • number
  • The total number of pages shown as being available.



  • total_results
  • number
  • The total number of search results shown as being available.

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      Category Parameters

Updated 08 Aug 2024
Did this page help you?
PREVIOUS
Search
NEXT
Product
Docs powered by Archbee