Core APIs
...
Parameters
Core Requests

Search

3min
search parameters get 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 https //www walmart com/search/?query=highlighter+pens on walmart for example, to request search results for the search term highlighter pens , sorted by "best selling products", the request would be http https //api bluecartapi com/request?api key=demo\&type=search\&search term=highlighter+pens\&sort by=best sellercurl l get https //api bluecartapi com/request \\ d api key="demo" \\ d type="search" \\ d search term="highlighter+pens" \\ d sort by="best seller"const axios = require('axios'); // set up the request parameters const params = { api key "demo", type "search", search term "highlighter pens", sort by "best seller" } // make the http get request to bluecart api axios get('https //api bluecartapi com/request', { params }) then(response => { // print the json response from bluecart api console log(json stringify(response data, 0, 2)); }) catch(error => { // catch and print the error console log(error); })import requests import json \# set up the request parameters params = { 'api key' 'demo', 'type' 'search', 'search term' 'highlighter pens', 'sort by' 'best seller' } \# make the http get request to bluecart api api result = requests get('https //api bluecartapi com/request', params) \# print the json response from bluecart api print(json dumps(api result json()))\<?php \# set up the request parameters $querystring = http build query(\[ 'api key' => 'demo', 'type' => 'search', 'search term' => 'highlighter pens', 'sort by' => 'best seller' ]); \# make the http get request to bluecart api $ch = curl init(sprintf('%s?%s', 'https //api bluecartapi com/request', $querystring)); curl setopt($ch, curlopt returntransfer, true); curl setopt($ch, curlopt followlocation, true); \# the following options are required if you're using an outdated openssl version \# more details https //www openssl org/blog/blog/2021/09/13/letsencryptrootcertexpire/ curl setopt($ch, curlopt ssl verifyhost, false); curl setopt($ch, curlopt ssl verifypeer, false); curl setopt($ch, curlopt timeout, 180); $api result = curl exec($ch); curl close($ch); \# print the json response from bluecart api echo $api result; ?> search parameters the following parameters are available for all requests made when type=search parameter required description walmart domain optional the walmart domain to target the value of the walmart domain parameeter determines which additional parameters are available for example, walmart ca supports only type=search and type= product at this time defaults to walmart com valid values for walmart domain are walmart domain=walmart com target walmart com domain walmart domain=walmart ca target walmart ca domain 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 https //docs trajectdata com/bluecartapi/walmart product data api/reference/search category ids to get category id values for use with search requests https //docs trajectdata com/bluecartapi/walmart product data api/reference/search category ids 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 https //docs trajectdata com/bluecartapi/walmart product data api/reference/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 https //docs trajectdata com/bluecartapi/categories api/overview sort by optional determines how the results are sorted valid values are best seller sort results by best selling products first price high to low sort results by highest to lowest priced price low to high sort results by lowest to highest priced best match sort results by best match highest rating sort results by highest rated products first newly listed sort results by newly listed products first new sort results by newest products first delivery type optional determines whether results are filtered to just those matching the given delivery type valid values are pickup filter results to products available for pickup in store delivery from store filter results to products available delivery from a store shipping filter results to products available via home shipping available in store filter results to products available in store (use the customer zipcode parameter to set the store location) rating optional determines whether results are filtered to just those matching the given customer star rating valid values are one star filter results to products with a 1 to 1 9 star customer rating two star filter results to products with a 2 to 2 9 star customer rating three star filter results to products with a 3 to 3 9 star customer rating four star filter results to products with a 4 to 5 star customer rating condition optional filters the results to just products matching the given condition valid values are new filter results to just new products refurbished 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 https //docs trajectdata com/bluecartapi/walmart product data api/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 https //docs trajectdata com/bluecartapi/walmart product data api/results/search