Core APIs
...
Parameters
Stock
Store Stock
4min
store stock parameters get get /request the store stock parameters are applicable when making a request with type=store stock to retrieve in store stock information of a single product on target the product is specified using either the tcin dpci or url parameter (where the url parameter contains a link to an target product page) the parameters should be appended as querystring parameters to the target product data api get http request the location to perform the search is specified using the store stock zipcode parameter up to 20 stores within a 50 mile radius of the specified zipcode will be returned store stock zipcode vs customer zipcode parameters when making type=store stock requests the store stock zipcode parameter is used this is a distinct parameter only used for store stock requests it is unrelated to the customer zipcode parameter used for geolocation in other request types there is no need to set up zipcodes used in the store stock store stock zipcode parameter in the zipcodes api prior to use, and they do not count towards your zipcodes quota you may use the only in stock=true parameter to limit your results to only those stores that have stock of the requested tcin store stock details are retrieved from the store stock check page https //www target com/p/sharpie 4pk highlighters pocket style chisel tip multicolor/ /a 78025470 for a single product on target for example, to request store stock details a product with tcin=78025470 in stores near to store stock zipcode=52404 the request would be http https //api redcircleapi com/request?api key=demo\&type=store stock\&tcin=78025470\&store stock zipcode=52404curl l get https //api redcircleapi com/request \\ d api key="demo" \\ d type="product" \\ d tcin="78025470" \\ d store stock zipcode="52404"const axios = require('axios'); // set up the request parameters const params = { api key "demo", type "product", tcin "78025470", store stock zipcode "52404" } // 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' 'product', 'tcin' '78025470', 'store stock zipcode' '52404' } \# 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' => 'product', 'tcin' => '78025470', 'store stock zipcode' => '52404' ]); \# 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; ?> store stock parameters the following parameters are available for all requests made when type=store stock parameter required description tcin optional the target tcin (item id) to retrieve store stock details for dpci optional the dpci code to look up a matching product on target for to retrieve store stock data dpci based requests work by searching for the dpci on target first, then retrieving the store stock details for the first matching tcin gtin optional the gtin/isbn/upc code to look up a matching product on target for to retrieve store stock data if the gtin parameter is supplied then the tcin and dpci parameters are ignored gtin based requests work by searching for the gtin/isbn/upc on target first, then retrieving the store stock details for the first matching tcin url optional the target product page url to retrieve store stock details from note if the url parameter is supplied then the tcin , dpci and gtin parameters are ignored the url must be a valid target product page url store stock zipcode required the zipcode to use to search for nearby store stock results up to 20 stores within a 50 mile radius are returned note that store stock zipcode is a distinct parameter only used for store stock requests it is unrelated to the customer zipcode parameter used for geolocation in other request types there is no need to set up zipcodes used in the store stock store stock zipcode parameter in the zipcodes api prior to use, and they do not count towards your zipcodes quota only in stock optional set to true to limit your results to only those stores that have stock of the requested tcin defaults to false (to include all stores within a 50 mile radius of the requested store stock zipcode , irrespective of whether they have stock of the requested tcin ) next steps store stock results https //docs trajectdata com/redcircleapi/target product data api/results/store stock