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
/service/application/catalog/v1.0/brands/
# List brands
GET
/service/application/catalog/v1.0/brands/{slug}/
# Get a brand
GET

List brands

Get a list of all the available brands. Filtering can be applied to the department.
Parameters
departmentquery
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/.
page_noquery
integer
The page number to navigate through the given set of results.
Default Value : 1
page_sizequery
integer
The number of items to retrieve in each page.
Default Value : 12
GET
/service/application/catalog/v1.0/brands/
Loading...
Response
200
Success. Returns a paginated list of brands.
Hide
Response containing a list of brand items along with pagination information.
items
array of object (BrandItem)
List of brand items included in the response.
Show
page
object (Page)
Show
Response
Loading...
GET

Get a brand

Get metadata of a brand such as name, information, logo, banner, etc.
Parameters
slugpath
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/.
GET
/service/application/catalog/v1.0/brands/{slug}/
Loading...
Response
200
Success. Returns a metadata object.
Hide
Detailed response for a specific brand, including its logo, description, and custom data.
logo
object (Media)
Show
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)
Show
_custom_json
object
Custom JSON data related to the brand, allowing for additional metadata.
name
string
Name of the brand.
slug
string
Unique slug identifier for the brand, used in URLs.
_app
object
Metadata or settings related to the brand's app integration.
Response
Loading...

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
/service/application/catalog/v1.0/categories/
# List product categories
GET
/service/application/catalog/v1.0/categories/{slug}/
# Get category by slug
GET

List product categories

List all available product categories. Also, users can filter the categories by department.
Parameters
departmentquery
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
GET
/service/application/catalog/v1.0/categories/
Loading...
Response
200
Success. Returns a list of categories.
Hide
Response containing a list of department category trees and department identifiers.
data
array of object (DepartmentCategoryTree)
List of department category trees.
Show
departments
array of object (DepartmentIdentifier)
List of departments.
Show
Response
Loading...
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
slugpath
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/.
GET
/service/application/catalog/v1.0/categories/{slug}/
Loading...
Response
200
Success. Returns metadata of a category.
Hide
Response containing metadata for a category.
logo
object (Media)
Show
uid
integer
Unique identifier for the category.
banners
object (ImageUrls)
Show
_custom_json
object
Custom JSON data related to the category, allowing for additional metadata.
name
string
Name of the category.
_app
object
Application-specific data associated with the category.
Response
Loading...

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
/service/application/catalog/v1.0/collections/
# List collections
GET
/service/application/catalog/v1.0/collections/{slug}/items/
# Lists items of collection
GET
/service/application/catalog/v1.0/collections/{slug}/
# Get a collection
GET

List collections

List of curated product collections with filtering options based on tags and collection names.
Parameters
page_noquery
integer
The page number to navigate through the given set of results.
Default Value : 1
page_sizequery
integer
The number of items to retrieve in each page.
Default Value : 12
tagquery
array of string
List of tags to filter collections.
Minimum Items : 1
qquery
string
Name of the collection to filter collection.
GET
/service/application/catalog/v1.0/collections/
Loading...
Response
200
Success. Returns a list of collections.
Hide
Response object containing a list of collection details, applicable filters, and pagination information for collection listings.
items
array of object (GetCollectionDetailNest)
An array of collection details. Each item in the array represents a collection with various attributes and configurations.
Show
filters
object (CollectionListingFilter)
Show
page
object (Page)
Show
Response
Loading...
GET

Lists items of collection

Fetch items within a particular collection identified by its slug.
Parameters
slugpath
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/.
fquery
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.
qquery
string
The search query for entering partial or full name of product, brand, category, or collection.
filtersquery
boolean
True for fetching all filter parameters and False for disabling the filter parameters.
Default Value : true
sort_onquery
string
The order in which the list of products should be sorted. Supported values include latest, popular, price_asc, price_dsc, discount_asc, discount_dsc. Custom sort keys configured via listing configuration (e.g., best_selling) are also supported for cohort-based sorting.
page_idquery
string
Page ID to retrieve next set of results.
Default Value : 1
page_sizequery
integer
The number of items to retrieve in each page.
Default Value : 12
page_noquery
integer
Page Number to retrieve next set of results.
Default Value : 1
page_typequery
string
Page Type to retrieve set of results can be cursor or number.
Enum
show_all_variantsquery
boolean
When true, return every product variant in the listing response. When false or omitted, each variant group is capped at 5 items (storefront default).
Default Value : false
GET
/service/application/catalog/v1.0/collections/{slug}/items/
Loading...
Response
200
Success. Returns a list items in a given collection. Check the example shown below or refer `ProductListingResponse` for more details.
Hide
Represents the response for a product listing query, including product details, filters, pagination, and sorting options.
items
array of object (ProductListingDetail)
List of product details included in the response.
Show
filters
array of object (ProductFilters)
List of filters available for refining the product listings.
Show
page
object (Page)
Show
sort_on
array of object (ProductSortOn)
List of sorting options available for the product listings.
Show
Response
Loading...
GET

Get a collection

Get detailed information about a specific collection using its slug.
Parameters
slugpath
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/.
GET
/service/application/catalog/v1.0/collections/{slug}/
Loading...
Response
200
Success. Returns a Collection object.
Hide
Detailed information about a specific collection, including attributes such as its name, description, schedule, and other relevant data.
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)
Show
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.
Show
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)
Show
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.
uid
string
Unique identifier for the item.
_id
string
ID of the item.
published
boolean
Indicates if the query or collection is published.
tags
array of string
List of tags associated with the query or collection.
action
object (ProductListingAction)
Show
_locale_language
object
Locale or language settings for the query or collection.
seo
object (CollectionItemSEO)
Show
is_visible
boolean
Indicates if the query or collection is visible.
Response
Loading...

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
/service/application/catalog/v1.0/departments/
# List departments
GET

List departments

List all departments associated with available products.
Parameters
No Parameters
GET
/service/application/catalog/v1.0/departments/
Loading...
Response
200
List of Departments.
Hide
Department details.
items
array of object (Department)
List of department detail objects.
Show
Examples
Parameters
Parameters are not required.
Response
Loading...

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
/service/application/catalog/v1.0/follow/{collection_type}/
# List followed products, brands
DEL
/service/application/catalog/v1.0/follow/{collection_type}/{collection_id}/
# Delete item, brand, product
POST
/service/application/catalog/v1.0/follow/{collection_type}/{collection_id}/
# Create item, brand, product
GET
/service/application/catalog/v1.0/follow/{collection_type}/{collection_id}/count/
# Get follower count
GET
/service/application/catalog/v1.0/follow/ids/
# List Ids of followed item, brand, product
GET

List followed products, brands

Get a list of products or brands the user is following.
Parameters
collection_typepath
string
Required
Type of collection followed, i.e. products, brands, or collections.
Enum
page_idquery
string
Page ID to retrieve next set of results.
Default Value : 1
page_sizequery
integer
Page ID to retrieve next set of results.
Default Value : 12
GET
/service/application/catalog/v1.0/follow/{collection_type}/
Loading...
Response
200
Success. Returns a Followed resource object.
Hide
Response object containing a list of products that the user is following and pagination information for the follow listing.
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.
Show
page
object (Page)
Show
Response
Loading...
DEL

Delete item, brand, product

Remove a followed item, brand, or product using its collection ID.
Parameters
collection_typepath
string
Required
Type of collection followed, i.e. products, brands, or collections.
Enum
collection_idpath
string
Required
The ID of the collection type.
DEL
/service/application/catalog/v1.0/follow/{collection_type}/{collection_id}/
Loading...
Response
200
Success. Returns a response object.
Hide
Response object returned after a user follows or unfollows an item, indicating the success of the operation.
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.
Response
Loading...
POST

Create item, brand, product

Add a product, brand, or item to the user's followed list by collection Id.
Parameters
collection_typepath
string
Required
Type of collection followed, i.e. products, brands, or collections.
Enum
collection_idpath
string
Required
The ID of the collection type.
POST
/service/application/catalog/v1.0/follow/{collection_type}/{collection_id}/
Loading...
Response
200
Success. Returns a response object.
Hide
Response object returned after a user follows or unfollows an item, indicating the success of the operation.
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.
Response
Loading...
GET

Get follower count

Get the total number of followers for a specific item by its ID.
Parameters
collection_typepath
string
Required
Type of collection, i.e. products, brands, or collections.
Enum
collection_idpath
integer
Required
The ID of the collection type.
GET
/service/application/catalog/v1.0/follow/{collection_type}/{collection_id}/count/
Loading...
Response
200
Success. Returns the number of followers for a given collection type.
Hide
Response object containing the count of followers for a specific item, such as a product, collection, or brand.
count
integer
The number of followers for the item. This count indicates how many users are following the specified item.
Response
Loading...
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
collection_typequery
string
Type of collection, i.e. products, brands, collections.
Enum
GET
/service/application/catalog/v1.0/follow/ids/
Loading...
Response
200
Success. Returns the IDs of all the Products, Brands and Collections which were followed.
Hide
Response object containing the follow IDs data for products, collections, and brands.
data
object (FollowIdsData)
Show
Response
Loading...

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
/service/application/catalog/v1.0/products/{slug}/
# Get a product
GET
/service/application/catalog/v1.0/products/{slug}/bundle/items
# Get children for a bundled product
GET
/service/application/catalog/v1.0/products/{slug}/size/{size}/bundle
# Get bundled items for a specific product size
GET
/service/application/catalog/v1.0/products/{slug}/sizes/
# List sizes
GET
/service/application/catalog/v1.0/products/compare/
# List products for comparison
GET
/service/application/catalog/v1.0/products/{slug}/similar/compare/
# List similar products
GET
/service/application/catalog/v1.0/products/{slug}/similar/compared-frequently/
# List frequent products
GET
/service/application/catalog/v1.0/products/{slug}/variants/
# List product variants
GET
/service/application/catalog/v1.0/products/stock-status/
# Get product stocks
GET
/service/application/catalog/v1.0/products/stock-status/poll/
# List future stock
GET
/service/application/catalog/v1.0/products/
# List products
GET
/service/application/catalog/v1.0/home/listing/
# List homepage-featured products
GET
/service/application/catalog/v2.0/products/sizes/
# List sizes for multiple products
GET
/service/application/catalog/v4.0/products/{slug}/sizes/{size}/price/
# Get product price
GET
/service/application/catalog/v4.0/products/{slug}/sizes/{size}/sellers/
# List sellers
GET
/service/application/catalog/v1.0/available-countries/
# List country to currency mapping
GET

Get a product

Get product details such as price, attributes, HSN code, SKU code, etc.
Parameters
slugpath
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/.
GET
/service/application/catalog/v1.0/products/{slug}/
Loading...
Response
200
Success. Returns a Product object.
Hide
Represents detailed information about a product.
uid
integer
Unique identifier for the product.
custom_order
object (ProductDetailCustomOrder)
Show
category_map
object (ProductCategoryMap)
Show
net_quantity
object (NetQuantity)
Show
rating_count
integer
Count of ratings the product has received.
_custom_meta
array of object (CustomMetaFields)
Custom metadata fields associated with the product.
Show
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)
Show
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, Set Digital.
Enum
description
string
Detailed description of the product.
grouped_attributes
array of object (ProductDetailGroupedAttribute)
Grouped attributes detailing various characteristics of the product.
Show
medias
array of object (Media)
Media files associated with the product.
Show
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)
Show
short_description
string
Brief description of the product.
categories
array of object (ProductBrand)
List of product categories associated with the product.
Show
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)
Show
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)
Show
brand
object (ProductBrand)
Show
department
object (ProductDepartment)
Show
teaser_tag
string
Teaser tag or short promotional phrase for the product.
promo_meta
object
Metadata related to promotions applied to the product.
no_of_boxes
integer
The number of boxes required for packaging the product.
country_of_origin
string
The country of origin for the product.
Response
Loading...
GET

Get children for a bundled product

Retrieve bundle children for a given bundled product slug with pricing, brand, media, and seller information.
Parameters
slugpath
string
Required
Unique product identifier slug.
page_noquery
integer
Page number to retrieve.
page_sizequery
integer
Number of items per page.
GET
/service/application/catalog/v1.0/products/{slug}/bundle/items
Loading...
Response
200
Successfully retrieved bundled items for a product.
Hide
Response schema representing a paginated list of bundled items for a product.
items
array of object (BundleItem)
List of bundled product items with associated brand, media, pricing, and seller information.
Show
page
object (Page)
Show
Response
Loading...
GET

Get bundled items for a specific product size

Retrieve bundled items for a given product slug and size with pricing, brand, media, and seller information.
Parameters
slugpath
string
Required
Unique product identifier slug.
sizepath
string
Required
Size of the product (e.g., S, M, L, XL, OS).
page_noquery
integer
Page number to retrieve.
page_sizequery
integer
Number of items per page.
GET
/service/application/catalog/v1.0/products/{slug}/size/{size}/bundle
Loading...
Response
200
Successfully retrieved bundled items for a product size.
Hide
Response schema representing a paginated list of bundled items for a specific product size.
items
array of object (BundleItem)
List of bundled product items with associated brand, media, pricing, seller information, and product slug.
Show
page
object (Page)
Show
Response
Loading...
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). Each size includes `seller_identifiers` (primary identifiers) and `all_identifiers` (primary and non-primary seller identifiers combined).
Parameters
slugpath
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/.
store_idquery
integer
The ID of the store that is selling the product, e.g. 1,2,3.
GET
/service/application/catalog/v1.0/products/{slug}/sizes/
Loading...
Response
200
Success. Returns a ProductSize object.
Hide
sizes
array of object (ProductSize)
List of available sizes for the product.
Show
price
object (ProductSizesPrice)
Show
price_per_piece
object (ProductSizesPrice)
Show
size_chart
object (SizeChart)
Show
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)
Show
discount_meta
object (DiscountMeta)
Show
moq
object (MOQ)
Show
tags
array of string
Tags associated with the product sizes.
custom_order
object
Custom order-related data for the product sizes.
no_of_boxes
integer
Number of boxes required for packaging the product.
teaser_tag
object
A flexible object that holds additional teaser tag information, where keys and values can vary based on the product's needs or marketing strategies.
Response
Loading...
GET

List products for comparison

Get all the products that have the same category.
Parameters
slugquery
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
GET
/service/application/catalog/v1.0/products/compare/
Loading...
Response
200
Success. Returns an array of objects containing the attributes for comparision.
Hide
Response schema for comparing multiple products.
items
array of object (ProductCompareDetail)
List of product details for comparison.
Show
attributes_metadata
array of object (AttributeMetadata)
Metadata about attributes used for comparing products.
Show
Response
Loading...
GET

List similar products

Get all products within the same category as the one specified by the provided slug.
Parameters
slugpath
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/.
GET
/service/application/catalog/v1.0/products/{slug}/similar/compare/
Loading...
Response
200
Success. Returns an array of objects containing the attributes for comparision.
Hide
Response schema for comparing products with additional metadata.
title
string
Title or name of the comparison.
items
array of object (ProductDetail)
List of product details for comparison.
Show
attributes_metadata
array of object (AttributeMetadata)
Metadata about attributes used for comparing products.
Show
subtitle
string
Subtitle or additional description for the comparison.
Response
Loading...
GET

List frequent products

Get products that are often compared to the product specified by its slug.
Parameters
slugpath
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/.
GET
/service/application/catalog/v1.0/products/{slug}/similar/compared-frequently/
Loading...
Response
200
Success. Returns an array of objects containing the attributes for comparision.
Hide
Response schema for products frequently compared with similar items.
similars
object (ProductCompareResponseSchema)
Show
Response
Loading...
GET

List product variants

Get all available variants of a specific product identified by its slug.
Parameters
slugpath
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/.
GET
/service/application/catalog/v1.0/products/{slug}/variants/
Loading...
Response
200
Success. Returns all variants of a product. For `display_type:image`, `color` key will be present otherwise `value` key will be shown.
Hide
Represents a response containing multiple product variants.
variants
array of object (ProductVariantResponseSchema)
A list of product variant responses, each detailing a specific variant.
Show
Response
Loading...
GET

Get product stocks

Get the current stock status for products identified by their IDs, such as SKU, ALU, EAN, etc.
Parameters
item_idquery
integer
The Item ID of the product (Max. 50 allowed).
aluquery
string
ALU of the product (limited upto 50 ALU identifier in a single request).
sku_codequery
string
Stock-keeping Unit of the product (limited upto 50 SKU Code in a single request).
eanquery
string
European Article Number of the product (limited upto 50 EAN identifier in a single request).
upcquery
string
Universal Product Code of the product (limited upto 50 UPC identifier in a single request).
GET
/service/application/catalog/v1.0/products/stock-status/
Loading...
Response
200
Success. Returns the status of the product stock.
Hide
Response containing product stock status information.
items
array of object (ProductStockStatusItem)
List of stock status items.
Show
Response
Loading...
GET

List future stock

Get the available stock levels for all products associated with a particular sales channel at a specified future time.
Parameters
timestampquery
string
Required
Timestamp in UTC format (2020-07-23T10:27:50Z).
page_sizequery
integer
The number of items to retrieve in each page.
Default Value : 12
page_idquery
string
Page ID to retrieve next set of results.
GET
/service/application/catalog/v1.0/products/stock-status/poll/
Loading...
Response
200
Success. Returns the status of the product stock.
Hide
Polling response for product stock details, including stock status and pagination information.
items
array of object (ProductStockStatusItem)
List of product stock status items.
Show
page
object (Page)
Show
Response
Loading...
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
qquery
string
The search query for entering partial or full name of product, brand, category, or collection.
fquery
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.
filtersquery
boolean
True for fetching all filter parameters and False for disabling the filter parameters.
Default Value : true
sort_onquery
string
The order in which the list of products should be sorted. Supported values include latest, popular, price_asc, price_dsc, discount_asc, discount_dsc. Custom sort keys configured via listing configuration (e.g., best_selling) are also supported for cohort-based sorting.
page_idquery
string
Page ID to retrieve next set of results.
page_sizequery
integer
The number of items to retrieve in each page.
Default Value : 12
page_noquery
integer
The page number to navigate through the given set of results.
Default Value : 1
page_typequery
string
Available pagination types are cursor or number.
Default Value : cursor
Enum
show_all_variantsquery
boolean
When true, return every product variant in the listing response. When false or omitted, each variant group is capped at 5 items (storefront default).
Default Value : false
GET
/service/application/catalog/v1.0/products/
Loading...
Response
200
Success. Returns a paginated list of products..
Hide
Represents the response for a product listing query, including product details, filters, pagination, and sorting options.
items
array of object (ProductListingDetail)
List of product details included in the response.
Show
filters
array of object (ProductFilters)
List of filters available for refining the product listings.
Show
page
object (Page)
Show
sort_on
array of object (ProductSortOn)
List of sorting options available for the product listings.
Show
Response
Loading...
GET

List homepage-featured products

List all the products associated with a brand, collection or category in a random order.
Parameters
sort_onquery
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.
page_idquery
string
Page ID to retrieve next set of results.
Default Value : 1
page_sizequery
integer
The number of items to retrieve in each page.
Default Value : 12
GET
/service/application/catalog/v1.0/home/listing/
Loading...
Response
200
Success. Returns a paginated list of products.
Hide
Response containing product listings for the home page.
items
array of object (ProductListingDetail)
List of product details displayed on the home page.
Show
page
object (Page)
Show
message
string
Message related to the home listing response.
sort_on
string
The attribute by which the products are sorted.
Response
Loading...
GET

List sizes for multiple products

Provides detailed size information (availability, quantities, dimensions, weight, price details, seller identifiers) for multiple products in a single request. Pass repeated `slug` query parameters (up to 50) to avoid N+1 per-product size lookups when rendering listings. Each entry in the response is a ProductSizes object annotated with its `slug`.
Parameters
slugquery
array of string
Required
Product slugs to fetch sizes for (max. 50 allowed). Pass the parameter multiple times, e.g. `?slug=a&slug=b`.
store_idquery
integer
The ID of the store that is selling the products, e.g. 1,2,3.
GET
/service/application/catalog/v2.0/products/sizes/
Loading...
Response
200
Success. Returns a list of ProductSizes objects, each annotated with its `slug`.
Hide
Sizes for multiple products, one entry per requested slug.
items
array of object (ProductSizesBySlug)
List of per-product size details keyed by slug.
Show
Response
Loading...
GET

Get product price

Get the price of a product size at all the selling locations near to a PIN Code.
Parameters
slugpath
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/.
sizepath
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.
store_idquery
integer
The ID of the store that is selling the product, e.g. 1,2,3.
moqquery
integer
An Integer indication the Minimum Order Quantity of a product, e.g. 100.
fulfillment_option_slugquery
string
specifies the fulfillment method, indicating whether an order is for home delivery or store pickup
GET
/service/application/catalog/v4.0/products/{slug}/sizes/{size}/price/
Loading...
Response
200
Success. Returns a ProductSizePriceV3 object.
Hide
Response schema for product size price.
store
object (StoreV4)
Show
article_assignment
object (ArticleAssignmentV3)
Show
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.
Show
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, Set Digital.
Enum
grouped_attributes
array of object (SellerGroupAttributes)
Collection of attributes grouped together, which provides detailed characteristics of the product, such as color, size, material, etc.
Show
return_config
object (ReturnConfigSchemaV3)
Show
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)
Show
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)
Show
discount_meta
object (DiscountMeta)
Show
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)
Show
price_per_unit
object (ProductStockUnitPriceV3)
Show
pincode
string
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.
Show
seller
object (SellerV3)
Show
delivery_promise
object (PromiseSchema)
Show
trader
array of object (Trader)
List of trader information.
Show
_custom_json
object
Custom JSON data.
tags
array of string
Tags associated with the product.
inventory_updated_on
string
| date-time
Date and time when the inventory was last updated.
is_serviceable
boolean
Indicates if the product is serviceable in the pincode.
fulfillment_option
object (FulfillmentOptionSchema)
Show
pickup_store_detail
object (PickupStoreDetailSchema)
Show
total_available_quantity
integer
The total quantity of the item available across all stores for all sellers.
Examples
Parameters
slug:
"test"
size:
"S"
store_id:
1
moq:
1
fulfillment_option_slug:
"pickup-delivery"
Response
Loading...
GET

List sellers

List all sellers offering a specific product identified by its slug and size. Optionally filter the seller list by store name, seller name, or store code using the `q` query parameter.
Parameters
slugpath
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/.
sizepath
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.
strategyquery
string
Sort stores on the basis of strategy. eg, fast-delivery, low-price, optimal.
Enum
fulfillment_option_slugquery
string
specifies the fulfillment method, indicating whether an order is for home delivery or store pickup
page_noquery
integer
The page number to navigate through the given set of results.
Default Value : 1
page_sizequery
integer
The number of items to retrieve in each page.
Default Value : 12
qquery
string
Filter sellers by matching text against store name, seller name, or store code. Case-insensitive partial match.
GET
/service/application/catalog/v4.0/products/{slug}/sizes/{size}/sellers/
Loading...
Response
200
Success. Returns a ProductSizeSellerV3 object. Check the example shown below or refer `ProductSizeSellersResponseV4` for more details.
Hide
Response schema for product size sellers.
items
array of object (ProductSellersPriceResponseV3)
A list of products with size and price details available from various sellers.
Show
page
object (Page)
Show
sort_on
array of object (ProductSizeSellerFilterSchemaV3)
A list of sorting and filtering criteria applied to the sellers' data.
Show
Response
Loading...
GET

List country to currency mapping

List all country-to-currencies mappings configured during the Price Factory setup for given application
Parameters
No Parameters
GET
/service/application/catalog/v1.0/available-countries/
Loading...
Response
200
Success. Returns all avaialble country-to-currencies mappings for given application.
Hide
items
array of object (CountryCurrencyMapping)
List all country-to-currencies mappings configured during the Price Factory setup
Show
Examples
Parameters
Parameters are not required.
Response
Loading...

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
/service/application/catalog/v1.0/auto-complete/
# 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
qquery
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.
GET
/service/application/catalog/v1.0/auto-complete/
Loading...
Response
200
Success. Returns a list autocomplete suggestions for the search query `q`.
Hide
Response containing a list of autocomplete items.
items
array of object (AutocompleteItem)
List of autocomplete items suggested based on user input.
Show
Response
Loading...

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
/service/application/catalog/v2.0/locations/
# List available stores
GET
/service/application/catalog/v2.0/in-stock/locations/
# List stores with inventory
GET
/service/application/catalog/v2.0/locations/{location_id}/
# Get selling location
GET

List available stores

List all stores associated with the sales channel.
Parameters
page_noquery
integer
The page number to navigate through the given set of results.
Default Value : 1
page_sizequery
integer
Number of items to retrieve in each page.
Default Value : 12
qquery
string
Search a store by its name or store_code.
cityquery
string
Search stores by the city in which they are situated.
rangequery
integer
Use this to retrieve stores within a particular range in meters, e.g. 10000, to indicate a 10km range.
Default Value : 20000
latitudequery
number
Latitude of the location from where one wants to retrieve the nearest stores, e.g. 72.8691788.
longitudequery
number
Longitude of the location from where one wants to retrieve the nearest stores, e.g. 19.1174114.
tagsquery
string
Search stores based on tags.
GET
/service/application/catalog/v2.0/locations/
Loading...
Response
200
Success. Returns a list of selling locations.
Hide
Response object containing a list of stores and pagination information for store listings.
items
array of object (Store)
An array of store details. Each store includes information such as name, address, and geographic coordinates.
Show
page
object (Page)
Show
Response
Loading...
GET

List stores with inventory

List stores where specified products are currently in stock.
Parameters
page_noquery
integer
The page number to navigate through the given set of results.
Default Value : 1
page_sizequery
integer
Number of items to retrieve in each page.
Default Value : 12
qquery
string
Search a store by its name or store_code.
cityquery
string
Search stores by the city in which they are situated.
rangequery
integer
Use this to retrieve stores within a particular range in meters, e.g. 10000, to indicate a 10km range.
Default Value : 20000
latitudequery
number
Latitude of the location from where one wants to retrieve the nearest stores, e.g. 72.8691788.
longitudequery
number
Longitude of the location from where one wants to retrieve the nearest stores, e.g. 19.1174114.
GET
/service/application/catalog/v2.0/in-stock/locations/
Loading...
Response
200
Success. Returns a list of selling locations.
Hide
A list of application stores with associated filters and pagination details.
filters
array of object (ApplicationStoreFilterListing)
A list of filters applied to the store listing.
Show
items
array of object (AppStore)
A list of application stores.
Show
page
object (Page)
Show
Response
Loading...
GET

Get selling location

Get details about a store based on its location Id.
Parameters
location_idpath
integer
Required
Unique Location ID.
GET
/service/application/catalog/v2.0/locations/{location_id}/
Loading...
Response
200
Success. Returns a metadata object.
Hide
Detailed information about a store.
uid
integer
The unique identifier for the store.
departments
array of object (StoreDepartments)
A list of departments within the store.
Show
company
object (CompanyStore)
Show
manager
object (StoreManagerSchema)
Show
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.
Show
address
object (StoreAddressSchema)
Show
_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.
Show
additional_contacts
array of object (ContactDetails)
List of additional contacts for the store.
Show
company_id
integer
Identifier of the company to which the store belongs.
display_name
string
Display name of the store.
store_type
string
Type of store (e.g., high_street).
Enum
auto_invoice
boolean
Whether auto-invoice is enabled for the store.
credit_note
boolean
Whether credit note issuance is enabled for the store.
stage
string
Current stage or status of the store (e.g., verified).
gst_credentials
object (GSTCredentials)
Show
product_return_config
object (ProductReturnConfig)
Show
avg_order_processing_time
object (OrderProcessingTime)
Show
bulk_shipment
boolean
Whether bulk shipment is enabled for the store.
default_order_acceptance_timing
boolean
Whether default order acceptance timings are enabled.
order_acceptance_timing
array of object (OrderTiming)
List of order acceptance timings for each weekday.
Show
auto_assign_courier_partner
boolean
Whether courier partner assignment is automatic.
Response
Loading...