Search

search results when making a request with the type parameter https //docs trajectdata com/redcircleapi/target product data api/parameters/search set to type=search redcircle api will return search results from target search results are retrieved from the search results page https //www target com/s?searchterm=highlighter+pens on target an example of the json object returned from a search request is shown below { "request info" { "success" true, "credits used" 1, "credits remaining" 999 }, "request metadata" { "created at" "2020 01 01t00 00 00 000z", "processed at" "2020 01 01t00 00 00 000z", "total time taken" 2 15, "target url" "https //www target com/s?searchterm=highlighter+pens\&sortby=bestselling\&nao=0\&facetedvalue=5zja3zfwtfr" }, "request parameters" { "type" "search", "search term" "highlighter pens", "sort by" "best seller" }, "search results" \[ { "position" 1, "product" { "title" "sharpie 12pk highlighters clearview chisel tip multicolor", "link" "https //www target com/p/sharpie 12pk highlighters clearview chisel tip multicolor/ /a 54241380", "tcin" "54241380", "dpci" "081 02 2450", "sponsored" true, "class id" 2, "department id" 81, "brand" "sharpie", "brand link" "https //www target com/b/sharpie/ /n 56cak", "feature bullets" \[ "clear tip allows you to highlight neatly and evenly all the way across the page", "slim barrel for optimal control, precise highlights and clear, legible notes", "fine chisel end draws thicker lines for highlighting or thin lines for underlining", "resists smearing of many pen and marker inks (let ink dry before highlighting)", "includes 12 highlighters in assorted colors" ], "rating" 4 7, "ratings total" 58, "main image" "https //target scene7 com/is/image/target/guest 94e3b7f9 4008 4910 8f5e 1fffa0cd9ab0", "images" \[ "https //target scene7 com/is/image/target/guest 94e3b7f9 4008 4910 8f5e 1fffa0cd9ab0", "https //target scene7 com/is/image/target/guest 4c328408 6ddf 453a 8186 c3ad8b465dab", "https //target scene7 com/is/image/target/guest db387ea7 5716 463b abfd 5684e1bc1435", "https //target scene7 com/is/image/target/guest b08515e9 db62 4d4f 8423 ce260de64e77" ], "videos" \[ { "link" "https //target scene7 com/is/content/target/guest 6a704552 1e1c 4841 b170 195add122580 flash9 autox720p 2600k", "type" "video/mp4" } ] }, "offers" { "primary" { "price" 18 99, "currency" "usd", "symbol" "$" }, "all offers" \[ { "price" 18 99, "currency" "usd", "symbol" "$" } ] }, "fulfillment" { "type" "3p" }, "seller" { "name" "myofficeinnovations", "id" "10003960" } }, { "position" 2, "product" { "title" "24pk marker pens flair medium tip 7mm multicolor papermate", "link" "https //www target com/p/24pk marker pens flair medium tip 7mm multicolor papermate/ /a 50358888", "tcin" "50358888", "dpci" "081 02 2035", "class id" 2, "department id" 81, "brand" "paper mate", "brand link" "https //www target com/b/paper mate/ /n 56c8g", "feature bullets" \[ "add a blast of fun to all your writing", "medium point felt tip for bold, expressive lines", "smear resistant ink for less smudging", "water based ink won't bleed through paper", "the point guard prevents the tip from fraying", "packaging may vary" ], "rating" 4 5, "ratings total" 89, "main image" "https //target scene7 com/is/image/target/guest 0b42c2dc 18b4 4144 b3f4 d751b63a9b7f", "images" \[ "https //target scene7 com/is/image/target/guest 0b42c2dc 18b4 4144 b3f4 d751b63a9b7f", "https //target scene7 com/is/image/target/guest d359e44b 88a6 452d 8f5b d6cb649e3052", "https //target scene7 com/is/image/target/guest cc9f2ecb cb0b 408d a2c7 0a4523f92cc6", "https //target scene7 com/is/image/target/guest 3271d3b6 0202 450d b8b0 a49e9f4d3190", "https //target scene7 com/is/image/target/guest 4fcba98a 7ef8 4f65 8300 f0ec0de012a8", "https //target scene7 com/is/image/target/guest 94994d28 d988 4cfc 947e 7fdb89e6018a", "https //target scene7 com/is/image/target/guest 588a8aa2 ca69 4f78 aa03 3347ae5870cf" ], "videos" \[ { "link" "https //target scene7 com/is/content/target/guest ed214196 b36a 4de0 964e 2b2ddd1bc451 flash9 autox720p 2600k", "type" "video/mp4" }, { "link" "https //target scene7 com/is/content/target/guest f2a05f63 8412 4ef7 86bf 2569752b320b flash9 autox720p 2600k", "type" "video/mp4" } ] }, "offers" { "primary" { "price" 19 99, "currency" "usd", "symbol" "$", "regular price" 24 99 }, "all offers" \[ { "price" 19 99, "currency" "usd", "symbol" "$", "regular price" 24 99 } ] }, "fulfillment" { "type" "1p" } } ], "related queries" \[ { "query" "dry erase marker", "link" "https //www target com/s?searchterm=dry+erase+marker" }, { "query" "green pen", "link" "https //www target com/s?searchterm=green+pen" }, { "query" "washable markers", "link" "https //www target com/s?searchterm=washable+markers" }, { "query" "crayola markers", "link" "https //www target com/s?searchterm=crayola+markers" } ], "pagination" { "current" { "page" 1, "link" "https //www target com/s?searchterm=highlighter+pens\&sortby=bestselling\&nao=0\&facetedvalue=5zja3zfwtfr" }, "next" { "page" 2, "link" "https //www target com/s?searchterm=highlighter+pens\&sortby=bestselling\&nao=24\&facetedvalue=5zja3zfwtfr" }, "total pages" 5, "total results" 119 }, "categories" \[ { "name" "school & office supplies", "id" "5xsxr" }, { "name" "home", "id" "5xtvd" }, { "name" "toys", "id" "5xtb0" } ], "facets" \[ { "display name" "price", "name" "d pricerange", "values" \[ { "display name" "$0 $15", "value" "$0 $15", "id" "5zja2" }, { "display name" "$15 $25", "value" "$15 $25", "id" "5zja3" }, { "display name" "$25 $50", "value" "$25 $50", "id" "5zja4" }, { "display name" "$50 $100", "value" "$50 $100", "id" "5zja5" }, { "display name" "$100 $150", "value" "$100 $150", "id" "5zja6" }, { "display name" "$150 $200", "value" "$150 $200", "id" "5zja7" }, { "display name" "$500 $800", "value" "$500 $800", "id" "5zjaa" } ] }, { "display name" "sold by", "name" "d sellers all", "values" \[ { "display name" "target", "value" "target", "id" "dq4mn" }, { "display name" "arteza", "value" "arteza", "id" "zbi86" }, { "display name" "myofficeinnovations", "value" "myofficeinnovations", "id" "jp8ap" }, { "display name" "school specialty", "value" "school specialty", "id" "7gkvi" } ] }, { "display name" "shipping & pickup", "name" "d channel", "values" \[ { "display name" "buy online & pick up", "value" "buy online & pick up", "id" "5zl7w" }, { "display name" "in stores", "value" "in stores", "id" "5zkty" }, { "display name" "shipping", "value" "shipping", "id" "5zktx" }, { "display name" "include out of stock", "value" "include out of stock", "id" "fwtfr" }, { "display name" "same day delivery", "value" "same day delivery", "id" "cl92v" } ] }, { "display name" "color", "name" "d color all", "values" \[ { "display name" "black", "value" "black", "id" "5y761" }, { "display name" "blue", "value" "blue", "id" "5y70h" }, { "display name" "brown", "value" "brown", "id" "5y746" }, { "display name" "clear", "value" "clear", "id" "5y6nd" }, { "display name" "gray", "value" "gray", "id" "5y759" }, { "display name" "green", "value" "green", "id" "5y73r" }, { "display name" "multicolored", "value" "multicolored", "id" "5xr7i" }, { "display name" "orange", "value" "orange", "id" "55ivi" }, { "display name" "pink", "value" "pink", "id" "5y76n" }, { "display name" "purple", "value" "purple", "id" "5y6hb" }, { "display name" "red", "value" "red", "id" "5y76d" }, { "display name" "yellow", "value" "yellow", "id" "5y72c" } ] }, { "display name" "type", "name" "d item type all", "values" \[ { "display name" "artist markers", "value" "artist markers", "id" "cdkak" }, { "display name" "brush markers", "value" "brush markers", "id" "rdnzh" }, { "display name" "dry erase markers", "value" "dry erase markers", "id" "jbq9g" }, { "display name" "felt tip pens", "value" "felt tip pens", "id" "555of" }, { "display name" "fountain pens", "value" "fountain pens", "id" "551o6" }, { "display name" "gel pens", "value" "gel pens", "id" "xf87j" }, { "display name" "highlighters", "value" "highlighters", "id" "6c0j" }, { "display name" "permanent markers", "value" "permanent markers", "id" "4nx9j" }, { "display name" "rollerball pens", "value" "rollerball pens", "id" "55o93" } ] }, { "display name" "package quantity", "name" "d package quantity", "values" \[ { "display name" "0 10", "value" "0 10", "id" "xo6o1" }, { "display name" "11 20", "value" "11 20", "id" "51tyh" }, { "display name" "21 30", "value" "21 30", "id" "ted2d" }, { "display name" "31 40", "value" "31 40", "id" "9s9jm" }, { "display name" "41 50", "value" "41 50", "id" "1o5mp" }, { "display name" "51 60", "value" "51 60", "id" "zl11t" } ] }, { "display name" "brand", "name" "d brand all", "values" \[ { "display name" "arteza", "value" "arteza", "id" "q643le9kydq" }, { "display name" "avery", "value" "avery", "id" "5d7pg" }, { "display name" "bic", "value" "bic", "id" "5pteu" }, { "display name" "business source", "value" "business source", "id" "n71bf" }, { "display name" "faber castell", "value" "faber castell", "id" "5s4to" }, { "display name" "integra", "value" "integra", "id" "34h06" }, { "display name" "myofficeinnovations", "value" "myofficeinnovations", "id" "q643leoowt" }, { "display name" "paper mate", "value" "paper mate", "id" "56c8g" }, { "display name" "pentel", "value" "pentel", "id" "5d7u4" }, { "display name" "pilot", "value" "pilot", "id" "5d8yf" }, { "display name" "sakura", "value" "sakura", "id" "if0po" }, { "display name" "school smart", "value" "school smart", "id" "8q5wb" }, { "display name" "sharpie", "value" "sharpie", "id" "56cak" }, { "display name" "staedtler", "value" "staedtler", "id" "56i5t" }, { "display name" "staples", "value" "staples", "id" "q643lev0bck" }, { "display name" "tombow", "value" "tombow", "id" "54xlg" }, { "display name" "tru red", "value" "tru red", "id" "q643leviis7" }, { "display name" "universal", "value" "universal", "id" "5wthz" }, { "display name" "yoobi", "value" "yoobi", "id" "551o8" }, { "display name" "zebra", "value" "zebra", "id" "5537i" } ] }, { "display name" "deals", "name" "d deals", "values" \[ { "display name" "all deals", "value" "all deals", "id" "akkos" }, { "display name" "buy and save", "value" "buy and save", "id" "55e6t" }, { "display name" "giftcard with purchase", "value" "giftcard with purchase", "id" "55e6u" }, { "display name" "sale", "value" "sale", "id" "5tdv0" }, { "display name" "weekly ad", "value" "weekly ad", "id" "55dgn" } ] }, { "display name" "lead size", "name" "d lead size", "values" \[ { "display name" "0 5mm", "value" "0 5mm", "id" "5pxtk9559ri" }, { "display name" "0 7mm", "value" "0 7mm", "id" "5pxtk9559rj" }, { "display name" "1 0mm", "value" "1 0mm", "id" "5pxtk95qrby" }, { "display name" "1 6mm", "value" "1 6mm", "id" "5pxtk9mlxhe" }, { "display name" "extra fine", "value" "extra fine", "id" "5pxtk92jhgy" }, { "display name" "fine", "value" "fine", "id" "5pxtk9n6e8u" } ] }, { "display name" "finish", "name" "d finish and color", "values" \[ { "display name" "black", "value" "black", "id" "4o3k2" }, { "display name" "yellow", "value" "yellow", "id" "4b21u25xkpk" }, { "display name" "blue", "value" "blue", "id" "4b21u25xku0" }, { "display name" "green", "value" "green", "id" "4b21u25xkwh" }, { "display name" "orange", "value" "orange", "id" "4b21u255ivh" }, { "display name" "pink", "value" "pink", "id" "4b21u25xkwk" }, { "display name" "purple", "value" "purple", "id" "4b21u25xkug" } ] }, { "display name" "fpo/apo", "name" "d apo fpo", "values" \[ { "display name" "only eligible items", "value" "only eligible items", "id" "vu13f" } ] }, { "display name" "featured", "name" "d marketing", "values" \[ { "display name" "new", "value" "new", "id" "5ewil" } ] } ] } redcircle api returns the following properties for search requests property type description search results array an array of search result objects, containing each of the product results shown on the search results page the search result object has the following properties position number the position of the result on the search results page product object the product object contains details about the product within the search result the product object has the following properties title string the product title link string the url to the product page brand string the brand name of the product, if shown brand link string a url to the brand landing page tcin string the product tcin (target product id) pass the tcin into a type=product request to get product level data about the product dpci string the target "department class item" id of the product sponsored boolean set to true when the search result is sponsored main image string the primary image url associated with the product images array an array of image urls for the product videos array an array of video objects containing string link and type properties for the url to the video, and its' mime type (i e video/mp4 ) class id string the target class id the product belongs to department id string the target department id the product belongs to rating number the customer rating of this product, out of 5 ratings total number the total number of customer ratings this product has received offers object the offers object contains details about the product offers the offers object has the following properties all offers array an array containing all of the offers, in the case of there being multiple the objects in the all offers array have the same properties as the primary offer object primary object primary offer object the primary offer object contains details about the primary seller offer for the product and has the following properties price number the price of the seller offer max price number the maximum price of the seller offer in the case of range pricing (min/max) min price number the minimum price of the seller offer in the case of range pricing (min/max) currency string the currency of the seller offer symbol string the currency symbol of the seller offer regular price number the regular, undiscounted price, if shown fulfillment object the fulfillment object contains details about the product delivery and pickup options the fulfillment object has the following properties type string the fulfillment model for the offer, values are be 1p sold and fulfilled by target 3p sold and fulfilled by third party seller seller object the seller object contains details the seller (populated when fulfillment type=1p ) it has the following properties name string the name of the seller of the buybox winning offer id string the id of the seller of the buybox winning offer related queries array related queries object an array containing details of any related queries shown on the search result page each object in the related queries array contains the following properties query string the related query search term text link number the url to the related query search results facets array facet object an array containing details of any available result facets (refinements) shown on the search result page you can use the facets returned here to refine your query by supplying facet information into the facets request parameter https //docs trajectdata com/redcircleapi/target product data api/parameters/search each object in the facets array contains the following properties name string the name of the facet display name string the display name of the facet (i e the user facing name) values array facet values array the facet values array shows the values of the given facet value string the value of the facet display name string the display name of the facet value (i e the user facing name of the facet value) id string the id of the facet, can be used in the facets request parameter https //docs trajectdata com/redcircleapi/target product data api/parameters/search categories array categories array an array containing details of the categories (i e subcategories) shown on the page you can use the id of a category to refine your query by supplying facet information into the category id request parameter https //docs trajectdata com/redcircleapi/target product data api/parameters/search each object in the categories array contains the following properties name string the name of the category id string the id of the category (can be used in the category id request parameter) pagination object pagination object an object containing details of the current results page and the total number of pages that are available to paginate you should specify the page number in your request's page parameter https //docs trajectdata com/redcircleapi/target product data api/parameters/search current object current page object contains details of the current page page number the current page number link string the current page url next object next page object contains details of the next page page number the next page number link string the next page url total pages number the total number of pages shown as being available total results number the total number of search results shown as being available next steps search parameters https //docs trajectdata com/redcircleapi/target product data api/parameters/search