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

Catalog management

Shopclues category structure

At shopclues we follow a tree structure for categories. At the top are the Meta categories, then these Meta categories have multiple Sub categories. These Sub categories have leaf nodes which are denoted by the Leaf categories. A product can be created only against a leaf category.

caption


Category APIs – The category APIs enable a merchant to use the Category ID or Product ID to check the product attributes such as MRP, selling price, stock count, shipping fees and product status. You can make the following API calls:

  • GET Category List
  • GET Feature List
  • GET Option List


Get Category List – To get the list of categories to which a product can be associated. The first call returns the meta categories. On subsequent calls, by quoting the category id of a category, a list of sub categories for the category are returned. You can add a product in only the leaf category�.


Get Feature List - This would be called on a leaf category and would return the list of features associated with the category. Details of all mandatory features of a particular category need to be provided to make the product live.�


Get Option List - This would give you the list of options that need to be considered for creating a variant for a product.�


Catalog APIs - Fetch product list and details, add, update and delete products�


  • Create product
  • Update product
  • Get product


Create product - To add a new product in your catalog�.

Update product/Inventory - Update price, quantity and status of a product.

Get product - To get list of products in your catalog and get product details for a specific product id�.


TYPE OF PRODUCTS

There are two types of products in Shopclues which is listed below.

  • Products with variants
  • Products without variants

To manage the catalog and inventory, integrate the following APIs as per your requirement:


CREATE PRODUCT PROCESS FLOW

To create a product you first need to call the Get category API which returns the list of Meta categories. On subsequent calls, by quoting the category id of a category, a list of sub categories for the category are returned. In this list of categories there are certain category specific details. They are as follows:�

  • category_id
  • category
  • is_leaf_category
  • has_options

Note: If the 'is_leaf_category' flag is Y then it indicates that the category is a leaf category.

You can create a product for a leaf category. To create a product you would need to call the GET features API to get the features associated with the category. When you call the GET features API quoting the feature id it returns the list of permissible values for that feature.

For each feature you would have the following informations:


  • FeatureId
  • FeatureName
  • FeatureType
  • IsFilterFeature
  • IsRequiredFeature

Note: Please ignore the feature id 53

Note: has_options flag identifies what kind of products can be added to this category. If the has_optons flag is Y then the products would have variants. To add variants in a product, you would have to call the GET options API which returns the list of options for a category. List of permissible values for each option can be fetched by call the GET options API by quoting the option id.

A variant is identified by combining the option ids (eg. If there are two options namely size (id: 626) and color (id: 728) then the variant is identified by combination of the ids 626_728 which forms the key and against this key you would have to pass the quantity as the value.

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.