Catalog
Manages product catalogs, including adding, updating, and deleting products, as well as categorizing them.
Brand
A brand represents a specific brand or manufacturer associated with a product. Brands help customers identify and differentiate products based on their manufacturer or designer. Each brand typically has a unique identifier and a name. For example, a clothing platform might have brands such as "Nike," "Adidas," "Gucci," and "Zara." Our Brand APIs facilitate access to brand-related data, offering functionalities such as retrieving list of available brands and obtaining detailed information about a specific brand using its unique slug.
Operations
GET
# List brands
GET
# Get a brand
GET
List brands
Get a list of all the available brands. Filtering can be applied to the department.
Parameters
department
string
The name of the department. Use this parameter to filter products by a particular department. See the list of available departments below. Also, you can get available departments from the endpoint /service/application/catalog/v1.0/departments/.
Enum
pageNo
integer
The page number to navigate through the given set of results.
Default Value : 1
pageSize
integer
The number of items to retrieve in each page.
Default Value : 12
Response
200
4XX
Success. Returns a paginated list of brands. Check the example shown below or refer `BrandListingResponse` for more details.
BrandListingResponse
items
array of object (BrandItem)
List of brand items included in the response.
Array of BrandItem
page
object (Page)
Page
Examples
Parameters
department:
"value"
pageNo:
0
pageSize:
0
Was this section helpful?
GET
Loading...
Response
Loading...
List brands
getBrands
GET
Get a brand
Get metadata of a brand such as name, information, logo, banner, etc.
Parameters
slug
string
Required
A short, human-readable, URL-friendly identifier of a brand. You can get slug value from the endpoint /service/application/catalog/v1.0/brands/.
Response
200
4XX
Success. Returns a metadata object. Check the example shown below or refer `BrandDetailResponse` for more details.
BrandDetailResponse
logo
object (Media)
Media
uid
integer
The unique identifier for the brand.
description
string
Detailed description of the brand, including its history, values, product offerings, and other relevant information.
banners
object (ImageUrls)
ImageUrls
_custom_json
object
Custom JSON data related to the brand, allowing for additional metadata.
name
string
Name of the brand.
Examples
Parameters
slug:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get a brand
getBrandDetailBySlug
Category
Categories are hierarchical structure that enables a systematic organization of products for better discoverability of products on storefront. Categories are structured into three levels: L1, L2, and L3, with L1 representing the top-level category, followed by L2 and L3. For example - Clothing(L1) >> Shirts(L2) >> Formal Shirts(L3) A single L1 category can encompass multiple L2 categories underneath it, and similarly, an L2 category can contain multiple L3 categories within it. Category is a sales-channel specific configuration. While categories are common across all companies, sales channel can configure L3 category names tailored to their unique requirements.
Operations
GET
# List product categories
GET
# Get category by slug
GET
List product categories
List all available product categories. Also, users can filter the categories by department.
Parameters
department
string
The name of the department. Use this parameter to filter products by a particular department. See the list of available departments below. Also, you can get available departments from the endpoint /service/application/catalog/v1.0/departments/.
Enum
Response
200
4XX
Success. Returns a list of categories. Check the example shown below or refer `CategoryListingResponse` for more details.
CategoryListingResponse
data
array of object (DepartmentCategoryTree)
List of department category trees.
Array of DepartmentCategoryTree
departments
array of object (DepartmentIdentifier)
List of departments.
Array of DepartmentIdentifier
Examples
Parameters
department:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List product categories
getCategories
GET
Get category by slug
Get detailed information about a specific product category using its slug and get metadata of a category such as name, information, logo, banner, etc.
Parameters
slug
string
Required
A short, human-readable, URL-friendly identifier of a brand. You can get slug value from the endpoint /service/application/catalog/v1.0/brands/.
Response
200
4XX
Success. Returns metadata of a category. Check the example shown below or refer `CategoryMetaResponse` for more details.
CategoryMetaResponse
logo
object (Media)
Media
uid
integer
Unique identifier for the category.
banners
object (ImageUrls)
ImageUrls
_custom_json
object
Custom JSON data related to the category, allowing for additional metadata.
name
string
Name of the category.
Examples
Parameters
slug:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get category by slug
getCategoryDetailBySlug
Collection
A collection is a grouping of products that sellers can create to make their stores easier to browse. For example, a seller might create a collection for a specific type of product by latest fashion trend or season, such as Summer collection or streetwear collection. Collections can be rule based on conditions like specific brand, category, etc. or a custom collection which can be comprised of handpicked products. Retrieve a list of collections, access items within a specific collection using its slug or unique identifier, and obtain detailed information about a specific collection, including its title, description, and associated items. This resource streamlines the management of curated sets of products, services, or other items., retrieve, update, and delete collections. Add and retrieve items within collections for organized content management.
Operations
GET
# List collections
GET
# Lists items of collection
GET
# Get a collection
GET
List collections
List of curated product collections with filtering options based on tags and collection names.
Parameters
pageNo
integer
The page number to navigate through the given set of results.
Default Value : 1
pageSize
integer
The number of items to retrieve in each page.
Default Value : 12
tag
array of string
List of tags to filter collections.
Minimum Items : 1
q
string
Name of the collection to filter collection.
Response
200
4XX
Success. Returns a list of collections. Check the example shown below or refer `GetCollectionListingResponse` for more details.
GetCollectionListingResponse
items
array of object (GetCollectionDetailNest)
An array of collection details. Each item in the array represents a collection with various attributes and configurations.
Array of GetCollectionDetailNest
filters
object (CollectionListingFilter)
CollectionListingFilter
page
object (Page)
Page
Examples
Parameters
pageNo:
0
pageSize:
0
tag:
"lorem","ipsum"
q:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List collections
getCollections
GET
Lists items of collection
Fetch items within a particular collection identified by its slug.
Parameters
slug
string
Required
A short, human-readable, URL-friendly identifier of a collection. You can get slug value from the endpoint /service/application/catalog/v1.0/collections/.
f
string
The search filter parameters. Filter parameters will be passed in f parameter as shown in the example below. Double Pipe (||) denotes the OR condition, whereas Triple-colon (:::) indicates a new filter parameter applied as an AND condition.
q
string
The search query for entering partial or full name of product, brand, category, or collection.
filters
boolean
True for fetching all filter parameters and False for disabling the filter parameters.
Default Value : true
sortOn
string
The order in which the list of products should be sorted, e.g. popularity, price, latest and discount, in either ascending or descending order. See the supported values below.
Enum
pageId
string
Page ID to retrieve next set of results.
Default Value : 1
pageSize
integer
The number of items to retrieve in each page.
Default Value : 12
pageNo
integer
Page Number to retrieve next set of results.
Default Value : 1
pageType
string
Page Type to retrieve set of results can be cursor or number.
Response
200
4XX
Success. Returns a list items in a given collection. Check the example shown below or refer `ProductListingResponse` for more details.
ProductListingResponse
items
array of object (ProductListingDetail)
List of product details included in the response.
Array of ProductListingDetail
filters
array of object (ProductFilters)
List of filters available for refining the product listings.
Array of ProductFilters
page
object (Page)
Page
sort_on
array of object (ProductSortOn)
List of sorting options available for the product listings.
Array of ProductSortOn
Examples
Parameters
slug:
"value"
f:
"value"
q:
"value"
filters:
false
sortOn:
"value"
pageId:
"value"
pageSize:
0
pageNo:
0
pageType:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Lists items of collection
getCollectionItemsBySlug
GET
Get a collection
Get detailed information about a specific collection using its slug.
Parameters
slug
string
Required
A short, human-readable, URL-friendly identifier of a collection. You can get slug value from the endpoint /service/application/catalog/v1.0/collections/.
Response
200
4XX
Success. Returns a Collection object. Check the example shown below or refer `CollectionDetailResponse` for more details.
CollectionDetailResponse
is_active
boolean
Indicates whether the collection is active.
sort_on
string
Criteria used to sort the items within the collection, such as price, popularity, or newest first.
meta
object
Metadata associated with the collection.
banners
object (ImageUrls)
ImageUrls
cron
object
Cron schedule details related to the collection, if applicable.
_schedule
object
Schedule details for the collection, including timing and duration information.
query
array of object (CollectionQuery)
Search or filter query used to dynamically generate the collection based on specific criteria or conditions.
Array of CollectionQuery
description
string
Detailed description of the collection,.
type
string
Type of collection, specifying the nature or category of the collection.
_custom_json
object
Custom JSON object containing additional properties specific to the collection.
name
string
The name of the collection.
allow_sort
boolean
Indicates if sorting is allowed for this collection.
visible_facets_keys
array of string
Keys of the facets visible for filtering within the collection.
badge
object
Badge information associated with the collection.
slug
string
The URL-friendly identifier for the collection.
allow_facets
boolean
Indicates if facets are allowed for filtering within the collection.
logo
object (Media)
Media
priority
integer
Priority level of the collection for sorting or display purposes.
tag
array of string
Tags associated with the collection.
app_id
string
Application ID associated with the collection.
Examples
Parameters
slug:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get a collection
getCollectionDetailBySlug
Department
A department categorizes products into different sections or categories based on their type or purpose. Departments help organize products in a logical manner, making it easier for customers to navigate the product catalog. Each department typically has a unique identifier and a name. For example, a clothing ecommerce platform might have departments such as "Men's Clothing," "Women's Clothing," "Accessories," and "Footwear." You can retrieve a list of all departments associated with available products, facilitating easy navigation and organization of products based on departmental categorization. Additionally, the APIs allow you to list all products associated with a specific brand, collection, or category in a random order, enhancing user engagement and discovery within your application
Operations
GET
# List departments
GET
List departments
List all departments associated with available products.
Parameters
No Parameters
Response
200
4XX
List of Departments. See example below or refer `DepartmentResponse` for details.
DepartmentResponse
items
array of object (Department)
List of department detail objects.
Array of Department
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
List departments
getDepartments
Follow and Unfollow
Customers have the ability to follow or unfollow specific products based on their preferences, allowing them to curate a list of favorites. This feature enables users to manage their preferences and interactions with different content or entities. By retrieving a list of products or brands they are following, customers can easily keep track of their interests. They can remove items, brands, or products from their followed list using the collection ID, and add new ones using the same ID. Additionally, customers can find out how many other users are following a specific item and get the IDs of all the items they are currently following, whether they are products, brands, or collections.
Operations
GET
# List followed products, brands
DEL
# Delete item, brand, product
POST
# Create item, brand, product
GET
# Get follower count
GET
# List Ids of followed item, brand, product
GET
List followed products, brands
Get a list of products or brands the user is following.
Parameters
collectionType
string
Required
Type of collection followed, i.e. products, brands, or collections.
pageId
string
Page ID to retrieve next set of results.
Default Value : 1
pageSize
integer
Page ID to retrieve next set of results.
Default Value : 12
Response
200
4XX
Success. Returns a Followed resource object. Check the example shown below or refer `GetFollowListingResponse` for more details.
GetFollowListingResponse
items
array of object (ProductListingDetail)
An array of product details that the user is following. Each item includes information such as the product name, price, and other attributes.
Array of ProductListingDetail
page
object (Page)
Page
Examples
Parameters
collectionType:
"value"
pageId:
"value"
pageSize:
0
Was this section helpful?
GET
Loading...
Response
Loading...
List followed products, brands
getFollowedListing
DEL
Delete item, brand, product
Remove a followed item, brand, or product using its collection ID.
Parameters
collectionType
string
Required
Type of collection followed, i.e. products, brands, or collections.
collectionId
string
Required
The ID of the collection type.
Response
200
4XX
Success. Returns a response object. Check the example shown below or refer `FollowPostResponse` for more details.
FollowPostResponse
message
string
A message indicating the result of the follow or unfollow operation. This could be a confirmation message or an error message.
id
string
A unique identifier for the follow operation, which can be used to reference or track the follow status.
Examples
Parameters
collectionType:
"value"
collectionId:
"value"
Was this section helpful?
DEL
Loading...
Response
Loading...
Delete item, brand, product
unfollowById
POST
Create item, brand, product
Add a product, brand, or item to the user's followed list by collection Id.
Parameters
collectionType
string
Required
Type of collection followed, i.e. products, brands, or collections.
collectionId
string
Required
The ID of the collection type.
Response
200
4XX
Success. Returns a response object. Check the example shown below or refer `FollowPostResponse` for more details.
FollowPostResponse
message
string
A message indicating the result of the follow or unfollow operation. This could be a confirmation message or an error message.
id
string
A unique identifier for the follow operation, which can be used to reference or track the follow status.
Examples
Parameters
collectionType:
"value"
collectionId:
"value"
Was this section helpful?
POST
Loading...
Response
Loading...
Create item, brand, product
followById
GET
Get follower count
Get the total number of followers for a specific item by its ID.
Parameters
collectionType
string
Required
Type of collection, i.e. products, brands, or collections.
collectionId
string
Required
The ID of the collection type.
Response
200
4XX
Success. Returns the number of followers for a given collection type. Check the example shown below or refer `FollowerCountResponse` for more details.
FollowerCountResponse
count
integer
The number of followers for the item. This count indicates how many users are following the specified item.
Examples
Parameters
collectionType:
"value"
collectionId:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get follower count
getFollowerCountById
GET
List Ids of followed item, brand, product
Get the IDs of all items the user is currently following, such as Products, Brands, and Collections.
Parameters
collectionType
string
Type of collection, i.e. products, brands, collections.
Response
200
4XX
Success. Returns the IDs of all the Products, Brands and Collections which were followed. Check the example shown below or refer `FollowIdsResponse` for more details.
FollowIdsResponse
data
object (FollowIdsData)
FollowIdsData
Examples
Parameters
collectionType:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List Ids of followed item, brand, product
getFollowIds
Product
A Product is an individual item available for sale. It includes details like the product's name, description, price, images, and variants (such as size or colour). This resource is crucial for managing the catalogue of items that customers can browse, search for, and purchase. Additionally, you can retrieve information about each product, including availability, sizes with quantities, dimensions, stock status, pricing details (marked, effective, selling), and minimum order quantity (MOQ). The APIs further support accessing products within the same category as a specified product, all available variants of a product, current stock status using unique identifiers like SKU, ALU, and EAN, as well as estimated future stock levels. Moreover, you can retrieve a comprehensive list of all products in the catalogue at the application level, with robust filtering options based on product attributes like name, brand, department, category, and collection, along with versatile sorting options based on factors like price, ratings, and discounts. The Product resource at the application level also facilitates operations such as retrieving product bundles, obtaining the price of specific product sizes across selling locations near a given PIN code, and retrieving a list of sellers offering a specific product in a specific size. With these functionalities, the 'Product' resource empowers you to efficiently manage and analyze your product catalogue holistically across your entire application, streamline operations, and enhance customer experiences
Operations
GET
# Get a product
GET
# List sizes
GET
# List products for comparison
GET
# List similar products
GET
# List frequent products
GET
# List product variants
GET
# Get product stocks
GET
# List future stock
GET
# List products
GET
# List homepage-featured products
GET
# List product bundles
GET
# Get product price
GET
# List sellers
GET
Get a product
Get product details such as price, attributes, HSN code, SKU code, etc.
Parameters
slug
string
Required
A short, human-readable, URL-friendly identifier of a product. You can get slug value from the endpoint /service/application/catalog/v1.0/products/.
Response
200
4XX
Success. Returns a Product object. Check the example shown below or refer `ProductDetail` for more details.
ProductDetail
uid
integer
Unique identifier for the product.
custom_order
object (ProductDetailCustomOrder)
ProductDetailCustomOrder
category_map
object (ProductCategoryMap)
ProductCategoryMap
net_quantity
object (NetQuantity)
NetQuantity
rating_count
integer
Count of ratings the product has received.
_custom_meta
array of object (CustomMetaFields)
Custom metadata fields associated with the product.
Array of CustomMetaFields
similars
array of string
List of products marked similar to given product.
tags
array of string
Tags associated with the product for better categorization.
seo
object (ApplicationItemSEO)
ApplicationItemSEO
image_nature
string
Type of the images associated with the product such as standard.
has_variant
boolean
Indicates whether the product has variants.
item_type
string
This field describes the type of item, indicating the category or nature of the product. Possible values are Standard, Composite, Wet, Digital.
description
string
Detailed description of the product.
grouped_attributes
array of object (ProductDetailGroupedAttribute)
Grouped attributes detailing various characteristics of the product.
Array of ProductDetailGroupedAttribute
medias
array of object (Media)
Media files associated with the product.
Array of Media
color
string
Color of the product, if applicable.
type
string
Product type or classification.
product_online_date
string
| date-time
Date and time when the product was made available online.
_custom_json
object
Custom JSON object for additional product data.
item_code
string
Item Code defined for the product.
name
string
Name of the product.
moq
object (ApplicationItemMOQ)
ApplicationItemMOQ
short_description
string
Brief description of the product.
categories
array of object (ProductBrand)
List of product categories associated with the product.
Array of ProductBrand
attributes
object
Additional attributes or characteristics of the product.
discount
string
Discount applied to the product, if any.
tryouts
array of string
Identifiers or names of tryout versions of the product.
slug
string
URL-friendly identifier for the product.
action
object (ProductListingAction)
ProductListingAction
rating
number
The rating of the product.
is_dependent
boolean
Indicates whether the product can be sold as an individual product.
product_group_tag
array of string
List of bundle/product grouping slugs mapped to the product.
highlights
array of string
Key highlights or features of the product.
price
object (ProductListingPrice)
ProductListingPrice
brand
object (ProductBrand)
ProductBrand
department
object (ProductDepartment)
ProductDepartment
teaser_tag
string
Teaser tag or short promotional phrase for the product.
Examples
Parameters
slug:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get a product
getProductDetailBySlug
GET
List sizes
Provides detailed information about a product, including its availability (sellable), available sizes with quantities, dimensions, weight, availability status, price details (marked, effective, selling), minimum order quantity (MOQ).
Parameters
slug
string
Required
A short, human-readable, URL-friendly identifier of a product. You can get slug value from the endpoint /service/application/catalog/v1.0/products/.
storeId
integer
The ID of the store that is selling the product, e.g. 1,2,3.
Response
200
4XX
Success. Returns a ProductSize object. Check the example shown below or refer `ProductSizes` for more details.
ProductSizes
sizes
array of object (ProductSize)
List of available sizes for the product.
Array of ProductSize
price
object (ProductSizesPrice)
ProductSizesPrice
price_per_piece
object (ProductSizesPrice)
ProductSizesPrice
size_chart
object (SizeChart)
SizeChart
sellable
boolean
Whether the product sizes are available for sale.
multi_size
boolean
Whether the product supports multiple sizes.
discount
string
Discount information applicable to the product sizes.
stores
object (ProductSizeStores)
ProductSizeStores
discount_meta
object (DiscountMeta)
DiscountMeta
Examples
Parameters
slug:
"value"
storeId:
0
Was this section helpful?
GET
Loading...
Response
Loading...
List sizes
getProductSizesBySlug
GET
List products for comparison
Get all the products that have the same category.
Parameters
slug
array of string
Required
A short, human-readable, URL-friendly identifier of a product. You can get slug value from the endpoint /service/application/catalog/v1.0/products/.
Minimum Items : 1
Response
200
4XX
Success. Returns an array of objects containing the attributes for comparision. Check the example shown below or refer `ProductsComparisonResponse` for more details.
ProductsComparisonResponse
items
array of object (ProductDetail)
List of product details for comparison.
Array of ProductDetail
attributes_metadata
array of object (AttributeMetadata)
Metadata about attributes used for comparing products.
Array of AttributeMetadata
Examples
Parameters
slug:
"lorem","ipsum"
Was this section helpful?
GET
Loading...
Response
Loading...
List products for comparison
getProductComparisonBySlugs
GET
List similar products
Get all products within the same category as the one specified by the provided slug.
Parameters
slug
string
Required
A short, human-readable, URL-friendly identifier of a product. You can get slug value from the endpoint /service/application/catalog/v1.0/products/.
Response
200
4XX
Success. Returns an array of objects containing the attributes for comparision. Check the example shown below or refer `ProductCompareResponse` for more details.
ProductCompareResponse
title
string
Title or name of the comparison.
items
array of object (ProductDetail)
List of product details for comparison.
Array of ProductDetail
attributes_metadata
array of object (AttributeMetadata)
Metadata about attributes used for comparing products.
Array of AttributeMetadata
subtitle
string
Subtitle or additional description for the comparison.
Examples
Parameters
slug:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List similar products
getSimilarComparisonProductBySlug
GET
List frequent products
Get products that are often compared to the product specified by its slug.
Parameters
slug
string
Required
A short, human-readable, URL-friendly identifier of a product. You can get slug value from the endpoint /service/application/catalog/v1.0/products/.
Response
200
4XX
Success. Returns an array of objects containing the attributes for comparision. Check the example shown below or refer `ProductFrequentlyComparedSimilarResponse` for more details.
ProductFrequentlyComparedSimilarResponse
similars
object (ProductCompareResponse)
ProductCompareResponse
Examples
Parameters
slug:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List frequent products
getComparedFrequentlyProductBySlug
GET
List product variants
Get all available variants of a specific product identified by its slug.
Parameters
slug
string
Required
A short, human-readable, URL-friendly identifier of a product. You can get slug value from the endpoint /service/application/catalog/v1.0/products/.
Response
200
4XX
Success. Returns all variants of a product. Check the example shown below or refer `ProductVariantsResponse` for more details. For `display_type:image`, `color` key will be present otherwise `value` key will be shown.
ProductVariantsResponse
variants
array of object (ProductVariantResponse)
A list of product variant responses, each detailing a specific variant.
Array of ProductVariantResponse
Examples
Parameters
slug:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List product variants
getProductVariantsBySlug
GET
Get product stocks
Get the current stock status for products identified by their IDs, such as SKU, ALU, EAN, etc.
Parameters
itemId
string
The Item ID of the product (Max. 50 allowed).
alu
string
ALU of the product (limited upto 50 ALU identifier in a single request).
skuCode
string
Stock-keeping Unit of the product (limited upto 50 SKU Code in a single request).
ean
string
European Article Number of the product (limited upto 50 EAN identifier in a single request).
upc
string
Universal Product Code of the product (limited upto 50 UPC identifier in a single request).
Response
200
4XX
Success. Returns the status of the product stock.Check the example shown below or refer `ProductStockStatusResponse` for more details.
ProductStockStatusResponse
items
array of object (ProductStockStatusItem)
NA.
Array of ProductStockStatusItem
Examples
Parameters
itemId:
"value"
alu:
"value"
skuCode:
"value"
ean:
"value"
upc:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get product stocks
getProductStockByIds
GET
List future stock
Get the available stock levels for all products associated with a particular sales channel at a specified future time.
Parameters
timestamp
string
Required
Timestamp in UTC format (2020-07-23T10:27:50Z).
pageSize
integer
The number of items to retrieve in each page.
Default Value : 12
pageId
string
Page ID to retrieve next set of results.
Response
200
4XX
Success. Returns the status of the product stock.Check the example shown below or refer `ProductStockPolling` for more details.
ProductStockPolling
items
array of object (ProductStockStatusItem)
NA.
Array of ProductStockStatusItem
page
object (Page)
Page
Examples
Parameters
timestamp:
"value"
pageSize:
0
pageId:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List future stock
getProductStockForTimeByIds
GET
List products
List all products available in the catalog. It supports filtering based on product name, brand, department, category, collection, and more, while also offering sorting options based on factors like price, ratings, discounts, and other relevant criteria.
Parameters
q
string
The search query for entering partial or full name of product, brand, category, or collection.
f
string
The search filter parameters. Filter parameters will be passed in f parameter as shown in the example below. Double Pipe (||) denotes the OR condition, whereas Triple-colon (:::) indicates a new filter parameter applied as an AND condition.
filters
boolean
True for fetching all filter parameters and False for disabling the filter parameters.
Default Value : true
sortOn
string
The order in which the list of products should be sorted, e.g. popularity, price, latest and discount, in either ascending or descending order. See the supported values below.
Enum
pageId
string
Page ID to retrieve next set of results.
pageSize
integer
The number of items to retrieve in each page.
Default Value : 12
pageNo
integer
The page number to navigate through the given set of results.
Default Value : 1
pageType
string
Available pagination types are cursor or number.
Default Value : cursor
Response
200
4XX
Success. Returns a paginated list of products..Check the example shown below or refer `ProductListingResponse` for more details.
ProductListingResponse
items
array of object (ProductListingDetail)
List of product details included in the response.
Array of ProductListingDetail
filters
array of object (ProductFilters)
List of filters available for refining the product listings.
Array of ProductFilters
page
object (Page)
Page
sort_on
array of object (ProductSortOn)
List of sorting options available for the product listings.
Array of ProductSortOn
Examples
Parameters
q:
"value"
f:
"value"
filters:
false
sortOn:
"value"
pageId:
"value"
pageSize:
0
pageNo:
0
pageType:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List products
getProducts
GET
List homepage-featured products
List all the products associated with a brand, collection or category in a random order.
Parameters
sortOn
string
The order in which the list of products should be sorted, e.g. popularity, price, latest and discount, in either ascending or descending order.
pageId
string
Page ID to retrieve next set of results.
Default Value : 1
pageSize
integer
The number of items to retrieve in each page.
Default Value : 12
Response
200
4XX
Success. Returns a paginated list of products. Check the example shown below or refer `HomeListingResponse` for more details.
HomeListingResponse
items
array of object (ProductListingDetail)
List of product details displayed on the home page.
Array of ProductListingDetail
page
object (Page)
Page
message
string
Message related to the home listing response.
Examples
Parameters
sortOn:
"value"
pageId:
"value"
pageSize:
0
Was this section helpful?
GET
Loading...
Response
Loading...
List homepage-featured products
getHomeProducts
GET
List product bundles
Get products bundles to the one specified by its slug.
Parameters
slug
string
Product slug for which bundles need to be fetched.
id
string
Product uid.
Response
200
4XX
Success. Returns a group of products bundle.
ProductBundle
items
array of object (ProductGroupingModel)
Represents list of bundles/product groupings.
Array of ProductGroupingModel
Examples
Parameters
slug:
"value"
id:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List product bundles
getProductBundlesBySlug
GET
Get product price
Get the price of a product size at all the selling locations near to a PIN Code.
Parameters
slug
string
Required
A short, human-readable, URL-friendly identifier of a product. You can get slug value from the endpoint /service/application/catalog/v1.0/products/.
size
string
Required
A string indicating the size of the product, e.g. S, M, XL. You can get slug value from the endpoint /service/application/catalog/v1.0/products/sizes.
storeId
integer
The ID of the store that is selling the product, e.g. 1,2,3.
moq
integer
An Integer indication the Minimum Order Quantity of a product, e.g. 100.
Response
200
4XX
Success. Returns a ProductSizePriceV3 object. Check the example shown below or refer `ProductSizePriceResponseV3` for more details.
ProductSizePriceResponseV3
store
object (StoreV3)
StoreV3
article_assignment
object (ArticleAssignmentV3)
ArticleAssignmentV3
is_cod
boolean
Whether Cash on Delivery (COD) is available for this product. It is true if COD is available and false otherwise.
strategy_wise_listing
array of object (StrategyWiseListingSchemaV3)
Details about serviceability attributes.
Array of StrategyWiseListingSchemaV3
quantity
integer
Available quantity of the product in stock. It shows the number of units available for purchase.
item_type
string
Type of item, indicating the category or nature of the product. Possible values are Standard, Composite, Wet, Digital.
grouped_attributes
array of object (SellerGroupAttributes)
Collection of attributes grouped together, which provides detailed characteristics of the product, such as color, size, material, etc.
Array of SellerGroupAttributes
return_config
object (ReturnConfigSchemaV3)
ReturnConfigSchemaV3
article_id
string
This unique identifier is assigned to the specific article. This represents item x size x location.
is_gift
boolean
Whether the product can be purchased as a gift. It is true if the product is available for gifting and false otherwise.
set
object (ProductSetV3)
ProductSetV3
seller_count
integer
Number of sellers offering this product. It indicates the level of competition and availability from different sellers.
price_per_piece
object (ProductStockPriceV3)
ProductStockPriceV3
discount_meta
object (DiscountMeta)
DiscountMeta
discount
string
Amount or percentage of discount applied to the product's price, showing the savings for the customer.
long_lat
array of number
Longitude and latitude coordinates, possibly indicating the location of the store or warehouse where the product is stocked.
special_badge
string
Special badges or labels assigned to the product, such as "Bestseller," "New Arrival," or "Limited Edition.".
price
object (ProductStockPriceV3)
ProductStockPriceV3
price_per_unit
object (ProductStockUnitPriceV3)
ProductStockUnitPriceV3
pincode
integer
Postal code or zip code for which the product's availability and delivery options are being checked.
marketplace_attributes
array of object (MarketPlaceSttributesSchemaV3)
Attributes specific to the marketplace, such as ratings, reviews, shipping options, and other marketplace-specific details.
Array of MarketPlaceSttributesSchemaV3
seller
object (SellerV3)
SellerV3
delivery_promise
object (PromiseSchema)
PromiseSchema
Examples
Parameters
slug:
"value"
size:
"value"
storeId:
0
moq:
0
Was this section helpful?
GET
Loading...
Response
Loading...
Get product price
getProductPriceBySlug
GET
List sellers
List all sellers offering a specific product identified by its slug and size.
Parameters
slug
string
Required
A short, human-readable, URL-friendly identifier of a product. You can get slug value from the endpoint /service/application/catalog/v1.0/products/.
size
string
Required
A string indicating the size of the product, e.g. S, M, XL. You can get slug value from the endpoint /service/application/catalog/v1.0/products/sizes.
strategy
string
Sort stores on the basis of strategy. eg, fast-delivery, low-price, optimal.
pageNo
integer
The page number to navigate through the given set of results.
Default Value : 1
pageSize
integer
The number of items to retrieve in each page.
Default Value : 12
Response
200
4XX
Success. Returns a ProductSizeSellerV3 object. Check the example shown below or refer `ProductSizeSellersResponseV3` for more details.
ProductSizeSellersResponseV3
items
array of object (ProductSizePriceResponseV3)
A list of products with size and price details available from various sellers.
Array of ProductSizePriceResponseV3
page
object (Page)
Page
sort_on
array of object (ProductSizeSellerFilterSchemaV3)
A list of sorting and filtering criteria applied to the sellers' data.
Array of ProductSizeSellerFilterSchemaV3
Examples
Parameters
slug:
"value"
size:
"value"
strategy:
"value"
pageNo:
0
pageSize:
0
Was this section helpful?
GET
Loading...
Response
Loading...
List sellers
getProductSellersBySlug
Search Autocomplete Suggestions
Search autocomplete suggestions are the results derived by user search queries giving suggestions according to what the customer has searched. Retrieve search results for products, brands, or categories based on user queries. Searches can be performed using partial or full text for names, enabling comprehensive and flexible search capabilities.
Operations
GET
# List product, brand, category
GET
List product, brand, category
Get products, brands, or categories based on a search query, which can be a partial or full name match.
Parameters
q
string
Required
The search query for entering partial or full name of a product, brand or category. For example, if the given search query `q` is _ski_, the relevant search suggestions could be _skirt_, _ski shoes_, __skin cream_ etc.
Response
200
4XX
Success. Returns a list autocomplete suggestions for the search query `q`. Check the example shown below or refer `AutoCompleteResponse` for more details.
AutoCompleteResponse
items
array of object (AutocompleteItem)
List of autocomplete items suggested based on user input.
Array of AutocompleteItem
Examples
Parameters
q:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List product, brand, category
getSearchResults
Selling Location
A selling location represents a geographical location where your stores, pop-up stores, headquarters, and warehouses exist. Find in-stock locations for products Additionally, the API retrieves detailed location information by ID, offering comprehensive store details for enhanced user convenience.
Operations
GET
# List available stores
GET
# List stores with inventory
GET
# Get selling location
GET
List available stores
List all stores associated with the sales channel.
Parameters
pageNo
integer
The page number to navigate through the given set of results.
Default Value : 1
pageSize
integer
Number of items to retrieve in each page.
Default Value : 12
q
string
Search a store by its name or store_code.
city
string
Search stores by the city in which they are situated.
range
integer
Use this to retrieve stores within a particular range in meters, e.g. 10000, to indicate a 10km range.
Default Value : 20000
latitude
number
Latitude of the location from where one wants to retrieve the nearest stores, e.g. 72.8691788.
longitude
number
Longitude of the location from where one wants to retrieve the nearest stores, e.g. 19.1174114.
tags
string
Search stores based on tags.
Response
200
4XX
Success. Returns a list of selling locations. Check the example shown below or refer `StoreListingResponse` for more details.
StoreListingResponse
items
array of object (Store)
An array of store details. Each store includes information such as name, address, and geographic coordinates.
Array of Store
page
object (Page)
Page
Examples
Parameters
pageNo:
0
pageSize:
0
q:
"value"
city:
"value"
range:
0
latitude:
1.1
longitude:
1.1
tags:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List available stores
getStores
GET
List stores with inventory
List stores where specified products are currently in stock.
Parameters
pageNo
integer
The page number to navigate through the given set of results.
Default Value : 1
pageSize
integer
Number of items to retrieve in each page.
Default Value : 12
q
string
Search a store by its name or store_code.
city
string
Search stores by the city in which they are situated.
range
integer
Use this to retrieve stores within a particular range in meters, e.g. 10000, to indicate a 10km range.
Default Value : 20000
latitude
number
Latitude of the location from where one wants to retrieve the nearest stores, e.g. 72.8691788.
longitude
number
Longitude of the location from where one wants to retrieve the nearest stores, e.g. 19.1174114.
Response
200
4XX
Success. Returns a list of selling locations. Check the example shown below or refer `StoreListingResponse` for more details.
ApplicationStoreListing
filters
array of object
A list of filters applied to the store listing.
items
array of object (AppStore)
A list of application stores.
Array of AppStore
page
object (Page)
Page
Examples
Parameters
pageNo:
0
pageSize:
0
q:
"value"
city:
"value"
range:
0
latitude:
1.1
longitude:
1.1
Was this section helpful?
GET
Loading...
Response
Loading...
List stores with inventory
getInStockLocations
GET
Get selling location
Get details about a store based on its location Id.
Parameters
locationId
integer
Required
Unique Location ID.
Response
200
4XX
Success. Returns a metadata object. Check the example shown below or refer `StoreDetails` for more details.
StoreDetails
uid
integer
The unique identifier for the store.
departments
array of object (StoreDepartments)
A list of departments within the store.
Array of StoreDepartments
company
object (CompanyStore)
CompanyStore
manager
object (StoreManagerSerializer)
StoreManagerSerializer
store_code
string
A unique code for identifying the store.
timing
array of object (StoreTiming)
The opening and closing times for the store throughout the week.
Array of StoreTiming
address
object (StoreAddressSerializer)
StoreAddressSerializer
_custom_json
object
Custom JSON data for the store.
name
string
The name of the store.
contact_numbers
array of object (SellerPhoneNumber)
A list of contact numbers for the store.
Array of SellerPhoneNumber
Examples
Parameters
locationId:
0
Was this section helpful?
GET
Loading...
Response
Loading...