Search

search parameters get 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 https //www target com/s?searchterm=highlighter+pens on target for example, to request search results for the search term highlighter pens , sorted by "best selling products", the request would be http https //api redcircleapi com/request?api key=demo\&type=search\&search term=highlighter+pens\&sort by=best sellercurl l get https //api redcircleapi 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 redcircle api axios get('https //api redcircleapi com/request', { params }) then(response => { // print the json response from redcircle 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 redcircle api api result = requests get('https //api redcircleapi com/request', params) \# print the json response from redcircle 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 redcircle api $ch = curl init(sprintf('%s?%s', 'https //api redcircleapi 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 redcircle api echo $api result; ?> 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 https //docs trajectdata com/redcircleapi/categories api/overview 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 https //docs trajectdata com/redcircleapi/target product data api/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 https //docs trajectdata com/redcircleapi/target product data api/results/search