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
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
page_no
integer
The page number to navigate through the given set of results.
Default Value : 1
page_size
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
uid
integer
The unique identifier for the brand.
logo
object (Media)
Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
description
string
Detailed description of the brand, including its history, values, product offerings, and other relevant information.
banners
object (ImageUrls)
ImageUrls
portrait
object (Media)
Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
landscape
object (Media)
Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
departments
array of string
Lists the departments or categories under which the brand's products are listed.
discount
string
Details about any discounts currently available on the brand's products.
name
string
Name of the brand.
slug
string
URL-friendly version of the brand's name, used in the web address to access the brand's page on the platform.
action
object (ProductListingAction)
ProductListingAction
type
string
Type of action to be taken e.g, page.
page
object (ProductListingActionPage)
ProductListingActionPage
type
string
The type of action such as product, products, category, brand.
query
object
Query parameter if any to be added to the action.
params
object
Parameters that should be considered in path.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
Examples
Parameters
department:
"value"
page_no:
1
page_size:
1
GET
/service/application/catalog/v1.0/brands/
Loading...
Response
Loading...
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
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
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
portrait
object (Media)
Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
landscape
object (Media)
Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
_custom_json
object
Custom JSON data related to the brand, allowing for additional metadata.
name
string
Name of the brand.
Examples
Parameters
slug:
"value"
GET
/service/application/catalog/v1.0/brands/{slug}/
Loading...
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
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
items
array of object (CategoryItems)
List of categories within the department.
Array of CategoryItems
uid
integer
Unique identifier for the category.
banners
object (CategoryBanner)
CategoryBanner
portrait
object (Media)
Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
landscape
object (Media)
Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
childs
array of object (Child)
List of L1 categories under the main category.
Array of Child
uid
integer
Unique identifier for the L1 category.
banners
object (ImageUrls)
ImageUrls
portrait
object (Media)
Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
landscape
object (Media)
Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
childs
array of object (SecondLevelChild)
List of categories under the L1 category.
Array of SecondLevelChild
uid
integer
Unique identifier for the L2 category.
banners
object (ImageUrls)
ImageUrls
portrait
object (Media)
Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
landscape
object (Media)
Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
childs
array of object (ThirdLevelChild)
List of categories under the L2 category.
Array of ThirdLevelChild
uid
integer
Unique identifier for the L3 category.
banners
object (ImageUrls)
ImageUrls
portrait
object (Media)
Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
landscape
object (Media)
Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
childs
array of object
List of categories under the L3 category.
_custom_json
object
Custom JSON data related to the L3 category, allowing for additional metadata.
name
string
Name of the L3 category.
slug
string
Slug or URL-friendly identifier for the L3 category.
action
object (ProductListingAction)
ProductListingAction
type
string
Type of action to be taken e.g, page.
page
object (ProductListingActionPage)
ProductListingActionPage
type
string
The type of action such as product, products, category, brand.
query
object
Query parameter if any to be added to the action.
params
object
Parameters that should be considered in path.
_custom_json
object
Custom JSON data related to the L2 category, allowing for additional metadata.
name
string
Name of the L2 category.
slug
string
Slug or URL-friendly identifier for the L2 category.
action
object (ProductListingAction)
ProductListingAction
type
string
Type of action to be taken e.g, page.
page
object (ProductListingActionPage)
ProductListingActionPage
type
string
The type of action such as product, products, category, brand.
query
object
Query parameter if any to be added to the action.
params
object
Parameters that should be considered in path.
_custom_json
object
Custom JSON data related to the L1 category, allowing for additional metadata.
name
string
Name of the L1 category.
slug
string
Slug or URL-friendly identifier for the L1 category.
action
object (ProductListingAction)
ProductListingAction
type
string
Type of action to be taken e.g, page.
page
object (ProductListingActionPage)
ProductListingActionPage
type
string
The type of action such as product, products, category, brand.
query
object
Query parameter if any to be added to the action.
params
object
Parameters that should be considered in path.
name
string
Name of the category.
slug
string
Slug or URL-friendly identifier for the category.
action
object (ProductListingAction)
ProductListingAction
type
string
Type of action to be taken e.g, page.
page
object (ProductListingActionPage)
ProductListingActionPage
type
string
The type of action such as product, products, category, brand.
query
object
Query parameter if any to be added to the action.
params
object
Parameters that should be considered in path.
department
string
Name of the department.
departments
array of object (DepartmentIdentifier)
List of departments.
Array of DepartmentIdentifier
uid
integer
Unique identifier for the department.
slug
string
Slug or URL-friendly identifier for the department.
Examples
Parameters
department:
"value"
GET
/service/application/catalog/v1.0/categories/
Loading...
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
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
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
uid
integer
Unique identifier for the category.
banners
object (ImageUrls)
ImageUrls
portrait
object (Media)
Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
landscape
object (Media)
Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
_custom_json
object
Custom JSON data related to the category, allowing for additional metadata.
name
string
Name of the category.
Examples
Parameters
slug:
"value"
GET
/service/application/catalog/v1.0/categories/{slug}/
Loading...
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_no
integer
The page number to navigate through the given set of results.
Default Value : 1
page_size
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
is_active
boolean
Indicates whether the collection is currently active.
uid
string
The unique identifier for the collection.
sort_on
string
The attribute by which the collection items are sorted.
meta
object
Additional metadata related to the collection.
banners
object (ImageUrls)
ImageUrls
portrait
object (Media)
Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
landscape
object (Media)
Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
cron
object
Cron details for scheduling related to the collection.
_schedule
object
The `Schedule` schema defines the timing and details for recurring or one-time tasks. It includes information on when the job should start and end, the frequency of the task, and any additional metadata. This schema helps in scheduling jobs or tasks based on specified timings and durations.
query
array of object (CollectionQuery)
A list of queries used to filter the collection.
Array of CollectionQuery
op
string
The operator used for filtering the collection.
Enum
value
array of Undefined Type
The values used for filtering based on the attribute.
attribute
string
The attribute on which the filter is applied.
description
string
A detailed description of the collection.
type
string
Type of collections e.g query, items.
_custom_json
object
Custom JSON data associated with 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.
action
object (ProductListingAction)
ProductListingAction
type
string
Type of action to be taken e.g, page.
page
object (ProductListingActionPage)
ProductListingActionPage
type
string
The type of action such as product, products, category, brand.
query
object
Query parameter if any to be added to the action.
params
object
Parameters that should be considered in path.
allow_facets
boolean
Indicates if facets are allowed for filtering within the collection.
logo
object (Media)
Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
priority
integer
Priority level of the collection for sorting or display purposes.
tags
array of string
Tags associated with the collection.
app_id
string
Application ID associated with the collection.
filters
object (CollectionListingFilter)
CollectionListingFilter
tags
array of object (CollectionListingFilterTag)
An array of tag filters available for the collection listings. Each tag allows for filtering based on specific attributes.
Array of CollectionListingFilterTag
name
string
The name of the tag. This is typically used as a label for filtering purposes.
is_selected
boolean
A flag indicating whether the tag is currently selected as a filter option.
display
string
The display name of the tag. This may be a user-friendly version of the tag name shown in the UI.
type
array of object (CollectionListingFilterType)
An array of filter types available for the collection listings. Each type represents a different category or attribute for filtering.
Array of CollectionListingFilterType
name
string
The name of the filter type. This indicates the type of filtering being applied, such as items, query.
is_selected
boolean
A flag indicating whether this filter type is currently selected as a filter option.
display
string
The display name of the filter type. This is the user-friendly name shown in the UI for the filter type.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
Examples
Parameters
page_no:
1
page_size:
1
tag:
"lorem","ipsum"
q:
"value"
GET
/service/application/catalog/v1.0/collections/
Loading...
Response
Loading...
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
sort_on
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
page_id
string
Page ID to retrieve next set of results.
Default Value : 1
page_size
integer
The number of items to retrieve in each page.
Default Value : 12
page_no
integer
Page Number to retrieve next set of results.
Default Value : 1
page_type
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
uid
integer
Unique identifier for the product.
custom_order
object (ProductDetailCustomOrder)
ProductDetailCustomOrder
manufacturing_time
integer
The unit of time taken for manufacturing.
manufacturing_time_unit
string
The unit of time required for manufacturing is defined in hours or days.
is_custom_order
boolean
A boolean flag indicating whether MTO (Make to Order) is enabled or not.
sizes
array of string
Available sizes for the product.
category_map
object (ProductCategoryMap)
ProductCategoryMap
l1
object (ProductBrand)
ProductBrand
uid
integer
Unique identifier for the product brand.
logo
object (Media)
Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
description
string
Description of the product brand.
Default Value :
name
string
Name of the product brand.
action
object (ProductListingAction)
ProductListingAction
type
string
Type of action to be taken e.g, page.
page
object (ProductListingActionPage)
ProductListingActionPage
type
string
The type of action such as product, products, category, brand.
query
object
Query parameter if any to be added to the action.
params
object
Parameters that should be considered in path.
l2
object (ProductBrand)
ProductBrand
uid
integer
Unique identifier for the product brand.
logo
object (Media)
Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
description
string
Description of the product brand.
Default Value :
name
string
Name of the product brand.
action
object (ProductListingAction)
ProductListingAction
type
string
Type of action to be taken e.g, page.
page
object (ProductListingActionPage)
ProductListingActionPage
type
string
The type of action such as product, products, category, brand.
query
object
Query parameter if any to be added to the action.
params
object
Parameters that should be considered in path.
l3
object (ProductBrand)
ProductBrand
uid
integer
Unique identifier for the product brand.
logo
object (Media)
Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
description
string
Description of the product brand.
Default Value :
name
string
Name of the product brand.
action
object (ProductListingAction)
ProductListingAction
type
string
Type of action to be taken e.g, page.
page
object (ProductListingActionPage)
ProductListingActionPage
type
string
The type of action such as product, products, category, brand.
query
object
Query parameter if any to be added to the action.
params
object
Parameters that should be considered in path.
net_quantity
object (NetQuantity)
NetQuantity
unit
Undefined Type
The unit of measurement used for the net quantity of the product.
Enum
value
number
| value >= 0.001
The value of the net quantity of the product.
rating_count
integer
The number of ratings the product has received.
_custom_meta
array of object (CustomMetaFields)
Custom metadata fields associated with the product.
Array of CustomMetaFields
value
string
A value to store in the custom field.
Minimum Length : 1
Maximum Length : 100
key
string
A key to store a custom field.
Minimum Length : 1
Maximum Length : 30
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
title
Undefined Type
The SEO title of the item.
description
Undefined Type
The SEO description of the item.
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
title
string
The title or name of the attribute group.
details
array of object (ProductDetailAttribute)
A list of product attributes within this group.
Array of ProductDetailAttribute
value
string
The value of the product attribute.
type
string
The type or category of the product attribute.
key
string
The key or name of the product attribute.
medias
array of object (Media)
Media files associated with the product.
Array of Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
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
minimum
integer
| value >= 1
The minimum quantity required for purchase.
Default Value : 1
maximum
integer
The maximum quantity allowed for purchase.
increment_unit
integer
| value >= 1
The minimum quantity increment in which the item can be purchased.
Default Value : 1
short_description
string
Brief description of the product.
categories
array of object (ProductBrand)
List of product categories associated with the product.
Array of ProductBrand
uid
integer
Unique identifier for the product brand.
logo
object (Media)
Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
description
string
Description of the product brand.
Default Value :
name
string
Name of the product brand.
action
object (ProductListingAction)
ProductListingAction
type
string
Type of action to be taken e.g, page.
page
object (ProductListingActionPage)
ProductListingActionPage
type
string
The type of action such as product, products, category, brand.
query
object
Query parameter if any to be added to the action.
params
object
Parameters that should be considered in path.
sellable
boolean
Indicates whether the product is available for sale.
attributes
object
Additional attributes or characteristics of the product.
variants
array of object (ProductVariantListingResponse)
List of product variants available for the product.
Array of ProductVariantListingResponse
header
string
Header or title for the product variant section.
items
array of object (ProductVariantItemResponse)
List of Upto 5 product variant items.
Array of ProductVariantItemResponse
uid
integer
Unique identifier for the product variant.
color_name
string
Name of the color for the variant.
color
string
Color code or representation for the variant.
medias
array of object (Media)
Media files associated with the product variant.
Array of Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
is_available
boolean
Indicates whether the product variant is available for purchase.
_custom_meta
array of object (CustomMetaFields)
Custom metadata fields associated with the product.
Array of CustomMetaFields
value
string
A value to store in the custom field.
Minimum Length : 1
Maximum Length : 100
key
string
A key to store a custom field.
Minimum Length : 1
Maximum Length : 30
name
string
Name of the product variant.
value
string
Value or label representing the product variant.
slug
string
URL-friendly identifier for the product.
_custom_json
object
Custom JSON object for additional data related to the product.
action
object (ProductListingAction)
ProductListingAction
type
string
Type of action to be taken e.g, page.
page
object (ProductListingActionPage)
ProductListingActionPage
type
string
The type of action such as product, products, category, brand.
query
object
Query parameter if any to be added to the action.
params
object
Parameters that should be considered in path.
total
integer
The total number of product variants available.
key
string
Attribute identifier of the variant.
display_type
string
The type of display for the product variant (e.g., image, text, image, color).
discount
string
Discount details or percentage applied to the product.
tryouts
array of string
List of tryout options available for the product.
identifiers
array of string
List of seller identifiers for the product.
Default Value :
slug
string
URL-friendly identifier for the product.
action
object (ProductListingAction)
ProductListingAction
type
string
Type of action to be taken e.g, page.
page
object (ProductListingActionPage)
ProductListingActionPage
type
string
The type of action such as product, products, category, brand.
query
object
Query parameter if any to be added to the action.
params
object
Parameters that should be considered in path.
rating
number
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
effective
object (Price)
Price
min
number
The minimum price for the product across stores.
currency_symbol
string
The currency symbol for the currency in which the product is available.
currency_code
string
The currency code for the currency in which the product is available.
max
number
The maximum price for the product across stores.
marked
object (Price)
Price
min
number
The minimum price for the product across stores.
currency_symbol
string
The currency symbol for the currency in which the product is available.
currency_code
string
The currency code for the currency in which the product is available.
max
number
The maximum price for the product across stores.
brand
object (ProductBrand)
ProductBrand
uid
integer
Unique identifier for the product brand.
logo
object (Media)
Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
description
string
Description of the product brand.
Default Value :
name
string
Name of the product brand.
action
object (ProductListingAction)
ProductListingAction
type
string
Type of action to be taken e.g, page.
page
object (ProductListingActionPage)
ProductListingActionPage
type
string
The type of action such as product, products, category, brand.
query
object
Query parameter if any to be added to the action.
params
object
Parameters that should be considered in path.
teaser_tag
string
Teaser tag or short promotional phrase for the product.
filters
array of object (ProductFilters)
List of filters available for refining the product listings.
Array of ProductFilters
values
array of object (ProductFiltersValue)
List of filter values associated with the filter key.
Array of ProductFiltersValue
min
integer
Minimum value for the range filter.
display_format
string
Format in which the filter value is displayed.
selected_max
integer
The maximum value selected by the user for range filter.
value
string
Value associated with the filter option.
query_format
string
Format used for the filter value in queries.
currency_symbol
string
Currency symbol for the price type filters.
selected_min
integer
The minimum value selected by the user for range filter.
currency_code
string
Currency code for the currency used for price type filters.
is_selected
boolean
Whether this filter value is currently selected.
display
string
Display name or label for the filter value.
count
integer
Number of products that match this filter value.
max
integer
Maximum value of the filter range.
key
object (ProductFiltersKey)
ProductFiltersKey
logo
string
| url
URL or path to the logo associated with the filter key.
name
string
Name or identifier of the filter key.
kind
string
Type or category of the filter key (e.g., range, multivalued).
display
string
Display name or label for the filter key.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
sort_on
array of object (ProductSortOn)
List of sorting options available for the product listings.
Array of ProductSortOn
logo
string
| url
URL or path to the logo associated with the sorting option.
is_selected
boolean
Indicates whether this sorting option is currently selected.
name
string
Name or identifier of the sorting option.
value
string
Value used to specify the sorting order (e.g., price_asc, discount_dsc).
display
string
Display name or label for the sorting option.
Examples
Parameters
slug:
"value"
f:
"value"
q:
"value"
filters:
false
sort_on:
"value"
page_id:
"value"
page_size:
1
page_no:
1
page_type:
"value"
GET
/service/application/catalog/v1.0/collections/{slug}/items/
Loading...
Response
Loading...
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
portrait
object (Media)
Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
landscape
object (Media)
Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
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
op
string
The operator used for filtering the collection.
Enum
value
array of object
The values used for filtering based on the attribute.
attribute
string
The attribute on which the filter is applied.
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
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
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"
GET
/service/application/catalog/v1.0/collections/{slug}/
Loading...
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
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
uid
integer
Unique identifier for the department.
logo
object (Media)
Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
priority_order
integer
Specifies the display order of the department, determining its position in lists and navigation menus based on priority.
name
string
Name of the department.
slug
string
URL-friendly version of the department's name, used in the web address to access the department's page on the platform.
Examples
Parameters
Parameters are not required.
GET
/service/application/catalog/v1.0/departments/
Loading...
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_type
string
Required
Type of collection followed, i.e. products, brands, or collections.
page_id
string
Page ID to retrieve next set of results.
Default Value : 1
page_size
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
uid
integer
Unique identifier for the product.
custom_order
object (ProductDetailCustomOrder)
ProductDetailCustomOrder
manufacturing_time
integer
The unit of time taken for manufacturing.
manufacturing_time_unit
string
The unit of time required for manufacturing is defined in hours or days.
is_custom_order
boolean
A boolean flag indicating whether MTO (Make to Order) is enabled or not.
sizes
array of string
Available sizes for the product.
category_map
object (ProductCategoryMap)
ProductCategoryMap
l1
object (ProductBrand)
ProductBrand
uid
integer
Unique identifier for the product brand.
logo
object (Media)
Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
description
string
Description of the product brand.
Default Value :
name
string
Name of the product brand.
action
object (ProductListingAction)
ProductListingAction
type
string
Type of action to be taken e.g, page.
page
object (ProductListingActionPage)
ProductListingActionPage
type
string
The type of action such as product, products, category, brand.
query
object
Query parameter if any to be added to the action.
params
object
Parameters that should be considered in path.
l2
object (ProductBrand)
ProductBrand
uid
integer
Unique identifier for the product brand.
logo
object (Media)
Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
description
string
Description of the product brand.
Default Value :
name
string
Name of the product brand.
action
object (ProductListingAction)
ProductListingAction
type
string
Type of action to be taken e.g, page.
page
object (ProductListingActionPage)
ProductListingActionPage
type
string
The type of action such as product, products, category, brand.
query
object
Query parameter if any to be added to the action.
params
object
Parameters that should be considered in path.
l3
object (ProductBrand)
ProductBrand
uid
integer
Unique identifier for the product brand.
logo
object (Media)
Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
description
string
Description of the product brand.
Default Value :
name
string
Name of the product brand.
action
object (ProductListingAction)
ProductListingAction
type
string
Type of action to be taken e.g, page.
page
object (ProductListingActionPage)
ProductListingActionPage
type
string
The type of action such as product, products, category, brand.
query
object
Query parameter if any to be added to the action.
params
object
Parameters that should be considered in path.
net_quantity
object (NetQuantity)
NetQuantity
unit
object
The unit of measurement used for the net quantity of the product.
Enum
value
number
| value >= 0.001
The value of the net quantity of the product.
rating_count
integer
The number of ratings the product has received.
_custom_meta
array of object (CustomMetaFields)
Custom metadata fields associated with the product.
Array of CustomMetaFields
value
string
A value to store in the custom field.
Minimum Length : 1
Maximum Length : 100
key
string
A key to store a custom field.
Minimum Length : 1
Maximum Length : 30
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
title
object
The SEO title of the item.
description
object
The SEO description of the item.
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
title
string
The title or name of the attribute group.
details
array of object (ProductDetailAttribute)
A list of product attributes within this group.
Array of ProductDetailAttribute
value
string
The value of the product attribute.
type
string
The type or category of the product attribute.
key
string
The key or name of the product attribute.
medias
array of object (Media)
Media files associated with the product.
Array of Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
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
minimum
integer
| value >= 1
The minimum quantity required for purchase.
Default Value : 1
maximum
integer
The maximum quantity allowed for purchase.
increment_unit
integer
| value >= 1
The minimum quantity increment in which the item can be purchased.
Default Value : 1
short_description
string
Brief description of the product.
categories
array of object (ProductBrand)
List of product categories associated with the product.
Array of ProductBrand
uid
integer
Unique identifier for the product brand.
logo
object (Media)
Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
description
string
Description of the product brand.
Default Value :
name
string
Name of the product brand.
action
object (ProductListingAction)
ProductListingAction
type
string
Type of action to be taken e.g, page.
page
object (ProductListingActionPage)
ProductListingActionPage
type
string
The type of action such as product, products, category, brand.
query
object
Query parameter if any to be added to the action.
params
object
Parameters that should be considered in path.
sellable
boolean
Indicates whether the product is available for sale.
attributes
object
Additional attributes or characteristics of the product.
variants
array of object (ProductVariantListingResponse)
List of product variants available for the product.
Array of ProductVariantListingResponse
header
string
Header or title for the product variant section.
items
array of object (ProductVariantItemResponse)
List of Upto 5 product variant items.
Array of ProductVariantItemResponse
uid
integer
Unique identifier for the product variant.
color_name
string
Name of the color for the variant.
color
string
Color code or representation for the variant.
medias
array of object (Media)
Media files associated with the product variant.
Array of Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
is_available
boolean
Indicates whether the product variant is available for purchase.
_custom_meta
array of object (CustomMetaFields)
Custom metadata fields associated with the product.
Array of CustomMetaFields
value
string
A value to store in the custom field.
Minimum Length : 1
Maximum Length : 100
key
string
A key to store a custom field.
Minimum Length : 1
Maximum Length : 30
name
string
Name of the product variant.
value
string
Value or label representing the product variant.
slug
string
URL-friendly identifier for the product.
_custom_json
object
Custom JSON object for additional data related to the product.
action
object (ProductListingAction)
ProductListingAction
type
string
Type of action to be taken e.g, page.
page
object (ProductListingActionPage)
ProductListingActionPage
type
string
The type of action such as product, products, category, brand.
query
object
Query parameter if any to be added to the action.
params
object
Parameters that should be considered in path.
total
integer
The total number of product variants available.
key
string
Attribute identifier of the variant.
display_type
string
The type of display for the product variant (e.g., image, text, image, color).
discount
string
Discount details or percentage applied to the product.
tryouts
array of string
List of tryout options available for the product.
identifiers
array of string
List of seller identifiers for the product.
Default Value :
slug
string
URL-friendly identifier for the product.
action
object (ProductListingAction)
ProductListingAction
type
string
Type of action to be taken e.g, page.
page
object (ProductListingActionPage)
ProductListingActionPage
type
string
The type of action such as product, products, category, brand.
query
object
Query parameter if any to be added to the action.
params
object
Parameters that should be considered in path.
rating
number
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
effective
object (Price)
Price
min
number
The minimum price for the product across stores.
currency_symbol
string
The currency symbol for the currency in which the product is available.
currency_code
string
The currency code for the currency in which the product is available.
max
number
The maximum price for the product across stores.
marked
object (Price)
Price
min
number
The minimum price for the product across stores.
currency_symbol
string
The currency symbol for the currency in which the product is available.
currency_code
string
The currency code for the currency in which the product is available.
max
number
The maximum price for the product across stores.
brand
object (ProductBrand)
ProductBrand
uid
integer
Unique identifier for the product brand.
logo
object (Media)
Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
description
string
Description of the product brand.
Default Value :
name
string
Name of the product brand.
action
object (ProductListingAction)
ProductListingAction
type
string
Type of action to be taken e.g, page.
page
object (ProductListingActionPage)
ProductListingActionPage
type
string
The type of action such as product, products, category, brand.
query
object
Query parameter if any to be added to the action.
params
object
Parameters that should be considered in path.
teaser_tag
string
Teaser tag or short promotional phrase for the product.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
Examples
Parameters
collection_type:
"value"
page_id:
"value"
page_size:
1
GET
/service/application/catalog/v1.0/follow/{collection_type}/
Loading...
Response
Loading...
DEL

Delete item, brand, product

Remove a followed item, brand, or product using its collection ID.
Parameters
collection_type
string
Required
Type of collection followed, i.e. products, brands, or collections.
collection_id
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
collection_type:
"value"
collection_id:
"value"
DEL
/service/application/catalog/v1.0/follow/{collection_type}/{collection_id}/
Loading...
Response
Loading...
POST

Create item, brand, product

Add a product, brand, or item to the user's followed list by collection Id.
Parameters
collection_type
string
Required
Type of collection followed, i.e. products, brands, or collections.
collection_id
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
collection_type:
"value"
collection_id:
"value"
POST
/service/application/catalog/v1.0/follow/{collection_type}/{collection_id}/
Loading...
Response
Loading...
GET

Get follower count

Get the total number of followers for a specific item by its ID.
Parameters
collection_type
string
Required
Type of collection, i.e. products, brands, or collections.
collection_id
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
collection_type:
"value"
collection_id:
"value"
GET
/service/application/catalog/v1.0/follow/{collection_type}/{collection_id}/count/
Loading...
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_type
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
products
array of integer
An array of IDs representing the products that the user is following.
collections
array of integer
An array of IDs representing the collections that the user is following.
brands
array of integer
An array of IDs representing the brands that the user is following.
Examples
Parameters
collection_type:
"value"
GET
/service/application/catalog/v1.0/follow/ids/
Loading...
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}/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/v1.0/product-grouping/
# List product bundles
GET
/service/application/catalog/v3.0/products/{slug}/sizes/{size}/price/
# Get product price
GET
/service/application/catalog/v3.0/products/{slug}/sizes/{size}/sellers/
# 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
manufacturing_time
integer
The unit of time taken for manufacturing.
manufacturing_time_unit
string
The unit of time required for manufacturing is defined in hours or days.
is_custom_order
boolean
A boolean flag indicating whether MTO (Make to Order) is enabled or not.
category_map
object (ProductCategoryMap)
ProductCategoryMap
l1
object (ProductBrand)
ProductBrand
uid
integer
Unique identifier for the product brand.
logo
object (Media)
Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
description
string
Description of the product brand.
Default Value :
name
string
Name of the product brand.
action
object (ProductListingAction)
ProductListingAction
type
string
Type of action to be taken e.g, page.
page
object (ProductListingActionPage)
ProductListingActionPage
type
string
The type of action such as product, products, category, brand.
query
object
Query parameter if any to be added to the action.
params
object
Parameters that should be considered in path.
l2
object (ProductBrand)
ProductBrand
uid
integer
Unique identifier for the product brand.
logo
object (Media)
Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
description
string
Description of the product brand.
Default Value :
name
string
Name of the product brand.
action
object (ProductListingAction)
ProductListingAction
type
string
Type of action to be taken e.g, page.
page
object (ProductListingActionPage)
ProductListingActionPage
type
string
The type of action such as product, products, category, brand.
query
object
Query parameter if any to be added to the action.
params
object
Parameters that should be considered in path.
l3
object (ProductBrand)
ProductBrand
uid
integer
Unique identifier for the product brand.
logo
object (Media)
Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
description
string
Description of the product brand.
Default Value :
name
string
Name of the product brand.
action
object (ProductListingAction)
ProductListingAction
type
string
Type of action to be taken e.g, page.
page
object (ProductListingActionPage)
ProductListingActionPage
type
string
The type of action such as product, products, category, brand.
query
object
Query parameter if any to be added to the action.
params
object
Parameters that should be considered in path.
net_quantity
object (NetQuantity)
NetQuantity
unit
object
The unit of measurement used for the net quantity of the product.
Enum
value
number
| value >= 0.001
The value of the net quantity of the product.
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
value
string
A value to store in the custom field.
Minimum Length : 1
Maximum Length : 100
key
string
A key to store a custom field.
Minimum Length : 1
Maximum Length : 30
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
title
object
The SEO title of the item.
description
object
The SEO description of the item.
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
title
string
The title or name of the attribute group.
details
array of object (ProductDetailAttribute)
A list of product attributes within this group.
Array of ProductDetailAttribute
value
string
The value of the product attribute.
type
string
The type or category of the product attribute.
key
string
The key or name of the product attribute.
medias
array of object (Media)
Media files associated with the product.
Array of Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
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
minimum
integer
| value >= 1
The minimum quantity required for purchase.
Default Value : 1
maximum
integer
The maximum quantity allowed for purchase.
increment_unit
integer
| value >= 1
The minimum quantity increment in which the item can be purchased.
Default Value : 1
short_description
string
Brief description of the product.
categories
array of object (ProductBrand)
List of product categories associated with the product.
Array of ProductBrand
uid
integer
Unique identifier for the product brand.
logo
object (Media)
Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
description
string
Description of the product brand.
Default Value :
name
string
Name of the product brand.
action
object (ProductListingAction)
ProductListingAction
type
string
Type of action to be taken e.g, page.
page
object (ProductListingActionPage)
ProductListingActionPage
type
string
The type of action such as product, products, category, brand.
query
object
Query parameter if any to be added to the action.
params
object
Parameters that should be considered in path.
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
type
string
Type of action to be taken e.g, page.
page
object (ProductListingActionPage)
ProductListingActionPage
type
string
The type of action such as product, products, category, brand.
query
object
Query parameter if any to be added to the action.
params
object
Parameters that should be considered in path.
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
effective
object (Price)
Price
min
number
The minimum price for the product across stores.
currency_symbol
string
The currency symbol for the currency in which the product is available.
currency_code
string
The currency code for the currency in which the product is available.
max
number
The maximum price for the product across stores.
marked
object (Price)
Price
min
number
The minimum price for the product across stores.
currency_symbol
string
The currency symbol for the currency in which the product is available.
currency_code
string
The currency code for the currency in which the product is available.
max
number
The maximum price for the product across stores.
brand
object (ProductBrand)
ProductBrand
uid
integer
Unique identifier for the product brand.
logo
object (Media)
Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
description
string
Description of the product brand.
Default Value :
name
string
Name of the product brand.
action
object (ProductListingAction)
ProductListingAction
type
string
Type of action to be taken e.g, page.
page
object (ProductListingActionPage)
ProductListingActionPage
type
string
The type of action such as product, products, category, brand.
query
object
Query parameter if any to be added to the action.
params
object
Parameters that should be considered in path.
department
object (ProductDepartment)
ProductDepartment
uid
integer
Unique identifier for the product department.
logo
object (Media)
Media
url
string
Absolute url for Media.
type
string
The type of media, such as image, video.
meta
object (Meta)
Meta
source
string
The source or origin of the media file, which could be a URL or a reference to where the media was obtained.
alt
string
Alternative text for the media, used for accessibility and SEO purposes.
slug
string
URL-friendly identifier for the product department.
name
string
Name of the product department.
teaser_tag
string
Teaser tag or short promotional phrase for the product.
Examples
Parameters
slug:
"value"
GET
/service/application/catalog/v1.0/products/{slug}/
Loading...
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).
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/.
store_id
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
quantity
integer
The quantity of the product size available.
dimension
object (Dimension)
Dimension
unit
string
The unit of dimension.
height
number
The height of the product.
length
number
The length of the product.