Catalog
The Catalog module manages product details and size availability, and enables easy comparisons. Use it to explore product options, check stock status, and retrieve brand and category information. The module also supports personalization by allowing tracking of preferred items and brands. It highlights popular products based on user engagement and provides store details. Additionally, this module covers bundled items, size-specific pricing, and seller information.
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
# Fetches all available brands.
GET
# Retrieves detailed brand info by slug.
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/.
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
400
Success. Returns a paginated list of brands.
BrandListingResponseSchema
items
array of object (BrandItem)
List of brand items included in the response.
Array of BrandItem
id
integer
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.
seo
object (ApplicationItemSEO)
ApplicationItemSEO
description
string
The SEO description of the item.
sitemap
object (ApplicationItemSeoSitemap)
ApplicationItemSeoSitemap
priority
number
| float
The SEO priority of the item.
Enum
frequency
string
The SEO frequency of the item.
Enum
breadcrumbs
array of object (ApplicationItemSeoBreadcrumbs)
Array of ApplicationItemSeoBreadcrumbs
url
string
The URL that this breadcrumb points to.
action
object (ApplicationItemSeoAction)
ApplicationItemSeoAction
page
object
Details of the page associated with this SEO action.
type
string
Type of action, such as navigation or redirection.
meta_tags
array of object (ApplicationItemSeoMetaTags)
Array of ApplicationItemSeoMetaTags
title
string
The SEO title of the product.
items
array of object (ApplicationItemSeoMetaTagItem)
The SEO items for the product.
Array of ApplicationItemSeoMetaTagItem
key
string
The name of the meta tag.
value
string
The value associated with the meta tag.
canonical_url
string
The SEO canonical URL of the item.
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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.
total
integer
| int32
Total number of items.
Examples
Parameters
department:
"fashion"
page_no:
1
page_size:
12
Was this section helpful?
GET
Response
Fetches all available brands.
getBrands
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
400
Success. Returns a metadata object.
BrandDetailResponseSchema
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.
slug
string
_app
object
name
string
Name of the brand.
seo
object (ApplicationItemSEO)
ApplicationItemSEO
description
string
The SEO description of the item.
sitemap
object (ApplicationItemSeoSitemap)
ApplicationItemSeoSitemap
priority
number
| float
The SEO priority of the item.
Enum
frequency
string
The SEO frequency of the item.
Enum
breadcrumbs
array of object (ApplicationItemSeoBreadcrumbs)
Array of ApplicationItemSeoBreadcrumbs
url
string
The URL that this breadcrumb points to.
action
object (ApplicationItemSeoAction)
ApplicationItemSeoAction
page
object
Details of the page associated with this SEO action.
type
string
Type of action, such as navigation or redirection.
meta_tags
array of object (ApplicationItemSeoMetaTags)
Array of ApplicationItemSeoMetaTags
title
string
The SEO title of the product.
items
array of object (ApplicationItemSeoMetaTagItem)
The SEO items for the product.
Array of ApplicationItemSeoMetaTagItem
key
string
The name of the meta tag.
value
string
The value associated with the meta tag.
canonical_url
string
The SEO canonical URL of the item.
Examples
Parameters
slug:
"Guerra-Chang"
Was this section helpful?
GET
Response
Retrieves detailed brand info by slug.
getBrandDetailBySlug
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
# Lists all product categories.
GET
# Retrieves category details by slug.
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
404
Success. Returns a list of categories.
CategoryListingResponseSchema
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
priority
integer
Priority of the category in the listing order.
_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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
priority
integer
Priority of the category in the listing order.
_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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
priority
integer
Priority of the category in the listing order.
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
priority
integer
Priority of the category in the listing order.
_custom_json
object
Custom JSON data associated with the category.
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:
"fashion"
Was this section helpful?
GET
Response
Lists all product categories.
getCategories
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
Success. Returns metadata of a category.
CategoryMetaResponseSchema
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.
_app
object
Application-specific data associated with the category.
Examples
Parameters
slug:
"Paul-Walker"
Was this section helpful?
GET
Response
Retrieves category details by slug.
getCategoryDetailBySlug
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
# Fetches all available collections.
GET
# Lists items in a collection by slug.
GET
# Retrieves collection details by slug.
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
404
Success. Returns a list of collections.
GetCollectionListingResponseSchema
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.
_id
string
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 (Schedule)
Schedule
cron
string
The cron expression for the schedule.
next_schedule
array of object (NextSchedule)
List of next schedules.
Array of NextSchedule
start
string
Nullable
The start time of the next schedule.
end
string
Nullable
The end time of the next schedule.
duration
integer
The duration of the job in seconds.
start
string
Nullable
The start time of the job.
end
string
Nullable
The end time of the job.
metadata
object
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 string
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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
app_id
string
Application ID associated with the collection.
published
boolean
Indicates if the item is published.
_locale_language
object
Locale or language settings for the item.
seo
object
SEO details for the item, with dynamic fields.
is_visible
boolean
Indicates if the item is visible.
modified_on
string
| date-time
Date and time when the filter was modified.
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.
total
integer
| int32
Total number of items.
Examples
Parameters
page_no:
1
page_size:
12
tag:
"test"
q:
"trending"
Was this section helpful?
GET
Response
Fetches all available collections.
getCollections
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.
Enum
Response
200
Success. Returns a list items in a given collection. Check the example shown below or refer `ProductListingResponse` for more details.
ProductListingResponseSchema
items
array of object (ProductListingDetail)
List of product details included in the response.
Array of ProductListingDetail
discount_meta
object (DiscountMeta)
DiscountMeta
timer
boolean
Determines whether the discount countdown is visible or not.
start_timer_in_minutes
number
The time in minutes before the discount ends when the countdown timer should start.
start
string
The start time of the live discount.
end
string
The end time of the live discount.
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.
type
string
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_custom_json
object
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.
type
string
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_custom_json
object
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.
type
string
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_custom_json
object
net_quantity
object (NetQuantity)
NetQuantity
unit
string
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
description
string
The SEO description of the item.
sitemap
object (ApplicationItemSeoSitemap)
ApplicationItemSeoSitemap
priority
number
| float
The SEO priority of the item.
Enum
frequency
string
The SEO frequency of the item.
Enum
breadcrumbs
array of object (ApplicationItemSeoBreadcrumbs)
Array of ApplicationItemSeoBreadcrumbs
url
string
The URL that this breadcrumb points to.
action
object (ApplicationItemSeoAction)
ApplicationItemSeoAction
page
object
Details of the page associated with this SEO action.
type
string
Type of action, such as navigation or redirection.
meta_tags
array of object (ApplicationItemSeoMetaTags)
Array of ApplicationItemSeoMetaTags
title
string
The SEO title of the product.
items
array of object (ApplicationItemSeoMetaTagItem)
The SEO items for the product.
Array of ApplicationItemSeoMetaTagItem
key
string
The name of the meta tag.
value
string
The value associated with the meta tag.
canonical_url
string
The SEO canonical URL 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, Set Digital.
Enum
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.
type
string
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_custom_json
object
sellable
boolean
Indicates whether the product is available for sale.
attributes
object
Additional attributes or characteristics of the product.
variants
array of object (ProductVariantListingResponseSchema)
List of product variants available for the product.
Array of ProductVariantListingResponseSchema
header
string
Header or title for the product variant section.
items
array of object (ProductVariantItemResponseSchema)
List of Upto 5 product variant items.
Array of ProductVariantItemResponseSchema
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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.
selling
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.
type
string
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_custom_json
object
teaser_tag
string
Teaser tag or short promotional phrase for the product.
country_of_origin
string
The country of origin for the product.
is_tryout
boolean
Indicates if the product is available for tryout.
channel
string
Identifier for the product channel.
modified_on
string
| date-time
Date and time when the filter was modified.
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.
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.
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.
total
integer
| int32
Total number of items.
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:
"test-collection-6aecd5b7"
f:
"brand:Guerra-Chang||test-brand:::l3_categories:Paul-Walker||Sarah-Murray||Sarah-Carter||Rerank-Category"
q:
"test"
filters:
true
sort_on:
"popular"
page_id:
"1"
page_size:
12
page_no:
1
page_type:
"number"
Was this section helpful?
GET
Response
Lists items in a collection by slug.
getCollectionItemsBySlug
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
404
Success. Returns a Collection object.
CollectionDetailResponseSchema
uid
string
published
boolean
tags
array of string
_locale_language
object
seo
object
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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)
Schedule
cron
string
The cron expression for the schedule.
next_schedule
array of object (NextSchedule)
List of next schedules.
Array of NextSchedule
start
string
Nullable
The start time of the next schedule.
end
string
Nullable
The end time of the next schedule.
duration
integer
The duration of the job in seconds.
start
string
Nullable
The start time of the job.
end
string
Nullable
The end time of the job.
metadata
object
modified_on
string
| date-time
Date and time when the filter was modified.
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 string
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.
_id
string
MongoDB ObjectID of the item.
is_visible
boolean
Indicates if the query or collection is visible.
Examples
Parameters
slug:
"test-collection-6aecd5b7"
Was this section helpful?
GET
Response
Retrieves collection details by slug.
getCollectionDetailBySlug
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
# Fetches homepage-featured products.
GET
# Lists all departments.
List all the products associated with a brand, collection or category in a random order.
Parameters
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.
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
Response
200
Success. Returns a paginated list of products.
HomeListingResponseSchema
items
array of object (ProductListingDetail)
List of product details displayed on the home page.
Array of ProductListingDetail
discount_meta
object (DiscountMeta)
DiscountMeta
timer
boolean
Determines whether the discount countdown is visible or not.
start_timer_in_minutes
number
The time in minutes before the discount ends when the countdown timer should start.
start
string
The start time of the live discount.
end
string
The end time of the live discount.
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.
type
string
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_custom_json
object
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.
type
string
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_custom_json
object
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.
type
string
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_custom_json
object
net_quantity
object (NetQuantity)
NetQuantity
unit
string
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
description
string
The SEO description of the item.
sitemap
object (ApplicationItemSeoSitemap)
ApplicationItemSeoSitemap
priority
number
| float
The SEO priority of the item.
Enum
frequency
string
The SEO frequency of the item.
Enum
breadcrumbs
array of object (ApplicationItemSeoBreadcrumbs)
Array of ApplicationItemSeoBreadcrumbs
url
string
The URL that this breadcrumb points to.
action
object (ApplicationItemSeoAction)
ApplicationItemSeoAction
page
object
Details of the page associated with this SEO action.
type
string
Type of action, such as navigation or redirection.
meta_tags
array of object (ApplicationItemSeoMetaTags)
Array of ApplicationItemSeoMetaTags
title
string
The SEO title of the product.
items
array of object (ApplicationItemSeoMetaTagItem)
The SEO items for the product.
Array of ApplicationItemSeoMetaTagItem
key
string
The name of the meta tag.
value
string
The value associated with the meta tag.
canonical_url
string
The SEO canonical URL 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, Set Digital.
Enum
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.
type
string
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_custom_json
object
sellable
boolean
Indicates whether the product is available for sale.
attributes
object
Additional attributes or characteristics of the product.
variants
array of object (ProductVariantListingResponseSchema)
List of product variants available for the product.
Array of ProductVariantListingResponseSchema
header
string
Header or title for the product variant section.
items
array of object (ProductVariantItemResponseSchema)
List of Upto 5 product variant items.
Array of ProductVariantItemResponseSchema
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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.
selling
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.
type
string
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_custom_json
object
teaser_tag
string
Teaser tag or short promotional phrase for the product.
country_of_origin
string
The country of origin for the product.
is_tryout
boolean
Indicates if the product is available for tryout.
channel
string
Identifier for the product channel.
modified_on
string
| date-time
Date and time when the filter was modified.
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.
total
integer
| int32
Total number of items.
message
string
Message related to the home listing response.
sort_on
string
The attribute by which the products are sorted.
Examples
Parameters
sort_on:
"latest"
page_id:
"636a4c5c295d937d233826a5"
page_size:
12
Was this section helpful?
GET
Response
Fetches homepage-featured products.
getHomeProducts
Parameters
No Parameters
Response
200
List of Departments.
DepartmentResponseSchema
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.
Was this section helpful?
GET
Response
Lists all departments.
getDepartments
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
# Retrieves user's followed listings.
DEL
# Delete item, brand, product
POST
# Follows an item by ID.
GET
# Retrieves follower count for an item.
GET
# Fetches IDs of followed items.
Parameters
collection_type
string
Required
Type of collection followed, i.e. products, brands, or collections.
Enum
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
Success. Returns a Followed resource object.
GetFollowListingResponseSchema
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
discount_meta
object (DiscountMeta)
DiscountMeta
timer
boolean
Determines whether the discount countdown is visible or not.
start_timer_in_minutes
number
The time in minutes before the discount ends when the countdown timer should start.
start
string
The start time of the live discount.
end
string
The end time of the live discount.
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.
type
string
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_custom_json
object
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.
type
string
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_custom_json
object
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.
type
string
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_custom_json
object
net_quantity
object (NetQuantity)
NetQuantity
unit
string
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
description
string
The SEO description of the item.
sitemap
object (ApplicationItemSeoSitemap)
ApplicationItemSeoSitemap
priority
number
| float
The SEO priority of the item.
Enum
frequency
string
The SEO frequency of the item.
Enum
breadcrumbs
array of object (ApplicationItemSeoBreadcrumbs)
Array of ApplicationItemSeoBreadcrumbs
url
string
The URL that this breadcrumb points to.
action
object (ApplicationItemSeoAction)
ApplicationItemSeoAction
page
object
Details of the page associated with this SEO action.
type
string
Type of action, such as navigation or redirection.
meta_tags
array of object (ApplicationItemSeoMetaTags)
Array of ApplicationItemSeoMetaTags
title
string
The SEO title of the product.
items
array of object (ApplicationItemSeoMetaTagItem)
The SEO items for the product.
Array of ApplicationItemSeoMetaTagItem
key
string
The name of the meta tag.
value
string
The value associated with the meta tag.
canonical_url
string
The SEO canonical URL 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, Set Digital.
Enum
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.
type
string
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_custom_json
object
sellable
boolean
Indicates whether the product is available for sale.
attributes
object
Additional attributes or characteristics of the product.
variants
array of object (ProductVariantListingResponseSchema)
List of product variants available for the product.
Array of ProductVariantListingResponseSchema
header
string
Header or title for the product variant section.
items
array of object (ProductVariantItemResponseSchema)
List of Upto 5 product variant items.
Array of ProductVariantItemResponseSchema
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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.
selling
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.
type
string
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_custom_json
object
teaser_tag
string
Teaser tag or short promotional phrase for the product.
country_of_origin
string
The country of origin for the product.
is_tryout
boolean
Indicates if the product is available for tryout.
channel
string
Identifier for the product channel.
modified_on
string
| date-time
Date and time when the filter was modified.
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.
total
integer
| int32
Total number of items.
Examples
Parameters
collection_type:
"products"
page_id:
"636a4c5c295d937d233826a5"
page_size:
12
Was this section helpful?
GET
Response
Retrieves user's followed listings.
getFollowedListing
Parameters
collection_type
string
Required
Type of collection followed, i.e. products, brands, or collections.
Enum
collection_id
string
Required
The ID of the collection type.
Response
200
400
Success. Returns a response object.
FollowPostResponseSchema
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"
Was this section helpful?
DEL
Response
Delete item, brand, product
unfollowById
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.
Enum
collection_id
string
Required
The ID of the collection type.
Response
200
404
Success. Returns a response object.
FollowPostResponseSchema
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:
"products"
collection_id:
"1"
Was this section helpful?
POST
Response
Follows an item by ID.
followById
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.
Enum
collection_id
integer
Required
The ID of the collection type.
Response
200
400
Success. Returns the number of followers for a given collection type.
FollowerCountResponseSchema
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:
1
Was this section helpful?
GET
Response
Retrieves follower count for an item.
getFollowerCountById
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.
Enum
Response
200
400
Success. Returns the IDs of all the Products, Brands and Collections which were followed.
FollowIdsResponseSchema
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:
"products"
Was this section helpful?
GET
Response
Fetches IDs of followed items.
getFollowIds
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
# Fetches detailed product information by slug.
GET
# Retrieves available sizes for a product by slug.
GET
# Compares multiple products by slugs.
GET
# Fetches similar products for comparison.
GET
# Retrieves products frequently compared with a given product.
GET
# Retrieves product variants by slug.
GET
# Checks product stock by IDs.
GET
# Fetches future stock data for products.
GET
# Lists all products.
GET
# Fetches product bundles by slug.
POST
# get size price for multiple products
GET
# Get the sellers of a product size at a PIN Code
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
404
Success. Returns a Product object.
ProductDetail
uid
integer
Unique identifier for the product.
sizes
array of string
identifiers
array of string
is_tryout
boolean
channel
string
discount_meta
object (DiscountMeta)
DiscountMeta
timer
boolean
Determines whether the discount countdown is visible or not.
start_timer_in_minutes
number
The time in minutes before the discount ends when the countdown timer should start.
start
string
The start time of the live discount.
end
string
The end time of the live discount.
variants
array of object (ProductVariantResponseSchema)
Array of ProductVariantResponseSchema
display_type
string
The type of display for the product variant (e.g., image, text, image, color).
header
string
Header or title for the product variant section.
logo
string
URL or path to the logo associated with the product variant.
group_id
string
Group ID used to group variants.
items
array of object (ProductVariantItemResponseSchema)
List of product variant items.
Array of ProductVariantItemResponseSchema
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
key
string
Attribute identifier of the variant.
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.
type
string
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_custom_json
object
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.
type
string
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_custom_json
object
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.
type
string
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_custom_json
object
net_quantity
object (NetQuantity)
NetQuantity
unit
string
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
description
string
The SEO description of the item.
sitemap
object (ApplicationItemSeoSitemap)
ApplicationItemSeoSitemap
priority
number
| float
The SEO priority of the item.
Enum
frequency
string
The SEO frequency of the item.
Enum
breadcrumbs
array of object (ApplicationItemSeoBreadcrumbs)
Array of ApplicationItemSeoBreadcrumbs
url
string
The URL that this breadcrumb points to.
action
object (ApplicationItemSeoAction)
ApplicationItemSeoAction
page
object
Details of the page associated with this SEO action.
type
string
Type of action, such as navigation or redirection.
meta_tags
array of object (ApplicationItemSeoMetaTags)
Array of ApplicationItemSeoMetaTags
title
string
The SEO title of the product.
items
array of object (ApplicationItemSeoMetaTagItem)
The SEO items for the product.
Array of ApplicationItemSeoMetaTagItem
key
string
The name of the meta tag.
value
string
The value associated with the meta tag.
canonical_url
string
The SEO canonical URL 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, Set Digital.
Enum
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.
type
string
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_custom_json
object
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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.
selling
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.
type
string
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_custom_json
object
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.
promo_meta
object
no_of_boxes
integer
template_tag
string
sellable
boolean
country_of_origin
string
The country of origin for the product.
modified_on
string
| date-time
Date and time when the filter was modified.
Examples
Parameters
slug:
"facilitate-value-added-infrastructures"
Was this section helpful?
GET
Response
Fetches detailed product information by slug.
getProductDetailBySlug
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
400
Success. Returns a ProductSize object.
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.
width
number
The width of the product.
is_default
boolean
Whether the dimension is the default one or not.
weight
object (Weight)
Weight
unit
string
The unit of weight.
shipping
number
The shipping weight of the product.
is_default
boolean
Whether the weight is the default one or not.
is_available
boolean
Indicates whether the product size is available for purchase.
seller_identifiers
array of string
List of identifiers used by sellers for the product size.
value
string
The value or label representing the product size.
display
string
Display name of the product size.
set
object (ProductSetV3)
ProductSetV3
quantity
integer
The quantity of products in the set.
size_distribution
object (ProductSetDistributionV3)
ProductSetDistributionV3
sizes
array of object (ProductSetDistributionSizeV3)
A list of size distributions in the product set.
Array of ProductSetDistributionSizeV3
pieces
integer
The number of pieces available in this size.
size
string
The size of the product.
price
object (ProductSizesPrice)
ProductSizesPrice
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.
selling
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.
price_per_piece
object (ProductSizesPrice)
ProductSizesPrice
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.
selling
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.
size_chart
object (SizeChart)
SizeChart
unit
string
Unit of measurement used in the size chart (e.g., in, cm).
image
string
| url
URL of the image representing the size chart.
size_tip
string
Additional tip or guideline related to sizing.
sizes
array of object (SizeChartValues)
Array of size chart values for different sizes.
Array of SizeChartValues
col_3
string
Value for column 3.
col_6
string
Value for column 6.
col_2
string
Value for column 2.
col_4
string
Value for column 4.
col_1
string
Value for column 1.
col_5
string
Value for column 5.
description
string
Description related to the size chart.
title
string
Title or name of the size chart.
headers
object (ColumnHeaders)
ColumnHeaders
col_3
object (ColumnHeader)
ColumnHeader
convertable
boolean
Indicates if the column value can be converted or transformed.
value
string
The value or title of the column header.
col_6
object (ColumnHeader)
ColumnHeader
convertable
boolean
Indicates if the column value can be converted or transformed.
value
string
The value or title of the column header.
col_2
object (ColumnHeader)
ColumnHeader
convertable
boolean
Indicates if the column value can be converted or transformed.
value
string
The value or title of the column header.
col_4
object (ColumnHeader)
ColumnHeader
convertable
boolean
Indicates if the column value can be converted or transformed.
value
string
The value or title of the column header.
col_1
object (ColumnHeader)
ColumnHeader
convertable
boolean
Indicates if the column value can be converted or transformed.
value
string
The value or title of the column header.
col_5
object (ColumnHeader)
ColumnHeader
convertable
boolean
Indicates if the column value can be converted or transformed.
value
string
The value or title of the column header.
sellable
boolean
Whether the product sizes are available for sale.
multi_size
boolean
Whether the product supports multiple sizes.
discount
string
Discount information applicable to the product sizes.
stores
object (ProductSizeStores)
ProductSizeStores
count
integer
Number of stores where the product size is available.
discount_meta
object (DiscountMeta)
DiscountMeta
timer
boolean
Determines whether the discount countdown is visible or not.
start_timer_in_minutes
number
The time in minutes before the discount ends when the countdown timer should start.
start
string
The start time of the live discount.
end
string
The end time of the live discount.
moq
object (MOQ)
MOQ
maximum
integer
The maximum quantity that can be ordered.
minimum
integer
The minimum quantity required to place an order.
increment_unit
integer
The unit increment for ordering beyond the minimum quantity.
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.
Examples
Parameters
slug:
"facilitate-value-added-infrastructures"
store_id:
9690
Was this section helpful?
GET
Response
Retrieves available sizes for a product by slug.
getProductSizesBySlug
Parameters
slug
array of string
Required
A short, human-readable, URL-friendly identifier of a product. You can get slug value from the endpoint /service/application/catalog/v1.0/products/.
Minimum Items : 1
Response
200
404
Success. Returns an array of objects containing the attributes for comparision.
ProductsComparisonResponseSchema
items
array of object (ProductCompareDetail)
List of product details for comparison.
Array of ProductCompareDetail
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.
net_quantity
object (NetQuantity)
NetQuantity
unit
string
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.
template_tag
string
Tag for identifying the product template.
sellable
boolean
Indicates whether the product is available for sale.
_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
description
string
The SEO description of the item.
sitemap
object (ApplicationItemSeoSitemap)
ApplicationItemSeoSitemap
priority
number
| float
The SEO priority of the item.
Enum
frequency
string
The SEO frequency of the item.
Enum
breadcrumbs
array of object (ApplicationItemSeoBreadcrumbs)
Array of ApplicationItemSeoBreadcrumbs
url
string
The URL that this breadcrumb points to.
action
object (ApplicationItemSeoAction)
ApplicationItemSeoAction
page
object
Details of the page associated with this SEO action.
type
string
Type of action, such as navigation or redirection.
meta_tags
array of object (ApplicationItemSeoMetaTags)
Array of ApplicationItemSeoMetaTags
title
string
The SEO title of the product.
items
array of object (ApplicationItemSeoMetaTagItem)
The SEO items for the product.
Array of ApplicationItemSeoMetaTagItem
key
string
The name of the meta tag.
value
string
The value associated with the meta tag.
canonical_url
string
The SEO canonical URL 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, Set, Digital.
Enum
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.
type
string
Product type or classification.
_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.
type
string
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_custom_json
object
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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.
selling
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.
type
string
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_custom_json
object
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.
country_of_origin
string
Country where the product is manufactured.
attributes_metadata
array of object (AttributeMetadata)
Metadata about attributes used for comparing products.
Array of AttributeMetadata
title
string
Title or name of the attribute metadata.
details
array of object (AttributeDetail)
List of detailed information about attributes.
Array of AttributeDetail
logo
string
URL or path to the logo associated with the attribute.
description
string
A description of the attribute.
display
string
Display name or label for the attribute.
key
string
Unique key or identifier for the attribute.
Examples
Parameters
slug:
"extend-back-end-relationships","facilitate value-added infrastructures"
Was this section helpful?
GET
Response
Compares multiple products by slugs.
getProductComparisonBySlugs
Get all products within the same category as the one specified by the provided slug.
Parameters
slug
string
Required
A short, human-readable, URL-friendly identifier of a product. You can get slug value from the endpoint /service/application/catalog/v1.0/products/.
Response
200
404
Success. Returns an array of objects containing the attributes for comparision.
ProductCompareResponseSchema
title
string
Title or name of the comparison.
items
array of object (ProductDetail)
List of product details for comparison.
Array of ProductDetail
uid
integer
Unique identifier for the product.
sizes
array of string
identifiers
array of string
is_tryout
boolean
channel
string
discount_meta
object (DiscountMeta)
DiscountMeta
timer
boolean
Determines whether the discount countdown is visible or not.
start_timer_in_minutes
number
The time in minutes before the discount ends when the countdown timer should start.
start
string
The start time of the live discount.
end
string
The end time of the live discount.
variants
array of object (ProductVariantResponseSchema)
Array of ProductVariantResponseSchema
display_type
string
The type of display for the product variant (e.g., image, text, image, color).
header
string
Header or title for the product variant section.
logo
string
URL or path to the logo associated with the product variant.
group_id
string
Group ID used to group variants.
items
array of object (ProductVariantItemResponseSchema)
List of product variant items.
Array of ProductVariantItemResponseSchema
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
key
string
Attribute identifier of the variant.
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.
type
string
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_custom_json
object
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.
type
string
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_custom_json
object
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.
type
string
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_custom_json
object
net_quantity
object (NetQuantity)
NetQuantity
unit
string
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
description
string
The SEO description of the item.
sitemap
object (ApplicationItemSeoSitemap)
ApplicationItemSeoSitemap
priority
number
| float
The SEO priority of the item.
Enum
frequency
string
The SEO frequency of the item.
Enum
breadcrumbs
array of object (ApplicationItemSeoBreadcrumbs)
Array of ApplicationItemSeoBreadcrumbs
url
string
The URL that this breadcrumb points to.
action
object (ApplicationItemSeoAction)
ApplicationItemSeoAction
page
object
Details of the page associated with this SEO action.
type
string
Type of action, such as navigation or redirection.
meta_tags
array of object (ApplicationItemSeoMetaTags)
Array of ApplicationItemSeoMetaTags
title
string
The SEO title of the product.
items
array of object (ApplicationItemSeoMetaTagItem)
The SEO items for the product.
Array of ApplicationItemSeoMetaTagItem
key
string
The name of the meta tag.
value
string
The value associated with the meta tag.
canonical_url
string
The SEO canonical URL 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, Set Digital.
Enum
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.
type
string
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_custom_json
object
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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.
selling
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.
type
string
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_custom_json
object
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.
promo_meta
object
no_of_boxes
integer
template_tag
string
sellable
boolean
country_of_origin
string
The country of origin for the product.
modified_on
string
| date-time
Date and time when the filter was modified.
attributes_metadata
array of object (AttributeMetadata)
Metadata about attributes used for comparing products.
Array of AttributeMetadata
title
string
Title or name of the attribute metadata.
details
array of object (AttributeDetail)
List of detailed information about attributes.
Array of AttributeDetail
logo
string
URL or path to the logo associated with the attribute.
description
string
A description of the attribute.
display
string
Display name or label for the attribute.
key
string
Unique key or identifier for the attribute.
subtitle
string
Subtitle or additional description for the comparison.
Examples
Parameters
slug:
"facilitate-value-added-infrastructures"
Was this section helpful?
GET
Response
Fetches similar products for comparison.
getSimilarComparisonProductBySlug
Get products that are often compared to the product specified by its slug.
Parameters
slug
string
Required
A short, human-readable, URL-friendly identifier of a product. You can get slug value from the endpoint /service/application/catalog/v1.0/products/.
Response
200
Success. Returns an array of objects containing the attributes for comparision.
ProductFrequentlyComparedSimilarResponseSchema
similars
object (ProductCompareResponseSchema)
ProductCompareResponseSchema
title
string
Title or name of the comparison.
items
array of object (ProductDetail)
List of product details for comparison.
Array of ProductDetail
uid
integer
Unique identifier for the product.
sizes
array of string
identifiers
array of string
is_tryout
boolean
channel
string
discount_meta
object (DiscountMeta)
DiscountMeta
timer
boolean
Determines whether the discount countdown is visible or not.
start_timer_in_minutes
number
The time in minutes before the discount ends when the countdown timer should start.
start
string
The start time of the live discount.
end
string
The end time of the live discount.
variants
array of object (ProductVariantResponseSchema)
Array of ProductVariantResponseSchema
display_type
string
The type of display for the product variant (e.g., image, text, image, color).
header
string
Header or title for the product variant section.
logo
string
URL or path to the logo associated with the product variant.
group_id
string
Group ID used to group variants.
items
array of object (ProductVariantItemResponseSchema)
List of product variant items.
Array of ProductVariantItemResponseSchema
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
key
string
Attribute identifier of the variant.
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.
type
string
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_custom_json
object
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.
type
string
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_custom_json
object
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.
type
string
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_custom_json
object
net_quantity
object (NetQuantity)
NetQuantity
unit
string
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
description
string
The SEO description of the item.
sitemap
object (ApplicationItemSeoSitemap)
ApplicationItemSeoSitemap
priority
number
| float
The SEO priority of the item.
Enum
frequency
string
The SEO frequency of the item.
Enum
breadcrumbs
array of object (ApplicationItemSeoBreadcrumbs)
Array of ApplicationItemSeoBreadcrumbs
url
string
The URL that this breadcrumb points to.
action
object (ApplicationItemSeoAction)
ApplicationItemSeoAction
page
object
Details of the page associated with this SEO action.
type
string
Type of action, such as navigation or redirection.
meta_tags
array of object (ApplicationItemSeoMetaTags)
Array of ApplicationItemSeoMetaTags
title
string
The SEO title of the product.
items
array of object (ApplicationItemSeoMetaTagItem)
The SEO items for the product.
Array of ApplicationItemSeoMetaTagItem
key
string
The name of the meta tag.
value
string
The value associated with the meta tag.
canonical_url
string
The SEO canonical URL 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, Set Digital.
Enum
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.
type
string
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_custom_json
object
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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.
selling
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.
type
string
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_custom_json
object
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.
promo_meta
object
no_of_boxes
integer
template_tag
string
sellable
boolean
country_of_origin
string
The country of origin for the product.
modified_on
string
| date-time
Date and time when the filter was modified.
attributes_metadata
array of object (AttributeMetadata)
Metadata about attributes used for comparing products.
Array of AttributeMetadata
title
string
Title or name of the attribute metadata.
details
array of object (AttributeDetail)
List of detailed information about attributes.
Array of AttributeDetail
logo
string
URL or path to the logo associated with the attribute.
description
string
A description of the attribute.
display
string
Display name or label for the attribute.
key
string
Unique key or identifier for the attribute.
subtitle
string
Subtitle or additional description for the comparison.
Examples
Parameters
slug:
"facilitate-value-added-infrastructures"
Was this section helpful?
GET
Response
Retrieves products frequently compared with a given product.
getComparedFrequentlyProductBySlug
Get all available variants of a specific product identified by its slug.
Parameters
slug
string
Required
A short, human-readable, URL-friendly identifier of a product. You can get slug value from the endpoint /service/application/catalog/v1.0/products/.
Response
200
Success. Returns all variants of a product. For `display_type:image`, `color` key will be present otherwise `value` key will be shown.
ProductVariantsResponseSchema
variants
array of object (ProductVariantResponseSchema)
A list of product variant responses, each detailing a specific variant.
Array of ProductVariantResponseSchema
display_type
string
The type of display for the product variant (e.g., image, text, image, color).
header
string
Header or title for the product variant section.
logo
string
URL or path to the logo associated with the product variant.
group_id
string
Group ID used to group variants.
items
array of object (ProductVariantItemResponseSchema)
List of product variant items.
Array of ProductVariantItemResponseSchema
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
key
string
Attribute identifier of the variant.
Examples
Parameters
slug:
"facilitate-value-added-infrastructures"
Was this section helpful?
GET
Response
Retrieves product variants by slug.
getProductVariantsBySlug
Get the current stock status for products identified by their IDs, such as SKU, ALU, EAN, etc.
Parameters
item_id
integer
The Item ID of the product (Max. 50 allowed).
alu
string
ALU of the product (limited upto 50 ALU identifier in a single request).
sku_code
string
Stock-keeping Unit of the product (limited upto 50 SKU Code in a single request).
ean
string
European Article Number of the product (limited upto 50 EAN identifier in a single request).
upc
string
Universal Product Code of the product (limited upto 50 UPC identifier in a single request).
Response
200
404
Success. Returns the status of the product stock.
ProductStockStatusResponseSchema
items
array of object (ProductStockStatusItem)
List of stock status items.
Array of ProductStockStatusItem
uid
string
NA.
quantity
integer
NA.
brand
object (BrandItem)
BrandItem
id
integer
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.
seo
object (ApplicationItemSEO)
ApplicationItemSEO
description
string
The SEO description of the item.
sitemap
object (ApplicationItemSeoSitemap)
ApplicationItemSeoSitemap
priority
number
| float
The SEO priority of the item.
Enum
frequency
string
The SEO frequency of the item.
Enum
breadcrumbs
array of object (ApplicationItemSeoBreadcrumbs)
Array of ApplicationItemSeoBreadcrumbs
url
string
The URL that this breadcrumb points to.
action
object (ApplicationItemSeoAction)
ApplicationItemSeoAction
page
object
Details of the page associated with this SEO action.
type
string
Type of action, such as navigation or redirection.
meta_tags
array of object (ApplicationItemSeoMetaTags)
Array of ApplicationItemSeoMetaTags
title
string
The SEO title of the product.
items
array of object (ApplicationItemSeoMetaTagItem)
The SEO items for the product.
Array of ApplicationItemSeoMetaTagItem
key
string
The name of the meta tag.
value
string
The value associated with the meta tag.
canonical_url
string
The SEO canonical URL of the item.
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
seller_identifier
string
price_effective
number
price_selling
number
price_marked
number
discount_meta
object (DiscountMeta)
DiscountMeta
timer
boolean
Determines whether the discount countdown is visible or not.
start_timer_in_minutes
number
The time in minutes before the discount ends when the countdown timer should start.
start
string
The start time of the live discount.
end
string
The end time of the live discount.
discount_applied
object
store
object (StoreDetail)
StoreDetail
name
string
Name of the store.
city
string
City where the store is located.
id
integer
Unique identifier for the store.
code
string
Code assigned to the store.
size
string
Identifier assigned by the seller.
identifier
object (ArticleIdentifier)
ArticleIdentifier
ean
string
European Article Number (EAN) for the product.
alu
string
Stock-keeping unit (SKU) used by retailers, also known as ALU.
upc
string
Universal Product Code (UPC) for the product.
sku_code
string
SKU code specific to the product.
price
object (ProductStockPrice)
ProductStockPrice
effective
number
Effective price of the product.
currency
string
Currency of the product price.
marked
number
Marked price of the product.
item_id
integer
Unique identifier of the item.
company
object (CompanyDetail)
CompanyDetail
name
string
Name of the company.
id
integer
Unique identifier for the company.
company_id
integer
Unique identifier for the company.
brand_id
integer
Unique identifier for the brand.
store_id
integer
Unique identifier for the store.
seller
object (Seller)
Seller
uid
integer
Unique identifier of the seller.
name
string
Name of the seller.
count
integer
Count of items available from the seller.
currency
string
Currency in which the prices are listed.
Examples
Parameters
item_id:
1
alu:
"#8680705321086"
sku_code:
"P10101101154425S"
ean:
"#8680705340025"
upc:
"#8680705326012"
Was this section helpful?
GET
Response
Checks product stock by IDs.
getProductStockByIds
Get the available stock levels for all products associated with a particular sales channel at a specified future time.
Parameters
timestamp
string
Required
Timestamp in UTC format (2020-07-23T10:27:50Z).
page_size
integer
The number of items to retrieve in each page.
Default Value : 12
page_id
string
Page ID to retrieve next set of results.
Response
200
400
Success. Returns the status of the product stock.
ProductStockPolling
items
array of object (ProductStockStatusItem)
List of product stock status items.
Array of ProductStockStatusItem
uid
string
NA.
quantity
integer
NA.
brand
object (BrandItem)
BrandItem
id
integer
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.
seo
object (ApplicationItemSEO)
ApplicationItemSEO
description
string
The SEO description of the item.
sitemap
object (ApplicationItemSeoSitemap)
ApplicationItemSeoSitemap
priority
number
| float
The SEO priority of the item.
Enum
frequency
string
The SEO frequency of the item.
Enum
breadcrumbs
array of object (ApplicationItemSeoBreadcrumbs)
Array of ApplicationItemSeoBreadcrumbs
url
string
The URL that this breadcrumb points to.
action
object (ApplicationItemSeoAction)
ApplicationItemSeoAction
page
object
Details of the page associated with this SEO action.
type
string
Type of action, such as navigation or redirection.
meta_tags
array of object (ApplicationItemSeoMetaTags)
Array of ApplicationItemSeoMetaTags
title
string
The SEO title of the product.
items
array of object (ApplicationItemSeoMetaTagItem)
The SEO items for the product.
Array of ApplicationItemSeoMetaTagItem
key
string
The name of the meta tag.
value
string
The value associated with the meta tag.
canonical_url
string
The SEO canonical URL of the item.
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
seller_identifier
string
price_effective
number
price_selling
number
price_marked
number
discount_meta
object (DiscountMeta)
DiscountMeta
timer
boolean
Determines whether the discount countdown is visible or not.
start_timer_in_minutes
number
The time in minutes before the discount ends when the countdown timer should start.
start
string
The start time of the live discount.
end
string
The end time of the live discount.
discount_applied
object
store
object (StoreDetail)
StoreDetail
name
string
Name of the store.
city
string
City where the store is located.
id
integer
Unique identifier for the store.
code
string
Code assigned to the store.
size
string
Identifier assigned by the seller.
identifier
object (ArticleIdentifier)
ArticleIdentifier
ean
string
European Article Number (EAN) for the product.
alu
string
Stock-keeping unit (SKU) used by retailers, also known as ALU.
upc
string
Universal Product Code (UPC) for the product.
sku_code
string
SKU code specific to the product.
price
object (ProductStockPrice)
ProductStockPrice
effective
number
Effective price of the product.
currency
string
Currency of the product price.
marked
number
Marked price of the product.
item_id
integer
Unique identifier of the item.
company
object (CompanyDetail)
CompanyDetail
name
string
Name of the company.
id
integer
Unique identifier for the company.
company_id
integer
Unique identifier for the company.
brand_id
integer
Unique identifier for the brand.
store_id
integer
Unique identifier for the store.
seller
object (Seller)
Seller
uid
integer
Unique identifier of the seller.
name
string
Name of the seller.
count
integer
Count of items available from the seller.
currency
string
Currency in which the prices are listed.
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.
total
integer
| int32
Total number of items.
Examples
Parameters
timestamp:
"2023-07-31T08:56:10.192+0000"
page_size:
12
page_id:
"636a4c5c295d937d233826a5"
Was this section helpful?
GET
Response
Fetches future stock data for products.
getProductStockForTimeByIds
List all products available in the catalog. It supports filtering based on product name, brand, department, category, collection, and more, while also offering sorting options based on factors like price, ratings, discounts, and other relevant criteria.
Parameters
q
string
The search query for entering partial or full name of product, brand, category, or collection.
f
string
The search filter parameters. Filter parameters will be passed in f parameter as shown in the example below. Double Pipe (||) denotes the OR condition, whereas Triple-colon (:::) indicates a new filter parameter applied as an AND condition.
filters
boolean
True for fetching all filter parameters and False for disabling the filter parameters.
Default Value : true
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.
page_size
integer
The number of items to retrieve in each page.
Default Value : 12
page_no
integer
The page number to navigate through the given set of results.
Default Value : 1
page_type
string
Available pagination types are cursor or number.
Default Value : cursor
Enum
Response
200
Success. Returns a paginated list of products..
ProductListingResponseSchema
items
array of object (ProductListingDetail)
List of product details included in the response.
Array of ProductListingDetail
discount_meta
object (DiscountMeta)
DiscountMeta
timer
boolean
Determines whether the discount countdown is visible or not.
start_timer_in_minutes
number
The time in minutes before the discount ends when the countdown timer should start.
start
string
The start time of the live discount.
end
string
The end time of the live discount.
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.
type
string
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_custom_json
object
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.
type
string
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_custom_json
object
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.
type
string
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_custom_json
object
net_quantity
object (NetQuantity)
NetQuantity
unit
string
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
description
string
The SEO description of the item.
sitemap
object (ApplicationItemSeoSitemap)
ApplicationItemSeoSitemap
priority
number
| float
The SEO priority of the item.
Enum
frequency
string
The SEO frequency of the item.
Enum
breadcrumbs
array of object (ApplicationItemSeoBreadcrumbs)
Array of ApplicationItemSeoBreadcrumbs
url
string
The URL that this breadcrumb points to.
action
object (ApplicationItemSeoAction)
ApplicationItemSeoAction
page
object
Details of the page associated with this SEO action.
type
string
Type of action, such as navigation or redirection.
meta_tags
array of object (ApplicationItemSeoMetaTags)
Array of ApplicationItemSeoMetaTags
title
string
The SEO title of the product.
items
array of object (ApplicationItemSeoMetaTagItem)
The SEO items for the product.
Array of ApplicationItemSeoMetaTagItem
key
string
The name of the meta tag.
value
string
The value associated with the meta tag.
canonical_url
string
The SEO canonical URL 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, Set Digital.
Enum
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.
type
string
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_custom_json
object
sellable
boolean
Indicates whether the product is available for sale.
attributes
object
Additional attributes or characteristics of the product.
variants
array of object (ProductVariantListingResponseSchema)
List of product variants available for the product.
Array of ProductVariantListingResponseSchema
header
string
Header or title for the product variant section.
items
array of object (ProductVariantItemResponseSchema)
List of Upto 5 product variant items.
Array of ProductVariantItemResponseSchema
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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.
selling
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.
type
string
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
_custom_json
object
teaser_tag
string
Teaser tag or short promotional phrase for the product.
country_of_origin
string
The country of origin for the product.
is_tryout
boolean
Indicates if the product is available for tryout.
channel
string
Identifier for the product channel.
modified_on
string
| date-time
Date and time when the filter was modified.
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.
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.
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.
total
integer
| int32
Total number of items.
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
q:
"interactive"
f:
"brand:Guerra:::l3_categories:Carter"
filters:
true
sort_on:
"popular"
page_id:
"636a4c5c295d937d233826a5"
page_size:
12
page_no:
1
page_type:
"cursor"
Was this section helpful?
GET
Response
Lists all products.
getProducts
Parameters
slug
string
Product slug for which bundles need to be fetched.
id
integer
Product uid.
size
string
specific size of the parent product
seller_id
integer
company id of the seller
Response
200
404
Success. Returns a group of products bundle.
ProductBundle
items
array of object (ProductGroupingModel)
Represents list of bundles/product groupings.
Array of ProductGroupingModel
logo
string
Nullable
The URL for the logo of the product group.
is_active
boolean
Whether the product grouping is active.
meta
object
A dictionary containing metadata information.
verified_by
object (UserDetail)
User details of the verifier of the document, if applicable.
UserDetail
super_user
boolean
A flag indicating whether the user is a super user.
contact
string
The contact details of the user.
username
string
The username of the user.
user_id
string
The user ID of the user.
created_on
string
| date-time
Timestamp of the creation of the document.
company_id
integer
The ID of the company that owns the product grouping.
page_visibility
array of string
A list of page visibilities of the product grouping.
Enum
modified_on
string
| date-time
Timestamp of the last modification of the document.
created_by
object (UserDetail)
User details of the creator of the document.
UserDetail
super_user
boolean
A flag indicating whether the user is a super user.
contact
string
The contact details of the user.
username
string
The username of the user.
user_id
string
The user ID of the user.
modified_by
object (UserDetail)
User details of the last modifier of the document.
UserDetail
super_user
boolean
A flag indicating whether the user is a super user.
contact
string
The contact details of the user.
username
string
The username of the user.
user_id
string
The user ID of the user.
products
array of object (ProductInGroup)
A list of products in the grouping.
Maximum Items : 10
Array of ProductInGroup
max_quantity
integer
The maximum quantity of the product that can be added to the cart.
sizes
array of object (Size)
The available sizes for the product.
Array of Size
quantity
integer
The quantity of this size available.
value
string
The value of the size.
display
string
The display string for the size.
is_available
boolean
Whether or not this size is available.
price
object (ProductGroupPrice)
ProductGroupPrice
effective
number
The effective price of the product.
marked
number
The marked price of the product.
selling
number
The selling price of the product.
currency
string
The currency code for the prices.
product_details
object (ProductDetails)
The details of the product.
ProductDetails
template_tag
string
The template tag of the product.
rating_count
integer
The number of ratings the product has received.
image_nature
string
The nature of the product's images.
has_variant
boolean
Whether or not the product has a variant.
description
string
The long description of the product.
out_of_stock
boolean
Whether or not the product is out of stock.
hsn_code
integer
The HSN code of the product.
grouped_attributes
object
A dictionary of grouped product attributes.
item_code
string
The item code of the product.
name
string
The name of the product.
country_of_origin
string
The country of origin for the product.
short_description
string
The short description of the product.
media
array of object
A list of media objects for the product.
attributes
object
A dictionary of product attributes.
is_set
boolean
Whether or not the product is a set of items.
images
array of string
A list of image URLs for the product.
slug
string
The slug of the product.
rating
number
The rating of the product.
identifier
object (Identifier)
Identifier
ean
string
The European Article Number (EAN) of the item.
sku_code
string
The Stock Keeping Unit (SKU) code of the item.
alu
string
The Alternative Lookup Product of the item.
upc
string
Universal Product Code of the item.
isbn
string
ISBN (International Standard Book Number) is a unique identifier used globally to identify books and other non-periodical publications
highlights
array of string
A list of highlights for the product.
brand_uid
integer
The unique ID of the product's brand.
min_quantity
integer
The minimum quantity of the product that can be added to the cart.
Default Value : 1
allow_remove
boolean
Whether the product can be removed from the cart.
product_uid
integer
The unique ID of the product in the group.
allow_remove
boolean
A flag indicating whether the product can be removed from the cart.
auto_add_to_cart
boolean
A flag indicating whether the product should be automatically added to the cart.
auto_select
boolean
A flag indicating whether the product should be automatically selected.
allow_individual_cancel
boolean
A flag indicating whether the product can be individually canceled.
allow_individual_return
boolean
A flag indicating whether the product can be individually returned.
prefer_single_shipment
boolean
A flag indicating whether the product should be shipped in a single shipment.
same_store_assignment
boolean
Whether the products are assigned to the same store.
Default Value : true
_id
string
Unique identifier of the product grouping.
name
string
The name of the product grouping.
choice
string
The choice of the product grouping.
slug
string
The unique identifier for the product grouping.
verified_on
string
Timestamp of when the document was verified, if applicable.
Examples
Parameters
slug:
"facilitate-value-added-infrastructures"
id:
1
size:
"OS"
seller_id:
1
Was this section helpful?
GET
Response
Fetches product bundles by slug.
getProductBundlesBySlug
Get the price of a product size at all the selling locations near to a PIN Code.
Parameters
No Parameters
Request body
seller_id
integer
store_id
integer
moq
integer
pincode
string
items
array of object (ProductSizePriceV1RequestBody)
Array of ProductSizePriceV1RequestBody
slug
string
size
string
parent_slug
string
product_grouping_id
string
Response
200
400
List of Size Price Object refer ProductSizePriceResponseV3 object
ProductSizePriceResponseV1
items
array of object (ProductSizePriceResponseV4)
Array of ProductSizePriceResponseV4
store
object (StoreV3)
StoreV3
uid
integer
The unique identifier for the store.
name
string
The name of the store.
count
integer
The count associated with the store.
article_assignment
object (ArticleAssignmentV3)
ArticleAssignmentV3
strategy
string
Method used for article assignment, such as optimal, fast-delivery, low-price, or manual.
level
string
Scope of assignment, which can be multi-companies, single-company, or single-store.
is_cod
boolean
Indicates whether the product is eligible for cash on delivery (COD).
strategy_wise_listing
array of object (StrategyWiseListingSchemaV3)
Array of StrategyWiseListingSchemaV3
distance
integer
Distance between bullfight location and customer location in kilometers. .
pincode
string
Pincode mapped based on strategy.
tat
integer
Turn around Time to deliver the product with this strategy.
quantity
integer
The quantity available for assigned store.
quantity
integer
Available quantity of the product.
item_type
string
The type of the product, defining its nature.
Enum
grouped_attributes
array of object (SellerGroupAttributes)
Array of SellerGroupAttributes
title
string
The title of the attribute group.
details
array of object (DetailsSchemaV3)
Detail of the attribute.
Array of DetailsSchemaV3
value
string
The value of the attribute.
type
string
The type of detail e.g, text.
key
string
The attribute key associated with the size.
return_config
object (ReturnConfigSchemaV3)
ReturnConfigSchemaV3
unit
string
The unit for the return configuration.
returnable
boolean
Indicates if the item is returnable.
time
integer
The time duration for the return policy.
article_id
string
Unique identifier of the product article.
is_gift
boolean
Indicates whether the product can be considered as a gift.
set
object (ProductSetV3)
ProductSetV3
quantity
integer
The quantity of products in the set.
size_distribution
object (ProductSetDistributionV3)
ProductSetDistributionV3
sizes
array of object (ProductSetDistributionSizeV3)
A list of size distributions in the product set.
Array of ProductSetDistributionSizeV3
pieces
integer
The number of pieces available in this size.
size
string
The size of the product.
price_per_piece
object (ProductStockPriceV3)
ProductStockPriceV3
effective
number
The effective or final price for the product at the given pincode.
currency_code
string
The currency code for which the product is available.
currency_symbol
string
The currency symbol for the currency in which the product is available.
marked
number
The marked price of the product.
selling
number
The selling price of the product.
discount_meta
object (DiscountMeta)
DiscountMeta
timer
boolean
Determines whether the discount countdown is visible or not.
start_timer_in_minutes
number
The time in minutes before the discount ends when the countdown timer should start.
start
string
The start time of the live discount.
end
string
The end time of the live discount.
discount
string
The discount applied to the product in percentage.
long_lat
array of number
Geographical coordinates [longitude, latitude] for the product's store location.
price
object (ProductStockPriceV3)
ProductStockPriceV3
effective
number
The effective or final price for the product at the given pincode.
currency_code
string
The currency code for which the product is available.
currency_symbol
string
The currency symbol for the currency in which the product is available.
marked
number
The marked price of the product.
selling
number
The selling price of the product.
price_per_unit
object (ProductStockUnitPriceV3)
ProductStockUnitPriceV3
unit
string
The unit of measure for the product.
currency_symbol
string
The currency symbol for the unit price.
currency_code
string
The currency code for the unit price.
price
number
The unit price of the product.
pincode
string
Delivery pincode for the product.
trader
array of string
Details of Traders associated with the product.
tags
array of string
Tags or labels assigned to the product for categorization or search purposes.
is_serviceable
boolean
Indicates if the product is serviceable in the given pincode.
marketplace_attributes
array of object (MarketPlaceSttributesSchemaV3)
Array of MarketPlaceSttributesSchemaV3
title
string
The title of the attribute.
details
array of object (DetailsSchemaV3)
Detail of the attribute.
Array of DetailsSchemaV3
value
string
The value of the attribute.
type
string
The type of detail e.g, text.
key
string
The attribute key associated with the size.
seller
object (SellerV3)
SellerV3
uid
integer
The unique identifier for the seller.
name
string
The name of the seller.
count
integer
The store count serviceable by this seller.
delivery_promise
object (PromiseSchema)
PromiseSchema
min
string
The minimum promise time.
max
string
The maximum promise time.
product_name
string
The name of the product.
_custom_json
object
Custom JSON data associated with the product.
error
string
Error message if the item is unavailable.
slug
string
A URL-friendly string representing the product.
size
string
Size of the product.
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
Response
get size price for multiple products
getProductPriceBySlug
List all sellers offering a specific product identified by its slug and size.
Parameters
slug
string
Required
A short, human-readable, URL-friendly identifier of a product. You can get slug value from the endpoint /service/application/catalog/v1.0/products/.
size
string
Required
A string indicating the size of the product, e.g. S, M, XL. You can get slug value from the endpoint /service/application/catalog/v1.0/products/sizes.
pincode
string
The 6-digit PIN Code of the area near which the selling locations should be searched, e.g. 400059
strategy
string
Sort stores on the basis of strategy. eg, fast-delivery, low-price, optimal.
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
400
Success. Returns a ProductSizeSellerV3 object. Check the example shown below or refer `ProductSizeSellersResponseV4` for more details.
ProductSizeSellersResponseV4
items
array of object (ProductSizePriceResponseV4)
Array of ProductSizePriceResponseV4
store
object (StoreV3)
StoreV3
uid
integer
The unique identifier for the store.
name
string
The name of the store.
count
integer
The count associated with the store.
article_assignment
object (ArticleAssignmentV3)
ArticleAssignmentV3
strategy
string
Method used for article assignment, such as optimal, fast-delivery, low-price, or manual.
level
string
Scope of assignment, which can be multi-companies, single-company, or single-store.
is_cod
boolean
Indicates whether the product is eligible for cash on delivery (COD).
strategy_wise_listing
array of object (StrategyWiseListingSchemaV3)
Array of StrategyWiseListingSchemaV3
distance
integer
Distance between bullfight location and customer location in kilometers. .
pincode
string
Pincode mapped based on strategy.
tat
integer
Turn around Time to deliver the product with this strategy.
quantity
integer
The quantity available for assigned store.
quantity
integer
Available quantity of the product.
item_type
string
The type of the product, defining its nature.
Enum
grouped_attributes
array of object (SellerGroupAttributes)
Array of SellerGroupAttributes
title
string
The title of the attribute group.
details
array of object (DetailsSchemaV3)
Detail of the attribute.
Array of DetailsSchemaV3
value
string
The value of the attribute.
type
string
The type of detail e.g, text.
key
string
The attribute key associated with the size.
return_config
object (ReturnConfigSchemaV3)
ReturnConfigSchemaV3
unit
string
The unit for the return configuration.
returnable
boolean
Indicates if the item is returnable.
time
integer
The time duration for the return policy.
article_id
string
Unique identifier of the product article.
is_gift
boolean
Indicates whether the product can be considered as a gift.
set
object (ProductSetV3)
ProductSetV3
quantity
integer
The quantity of products in the set.
size_distribution
object (ProductSetDistributionV3)
ProductSetDistributionV3
sizes
array of object (ProductSetDistributionSizeV3)
A list of size distributions in the product set.
Array of ProductSetDistributionSizeV3
pieces
integer
The number of pieces available in this size.
size
string
The size of the product.
price_per_piece
object (ProductStockPriceV3)
ProductStockPriceV3
effective
number
The effective or final price for the product at the given pincode.
currency_code
string
The currency code for which the product is available.
currency_symbol
string
The currency symbol for the currency in which the product is available.
marked
number
The marked price of the product.
selling
number
The selling price of the product.
discount_meta
object (DiscountMeta)
DiscountMeta
timer
boolean
Determines whether the discount countdown is visible or not.
start_timer_in_minutes
number
The time in minutes before the discount ends when the countdown timer should start.
start
string
The start time of the live discount.
end
string
The end time of the live discount.
discount
string
The discount applied to the product in percentage.
long_lat
array of number
Geographical coordinates [longitude, latitude] for the product's store location.
price
object (ProductStockPriceV3)
ProductStockPriceV3
effective
number
The effective or final price for the product at the given pincode.
currency_code
string
The currency code for which the product is available.
currency_symbol
string
The currency symbol for the currency in which the product is available.
marked
number
The marked price of the product.
selling
number
The selling price of the product.
price_per_unit
object (ProductStockUnitPriceV3)
ProductStockUnitPriceV3
unit
string
The unit of measure for the product.
currency_symbol
string
The currency symbol for the unit price.
currency_code
string
The currency code for the unit price.
price
number
The unit price of the product.
pincode
string
Delivery pincode for the product.
trader
array of string
Details of Traders associated with the product.
tags
array of string
Tags or labels assigned to the product for categorization or search purposes.
is_serviceable
boolean
Indicates if the product is serviceable in the given pincode.
marketplace_attributes
array of object (MarketPlaceSttributesSchemaV3)
Array of MarketPlaceSttributesSchemaV3
title
string
The title of the attribute.
details
array of object (DetailsSchemaV3)
Detail of the attribute.
Array of DetailsSchemaV3
value
string
The value of the attribute.
type
string
The type of detail e.g, text.
key
string
The attribute key associated with the size.
seller
object (SellerV3)
SellerV3
uid
integer
The unique identifier for the seller.
name
string
The name of the seller.
count
integer
The store count serviceable by this seller.
delivery_promise
object (PromiseSchema)
PromiseSchema
min
string
The minimum promise time.
max
string
The maximum promise time.
product_name
string
The name of the product.
_custom_json
object
Custom JSON data associated with the product.
error
string
Error message if the item is unavailable.
slug
string
A URL-friendly string representing the product.
size
string
Size of 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.
total
integer
| int32
Total number of items.
sort_on
array of object (ProductSizeSellerFilterSchemaV4)
Array of ProductSizeSellerFilterSchemaV4
name
string
is_selected
boolean
value
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
slug:
"facilitate-value-added-infrastructures"
size:
"13"
pincode:
"400603"
strategy:
"optimal"
page_no:
1
page_size:
12
Was this section helpful?
GET
Response
Get the sellers of a product size at a PIN Code
getProductSellersBySlug
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
# Retrieves search result listings.
Get products, brands, or categories based on a search query, which can be a partial or full name match.
Parameters
q
string
Required
The search query for entering partial or full name of a product, brand or category. For example, if the given search query `q` is _ski_, the relevant search suggestions could be _skirt_, _ski shoes_, __skin cream_ etc.
Response
200
Success. Returns a list autocomplete suggestions for the search query `q`.
AutoCompleteResponseSchema
items
array of object (AutocompleteItem)
List of autocomplete items suggested based on user input.
Array of AutocompleteItem
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.
display
string
Text or value displayed for the autocomplete item.
type
string
The type of action such as product, products, category, brand.
_custom_json
object
Custom JSON data related to the autocomplete item, allowing for additional metadata.
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 (QueryParams)
QueryParams
category
array of string
brand
array of string
department
array of string
params
object (Params)
Params
slug
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
q:
"Sarah"
Was this section helpful?
GET
Response
Retrieves search result listings.
getSearchResults
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
# Get store meta information.
GET
# Get store meta information.
GET
# Get store meta information.
Parameters
page_no
integer
The page number to navigate through the given set of results.
Default Value : 1
page_size
integer
Number of items to retrieve in each page.
Default Value : 12
q
string
Search a store by its name or store_code.
city
string
Search stores by the city in which they are situated.
range
integer
Use this to retrieve stores within a particular range in meters, e.g. 10000, to indicate a 10km range.
Default Value : 20000
latitude
number
Latitude of the location from where one wants to retrieve the nearest stores, e.g. 72.8691788.
longitude
number
Longitude of the location from where one wants to retrieve the nearest stores, e.g. 19.1174114.
tags
string
Search stores based on tags.
Response
200
Success. Returns a list of selling locations.
StoreListingResponseSchema
items
array of object (Store)
An array of store details. Each store includes information such as name, address, and geographic coordinates.
Array of Store
uid
integer
A unique identifier for the store.
store_email
string
| email
The manager's email address for the store.
state
string
The state or province where the store is located.
country
string
The country where the store is located.
pincode
string
The postal code or zip code for the store's location.
city
string
The city where the store is located.
address
string
The street address of the store.
store_code
string
A unique code or identifier for the store, often used for internal reference.
lat_long
object (LatLong)
LatLong
coordinates
array of number
An array containing the latitude and longitude values of the location.
type
string
The type of geographic coordinate system used. For example, "Point" indicates a single point in a geographic coordinate system.
name
string
The name of the store.
tags
array of string
The list of tags mapped to the store.
manager_contact
string
Contact number for the store manager.
contacts
array of object (ContactDetails)
List of contact numbers for the store.
Array of ContactDetails
number
string
Contact number for the store.
country_code
integer
Country code for the contact number.
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.
total
integer
| int32
Total number of items.
Examples
Parameters
page_no:
1
page_size:
12
q:
"Zachary-Waller"
city:
"mumbai"
range:
20000
latitude:
72.915978
Was this section helpful?
GET
Response
Get store meta information.
getStores
Parameters
page_no
integer
The page number to navigate through the given set of results.
Default Value : 1
page_size
integer
Number of items to retrieve in each page.
Default Value : 12
q
string
Search a store by its name or store_code.
city
string
Search stores by the city in which they are situated.
range
integer
Use this to retrieve stores within a particular range in meters, e.g. 10000, to indicate a 10km range.
Default Value : 20000
latitude
number
Latitude of the location from where one wants to retrieve the nearest stores, e.g. 72.8691788.
longitude
number
Longitude of the location from where one wants to retrieve the nearest stores, e.g. 19.1174114.
Response
200
Success. Returns a list of selling locations.
ApplicationStoreListing
filters
array of object (ApplicationStoreFilterListing)
A list of filters applied to the store listing.
Array of ApplicationStoreFilterListing
slug
string
Slug for the filter.
uid
integer
Unique identifier for the filter.
is_active
boolean
Whether the filter is active.
priority_order
integer
Priority order of the filter.
name
string
Name of the filter.
logo
string
URL for the filter's logo.
modified_by
object (ModifiedBy)
ModifiedBy
user_id
string
The unique identifier of the user who verified the product.
username
string
The username of the user who verified the product.
modified_on
string
| date-time
Date and time when the filter was modified.
items
array of object (AppStore)
A list of application stores.
Array of AppStore
uid
integer
The unique identifier for the application store.
departments
array of object (AppStoreDepartment)
A list of departments within the store.
Array of AppStoreDepartment
priority_order
integer
Priority order of the department.
name
string
Name of the department.
is_active
boolean
Whether the department is active.
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 department.
slug
string
Slug or URL-friendly name for the department.
company
object (CompanyStore)
CompanyStore
uid
integer
The unique identifier for the company store.
name
string
The name of the company store.
company_type
string
The type of company, which can be one of the following:
- `distributor`: Distributor
- `franchise`: Franchise
- `mbo`: MBO (Managed Business Operations)
- `manufacturer-owner`: Owner/Manufacturer.
business_type
string
The type of business structure, which can be one of the following:
- `Private`: Private Limited Company
- `LLP/Partnership`: Limited Liability Partnership or Partnership
- `HUF/Proprietorship`: Hindu Undivided Family or Proprietorship.
manager
object (StoreManagerSchema)
StoreManagerSchema
name
string
The name of the store manager.
email
string
The email address of the store manager.
mobile_no
object (SellerPhoneNumber)
SellerPhoneNumber
country_code
integer
The country code of the seller's phone number.
number
string
The seller's contact number.
Maximum Length : 12
store_code
string
A unique code for identifying the store.
address
object (StoreAddressSchema)
StoreAddressSchema
latitude
number
The latitude of the store's location.
state
string
The state where the store is located.
country
string
The country where the store is located.
landmark
string
A landmark near the store.
address1
string
The address line 1 of the store.
pincode
string
The postal code for the store's location.
city
string
The city where the store is located.
longitude
number
The longitude of the store's location.
address2
string
The address line2 of the store.
lat_long
object (LatLong)
LatLong
coordinates
array of number
An array containing the latitude and longitude values of the location.
type
string
The type of geographic coordinate system used. For example, "Point" indicates a single point in a geographic coordinate system.
country_code
string
Country code for the store address.
address_meta
object
Meta information related to the store's address.
name
string
The name of the store.
contact_numbers
array of object (SellerPhoneNumber)
A list of contact numbers for the store.
Array of SellerPhoneNumber
country_code
integer
The country code of the seller's phone number.
number
string
The seller's contact number.
Maximum Length : 12
_custom_json
object
Custom JSON data for the store.
additional_contacts
array of object (ContactDetails)
List of additional contacts for the store.
Array of ContactDetails
number
string
Contact number for the store.
country_code
integer
Country code for the contact number.
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 the store.
Enum
auto_invoice
boolean
Whether auto-invoice is enabled for the store.
credit_note
boolean
Whether credit note issuance is enabled.
stage
string
Stage or status of the store (e.g., verified).
gst_credentials
object (GSTCredentials)
GSTCredentials
e_invoice
object (EnabledStatus)
EnabledStatus
enabled
boolean
Whether the feature is enabled.
e_waybill
object (EnabledStatus)
EnabledStatus
enabled
boolean
Whether the feature is enabled.
product_return_config
object (ProductReturnConfig)
ProductReturnConfig
on_same_store
boolean
Whether product return is allowed at the same store.
avg_order_processing_time
object (OrderProcessingTime)
OrderProcessingTime
duration
integer
Average order processing time.
duration_type
string
Unit of time for order processing (e.g., days).
Enum
bulk_shipment
boolean
Whether bulk shipment is enabled for the store.
default_order_acceptance_timing
boolean
Whether the store has default order acceptance timings.
order_acceptance_timing
array of object (OrderTiming)
List of order acceptance timings for each weekday.
Array of OrderTiming
weekday
string
Day of the week (e.g., Monday).
opening
object (Time)
Time
hour
integer
The hour part of the time.
minute
integer
The minute part of the time.
closing
object (Time)
Time
hour
integer
The hour part of the time.
minute
integer
The minute part of the time.
open
boolean
Whether the store is open on this day.
auto_assign_courier_partner
boolean
Whether courier partner assignment is automatic.
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.
total
integer
| int32
Total number of items.
Examples
Parameters
page_no:
1
page_size:
12
q:
"Zachary-Waller"
city:
"mumbai"
range:
20
latitude:
72.9159784
longitude:
19.0990231
Was this section helpful?
GET
Response
Get store meta information.
getInStockLocations
Parameters
location_id
integer
Required
Unique Location ID.
Response
200
400
Success. Returns a metadata object.
StoreDetails
uid
integer
The unique identifier for the store.
departments
array of object (StoreDepartments)
A list of departments within the store.
Array of StoreDepartments
uid
integer
The unique identifier assigned to the store department.
logo
object
An object containing information about the store department's logo, such as the URL or other related media details.
priority_order
integer
The priority or ranking of the department within the store. This field is used to determine the order in which departments are displayed or processed.
name
string
The name of the store department, which is typically used for display and identification purposes.
slug
string
A URL-friendly identifier for the store department, often used in web addresses and routing to uniquely identify the department.
company
object (CompanyStore)
CompanyStore
uid
integer
The unique identifier for the company store.
name
string
The name of the company store.
company_type
string
The type of company, which can be one of the following:
- `distributor`: Distributor
- `franchise`: Franchise
- `mbo`: MBO (Managed Business Operations)
- `manufacturer-owner`: Owner/Manufacturer.
business_type
string
The type of business structure, which can be one of the following:
- `Private`: Private Limited Company
- `LLP/Partnership`: Limited Liability Partnership or Partnership
- `HUF/Proprietorship`: Hindu Undivided Family or Proprietorship.
manager
object (StoreManagerSchema)
StoreManagerSchema
name
string
The name of the store manager.
email
string
The email address of the store manager.
mobile_no
object (SellerPhoneNumber)
SellerPhoneNumber
country_code
integer
The country code of the seller's phone number.
number
string
The seller's contact number.
Maximum Length : 12
store_code
string
A unique code for identifying the store.
timing
array of object (StoreTiming)
The opening and closing times for the store throughout the week.
Array of StoreTiming
open
boolean
Indicates if the store is open on this day.
closing
object (Time)
Time
hour
integer
The hour part of the time.
minute
integer
The minute part of the time.
weekday
string
The day of the week.
opening
object (Time)
Time
hour
integer
The hour part of the time.
minute
integer
The minute part of the time.
address
object (StoreAddressSchema)
StoreAddressSchema
latitude
number
The latitude of the store's location.
state
string
The state where the store is located.
country
string
The country where the store is located.
landmark
string
A landmark near the store.
address1
string
The address line 1 of the store.
pincode
string
The postal code for the store's location.
city
string
The city where the store is located.
longitude
number
The longitude of the store's location.
address2
string
The address line2 of the store.
lat_long
object (LatLong)
LatLong
coordinates
array of number
An array containing the latitude and longitude values of the location.
type
string
The type of geographic coordinate system used. For example, "Point" indicates a single point in a geographic coordinate system.
country_code
string
Country code for the store address.
address_meta
object
Meta information related to the store's address.
_custom_json
object
Custom JSON data for the store.
name
string
The name of the store.
contact_numbers
array of object (SellerPhoneNumber)
A list of contact numbers for the store.
Array of SellerPhoneNumber
country_code
integer
The country code of the seller's phone number.
number
string
The seller's contact number.
Maximum Length : 12
additional_contacts
array of object (ContactDetails)
List of additional contacts for the store.
Array of ContactDetails
number
string
Contact number for the store.
country_code
integer
Country code for the contact number.
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)
GSTCredentials
e_invoice
object (EnabledStatus)
EnabledStatus
enabled
boolean
Whether the feature is enabled.
e_waybill
object (EnabledStatus)
EnabledStatus
enabled
boolean
Whether the feature is enabled.
product_return_config
object (ProductReturnConfig)
ProductReturnConfig
on_same_store
boolean
Whether product return is allowed at the same store.
avg_order_processing_time
object (OrderProcessingTime)
OrderProcessingTime
duration
integer
Average order processing time.
duration_type
string
Unit of time for order processing (e.g., days).
Enum
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.
Array of OrderTiming
weekday
string
Day of the week (e.g., Monday).
opening
object (Time)
Time
hour
integer
The hour part of the time.
minute
integer
The minute part of the time.
closing
object (Time)
Time
hour
integer
The hour part of the time.
minute
integer
The minute part of the time.
open
boolean
Whether the store is open on this day.
auto_assign_courier_partner
boolean
Whether courier partner assignment is automatic.
Examples
Parameters
location_id:
1
Was this section helpful?
GET
Response