Core APIs
...
Parameters
Core Requests

Search

3min

Search Parameters

GET /request

The Search Parameters are applicable when making a request with type=search to retrieve search results from Walmart. The search term is specified in the search_term parameter. The parameters should be appended as querystring parameters to the Walmart Product Data API GET HTTP request.

Search results are retrieved from the Search results page on Walmart.

Search Results Page
Search Results Page


For example, to request search results for the search term highlighter pens , sorted by "best selling products", the request would be:

HTTP
Curl
Node.js
Python
PHP



Search Parameters

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

Parameter

Required

Description

search_term

required

A search term to use to search for Walmart items. Either the search_term or url parameter must be supplied.

category_id

optional

Limits the search results returned from type=search requests to the category area specified in the search category_id property.

View the official Search Category IDs to get category_id values for use with Search Requests . Search Category IDs can also be retrieved from any Walmart URL in the cat_id Walmart URL querystring parameter.

Either the category_id or search_term parameter must be supplied when making type=search requests.

Note the category_id values supplied to a type=search request are Search Category IDs . They are not the same as the category_id values supplied to a type=category request and returned by the Categories API .

sort_by

optional

Determines how the results are sorted. Valid values are:

  1. best_seller
  2. Sort results by best selling products first.



  1. price_high_to_low
  2. Sort results by highest to lowest priced.



  1. price_low_to_high
  2. Sort results by lowest to highest priced.



  1. best_match
  2. Sort results by best match.



  1. highest_rating
  2. Sort results by highest rated products first.



  1. newly_listed
  2. Sort results by newly listed products first.



  1. new
  2. Sort results by newest products first

  • 

    Document image
    

delivery_type

optional

Determines whether results are filtered to just those matching the given delivery type. Valid values are:

  1. pickup
  2. Filter results to products available for pickup in store.



  1. delivery_from_store
  2. Filter results to products available delivery from a store.



  1. shipping
  2. Filter results to products available via home shipping.



  1. available_in_store
  2. Filter results to products available in store (use the customer_zipcode parameter to set the store location).

  • 

    Document image
    

rating

optional

Determines whether results are filtered to just those matching the given customer star rating. Valid values are:

  1. one_star
  2. Filter results to products with a 1 to 1.9 star customer rating.



  1. two_star
  2. Filter results to products with a 2 to 2.9 star customer rating.



  1. three_star
  2. Filter results to products with a 3 to 3.9 star customer rating.



  1. four_star
  2. Filter results to products with a 4 to 5 star customer rating.

  • 

    Document image
    

condition

optional

Filters the results to just products matching the given condition. Valid values are:

  1. new
  2. Filter results to just new products.



  1. refurbished
  2. Filter results to just refurbished products.

min_price

optional

Determines the minimum price of results to return, expressed in dollars and cents (i.e. min_price=2.99 for $2.99).

max_price

optional

Determines the maximum price of results to return, expressed in dollars and cents (i.e. min_price=39.99 for $39.99).

page

optional

The current page of results to retrieve. Inspect the pagination results property for details on the number of pages available.

max_page

optional

Use the max_page parameter to get multiple pages of results in one request. The API will automatically paginate through pages and concatenate the results into one response.

See the Pagination docs for more information.

facets

optional

A free-form set of filter facets to use with the request. Available facet data is returned from type=search requests or can be retrieved from any Walmart URL in the facet Walmart URL querystring parameter.

Facet data should be expressed in comma seperated notation, with the name and value of the facet delimited by an equals ("=") character.

For example, to set the brand facet to the value Garmin and the screen_size facet to the value 6" the value of the facets request parameter would be facets=brand=Garmin,screen_size=6"

url

optional

The Walmart search results page to retrieve results from.

Note : If the url parameter is supplied then all other parameters are ignored as they are overriden be those specified in the url parameter.



Next Steps      Search Results

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