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

Get Product API

Lists all the available product in the catalog. By default, 25 products will be listed on a page.

METHOD = GET

Headers

Field name Description Mandatory
Header - “Authorization” Access token is passed to identify the user. Eg- ”Bearer bc1f461de4f193" Yes
Header - “Content-Type” Input Content Type here it would be “application/json" Yes


Fields description

Sr. No. Field Visibility Level Type Description
1. product_id public int Unique id assigned to every category.
2. product_code public int Specific code for the product.
3. product_group public string ===
4. status public string/char Current status of the product in catalog.
5. company_id public int Identifies company or merchant.
6. list_price public int RSP
7. third_price public int ===
8. last_update public string Time when the product was the last updated
9. Tracking public string =====
10. Price public int Price of the product.
11. product_name public string Name of the product.
12. Product public string Name of the product.
13. Quantity public int Quantity available of the product
14. under_promotion public char If product is under any promotional activity.
15. image public string Path of product’s image.
16. category_id public int Category in which product is tagged (Always the leaf category).
17. hsn_code public int hsn code of product(GST)

Status type detail

Feature Type Description
A Active.
B Disapproved.
D Disabled
F Feature missing
H Hidden
R Request Approval
X Deleted
Z Image Processing

Description of Fields

parameter name Description
additional_fields ?additional_fields=product_id,status,company_id

Additional Field Description

Field Visibility Level Permission Scope Type Description
category_name public none int The identifier for the product.
main_image_thumbnails public none int The specific code for the product.
product_variants public none string This represents variants for size and/or color options in the product.
meta_category_id Public None int Represents meta category of the product.
Additional_category_ids Public None int Represents other categories in which the product is to be added.
Discount_percentage Public None int The discount percentage offered on the product.
pdp_url Public None String The url for the current product.

Using Filters

To get list of products on the basis of defined filters.

Filter List

Field name Description
Status This tells us about the status of the product.

A – Active
X – Deleted
D – Disabled
F – Feature Missing
H – Hidden
R – Request Approval
W - POS Active
Z - POS Disabled

product_groups This is used, if you have few products in a particular group, it will return the complete set of products you have in that group.
Product_id This is for getting the complete information about a particular product.
page This is for pagination purpose

Combination of filters, selected fields and additional fields

If you want to combine some selected fields, additional fields and filters then you need to pass the additional_fields param as query string with additional fields separated by commas.

Parameter Name Example
additional_fields ?additional_fields=main_image_thumbnails,
discount_percentage,pdp_url,meta_category_id

,product_variants,category_name,meta_category_id,

Get Product Details

To get complete description of a specific product.

METHOD = GET

Details of Return Parameters

Fields Description
status API status

1: implies API responded successfully
0: implies validation failed

code
message Text response message
data Detailed information of the order with all required parameters.
extra It shows total records as well as pagination link
Total:
First:
Last:
Previous:
Next:

Fields selection

If you want to see only selected fields then you may pass those fields param as query string with the fields separated by commas.

Fields description

Parameter name Description
Fields ?fields=product_id,status,company_id

Additional Fields

You can get some additional fields by simply passing the additional_fields param as query string with additional fields separated by commas.

  • Production URL :
     http://developer.shopclues.com/api/v1/product
  • Sandbox URL :
    http://sandbox.shopclues.com/api/v1/product

Sample JSON Response

{
  "status": 1,
  "code": 200,
  "message": "success",
  "data": [
    {
      "product_id": "101069544",
      "product_code": "101069544",
      "product_group": "0",
      "status": "A",
      "company_id": "14",
      "list_price": "2113.00",
      "third_price": "0.00",
      "last_update": "2017-06-19 13:50:13",
      "tracking": "B",
      "quantity": "30",
      "price": "2113.00",
      "final_price": "2113.00",
      "product_name": "Darco D5400 80/20 Bronze Acoustic Guitar Strings, Extra Light",
      "product": "Darco D5400 80/20 Bronze Acoustic Guitar Strings, Extra Light",
      "combination_hash": null,
      "variant_amount": null,
      "under_promotion": "N",
      "image": "cdn.shopclues.com/images/no_image.gif",
      "category_id": "40451",
      "hsn_code": "10011090"
    }
  ],
  "extra": {
    "total": 69,
    "first": "http://developer.shopclues.com/api/v1/product?page=1",
    "last": "http://developer.shopclues.com/api/v1/product?page=3",
    "previous": "",
    "next": "http://developer.shopclues.com/api/v1/product?page=2"
  }
}


'Sample error response

{ 
   "status": 1, 
   "code": 200, 
   "message": "Success", 
   "data": { 
       "product_id": 121532257, 
       "variants": [] 
   }, 
   "extra": "Successful" 
} 
Production URL :
http://developer.shopclues.com/api/v1/product?fields=product_id,status,company_id
Sandbox URL :
 http://sandbox.shopclues.com/api/v1/product?fields=product_id,status,company_id

Sample JSON response

{ 
"status": 1, 
"code": 200, 
"message": "success", 
"data": [ 
    { 
        "product_id": "101069544", 
        "product_code": "101069544", 
        "product_group": "0", 
        "status": "A", 
        "company_id": "14", 
        "list_price": "2113.00", 
        "third_price": "0.00", 
        "last_update": "2017-06-19 13:50:13", 
        "tracking": "B", 
        "quantity": "30", 
        "price": "2113.00", 
        "final_price": "2113.00", 
        "product_name": "Darco D5400 80/20 Bronze Acoustic Guitar Strings, Extra Light", 
        "product": "Darco D5400 80/20 Bronze Acoustic Guitar Strings, Extra Light", 
        "combination_hash": null, 
        "variant_amount": null, 
        "under_promotion": "N", 
        "image": "cdn.shopclues.com/images/no_image.gif", 
        "category_id": "40451", 
        "hsn_code": "10011090" 
    } 
], 
"extra": { 
    "total": 69, 
    "first": "http://developer.shopclues.com/api/v1/product?page=1", 
    "last": "http://developer.shopclues.com/api/v1/product?page=3", 
    "previous": "", 
    "next": "http://developer.shopclues.com/api/v1/product?page=2" 
} 
} 
Production URL:
http://developer.shopclues.com/api/v1/product?<br>additional_fields=discount_percentage,pdp_url,category_name,main_image_thumbnails,<br>product_variants,
meta_category_id,additional_category_ids
Sandbox URL:
http://sandbox.shopclues.com/api/v1/product?
<br>additional_fields=discount_percentage,pdp_url,category_name,main_image_thumbnails,<br>product_variants,meta_category_id,additional_category_ids

Sample JSON response

{
  "product_id": "84410776",
  "product_code": "",
  "product_group": "0",
  "status": "A",
  "company_id": "145939",
  "list_price": "999.00",
  "third_price": "0.00",
  "last_update": "2016-03-22 11:19:46",
  "tracking": "O",
  "price": "450.00",
  "product_name": "Oricum Footwear",
  "product": "Oricum Footwear",
  "quantity": "50",
  "under_promotion": "N",
  "image": "http://cdn.shopclues.com/images/thumbnails/27656/160/160/IMG298014336581601457952167.jpg",
  "main_image_thumbnails": {
    "50X50": "cdn.shopclues.com/images/thumbnails/27656/50/50/IMG298014336581601457952167.jpg",
    "60X60": "cdn.shopclues.com/images/thumbnails/27656/60/60/IMG298014336581601457952167.jpg",
    "160X160": "cdn.shopclues.com/images/thumbnails/27656/160/160/IMG298014336581601457952167.jpg",
    "320X320": "cdn.shopclues.com/images/thumbnails/27656/320/320/IMG298014336581601457952167.jpg"
  },
  "category_id": "251",
  "category_name": "Slippers & Flip Flops",
  "meta_category_id": "89/186/251",
  "pdp_url": "http://www.shopclues.com/oricum-footwear-494.html",
  "discount_percentage": 54.95,
  "product_variants": [
    {
      "SKU": "",
      "combination_hash": "2177045918",
      "Amount": "76",
      "option_name": {
        "352151": "Size - EUR or IND"
      },
      "variant_name": {
        "4741555": "7(IND/UK)"
      },
      "options": {
        "Size - EUR or IND": "7(IND/UK)"
      }
    }
  ]
}
Example URL For Filters:
http://developer.shopclues.com/api/v1/product?status=A,D

Sample Json Response

{
  "status": 1,
  "code": 200,
  "message": "success",
  "data": [
{
  "product_id": "91617607",
  "product_code": "91617607",
  "product_group": "0",
  "status": "D",
  "company_id": "126029",
  "list_price": "1009.00",
  "third_price": "0.00",
  "last_update": "2016-05-02 16:55:43",
  "tracking": "B",
  "price": "391.00",
  "product_name": "Pedi Spin Ultimate Foot Smoothing Tool /Electronic Foot Callus Removal Kit",
  "product": "Pedi Spin Ultimate Foot Smoothing Tool /Electronic Foot Callus Removal Kit",
  "quantity": "60",
  "under_promotion": "Y",
  "image":    "http://cdn.shopclues.com/images/thumbnails/36309/160/160/PEDISPIN14414399621461356764.jpg",
  "category_id": "541"
},
{
  "product_id": "91042834",
  "product_code": "91042834",
  "product_group": "0",
  "status": "A",
  "company_id": "126029",
  "list_price": "1000.00",
  "third_price": "0.00",
  "last_update": "2016-04-27 21:54:20",
  "tracking": "B",
  "price": "350.00",
  "product_name": "White Pearl Jura (Bun) Ring",
  "product": "White Pearl Jura (Bun) Ring",
  "quantity": "1",
  "under_promotion": "N", "image":    "http://cdn.shopclues.com/images/thumbnails/35617/160/160/juraclipp1460707518.jpg",
  "category_id": "541"
}
}

Example URL: http://sandbox.shopclues.com/api/v1/product?additional_fields=main_image_thumbnails,
discount_percentage,pdp_url,meta_category_id,product_variants,category_name,meta_category_id,&status=A,D

{
  "product_id": "84410776",
  "product_code": "",
  "product_group": "0",
  "status": "A",
  "company_id": "145939",
  "list_price": "999.00",
  "third_price": "0.00",
  "last_update": "2016-03-22 11:19:46",
  "tracking": "O",
  "price": "450.00",
  "product_name": "Oricum Footwear",
  "product": "Oricum Footwear",
  "quantity": "50",
  "under_promotion": "N",
  "image":     "http://cdn.shopclues.com/images/thumbnails/27656/160/160/IMG298014336581601457952167.jpg",
  "main_image_thumbnails": {
  "50X50": "cdn.shopclues.com/images/thumbnails/27656/50/50/IMG298014336581601457952167.jpg",
  "60X60": "cdn.shopclues.com/images/thumbnails/27656/60/60/IMG298014336581601457952167.jpg",
  "160X160": "cdn.shopclues.com/images/thumbnails/27656/160/160/IMG298014336581601457952167.jpg",
  "320X320":   "cdn.shopclues.com/images/thumbnails/27656/320/320/IMG298014336581601457952167.jpg"

},
  "category_id": "251",
  "category_name": "Slippers & Flip Flops",
  "meta_category_id": "89/186/251", "pdp_url": "http://www.shopclues.com/oricum-footwear-                    494.html",
  "discount_percentage": 54.95,
  "product_variants": [

{
  "SKU": "",
  "combination_hash": "2177045918",
  "Amount": "76",
  "option_name": {
  "352151": "Size - EUR or IND"
},
  "variant_name": {
  "4741555": "7(IND/UK)"
},
  "options": {
  "Size - EUR or IND": "7(IND/UK)"
}
}
]
}

Sample Json Response

{ 
   "status": 1, 
   "code": 200, 
   "message": "success", 
   "data": { 
       "product_id": 121141490, 
       "product_code": "12390", 
       "product_group": "0", 
       "seo_name": "http://www.shopclues.com/.html?utm_soa=19AVVRJFIMYG1CZCBY7QIH99IO64PX", 
       "merchant_reference_number": "SS1123", 
       "manufacturer_reference_number": "", 
       "manufacturer_reference_type": "", 
       "status": "F", 
       "company_id": "14", 
       "list_price": "28899.00", 
       "third_price": "0.00", 
       "amount": "0", 
       "weight": "0.00", 
       "shipping_freight": 0, 
       "timestamp": "1498026388", 
       "tracking": "O", 
       "free_shipping": "", 
       "avail_since": "0", 
       "last_update": "2017-06-21 14:49:36", 
       "is_cod": "Y", 
       "show_size_chart": "N", 
       "product": "newproduct", 
       "full_description": "newest my name product hii", 
       "meta_keywords": "", 
       "meta_description": "", 
       "search_words": "", 
       "page_title": "", 
       "price": "2134.00", 
       "category_ids": { 
           "218": "M" 
       }, 
       "main_category": 218, 
       "main_pair": { 
           "image_id_v1": "60939403", 
           "detailed": { 
               "http_image_path": "cdn.shopclues.com/images/no_image.gif", 
               "image_path": "http://cdn.shopclues.com" 
           } 
       }, 
       "image_pairs": [], 
       "taxes": [], 
       "prices": [ 
           { 
               "price": "2134.00", 
               "shipping_charge": "0.00", 
               "lower_limit": "1", 
               "usergroup_id": "0" 
           } 
       ], 
       "product_features": { 
           "63": { 
               "feature_id": "63", 
               "feature_type": "G", 
               "parent_id": "0", 
               "display_on_product": "1", 
               "display_on_catalog": "0", 
               "description": "What's in a Box", 
               "prefix": "", 
               "suffix": "", 
               "categories_path": "455,99,458,87,89,480,175,337,85,460,453,129,180,95,119,113,93,111,181,177,493,372,648,642,461,683", 
               "full_description": "List of items that get shipped in the box", 
               "creation_time": "2015-10-07 12:46:52", 
               "status": "A", 
               "comparison": "N", 
               "position": "65534", 
               "is_key": "0", 
               "is_filter_feature": "N", 
               "required_feature": "N", 
               "hidden_from_merchant": "1", 
               "update_time": "0", 
               "group_position": null, 
               "value": null, 
               "variant_id": null, 
               "value_int": null, 
               "variant": null 
           }, 
"under_promotion": "N", 
       "hsn_code": "10011090", 
  
       ] 
   }, 
   "extra": [] 
} 

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.