Common

common parameters get get /request the following parameters are used to configure your request to the walmart product data api they should be appended as querystring parameters to a get http request to the /request endpoint for example, to request search results, for the search term highlighter pens , sorted by best seller , on walmart com 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; ?> request specific parameters additional parameters are available depending on the type of request being made (as determined by the type parameter) common parameters the following common parameters are required for all requests to the walmart product data api parameter required description api key required the api key for your bluecart api account 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 valud values for walmart domain are walmart domain=walmart com target walmart com domain walmart domain=walmart ca target walmart ca domain type required the type of walmart data to retrieve the value of the type parameter determines which additional parameters are available for example, if you make a request with type=search then additional search parameters https //docs trajectdata com/bluecartapi/walmart product data api/parameters/search , specific to search requests, are available valid values for type are search request search results for a search term or walmart search results page url see additional search parameters https //docs trajectdata com/bluecartapi/walmart product data api/parameters/search category request category listing results for a category id or walmart search results page url see additional category parameters https //docs trajectdata com/bluecartapi/walmart product data api/parameters/category product request data from a walmart product page via an item id or walmart product page url see additional product parameters https //docs trajectdata com/bluecartapi/walmart product data api/parameters/product reviews request customer reviews for an item id or walmart product page url see additional reviews parameters https //docs trajectdata com/bluecartapi/walmart product data api/parameters/reviews seller profile request seller profile data for an seller id or walmart seller profile page url see additional seller profile parameters https //docs trajectdata com/bluecartapi/walmart product data api/parameters/seller profile autocomplete request autocomplete data for an search term see additional autocomplete parameters https //docs trajectdata com/bluecartapi/walmart product data api/parameters/autocomplete store id walmart com optional to use the store id parameter, you must look up the store you want to target your request note this is optional for com if you include a store id param, it cannot be combined with customer zipcode this does not require any setup store id walmart ca required to use the store id parameter, you must look up the store you want to target your request note 1/ store id is required for type=product 2/ store id is not required for type=search customer zipcode optional determines the specific customer zipcode location of the request this is useful, for example, for seeing details highly localized listings to use the customer zipcode parameter you must first setup the zipcode in the zipcodes section https //app bluecartapi com/zipcodes of the dashboard note it cannot be combined with store id this does not require any setup for more information please see the customer zipcode reference https //docs trajectdata com/bluecartapi/zipcodes api/overview output optional determines the format in which results are returned can be set to json (default) to get the results as structured json, html to get the raw html retrieved or csv to return the results in csv format when using csv you can also use the csv fields parameter to specify which fields to return in the csv csv fields optional determines the fields that are returned when returning in csv mode (i e when the output parameter is set to csv ) should be specified as a comma seperated list of fields (in nested field, dot notation, format) for more information on the csv fields parameter please see the csv fields reference https //docs trajectdata com/bluecartapi/walmart product data api/reference/csv fields include fields optional a comma seperated list json field names to include in the json object the api returns you can specify the field names in dot notation i e include fields=pagination will only include the the pagination property in the response json use include fields if you only want to include specific fields in the api's json response exclude fields optional a comma seperated list of json field names to exclude from the json object the api returns you can specify the field names in dot notation i e exclude fields=pagination will remove the pagination property from the response json use exclude fields if there are specific fields you wish to exclude from the api's json response next steps search parameters https //docs trajectdata com/bluecartapi/walmart product data api/parameters/search category parameters https //docs trajectdata com/bluecartapi/walmart product data api/parameters/category product parameters https //docs trajectdata com/bluecartapi/walmart product data api/parameters/product reviews parameters https //docs trajectdata com/bluecartapi/walmart product data api/parameters/reviews autocomplete parameters https //docs trajectdata com/bluecartapi/walmart product data api/parameters/autocomplete