--- title: Category slug: bluecartapi/walmart-product-data-api/parameters/category docTags: createdAt: 2024-07-27T17:51:31.971Z --- # Category Parameters `GET` `/request` The Category Parameters are applicable when making a request with `type=category` to retrieve category results from Walmart. The category is specified in the `category_id` parameter. The parameters should be appended as querystring parameters to the Walmart Product Data API `GET` HTTP request. Category results are retrieved from the [Category results page](https://www.walmart.com/cp/skateboards-skates/7628560) on Walmart. :::hint{type="warning"} `type=category` is not supported for `walmart.ca` ::: ![](https://apiimages.imgix.net/bluecartapi/images/png/docs/category.png?auto=format\&ixlib=react-9.5.1-beta.1\&w=600 "Category Results Page") For example, to request category results for the `category_id` of `5F9BB75E8BEE926724ADA8F8C0DAE926912E15A2` , the request would be: :::CodeblockTabs HTTP ```HTTP https://api.bluecartapi.com/request?api_key=demo&type=category&category_id=5F9BB75E8BEE926724ADA8F8C0DAE926912E15A2 ``` ```curl curl -L --get https://api.bluecartapi.com/request -d api_key="demo" -d type="category" -d category_id="5F9BB75E8BEE926724ADA8F8C0DAE926912E15A2" ``` ```nodejs const axios = require('axios'); // set up the request parameters const params = { api_key: "demo", type: "category", category_id: "5F9BB75E8BEE926724ADA8F8C0DAE926912E15A2" } // 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); }) ``` ```python import requests import json # set up the request parameters params = { 'api_key': 'demo', 'type': 'category', 'category_id': '5F9BB75E8BEE926724ADA8F8C0DAE926912E15A2' } # 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())) ``` ::: *** ### Category Parameters The following parameters are available for all requests made when `type=category` . | *`Parameter`* | *`Required`* | *`Description`* | | ----------------- | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | *`category_id`* | *`required`* | A category ID to retrieve results from. You may supply any arbitary value in the `category_id` parameter however we recommend using a category ID returned from the [Categories API ](https://docs.trajectdata.com/bluecartapi/categories-api/overview)as these are known-good category IDs from Walmart.
In the case of the `category_id` parameter not matching a value from the [Categories API ](https://docs.trajectdata.com/bluecartapi/categories-api/overview), BlueCart will append the passed `category_id` value in the `cat_id` Walmart URL querystring parameter. | | *`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
-
:inlineImage[]{src="https://apiimages.imgix.net/bluecartapi/images/png/docs/sort_by.png?auto=format&ixlib=react-9.5.1-beta.1&w=150" alt caption} | | *`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).
-
:inlineImage[]{src="https://apiimages.imgix.net/bluecartapi/images/png/docs/search_delivery_type.png?auto=format&ixlib=react-9.5.1-beta.1&w=150" alt caption} | | *`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.
-
:inlineImage[]{src="https://apiimages.imgix.net/bluecartapi/images/png/docs/search_rating.png?auto=format&ixlib=react-9.5.1-beta.1&w=150" alt caption} | | *`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 ](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=category` 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 category 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**      [Category Results](https://docs.trajectdata.com/bluecartapi/walmart-product-data-api/results/category)