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 Option List

This API provides the list of available options (Ex.- Size, Color etc) for any category.

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

Parameter

Parameter Name ?Example
category_id ?category_id=1371

Fields description

Sr. No. Field Visibility Level Type Description
1. OptionId public int Unique id assigned to any option.
2. OptionName public string Name of the option.
3. OptionType public char Tells about the method of selection of the options (ex- Drop down box, Radio Button, Check box etc)
4. TrackWithInventory public char If option's inventory can be tracked.
5. Description public string Gives us the categories in which that option is available.
6. IsMandatory public char Denotes if it is a mandatory feature.

Option type detail

Feature Type Description
S Dropdown list allows the user to select a single option out of a large number of items.
R Defined on a Radio Group.
C Single Check Box .
I Defined on a Text.
T Text Area.
F Defined on a file (For Upload option).

Get option by option id

To list the variants available for a particular option (ex- For Size option, the variants are Small, Medium, Large, Extra Large etc)

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:

Get option by category id

Production url:
http://developer.shopclues.com/api/v1/option?category_id=1371
Sandbox url:
http://sandbox.shopclues.com/api/v1/option?category_id=1371

Sample JSON response


{
  "status": 1,
  "code": 200,
  "message": "success",
  "data": {
    "273438": {
      "OptionId": "273438",
      "OptionName": "Color",
      "OptionType": "S",
      "TrackWithInventory": "Y",
      "Description": "fashion, automotive",
      "IsMandatory": "N"
    },
    "425432": {
      "OptionId": "425432",
      "OptionName": "Size-Women-Upper",
      "OptionType": "S",
      "TrackWithInventory": "Y",
      "Description": "Women Tshirt",
      "IsMandatory": "N"
    }
  },
  "extra": {
    "count": 2
  }
}


Production url:
http://developer.shopclues.com/api/v1/option/{option_id}
Sandbox url:
http://sandbox.shopclues.com/api/v1/option/{option_id}


Sample JSON response

{
  "status": 1,
  "code": 200,
  "message": "success",
  "data": [
    {
      "VariantId": "1056205",
      "VariantName": "S"
    },
    {
      "VariantId": "1056207",
      "VariantName": "M"
    }
  ],
  "extra": {
    "count": 2
  }
}

Sample Error response

{
  "status": 0,
  "code": 200,
  "message": "OK",
  "data": {
    "message": "No data or invalid option id"
  },
  "extra": {
    "count": 0
  }
}

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.