Top
Developers Your place to code all things handmade

Welcome to the Shopclues Developer Platform

We believe in code as craft. Join the community of developers, creators and build tools that enrich the ways you can shop, sell and connect with the India's largest merchant base most easily.

Get Started

Register, Upload, Search and Connect

Explore Shopclues' marketplace of over 8.5 million products from over 3.5 lakh merchants. Connect buyers with the items they'll love.

Learn More About Catalog Management

Login, Integrate and Create

Build the best tools for Shopclues merchants. Simply login, Integrate and start developing you own apps.

Learn More About Start Developing
<
>
Jump to: navigation, search

Product Feed API

The product feed API returns 500 products per API call. For the next 500 products, increment the value of page parameter in the API call. Alternatively, for the next 500 products, the API URL may be obtained from next Url attribute in the response. The total number of pages in the specified interval is obtained in the total pages attribute in the response. Alternatively, the last page in the specified interval will have the next URL attribute as "NULL". The start_date and end_date parameters in the API call are used to specify the interval between which the product feed is required. If no start_date and end_date is mentioned, by default all the active products are fetched by the API, i.e. start_date is considered to be 0 and end_date is considered to be the current date. The output formats available are JSON/XML (JSON being the default) and can be toggled using the output parameter. If only products belonging to a particular category is required, then the cat_id parameter may be used to specify the required category id.

METHOD = GET
SUPPORTED FORMAT = JSON/XML,
SERVICE NAME = productfeed

Headers

Field name Description Mandatory
Header - “Authorization” Token with token type to identify user created using api call above.”Bearer bc1f461de" Yes
Header - “Content-Type” Input Content Type here it would be “application/json" Yes

Details of return parameters :

Variable Description
status Api status if 1: implies success , 0:implies fail error.
message Text response message
data Detailed information of product with all required parameters.
page Represents the page number of the products. The default value is 0.
start_date Represents the starting date of the interval for pulling products (YYYY-MM-DD)Default value is 0.
end_date Represents the end date of the interval for pulling products (YYYY-MM-DD) Default
value is the current date.
output Represents the format for the API response( Values= json(for JSON output) and xml (for XML). By default, output is JSON.
cat_id Represents the category ID for which the products are required. Only one category ID
may be specified per request. If no category ID is specified, products from all categories are
returned.Response Fields
nextUrl Contains the next URL to be called to obtain the next 500 products
noofproducts: This contains the number of products in the current response. This is fixed at 500 in this version of the API.
totalpages Total number of pages to be called
totalproducts Total number of active products
productInfoList Contains the products information


  • JSON
  • PHP
Production Url for json output -
http://developer.shopclues.com/api/v1/productfeed?output=json
Production Url for json output -
http://developer.shopclues.com/api/productfeed?page=0&start_date=<START_DATE>&end_date=<END_DATE>
Production Url for json output -
http://developer.shopclues.com/api/productfeed?cat_id=1234
Production Url for json output -
http://developer.shopclues.com/api/productfeed?product_id=123456
Production Url for json output -
http://developer.shopclues.com/api/productfeed?merchant_id=1234
sandbox Url for json output -
http://sandbox.shopclues.com/api/v1/productfeed?output=json
sandbox Url for json output -
http://sandbox.shopclues.com/api/productfeed?page=0&start_date=<START_DATE>&end_date=<END_DATE>
sandbox Url for json output -
http://sandbox.shopclues.com/api/productfeed?cat_id=1234
sandbox Url for json output -
http://sandbox.shopclues.com/api/productfeed?product_id=123456
sandbox Url for json output -
http://sandbox.shopclues.com/api/productfeed?merchant_id=1234

Sample JSON RESPONSE


 {
  "status": 1,
  "code": 200,
  "message": "success",
  "data": [
    {
      "ID": "75870374",
      "link": "http://www.shopclues.com/freshlook-one-day-10-lenses-pack-pure-hazel-flddph-325.html",
      "title": "Freshlook one Day 10 Lenses Pack Pure Hazel FLDDPH325",
      "Category Id": 9691,
      "price": 900,
      "Discount (percentage)": "11%",
      "image link": "http://cdn.shopclues.com/images/thumbnails/19261/320/320/71dm4SgcGgL1433657884.jpg",
      "Meta category": "Aspheric",
      "sale price": 800,
      "Brand": null,
      "Product Rating": 0,
      "Merchant Rating": 0,
      "google product category": null,
      "product_description": "Focus Dailies Lightstream Technology",
      "availability": false,
      "condition": "New",
      "Deal": "No",
      "Category Path": "Fashion>Eye Wear OLD >Contact Lens>Aspheric",
      "Customer_type": null,
      "Gender": null,
      "shipping_charges": 0,
      "COD": "N",
      "status": "A",
      "cod_fee": 30,
      "is_master": "N",
      "master_id": "0",
      "updated_at": "2016-04-01T09:03:17Z"
    }
  ],
  "extra": {
    "nextUrl": "developer.shopclues.com/api/productfeed?page=2&start_date=&end_date=",
    "noofproducts": 500,
    "totalpages": 12715,
    "totalproducts": 6357048
  }
}

Sample ERROR Response:

{
    "status": "401",
    "message": "Error",
    "data": null
}
  • Production Url for XML output -
    http://developer.shopclues.com/api/productfeed?output=xml
  • sandbox Url for XML output -
    http://sandbox.shopclues.com/api/productfeed?output=xml

Sample XML Response



<?xml version="1.0"?>
<root>
    <status>1</status>
    <message>success</message>
    <nextUrl>developer.shopclues.com/api/productfeed?output=xml&page=2&start_date=&end_date=</nextUrl>
    <noofproducts>500</noofproducts>
    <totalpages>12799</totalpages>
    <totalproducts>6399277</totalproducts>
    <productInfoList>
        <item0>
            <ID>75870374</ID>
            <link>http://www.shopclues.com/freshlook-one-day-10-lenses-pack-pure-hazel-flddph-325.html</link>
            <title>Freshlook one Day 10 Lenses Pack Pure Hazel FLDDPH325</title>
            <CategoryId>9691</CategoryId>
            <price>900</price>
            <DiscountPercentage>11%</DiscountPercentage>
            <imagelink>http://cdn.shopclues.com/images/thumbnails/19261/320/320/71dm4SgcGgL1433657884.jpg</imagelink>
            <MetaCategory>Aspheric</MetaCategory>
            <salePrice>800</salePrice>
            <Brand/>
            <ProductRating>0</ProductRating>
            <MerchantRating>0</MerchantRating>
            <googleProductCategory/>
            <product_description>Focus Dailies Lightstream Technology</product_description>
            <availability></availability>
            <condition>New</condition>
            <Deal>No</Deal>
            <CategoryPath>Fashion>Eye Wear OLD >Contact Lens>Aspheric</CategoryPath>
            <Customer_type/>
            <Gender/>
            <shipping_charges>0</shipping_charges>
            <COD>N</COD>
            <status>A</status>
            <cod_fee>30</cod_fee>
            <is_master>N</is_master>
            <master_id>0</master_id>
            <updated_at>2016-04-01T09:03:17Z</updated_at>
        </item0>
    </productInfoList>
</root> 

</div>

Click here for access token documentation.
<?php
$token="<token>";
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "http://sandbox.shopclues.com/api/v1/productfeed?output=json");
curl_setopt($ch,CURLOPT_HTTPHEADER,array('Content-Type: application/json',
  'Authorization: Bearer .$token'));
curl_setopt($ch, CURLOPT_HEADER, 0);
curl_exec($ch);
curl_close($ch);

?>
 

Looking for ShopClues Apps?

Check out our new
App Gallery!

It's the best way to find cool and useful tools built upon Shopclues's API.