Search

3min

Search Parameters
﻿GET  /request
The Search Parameters are applicable when making a request with  type=search  to retrieve search results from Target. The search term is specified in the  search_term  parameter. The parameters should be appended as querystring parameters to the Target Product Data API GET HTTP request.
Search results are retrieved from the Search results page on Target.
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
https://api.redcircleapi.com/request?api_key=demo&type=search&search_term=highlighter+pens&sort_by=best_seller
https://api.redcircleapi.com/request?api_key=demo&type=search&search_term=highlighter+pens&sort_by=best_seller
﻿
﻿
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 Target items. Either the search_term or url parameter must be supplied.
category_id
optional
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 as these are known-good category IDs from Target.
Category IDs can also be retrieved from any Target URL in the category Target URL querystring parameter.
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 newest products first
﻿
featured 
Sort results by featured products first
﻿
﻿
delivery_type
optional
Determines whether results are filtered to just those matching the given delivery type. Valid values are:
in_store_pickup 
Filter results to products available in store (use the customer_zipcode parameter to specify the store).
﻿
same_day_delivery 
Filter results to products available via same-day delivery.
﻿
buy_at_store 
Filter results to products available via "Buy it at the Store" (use the customer_zipcode parameter to specify the store).
﻿
ship_to_home 
Filter results to products available via ship-to-home delivery.
﻿
﻿
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.
﻿
five_star 
Filter results to products with a 5 star customer rating.
﻿
﻿
include_out_of_stock
optional
Set to true to include out of stock products or false (the default) to exclude them.
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 facet IDs to use with the request. Available facet IDs are returned from type=search requests in the id property of the facets array. Facet IDs can also be retrieved from any Target URL in the facetedValue Target URL querystring parameter.  
Facet IDs should be expressed in comma seperated notation, with each facet ID delimited by a comma (",") character.
For example, to set the Sold By facet to the value Target (facet ID dq4mn ), and the Color facet to the value Blue (facet ID 5y70h ), the facets request parameter would be facets=dq4mn,5y70h
url
optional
The Target 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﻿

Parameter	Required	Description
search_term	required	A search term to use to search for Target items. Either the search_term or url parameter must be supplied.
category_id	optional	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 as these are known-good category IDs from Target. Category IDs can also be retrieved from any Target URL in the category Target URL querystring parameter.
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 newest products first featured Sort results by featured products first
delivery_type	optional	Determines whether results are filtered to just those matching the given delivery type. Valid values are: in_store_pickup Filter results to products available in store (use the customer_zipcode parameter to specify the store). same_day_delivery Filter results to products available via same-day delivery. buy_at_store Filter results to products available via "Buy it at the Store" (use the customer_zipcode parameter to specify the store). ship_to_home Filter results to products available via ship-to-home delivery.
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. five_star Filter results to products with a 5 star customer rating.
include_out_of_stock	optional	Set to true to include out of stock products or false (the default) to exclude them.
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 facet IDs to use with the request. Available facet IDs are returned from type=search requests in the id property of the facets array. Facet IDs can also be retrieved from any Target URL in the facetedValue Target URL querystring parameter. Facet IDs should be expressed in comma seperated notation, with each facet ID delimited by a comma (",") character. For example, to set the Sold By facet to the value Target (facet ID dq4mn ), and the Color facet to the value Blue (facet ID 5y70h ), the facets request parameter would be facets=dq4mn,5y70h
url	optional	The Target 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.

Updated 08 Aug 2024

Did this page help you?

Common