Core APIs
...
Results
Stock

Store Stock

3min

Store Stock Results

When making a request with the type parameter set to type=store_stock RedCircle API will 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 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 in the store_stock_results array.

Store stock details are retrieved from the store stock check page for a single product on Target.

Store Stock Page
Store Stock Page


An example of the JSON object returned from an Store Stock request is shown below:

JSON


RedCircle API returns the following properties for Store Stock requests:

Property

Type

Description

store_stock_results

array

An array containing up to 20 Store Stock objects showing in-store stock status for the requested tcin in stores within a 50-mile radius of the requested store_stock_zipcode .

  • position
  • string
  • The position of the result in the store_stock_results array.



  • in_stock
  • boolean
  • Set to true if this store has stock of the given tcin , otherwise false .



  • stock_level
  • number
  • The quantity of stock available in the given store, if shown.



  • address
  • string
  • The address of the store the request was run in.



  • city
  • string
  • The city the request was run in.



  • state
  • string
  • The state the request was run in.



  • zipcode
  • string
  • The zipcode the request was run in.



  • phone
  • string
  • The phone number of the store, if shown.



  • store_name
  • string
  • The name of the store that the request was run from.



  • store_id
  • string
  • The ID of the store that the request was run from.



  • distance
  • number
  • The distance, in fractional miles, of the store from the zipcode specified in the store_stock_zipcode request parameter.

product

object

An object containing details of the product for which in-store stock data was requested.

  • tcin
  • string
  • The product TCIN (Target product ID).



  • dpci
  • string
  • The Target "Department - Class - Item" ID of the product.


Next Steps      Store Stock Parameters