Catalog
Manages product catalogs, including adding, updating, and deleting products, as well as categorizing them.
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, Zara, etc. Brand APIs facilitate access to brand-related data, offering functionalities such as retrieving list of available brands and obtaining detailed information about a specific brand using its unique slug.
Operations
GET
# List sales channel brands
PATCH
# Update sales channel brand
GET
# List brands
Retrieve brand listings related to the sales channel. A brand is the name under which a product is being sold
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
page_no
integer
The page number to navigate through the given set of results
page_size
integer
Number of items to retrieve in each page. Default is 12.
Default Value : 12
q
string
Search query with brand name. Use this parameter to search brands by brand name.
Response
200
4XX
List of Brands.
ApplicationBrandListingSchema
items
array of object (ApplicationBrandListingItemSchema)
Array of ApplicationBrandListingItemSchema
_custom_json
object
Custom JSON object for additional data.
_locale_language
object
Custom object for locale-specific language data.
Default Value : [object Object]
brand_banner_portrait_url
string
URL of the brand's portrait banner.
brand_banner_url
string
URL of the brand's landscape banner.
brand_logo_url
string
URL of the brand's logo.
description
string
Description of the brand.
name
string
Name of the brand.
slug_key
string
Unique slug key for the brand.
priority
integer
Priority of the brand in listing.
uid
integer
Unique identifier of the brand.
created_on
string
| date-time
Timestamp when the category was created.
last_updated
string
| date-time
Timestamp when the category was created.
is_active
boolean
Indicates if the brand is active.
departments
array of integer
List of department IDs associated with the brand.
modified_on
string
| date-time
Timestamp when the brand was last 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.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Response
Modify data associated to the brand for that particular sales channel.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
brand_uid
integer
Required
A `brand id` is a unique identifier for a particular brand.
Request body
_custom_json
object
Required
A custom JSON object containing additional brand-specific configurations or data. The structure is flexible and may vary based on application needs.
Response
200
4XX
Returns a success response
SuccessResponseObject
success
boolean
Indicates whether the operation was successful or not.
uid
integer
A unique identifier associated with the successful operation.
Examples
Parameters
body:
body
Was this section helpful?
PATCH
Response
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
department
string
The name of the department. Use this parameter to filter products by a particular department. See below the list of available departments. You can retrieve available departments from the "v1.0/departments/" API
page_no
integer
The page number to navigate through the given set of results
page_size
integer
Number of items to retrieve in each page. Default is 12.
Default Value : 12
q
string
Search query with brand name. Use this parameter to search brands by brand name.
brand_id
array of integer
Helps to sort the brands list on the basis of uid list.
Response
200
4XX
List of Brands.
BrandListingResponseSchema
items
array of object (BrandItem)
An array of brand items, each containing detailed information about the brand, such as action, banners, departments, discount, logo, and other related fields.
Array of BrandItem
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
banners
object (ImageUrls)
ImageUrls
landscape
object (BannerImage)
BannerImage
aspect_ratio
string
The aspect ratio of the banner image, typically represented as a ratio (e.g., '16:9' or '4:3').
type
string
The type of media, such as 'image' or 'banner', indicating the format of the banner.
url
string
| url
The URL where the banner image is located, typically a web address pointing to the image resource.
portrait
object (BannerImage)
BannerImage
aspect_ratio
string
The aspect ratio of the banner image, typically represented as a ratio (e.g., '16:9' or '4:3').
type
string
The type of media, such as 'image' or 'banner', indicating the format of the banner.
url
string
| url
The URL where the banner image is located, typically a web address pointing to the image resource.
departments
array of string
An array of department names or categories that the brand belongs to, represented as strings.
discount
string
A string representing the discount offered by the brand, such as percentage or amount off.
logo
object (BrandMedia)
BrandMedia
aspect_ratio
string
The aspect ratio of the media, typically represented as a string like '16:9' or '4:3'.
type
string
The type of media, such as 'image', 'video', or 'audio', describing the content format.
url
string
The URL where the media file is hosted, typically a link to an image or video resource.
name
string
The name of the brand.
slug
string
A URL-friendly identifier for the brand, often used in website routing.
uid
integer
A unique identifier for the brand, typically used for internal reference.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
department:
"kids"
page_no:
1
page_size:
1
q:
"test"
brand_id:
2
Was this section helpful?
GET
Response
Categories are hierarchical structure that enables a systematic organization of products for better discoverability of products on storefront. Categories are structured into three levels: L1, L2, and L3, with L1 representing the top-level category, followed by L2 and L3. For example - Clothing(L1) >> Shirts(L2) >> Formal Shirts(L3) A single L1 category can encompass multiple L2 categories underneath it, and similarly, an L2 category can contain multiple L3 categories within it. Category is a sales-channel specific configuration. While categories are common across all companies, sales channel can configure L3 category names tailored to their unique requirements.
Operations
GET
# List categories
GET
# List sales channel categories
PATCH
# Update sales channel category
Retrieve a list of categories associated to company and sales channel. user can filter on departments.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
department
string
The name of the department. Use this parameter to filter products by a particular department. See below the list of available departments. You can retrieve available departments from the "v1.0/departments/" API
Response
200
4XX
List of Categories.
CategoryListingResponseSchema
data
array of object (DepartmentCategoryTree)
An array containing the department category trees, which provide hierarchical information about categories and their associated departments.
Array of DepartmentCategoryTree
department
string
The name of the department that this category tree belongs to, such as 'Men', 'Women', or 'Electronics'.
items
array of object (CategoryItems)
An array of categories that fall under the specified department, each containing details about category items.
Array of CategoryItems
_custom_json
object
Nullable
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
banners
object (ImageUrls)
ImageUrls
landscape
object (BannerImage)
BannerImage
aspect_ratio
string
The aspect ratio of the banner image, typically represented as a ratio (e.g., '16:9' or '4:3').
type
string
The type of media, such as 'image' or 'banner', indicating the format of the banner.
url
string
| url
The URL where the banner image is located, typically a web address pointing to the image resource.
portrait
object (BannerImage)
BannerImage
aspect_ratio
string
The aspect ratio of the banner image, typically represented as a ratio (e.g., '16:9' or '4:3').
type
string
The type of media, such as 'image' or 'banner', indicating the format of the banner.
url
string
| url
The URL where the banner image is located, typically a web address pointing to the image resource.
childs
array of object (Child)
Array of Child
_custom_json
object
Custom JSON object to store additional data for the child.
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
banners
object (ImageUrls)
ImageUrls
landscape
object (BannerImage)
BannerImage
aspect_ratio
string
The aspect ratio of the banner image, typically represented as a ratio (e.g., '16:9' or '4:3').
type
string
The type of media, such as 'image' or 'banner', indicating the format of the banner.
url
string
| url
The URL where the banner image is located, typically a web address pointing to the image resource.
portrait
object (BannerImage)
BannerImage
aspect_ratio
string
The aspect ratio of the banner image, typically represented as a ratio (e.g., '16:9' or '4:3').
type
string
The type of media, such as 'image' or 'banner', indicating the format of the banner.
url
string
| url
The URL where the banner image is located, typically a web address pointing to the image resource.
childs
array of object (SecondLevelChild)
A list of second-level child elements under the current child.
Array of SecondLevelChild
_custom_json
object
Custom JSON object to store additional data for the second-level child.
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
banners
object (ImageUrls)
ImageUrls
landscape
object (BannerImage)
BannerImage
aspect_ratio
string
The aspect ratio of the banner image, typically represented as a ratio (e.g., '16:9' or '4:3').
type
string
The type of media, such as 'image' or 'banner', indicating the format of the banner.
url
string
| url
The URL where the banner image is located, typically a web address pointing to the image resource.
portrait
object (BannerImage)
BannerImage
aspect_ratio
string
The aspect ratio of the banner image, typically represented as a ratio (e.g., '16:9' or '4:3').
type
string
The type of media, such as 'image' or 'banner', indicating the format of the banner.
url
string
| url
The URL where the banner image is located, typically a web address pointing to the image resource.
childs
array of object (ThirdLevelChild)
A list of third-level child elements under the second-level child.
Array of ThirdLevelChild
_custom_json
object
Custom JSON object to store additional data for the third-level child.
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
banners
object (ImageUrls)
ImageUrls
landscape
object (BannerImage)
BannerImage
aspect_ratio
string
The aspect ratio of the banner image, typically represented as a ratio (e.g., '16:9' or '4:3').
type
string
The type of media, such as 'image' or 'banner', indicating the format of the banner.
url
string
| url
The URL where the banner image is located, typically a web address pointing to the image resource.
portrait
object (BannerImage)
BannerImage
aspect_ratio
string
The aspect ratio of the banner image, typically represented as a ratio (e.g., '16:9' or '4:3').
type
string
The type of media, such as 'image' or 'banner', indicating the format of the banner.
url
string
| url
The URL where the banner image is located, typically a web address pointing to the image resource.
childs
array of object
A list of further nested child elements under the third-level child (if applicable).
name
string
Name of the third-level child element.
slug
string
Slug or URL-friendly identifier for the third-level child element.
uid
integer
Unique identifier for the third-level child element.
name
string
Name of the second-level child element.
slug
string
Slug or URL-friendly identifier for the second-level child element.
uid
integer
Unique identifier for the second-level child element.
name
string
Name of the child element.
slug
string
Slug or URL-friendly identifier for the child element.
uid
integer
Unique identifier for the child element.
name
string
slug
string
uid
integer
departments
array of object (DepartmentIdentifier)
An array of department identifiers, each providing basic information like name, slug, and unique ID for departments within the catalog.
Array of DepartmentIdentifier
name
string
The name of the department, such as 'Electronics', 'Apparel', or 'Home Appliances'.
slug
string
A URL-friendly identifier for the department, often used in creating department-specific links or routes.
uid
integer
A unique identifier for the department, used to distinguish it from other departments in the system.
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
department:
"kids"
Was this section helpful?
GET
Response
Retrieve category listings related to the sales channel , with the ability to filter results based on department ,category names etc.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
department_id
integer
A `department_id` is a unique identifier for a particular department.
page_no
integer
The page number to navigate through the given set of results
page_size
integer
Number of items to retrieve in each page. Default is 12.
Default Value : 12
q
string
A search query string. Use this parameter to filter results based on a keyword or specific value.
Response
200
4XX
List of Categories.
ApplicationCategoryListingSchema
items
array of object (ApplicationCategoryListingItemSchema)
Array of ApplicationCategoryListingItemSchema
name
string
Name of the category.
logo
string
URL of the category's logo.
departments
array of integer
List of department IDs.
attr_name
string
Attribute name of the category.
landscape_url
string
URL of the landscape banner.
portrait_url
string
URL of the portrait banner.
_custom_json
object
Custom JSON object for additional data.
priority
integer
Priority of the category.
created_by
object (CreatedBy)
CreatedBy
user_id
string
Unique identifier for the user.
username
string
Username of the user who created the product.
created_on
string
| date-time
Timestamp when the category was created.
modified_by
object (CreatedBy)
CreatedBy
user_id
string
Unique identifier for the user.
username
string
Username of the user who created the product.
modified_on
string
| date-time
Timestamp when the category was last modified.
app_id
string
Application ID associated with the category.
is_active
boolean
Indicates whether the category is active.
uid
integer
Unique identifier of the category.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
Examples
Parameters
company_id:
1
application_id:
"64aed475db2cfb5b8a9f623d"
department_id:
1
page_no:
1
page_size:
1
q:
"test"
Was this section helpful?
GET
Response
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
category_uid
string
Required
A `category id` is a unique identifier for a particular category.
Request body
_custom_json
object
Required
A custom JSON object containing additional details or configurations specific to the application category.
Response
200
4XX
Returns a success response
SuccessResponseObject
success
boolean
Indicates whether the operation was successful or not.
uid
integer
A unique identifier associated with the successful operation.
Examples
Parameters
company_id:
1
application_id:
"64aed475db2cfb5b8a9f623d"
category_uid:
1
body:
body
Was this section helpful?
PATCH
Response
The Collection is grouping of products together within an e-commerce platform, enabling sellers to curate and showcase these collections on the product listing page. Collections serve as a means to organize and highlight related products. Two types of collections basic and handpicked collections are availble. Basic Collections: These collections are configured based on predefined criteria such as brand, category, department, or a combination thereof. Sellers can create basic collections to showcase products that share common attributes.For example, a basic collection can include all products from a specific brand, a particular category, or a combination of brands and categories. Handpicked Collections: In contrast to basic collections, handpicked collections allow sellers to manually select products regardless of their categorization. This type of collection enables sellers to curate unique assortments that may not fit within predefined categories or brands. Sellers have the flexibility to include products based on their individual preferences, promotions, or seasonal themes, creating curated collections that resonate with their target audience.
Operations
GET
# List collections
POST
# Create a collection
DEL
# Delete a collection
PUT
# Update a collection
GET
# List items of collection
POST
# Create items in a collection
GET
# Get a collection
Retrieve all collections based on criteria such as collection name, schedule status, and active status.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
q
string
Get collection list filtered by q string,
schedule_status
string
Get collection list filtered by scheduled status,
Enum
type
string
Type of the collections
tags
array of string
Each response will contain next_id param, which should be sent back to make pagination work.
is_active
boolean
Get collections filtered by active status.
page_no
integer
The page number to navigate through the given set of results.
page_size
integer
Number of items to retrieve in each page. Default is 12.
Response
200
4XX
List of collections.
GetCollectionListingResponseSchema
filters
object (CollectionListingFilter)
CollectionListingFilter
tags
array of object (CollectionListingFilterTag)
A list of tags used to filter the collection listing.
Array of CollectionListingFilterTag
display
string
The display name of the tag for the collection listing.
is_selected
boolean
Indicates whether the tag is currently selected.
name
string
The name of the tag.
type
array of object (CollectionListingFilterType)
A list of types used to filter the collection listing.
Array of CollectionListingFilterType
display
string
The display name of the type for the collection listing.
is_selected
boolean
Indicates whether the type is currently selected.
name
string
The internal name of the type.
items
array of object (GetCollectionDetailNest)
Array of nested collection details.
Array of GetCollectionDetailNest
_schedule
object (CollectionSchedule)
CollectionSchedule
cron
string
Nullable
The cron expression that defines the scheduling pattern, allowing for tasks or events to be repeated at specific intervals (e.g., daily, weekly).
duration
integer
Nullable
The duration in seconds for which the collection is active or valid.
end
string
| date-time
Nullable
The end date and time for the collection's schedule, formatted as a date-time string.
next_schedule
array of object (NextSchedule)
The next set of scheduled times when the collection will become active, based on the cron expression.
Array of NextSchedule
end
string
| date-time
Nullable
The end time of the schedule.
start
string
| date-time
The start time of the schedule.
start
string
| date-time
The start date and time for the collection's schedule, formatted as a date-time string.
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
allow_facets
boolean
Indicates whether facets are allowed for filtering the collection.
allow_sort
boolean
Indicates whether sorting options are allowed for the collection.
app_id
string
The application ID associated with the collection.
badge
object (CollectionBadge)
CollectionBadge
color
string
The color of the badge displayed with the collection, typically represented as a string (e.g., a hex code or color name).
text
string
The text displayed on the badge, which may indicate a label or promotion related to the collection.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
banners
object (ImageUrls)
ImageUrls
landscape
object (BannerImage)
BannerImage
aspect_ratio
string
The aspect ratio of the banner image, typically represented as a ratio (e.g., '16:9' or '4:3').
type
string
The type of media, such as 'image' or 'banner', indicating the format of the banner.
url
string
| url
The URL where the banner image is located, typically a web address pointing to the image resource.
portrait
object (BannerImage)
BannerImage
aspect_ratio
string
The aspect ratio of the banner image, typically represented as a ratio (e.g., '16:9' or '4:3').
type
string
The type of media, such as 'image' or 'banner', indicating the format of the banner.
url
string
| url
The URL where the banner image is located, typically a web address pointing to the image resource.
cron
object
description
string
A description of the collection.
is_active
boolean
Indicates whether the collection is currently active.
logo
object (Media)
Media
meta
object
A metadata object containing additional information about the media, such as dimensions, format, or other relevant details.
type
string
The type of media.
Enum
url
string
The URL where the media can be accessed.
alt
string
The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed.
thumbnail
string
The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media.
meta
object
Additional metadata related to the collection.
name
string
The name of the collection.
priority
integer
The priority level of the collection in the display list.
query
array of object (CollectionQuery)
Array of queries that define how the collection is fetched or filtered.
Array of CollectionQuery
attribute
string
The attribute of the collection query
op
string
The operation to be performed on the attribute of the collection query
Enum
value
array of Undefined Type
The value of the attribute of the collection query
slug
string
The URL-friendly identifier of the collection.
tag
array of string
Array of tags associated with the collection.
type
string
The type of collection, such as manual or automated.
uid
string
The unique identifier for the collection.
visible_facets_keys
array of string
List of facet keys that are visible for filtering the collection.
_id
string
Internal identifier for the collection.
published
boolean
Indicates if the collection is published.
tags
array of string
Tags associated with the collection.
sort_on
string
Sort criteria for the collection.
_custom_json
object
Custom JSON data for the collection.
_locale_language
object
Locale-specific language settings.
seo
object (SeoDetail)
SeoDetail
description
string
SEO meta description for the item or collection. This is used to describe the content for search engines.
title
string
SEO meta title for the item or collection. It is used as the title that appears in search results.
sitemap
object
Information regarding the sitemap configuration for the item or collection.
breadcrumbs
array of object (ApplicationItemSeoBreadcrumbs)
List of breadcrumbs for navigation, showing the hierarchy of pages leading to the current page.
Array of ApplicationItemSeoBreadcrumbs
url
string
action
object (ApplicationItemSeoAction)
ApplicationItemSeoAction
page
object
type
string
meta_tags
array of object (Metatags)
An array of meta tags, each containing key-value pairs for various SEO meta tags used to enhance search visibility.
Array of Metatags
title
string
The title or heading for the meta tags section.
items
array of object (ApplicationItemSeoMetaTagItem)
An array of meta tag items, each consisting of key-value pairs.
Array of ApplicationItemSeoMetaTagItem
key
string
value
string
canonical_url
string
The canonical URL for the item or collection, which tells search engines the preferred version of the URL to avoid duplicate content issues.
is_visible
boolean
Indicates if the collection is visible.
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.
Examples
Parameters
application_id:
"64c00b72c07acacc1357503b"
q:
"test"
schedule_status:
"live"
type:
"query"
tags:
"Test Collection 123"
is_active:
true
page_no:
1
page_size:
1
Was this section helpful?
GET
Response
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
q
string
Get collection list filtered by q string,
schedule_status
string
Get collection list filtered by scheduled status,
Enum
type
string
Type of the collections
tags
array of string
Each response will contain next_id param, which should be sent back to make pagination work.
is_active
boolean
Get collections filtered by active status.
page_no
integer
The page number to navigate through the given set of results.
page_size
integer
Number of items to retrieve in each page. Default is 12.
Request body
_custom_json
object
Custom JSON data for the collection, used for any additional information.
Default Value : [object Object]
_locale_language
object
Locale-specific data for supporting multiple languages.
Default Value : [object Object]
_schedule
object (CollectionSchedule)
CollectionSchedule
cron
string
Nullable
The cron expression that defines the scheduling pattern, allowing for tasks or events to be repeated at specific intervals (e.g., daily, weekly).
duration
integer
Nullable
The duration in seconds for which the collection is active or valid.
end
string
| date-time
Nullable
The end date and time for the collection's schedule, formatted as a date-time string.
next_schedule
array of object (NextSchedule)
The next set of scheduled times when the collection will become active, based on the cron expression.
Array of NextSchedule
end
string
| date-time
Nullable
The end time of the schedule.
start
string
| date-time
The start time of the schedule.
start
string
| date-time
The start date and time for the collection's schedule, formatted as a date-time string.
allow_facets
boolean
Indicates whether facet-based filtering is allowed for the collection.
Default Value : true
allow_sort
boolean
Indicates whether sorting options are allowed for the collection.
Default Value : true
app_id
string
Required
The application ID associated with the collection.
badge
object (CollectionBadge)
CollectionBadge
color
string
The color of the badge displayed with the collection, typically represented as a string (e.g., a hex code or color name).
text
string
The text displayed on the badge, which may indicate a label or promotion related to the collection.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
banners
object (CollectionBanner)
Required
CollectionBanner
landscape
object (CollectionImage)
Required
CollectionImage
aspect_ratio
string
Required
The aspect ratio of the image, typically represented as a string (e.g., "16:9" or "4:3") to indicate the proportional relationship between the image's width and height.
url
string
Required
The URL of the image, which provides the location where the image is hosted and can be accessed.
portrait
object (CollectionImage)
Required
CollectionImage
aspect_ratio
string
Required
The aspect ratio of the image, typically represented as a string (e.g., "16:9" or "4:3") to indicate the proportional relationship between the image's width and height.
url
string
Required
The URL of the image, which provides the location where the image is hosted and can be accessed.
created_by
object (UserInfo)
Information about the user who created the collection.
UserInfo
email
string
| email
The email address of the user.
uid
string
The unique ID of the user.
user_id
string
The ID of the user.
username
string
The username of the user.
description
string
A description of the collection.
is_active
boolean
Indicates whether the collection is currently active.
Default Value : true
is_visible
boolean
Indicates whether the collection is visible to users.
Default Value : true
logo
object (CollectionImage)
Required
CollectionImage
aspect_ratio
string
Required
The aspect ratio of the image, typically represented as a string (e.g., "16:9" or "4:3") to indicate the proportional relationship between the image's width and height.
url
string
Required
The URL of the image, which provides the location where the image is hosted and can be accessed.
meta
object
Additional metadata related to the collection.
Default Value : [object Object]
modified_by
object (UserInfo)
Information about the user who last modified the collection.
UserInfo
email
string
| email
The email address of the user.
uid
string
The unique ID of the user.
user_id
string
The ID of the user.
username
string
The username of the user.
name
string
Required
The name of the collection.
priority
integer
The priority level of the collection, used to determine its display order.
Default Value : 99999
published
boolean
Indicates whether the collection is published and available to users.
Default Value : true
query
array of object (CollectionQuery)
Query objects that define how the collection's items are retrieved or filtered.
Default Value :
Array of CollectionQuery
attribute
string
Required
The attribute of the collection query
op
string
Required
The operation to be performed on the attribute of the collection query
Enum
value
array of object
Required
The value of the attribute of the collection query
seo
object (SeoDetail)
SeoDetail
description
string
SEO meta description for the item or collection. This is used to describe the content for search engines.
title
string
SEO meta title for the item or collection. It is used as the title that appears in search results.
sitemap
object
Information regarding the sitemap configuration for the item or collection.
breadcrumbs
array of object (ApplicationItemSeoBreadcrumbs)
List of breadcrumbs for navigation, showing the hierarchy of pages leading to the current page.
Array of ApplicationItemSeoBreadcrumbs
url
string
action
object (ApplicationItemSeoAction)
ApplicationItemSeoAction
page
object
type
string
Required
meta_tags
array of object (Metatags)
An array of meta tags, each containing key-value pairs for various SEO meta tags used to enhance search visibility.
Array of Metatags
title
string
The title or heading for the meta tags section.
items
array of object (ApplicationItemSeoMetaTagItem)
An array of meta tag items, each consisting of key-value pairs.
Array of ApplicationItemSeoMetaTagItem
key
string
Required
value
string
Required
canonical_url
string
The canonical URL for the item or collection, which tells search engines the preferred version of the URL to avoid duplicate content issues.
slug
string
Required
The URL-friendly identifier for the collection.
sort_on
string
The default sorting order for items in the collection, e.g., 'popular'.
Default Value : popular
tags
array of string
Array of tags associated with the collection for categorization and filtering.
type
string
Required
The type of collection, either 'items' for manually added items or 'query' for dynamically fetched items.
Enum
visible_facets_keys
array of string
Keys of the facets that are visible and can be used for filtering the collection.
Default Value :
Response
200
4XX
List of all the collections including the one you added.
CollectionCreateResponseSchema
uid
string
Unique identifier for the collection.
_schedule
object (CollectionSchedule)
CollectionSchedule
cron
string
Nullable
The cron expression that defines the scheduling pattern, allowing for tasks or events to be repeated at specific intervals (e.g., daily, weekly).
duration
integer
Nullable
The duration in seconds for which the collection is active or valid.
end
string
| date-time
Nullable
The end date and time for the collection's schedule, formatted as a date-time string.
next_schedule
array of object (NextSchedule)
The next set of scheduled times when the collection will become active, based on the cron expression.
Array of NextSchedule
end
string
| date-time
Nullable
The end time of the schedule.
start
string
| date-time
The start time of the schedule.
start
string
| date-time
The start date and time for the collection's schedule, formatted as a date-time string.
allow_facets
boolean
Indicates whether facet-based filtering is allowed for the collection.
allow_sort
boolean
Indicates whether sorting options are allowed for the collection.
app_id
string
The application ID associated with the collection.
badge
object
Details of the badge associated with the collection.
banners
object (ImageUrls)
ImageUrls
landscape
object (BannerImage)
BannerImage
aspect_ratio
string
The aspect ratio of the banner image, typically represented as a ratio (e.g., '16:9' or '4:3').
type
string
The type of media, such as 'image' or 'banner', indicating the format of the banner.
url
string
| url
The URL where the banner image is located, typically a web address pointing to the image resource.
portrait
object (BannerImage)
BannerImage
aspect_ratio
string
The aspect ratio of the banner image, typically represented as a ratio (e.g., '16:9' or '4:3').
type
string
The type of media, such as 'image' or 'banner', indicating the format of the banner.
url
string
| url
The URL where the banner image is located, typically a web address pointing to the image resource.
cron
object
description
string
A description of the collection.
is_active
boolean
Indicates whether the collection is currently active.
logo
object (BannerImage)
BannerImage
aspect_ratio
string
The aspect ratio of the banner image, typically represented as a ratio (e.g., '16:9' or '4:3').
type
string
The type of media, such as 'image' or 'banner', indicating the format of the banner.
url
string
| url
The URL where the banner image is located, typically a web address pointing to the image resource.
meta
object
Additional metadata related to the collection.
name
string
The name of the collection.
priority
integer
The priority level of the collection, used to determine its display order.
query
array of object (CollectionQuery)
Query objects that define how the collection's items are retrieved or filtered.
Array of CollectionQuery
attribute
string
The attribute of the collection query
op
string
The operation to be performed on the attribute of the collection query
Enum
value
array of object
The value of the attribute of the collection query
slug
string
The URL-friendly identifier for the collection.
sort_on
string
The default sorting order for items in the collection, e.g., 'popular'.
tag
array of string
Array of tags associated with the collection for categorization and filtering.
type
string
The type of collection, such as 'items' for manually added items or 'query' for dynamically fetched items.
visible_facets_keys
array of string
Keys of the facets that are visible and can be used for filtering the collection.
published
boolean
Indicates whether the collection is published.
tags
array of string
List of tags associated with the collection.
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
_custom_json
object
Custom JSON data for additional information.
_locale_language
object
Locale language settings for the collection.
seo
object (SeoDetail)
SeoDetail
description
string
SEO meta description for the item or collection. This is used to describe the content for search engines.
title
string
SEO meta title for the item or collection. It is used as the title that appears in search results.
sitemap
object
Information regarding the sitemap configuration for the item or collection.
breadcrumbs
array of object (ApplicationItemSeoBreadcrumbs)
List of breadcrumbs for navigation, showing the hierarchy of pages leading to the current page.
Array of ApplicationItemSeoBreadcrumbs
url
string
action
object (ApplicationItemSeoAction)
ApplicationItemSeoAction
page
object
type
string
meta_tags
array of object (Metatags)
An array of meta tags, each containing key-value pairs for various SEO meta tags used to enhance search visibility.
Array of Metatags
title
string
The title or heading for the meta tags section.
items
array of object (ApplicationItemSeoMetaTagItem)
An array of meta tag items, each consisting of key-value pairs.
Array of ApplicationItemSeoMetaTagItem
key
string
value
string
canonical_url
string
The canonical URL for the item or collection, which tells search engines the preferred version of the URL to avoid duplicate content issues.
is_visible
boolean
Indicates if the collection is visible to users.
id
string
Unique identifier for the collection.
Examples
Parameters
company_id:
1
application_id:
"64c00b72c07acacc1357503b"
q:
"test"
schedule_status:
"live"
type:
"query"
tags:
"Test Collection 123"
is_active:
true
page_no:
1
page_size:
1
Was this section helpful?
POST
Response
Delete a collection by it's id. Returns an object that tells whether the collection was deleted successfully
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
id
string
Required
A `id` is a unique identifier of a collection.
Response
200
4XX
Status object. Tells whether the operation was successful.
CommonResponseSchemaCollection
message
string
A message providing details about the response.
Examples
Parameters
company_id:
1
application_id:
"64c00b72c07acacc1357503b"
id:
"65620443a7d23306c5d75df2"
Was this section helpful?
DEL
Response
Update a collection by it's id. On successful request, returns the updated collection
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
id
string
Required
A `id` is a unique identifier of a collection.
Request body
_custom_json
object
Custom JSON object containing additional metadata specific to the collection.
_locale_language
object
Locale-based language settings for the collection.
_schedule
object (CollectionSchedule)
CollectionSchedule
cron
string
Nullable
The cron expression that defines the scheduling pattern, allowing for tasks or events to be repeated at specific intervals (e.g., daily, weekly).
duration
integer
Nullable
The duration in seconds for which the collection is active or valid.
end
string
| date-time
Nullable
The end date and time for the collection's schedule, formatted as a date-time string.
next_schedule
array of object (NextSchedule)
The next set of scheduled times when the collection will become active, based on the cron expression.
Array of NextSchedule
end
string
| date-time
Nullable
The end time of the schedule.
start
string
| date-time
The start time of the schedule.
start
string
| date-time
The start date and time for the collection's schedule, formatted as a date-time string.
allow_facets
boolean
Indicates whether facets are allowed for filtering items in the collection.
allow_sort
boolean
Specifies whether sorting is allowed for items within the collection.
badge
object (CollectionBadge)
CollectionBadge
color
string
The color of the badge displayed with the collection, typically represented as a string (e.g., a hex code or color name).
text
string
The text displayed on the badge, which may indicate a label or promotion related to the collection.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
banners
object (CollectionBanner)
CollectionBanner
landscape
object (CollectionImage)
Required
CollectionImage
aspect_ratio
string
Required
The aspect ratio of the image, typically represented as a string (e.g., "16:9" or "4:3") to indicate the proportional relationship between the image's width and height.
url
string
Required
The URL of the image, which provides the location where the image is hosted and can be accessed.
portrait
object (CollectionImage)
Required
CollectionImage
aspect_ratio
string
Required
The aspect ratio of the image, typically represented as a string (e.g., "16:9" or "4:3") to indicate the proportional relationship between the image's width and height.
url
string
Required
The URL of the image, which provides the location where the image is hosted and can be accessed.
description
string
A brief description of the collection.
is_active
boolean
Indicates if the collection is active and visible to users.
is_visible
boolean
Specifies whether the collection is visible to users on the platform.
logo
object (CollectionImage)
CollectionImage
aspect_ratio
string
Required
The aspect ratio of the image, typically represented as a string (e.g., "16:9" or "4:3") to indicate the proportional relationship between the image's width and height.
url
string
Required
The URL of the image, which provides the location where the image is hosted and can be accessed.
meta
object
Additional metadata related to the collection.
modified_by
object (UserInfo)
UserInfo
email
string
| email
The email address of the user.
uid
string
The unique ID of the user.
user_id
string
The ID of the user.
username
string
The username of the user.
name
string
The name of the collection.
priority
integer
Priority level of the collection, determining its order in listings.
published
boolean
Indicates whether the collection is published and accessible to the public.
query
array of object (CollectionQuery)
List of query filters that define which items are included in the collection.
Array of CollectionQuery
attribute
string
Required
The attribute of the collection query
op
string
Required
The operation to be performed on the attribute of the collection query
Enum
value
array of object
Required
The value of the attribute of the collection query
seo
object (CollectionSeoDetail)
CollectionSeoDetail
description
string
SEO meta description for the item or collection. This is used to describe the content for search engines.
title
string
SEO meta title for the item or collection. It is used as the title that appears in search results.
sitemap
object (Sitemap)
Sitemap
priority
number
Indicates the priority of this URL relative to other URLs on the site. A value between 0.0 and 1.0, where 1.0 is the highest priority.
frequency
string
How frequently the content at the URL is likely to change.
breadcrumbs
array of object (ApplicationCollectionItemSeoBreadcrumbs)
List of breadcrumbs for navigation, showing the hierarchy of pages leading to the current page.
Array of ApplicationCollectionItemSeoBreadcrumbs
url
string
The URL that this breadcrumb points to.
action
object (ApplicationCollectionItemSeoAction)
ApplicationCollectionItemSeoAction
type
string
The type of action, typically 'page'.
page
object (ApplicationCollectionItemSeoPage)
ApplicationCollectionItemSeoPage
params
object
Any parameters associated with the page.
query
object (PageQuery)
PageQuery
brand
array of string
List of brands being filtered by the query.
type
string
The type of page.
url
string
| uri
The URL for the page.
meta_tags
array of object (Metatags)
An array of meta tags, each containing key-value pairs for various SEO meta tags used to enhance search visibility.
Array of Metatags
title
string
The title or heading for the meta tags section.
items
array of object (ApplicationItemSeoMetaTagItem)
An array of meta tag items, each consisting of key-value pairs.
Array of ApplicationItemSeoMetaTagItem
key
string
Required
value
string
Required
canonical_url
string
The canonical URL for the item or collection, which tells search engines the preferred version of the URL to avoid duplicate content issues.
slug
string
A unique identifier used to reference the collection in URLs.
sort_on
string
The field by which items in the collection are sorted (e.g., popular, latest).
tags
array of string
List of tags associated with the collection.
type
string
The type of collection, either 'items' or 'query'.
visible_facets_keys
array of string
Keys for facets that are visible to users for filtering items in the collection.
Response
200
4XX
The Collection object.
UpdateCollection
_custom_json
object
Custom JSON object containing additional metadata specific to the collection.
_locale_language
object
Locale-based language settings for the collection.
_schedule
object (CollectionSchedule)
CollectionSchedule
cron
string
Nullable
The cron expression that defines the scheduling pattern, allowing for tasks or events to be repeated at specific intervals (e.g., daily, weekly).
duration
integer
Nullable
The duration in seconds for which the collection is active or valid.
end
string
| date-time
Nullable
The end date and time for the collection's schedule, formatted as a date-time string.
next_schedule
array of object (NextSchedule)
The next set of scheduled times when the collection will become active, based on the cron expression.
Array of NextSchedule
end
string
| date-time
Nullable
The end time of the schedule.
start
string
| date-time
The start time of the schedule.
start
string
| date-time
The start date and time for the collection's schedule, formatted as a date-time string.
allow_facets
boolean
Indicates whether facets are allowed for filtering items in the collection.
allow_sort
boolean
Specifies whether sorting is allowed for items within the collection.
badge
object (CollectionBadge)
CollectionBadge
color
string
The color of the badge displayed with the collection, typically represented as a string (e.g., a hex code or color name).
text
string
The text displayed on the badge, which may indicate a label or promotion related to the collection.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
banners
object (CollectionBanner)
CollectionBanner
landscape
object (CollectionImage)
CollectionImage
aspect_ratio
string
The aspect ratio of the image, typically represented as a string (e.g., "16:9" or "4:3") to indicate the proportional relationship between the image's width and height.
url
string
The URL of the image, which provides the location where the image is hosted and can be accessed.
portrait
object (CollectionImage)
CollectionImage
aspect_ratio
string
The aspect ratio of the image, typically represented as a string (e.g., "16:9" or "4:3") to indicate the proportional relationship between the image's width and height.
url
string
The URL of the image, which provides the location where the image is hosted and can be accessed.
description
string
A brief description of the collection.
is_active
boolean
Indicates if the collection is active and visible to users.
is_visible
boolean
Specifies whether the collection is visible to users on the platform.
logo
object (CollectionImage)
CollectionImage
aspect_ratio
string
The aspect ratio of the image, typically represented as a string (e.g., "16:9" or "4:3") to indicate the proportional relationship between the image's width and height.
url
string
The URL of the image, which provides the location where the image is hosted and can be accessed.
meta
object
Additional metadata related to the collection.
modified_by
object (UserInfo)
UserInfo
email
string
| email
The email address of the user.
uid
string
The unique ID of the user.
user_id
string
The ID of the user.
username
string
The username of the user.
name
string
The name of the collection.
priority
integer
Priority level of the collection, determining its order in listings.
published
boolean
Indicates whether the collection is published and accessible to the public.
query
array of object (CollectionQuery)
List of query filters that define which items are included in the collection.
Array of CollectionQuery
attribute
string
The attribute of the collection query
op
string
The operation to be performed on the attribute of the collection query
Enum
value
array of object
The value of the attribute of the collection query
seo
object (CollectionSeoDetail)
CollectionSeoDetail
description
string
SEO meta description for the item or collection. This is used to describe the content for search engines.
title
string
SEO meta title for the item or collection. It is used as the title that appears in search results.
sitemap
object (Sitemap)
Sitemap
priority
number
Indicates the priority of this URL relative to other URLs on the site. A value between 0.0 and 1.0, where 1.0 is the highest priority.
frequency
string
How frequently the content at the URL is likely to change.
breadcrumbs
array of object (ApplicationCollectionItemSeoBreadcrumbs)
List of breadcrumbs for navigation, showing the hierarchy of pages leading to the current page.
Array of ApplicationCollectionItemSeoBreadcrumbs
url
string
The URL that this breadcrumb points to.
action
object (ApplicationCollectionItemSeoAction)
ApplicationCollectionItemSeoAction
type
string
The type of action, typically 'page'.
page
object (ApplicationCollectionItemSeoPage)
ApplicationCollectionItemSeoPage
params
object
Any parameters associated with the page.
query
object (PageQuery)
PageQuery
brand
array of string
List of brands being filtered by the query.
type
string
The type of page.
url
string
| uri
The URL for the page.
meta_tags
array of object (Metatags)
An array of meta tags, each containing key-value pairs for various SEO meta tags used to enhance search visibility.
Array of Metatags
title
string
The title or heading for the meta tags section.
items
array of object (ApplicationItemSeoMetaTagItem)
An array of meta tag items, each consisting of key-value pairs.
Array of ApplicationItemSeoMetaTagItem
key
string
value
string
canonical_url
string
The canonical URL for the item or collection, which tells search engines the preferred version of the URL to avoid duplicate content issues.
slug
string
A unique identifier used to reference the collection in URLs.
sort_on
string
The field by which items in the collection are sorted (e.g., popular, latest).
tags
array of string
List of tags associated with the collection.
type
string
The type of collection, either 'items' or 'query'.
visible_facets_keys
array of string
Keys for facets that are visible to users for filtering items in the collection.
Examples
Parameters
company_id:
1
application_id:
"64c00b72c07acacc1357503b"
id:
"65620443a7d23306c5d75df2"
body:
body
Was this section helpful?
PUT
Response
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
id
string
Required
A `id` is a unique identifier of a collection.
sort_on
string
Each response will contain sort_on param, which should be sent back to make pagination work.
page_id
string
Each response will contain next_id param, which should be sent back to make pagination work.
page_size
integer
Number of items to retrieve in each page. Default is 12.
page_no
integer
Identifies the specific page of results being requested.
Response
200
4XX
The attached items of an collection.
GetCollectionItemsResponseSchema
filters
array of object (ProductFilters)
An array of filters applicable to the products in the collection.
Array of ProductFilters
key
object (ProductFiltersKey)
ProductFiltersKey
display
string
The display name of the filter key, used for showing on the UI.
kind
string
The kind or type of filter, defining the category of the filter.
logo
string
| url
A URL to the logo associated with the filter key.
name
string
The name of the filter key, used in the query.
operators
array of string
A list of supported operators for this filter key.
values
array of object (ProductFiltersValue)
A list of possible values corresponding to the filter key. These values can be selected for filtering products.
Array of ProductFiltersValue
count
integer
The number of products that match this filter value.
currency_code
string
The currency code used if the filter is related to price.
currency_symbol
string
The symbol of the currency used in price-related filters.
display
string
The human-readable label for this filter value.
display_format
string
A format string that controls how the value is displayed, commonly used for numeric or price ranges.
is_selected
boolean
Indicates whether this filter value is currently selected by the user.
max
integer
The maximum value for a range filter (e.g., price range).
min
integer
The minimum value for a range filter (e.g., price range).
query_format
string
The format string used in the query for filtering by this value.
selected_max
integer
The maximum value selected by the user in a range filter.
selected_min
integer
The minimum value selected by the user in a range filter.
value
object
The actual value of the filter.
items
array of object (ApplicationProductsSchema)
An array of products that belong to the collection.
Array of ApplicationProductsSchema
attributes
object
Additional attributes of the product, such as custom properties or features.
brand
object (ProductBrand)
ProductBrand
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
logo
object (Media)
Media
meta
object
A metadata object containing additional information about the media, such as dimensions, format, or other relevant details.
type
string
The type of media.
Enum
url
string
The URL where the media can be accessed.
alt
string
The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed.
thumbnail
string
The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media.
name
string
uid
integer
color
string
description
string
A detailed description of the product.
discount
string
The discount applied to the product.
has_variant
boolean
Indicates whether the product has variants, such as different sizes or colors.
highlights
array of string
Key highlights of the product.
image_nature
string
The nature of the product image, indicating if it's the default or a standard image.
Enum
item_code
string
A unique code assigned to the product item at company and brand level.
item_type
string
The type of the product, defining its nature.
Enum
medias
array of object (Media)
A list of media items associated with the product, such as images or videos.
Array of Media
meta
object
A metadata object containing additional information about the media, such as dimensions, format, or other relevant details.
type
string
The type of media.
Enum
url
string
The URL where the media can be accessed.
alt
string
The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed.
thumbnail
string
The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media.
name
string
The name of the product.
price
object (ProductListingPrice)
ProductListingPrice
effective
object (Price1)
Price1
currency_code
object (CurrencyCodeEnum)
Enum
currency_symbol
string
max
number
min
number
marked
object (Price1)
Price1
currency_code
object (CurrencyCodeEnum)
Enum
currency_symbol
string
max
number
min
number
selling
object (Price1)
Price1
currency_code
object (CurrencyCodeEnum)
Enum
currency_symbol
string
max
number
min
number
product_online_date
string
| date-time
The date and time when the product becomes available online.
promo_meta
object
Metadata related to any promotions associated with the product.
rating
number
The average rating of the product, typically based on customer reviews.
rating_count
integer
The total number of ratings the product has received.
sellable
boolean
Indicates whether the product is available for sale.
short_description
string
A brief description of the product.
similars
array of string
A list of similar products.
slug
string
A URL-friendly string representing the product.
teaser_tag
object
A teaser tag object providing short promotional information about the product.
tryouts
array of string
A list of tryout options or samples available for the product.
type
string
The type or category of the product.
uid
integer
A unique identifier for the product.
popularity
integer
A numerical value indicating the popularity of the product.
brand_uid
integer
The unique identifier for the brand associated with the product.
category_uid
integer
The unique identifier for the category to which the product belongs.
verification_status
integer
The verification status of the product, typically represented as an integer.
channel_identifier
string
The identifier for the sales channel through which the product is sold.
category_slug
string
A URL-friendly string representing the product's category.
size_guide
string
A guide or chart providing size information for the product.
l3_categories
array of integer
A list of L3 category IDs of the product.
store_ids
array of integer
A list of store IDs where the product is available.
company_ids
array of integer
A list of company IDs associated with the product.
departments
array of integer
A list of department IDs where the product is categorized.
tags
array of string
A list of tags or keywords associated with the product.
l3_category_names
array of string
A list of names of L3 categories of the product.
sizes
array of string
A list of available sizes for the product.
product_group_tag
array of string
Tags that group the product with other similar products.
multi_size
boolean
Indicates whether the product is available in multiple sizes.
is_gift
boolean
Indicates whether the product can be considered as a gift.
is_cod
boolean
Indicates whether the product is eligible for cash on delivery (COD).
is_dependent
boolean
Indicates whether the product depends on another product.
is_available
boolean
Indicates whether the product is currently available for purchase.
moq
object (ApplicationItemMOQ)
ApplicationItemMOQ
increment_unit
integer
| value >= 1
The minimum quantity increment in which the item can be purchased.
Default Value : 1
maximum
integer
The maximum quantity allowed for purchase.
minimum
integer
| value >= 1
The minimum quantity required for purchase.
Default Value : 1
seo
object (ApplicationItemSEO)
ApplicationItemSEO
description
string
The SEO description of the item
title
string
The SEO title of the item
sitemap
object (ApplicationItemSeoSitemap)
ApplicationItemSeoSitemap
priority
number
The SEO priority of the item
frequency
string
The SEO frequency of the item
breadcrumbs
array of object (ApplicationItemSeoBreadcrumbs)
Array of ApplicationItemSeoBreadcrumbs
url
string
action
object (ApplicationItemSeoAction)
ApplicationItemSeoAction
page
object
type
string
meta_tags
array of object (ApplicationItemSeoMetaTags)
Array of ApplicationItemSeoMetaTags
title
string
items
array of object (ApplicationItemSeoMetaTagItem)
Array of ApplicationItemSeoMetaTagItem
key
string
value
string
canonical_url
string
variants
object
An object containing details about the product variants.
variant_media
object
Media items specific to the product variants.
variant_group
object
A group identifier for products that are variants of one another.
multi_categories
array of object (MultiCategoriesSchema)
Array of MultiCategoriesSchema
l1
integer
The ID of the Level 1 (L1) category of the product.
l2
integer
The ID of the Level 2 (L2) category of the product.
l3
integer
The ID of the Level 3 (L3) category of the product.
is_active
boolean
Indicates whether the L3 category of the product is currently active.
department
integer
The department associated with the L3 category of the product.
template_tag
string
Tag used for categorizing or templating purposes.
net_quantity
object
Net quantity details for the product.
custom_order
object (CustomOrder)
CustomOrder
manufacturing_time_unit
string
Unit of time for manufacturing (e.g., days, weeks).
is_custom_order
boolean
Indicates if the product is available for custom orders.
manufacturing_time
integer
Time required for manufacturing in the specified unit.
country_of_origin
string
Country where the product is manufactured or sourced from.
_custom_json
object
Custom JSON data associated with the product.
identifiers
array of string
Identifiers associated with the product.
item_id
integer
Unique identifier for the item.
_custom_meta
array of object (CustomMeta)
Custom meta associated with the product.
Array of CustomMeta
key
string
The key of the metadata. Should be a non-empty string and length should not exceed 30 characters.
Minimum Length : 1
Maximum Length : 30
value
string
The value of the metadata. Should be a non-empty string and length should not exceed 100 characters.
Minimum Length : 1
Maximum Length : 100
discount_percentage
integer
The discount applied to the product in percentage.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
sort_on
array of object (ProductSortOn)
Sorting options available for the products in the collection.
Array of ProductSortOn
is_selected
boolean
Indicates whether this sorting option is currently selected.
name
string
The display name of the sorting option, used to show on the UI.
value
string
The value representing the sorting option.
Examples
Parameters
company_id:
1
application_id:
"64c00b72c07acacc1357503b"
id:
"65620443a7d23306c5d75df2"
sort_on:
"latest"
page_size:
12
page_no:
1
Was this section helpful?
GET
Response
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
id
string
Required
A `id` is a unique identifier of a collection.
Request body
allow_facets
boolean
Indicates whether facets are allowed for filtering the collection items.
allow_sort
boolean
Indicates whether sorting is enabled for the collection items.
items
array of object (CollectionItemSchemaV2)
A list of items in the collection.
Array of CollectionItemSchemaV2
action
string
Required
Specifies whether the item should be added or removed from the collection.
Enum
item_id
integer
Required
The unique identifier of the item in the collection.
priority
integer
The priority level of the item in the collection, with higher values representing higher priority.
query
array of object (CollectionQuerySchemaV2)
A list of query conditions to filter the collection items.
Array of CollectionQuerySchemaV2
attribute
string
Required
The attribute of the collection query
op
string
Required
The operation to be performed on the attribute of the collection query
Enum
value
array of object
Required
The value of the attribute of the collection query
type
string
Required
The type of the collection item, defining its classification.
visible_facets_keys
array of string
A list of keys representing visible facets for the collection, used for filtering.
Response
200
4XX
Status object. Tells whether the operation was successful.
CommonResponseSchemaCollection
message
string
A message providing details about the response.
Examples
Parameters
company_id:
1
application_id:
"6606a10edc4fd506edce0f7b"
id:
"6606a10edc4fd506edce0f7b"
body:
body
Was this section helpful?
POST
Response
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
slug
string
Required
A `slug` is a human readable, URL friendly unique identifier of an object. Pass the `slug` of the collection which you want to retrieve.
Response
200
4XX
The Collection object.
GetCollectionDetailResponseSchema
_custom_json
object
Custom JSON data associated with the collection.
_locale_language
object
Locale-specific language details.
_schedule
object (CollectionSchedule)
CollectionSchedule
cron
string
Nullable
The cron expression that defines the scheduling pattern, allowing for tasks or events to be repeated at specific intervals (e.g., daily, weekly).
duration
integer
Nullable
The duration in seconds for which the collection is active or valid.
end
string
| date-time
Nullable
The end date and time for the collection's schedule, formatted as a date-time string.
next_schedule
array of object (NextSchedule)
The next set of scheduled times when the collection will become active, based on the cron expression.
Array of NextSchedule
end
string
| date-time
Nullable
The end time of the schedule.
start
string
| date-time
The start time of the schedule.
start
string
| date-time
The start date and time for the collection's schedule, formatted as a date-time string.
action
object
Action details, including navigation or page redirection information.
allow_facets
boolean
Indicates whether facets are allowed for filtering the collection.
allow_sort
boolean
Indicates whether sorting is enabled for the collection.
app_id
string
The unique identifier of the application to which the collection belongs.
badge
object (CollectionBadge)
CollectionBadge
color
string
The color of the badge displayed with the collection, typically represented as a string (e.g., a hex code or color name).
text
string
The text displayed on the badge, which may indicate a label or promotion related to the collection.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
banners
object (ImageUrls)
ImageUrls
landscape
object (BannerImage)
BannerImage
aspect_ratio
string
The aspect ratio of the banner image, typically represented as a ratio (e.g., '16:9' or '4:3').
type
string
The type of media, such as 'image' or 'banner', indicating the format of the banner.
url
string
| url
The URL where the banner image is located, typically a web address pointing to the image resource.
portrait
object (BannerImage)
BannerImage
aspect_ratio
string
The aspect ratio of the banner image, typically represented as a ratio (e.g., '16:9' or '4:3').
type
string
The type of media, such as 'image' or 'banner', indicating the format of the banner.
url
string
| url
The URL where the banner image is located, typically a web address pointing to the image resource.
description
string
A textual description of the collection.
is_active
boolean
Indicates whether the collection is currently active.
is_visible
boolean
Indicates whether the collection is visible on the platform.
logo
object (Media)
Media
meta
object
A metadata object containing additional information about the media, such as dimensions, format, or other relevant details.
type
string
The type of media.
Enum
url
string
The URL where the media can be accessed.
alt
string
The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed.
thumbnail
string
The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media.
meta
object
Metadata associated with the collection.
name
string
The name of the collection.
priority
integer
The priority level assigned to the collection.
published
boolean
Indicates whether the collection is published and visible to customers.
query
array of object (CollectionQuery)
Query details that define how items in the collection are filtered.
Array of CollectionQuery
attribute
string
The attribute of the collection query
op
string
The operation to be performed on the attribute of the collection query
Enum
value
array of object
The value of the attribute of the collection query
seo
object (SeoDetail)
SeoDetail
description
string
SEO meta description for the item or collection. This is used to describe the content for search engines.
title
string
SEO meta title for the item or collection. It is used as the title that appears in search results.
sitemap
object
Information regarding the sitemap configuration for the item or collection.
breadcrumbs
array of object (ApplicationItemSeoBreadcrumbs)
List of breadcrumbs for navigation, showing the hierarchy of pages leading to the current page.
Array of ApplicationItemSeoBreadcrumbs
url
string
action
object (ApplicationItemSeoAction)
ApplicationItemSeoAction
page
object
type
string
meta_tags
array of object (Metatags)
An array of meta tags, each containing key-value pairs for various SEO meta tags used to enhance search visibility.
Array of Metatags
title
string
The title or heading for the meta tags section.
items
array of object (ApplicationItemSeoMetaTagItem)
An array of meta tag items, each consisting of key-value pairs.
Array of ApplicationItemSeoMetaTagItem
key
string
value
string
canonical_url
string
The canonical URL for the item or collection, which tells search engines the preferred version of the URL to avoid duplicate content issues.
slug
string
The URL-friendly slug for the collection.
sort_on
string
The sorting criteria applied to the collection (e.g., by latest, discount).
tags
array of string
Tags associated with the collection.
type
string
The type of the collection (e.g., query-based).
uid
string
A unique identifier for the collection.
_id
string
A unique identifier for the collection, matching `uid`.
visible_facets_keys
array of string
Keys representing visible facets for filtering.
Examples
Parameters
company_id:
1
application_id:
"6606a10edc4fd506edce0f7b"
slug:
"sample-coll"
Was this section helpful?
GET
Response
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, Footwear, etc. You can retrieve a list of all departments associated with available products, facilitating easy navigation and organization of products based on departmental categorization. Additionally, the APIs allow you to list all products associated with a specific brand, collection, or category in a random order, enhancing user engagement and discovery within your application
Operations
GET
# List sales channel departments
PATCH
# Update sales channel department
GET
# List departments
Retrieve department listings related to the sales channel. Departments are used to categorize similar products, and you can filter the results based on department names
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
page_no
integer
The page number to navigate through the given set of results
page_size
integer
Number of items to retrieve in each page. Default is 12.
Default Value : 12
q
string
A search query string. Use this parameter to filter results based on a keyword or specific value.
Response
200
4XX
List of Departments.
ApplicationDepartmentListingResponseSchema
items
array of object (ApplicationDepartment)
Array of ApplicationDepartment
_custom_json
object
Custom JSON data specific to the department, used to store additional attributes or configurations.
app_id
string
Unique identifier for the application to which the department belongs.
is_active
boolean
Indicates whether the department is currently active within the application.
logo
string
URL or path to the logo representing the department.
name
string
Name of the department within the application.
uid
integer
Unique identifier for the department.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
Examples
Parameters
company_id:
1
application_id:
"64c00b72c07acacc1357503b"
page_no:
1
page_size:
1
q:
"test"
Was this section helpful?
GET
Response
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
department_uid
integer
Required
A `department id` is a unique identifier for a particular department.
Request body
_custom_json
object
Required
A custom JSON object containing additional details or configurations specific to the application department.
Response
200
4XX
Returns a success response
SuccessResponseObject
success
boolean
Indicates whether the operation was successful or not.
uid
integer
A unique identifier associated with the successful operation.
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
department_uid:
4
body:
body
Was this section helpful?
PATCH
Response
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Response
200
4XX
List of Departments.
DepartmentResponseSchema
items
array of object (Department)
Array of Department
logo
object (DepartmentMedia)
DepartmentMedia
aspect_ratio
string
The aspect ratio of the media, typically represented as width:height (e.g., '16:9').
type
string
The type of media, such as 'image', 'video', or other supported media formats.
url
string
The URL where the media resource is hosted and can be accessed.
name
string
The name of the department, used to identify it within the application.
priority_order
integer
Defines the priority or order in which the department should appear in listings.
slug
string
A URL-friendly string used to uniquely identify the department.
uid
integer
A unique identifier for the department.
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
Was this section helpful?
GET
Response
The "Product" resource offers detailed insights into items available for sale on Sales Channels or Marketplaces. It provides comprehensive product listings, stock status insights, seller details, and facilitates efficient product catalog management
Operations
GET
# List sales channel inventory
GET
# Get discounted inventory
GET
# Get product details
Retrieve inventory data related to the sales channel. this can be used to get the Inventory status of products.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
item_ids
array of integer
The Item Id of the product.
store_ids
array of integer
The Store Id of products to fetch inventory.
brand_ids
array of integer
The Brand Id of products to fetch inventory.
seller_identifiers
array of string
Unique seller_identifier of the product.
timestamp
string
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.
qty_gt
integer
This field allows you to filter for inventories that have quantity greater than to the specified value based on qty_type filter.
qty_lt
integer
This field allows you to filter for inventories that have a quantity less than to the specified value based on qty_type filter.
qty_type
string
This field provides flexibility in selecting filter for inventory quantity counts and date queries. For example, you might use this field to specify "total" or "sellable" quantity.
Enum
from_date
string
| date-time
Inventory updated on filter to get inventories greater then or equal to provided date based on qty_type value.
to_date
string
| date-time
Inventory updated on filter to get inventories less then or equal to provided date based on qty_type value.
Response
200
4XX
Success. Returns the article/stock of the product stock.
InventoryStockResponseSchema
items
array of object
An array of inventory stock items. Each item represents a stock entry for a specific product or SKU.
Default Value :
page
object (InventoryPage)
InventoryPage
has_next
boolean
Indicates whether there is a next page of results.
has_previous
boolean
Indicates whether there is a previous page of results.
item_total
integer
The total number of items available in the inventory.
next_id
string
Nullable
The identifier for fetching the next set of results. If null, there are no more results.
type
string
The type of pagination being used, often indicating the method or strategy for paginating the results.
Examples
Parameters
company_id:
1
application_id:
"655b09a916628f2bf9203e3b"
item_ids:
1
store_ids:
1
brand_ids:
4
seller_identifiers:
"TEST"
timestamp:
"2020-07-23T10:27:50Z"
page_size:
1
page_id:
"636a4c5c295d937d233826a5"
qty_gt:
1
qty_lt:
1
qty_type:
"sellable"
from_date:
"2024-01-20T09:40:58Z"
to_date:
"2024-07-20T09:40:58Z"
Was this section helpful?
GET
Response
Allows to retrieve Inventory data for particular company grouped by size and store.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
item_id
integer
Required
A `item_id` is a unique identifier for a specific product.
size_identifier
integer
Required
Size Identifier (Seller Identifier or Primary Identifier).
page_no
integer
The page number to navigate through the given set of results
page_size
integer
Number of items to retrieve in each page. Default is 12.
Default Value : 12
location_ids
array of integer
Search by store ids.
Response
200
4XX
returns a list of all inventory grouped by size and store
ApplicationInventorySellerIdentifierResponsePaginated
items
array of object (InventorySellerResponseSchema)
Array of InventorySellerResponseSchema
_custom_json
object
Custom JSON data for the article.
added_on_store
string
| date-time
The date and time when the article was added to the store.
brand
object (BrandMeta)
The metadata of the brand.
BrandMeta
id
integer
Unique identifier for the brand.
name
string
Name of the brand.
company
object (CompanyMeta)
The metadata of the company.
CompanyMeta
id
integer
Unique identifier for the company.
country_of_origin
string
The country of origin of the article.
created_by
object (RequestUserSchema)
Nullable
The user who created the article.
RequestUserSchema
_id
string
contact
string
uid
string
user_id
string
username
string
dimension
object (DimensionResponseSchema)
The dimensions of the article.
DimensionResponseSchema
height
number
The height dimension.
is_default
boolean
Indicates if it is the default dimension.
length
number
The length dimension.
unit
string
The unit of dimension.
width
number
The width dimension.
expiration_date
string
| date-time
The expiration date of the article.
fragile
boolean
Indicates if the article is fragile.
fynd_article_code
string
The Fynd article code.
fynd_item_code
string
The Fynd item code.
fynd_meta
object
The Fynd metadata of the article.
identifier
object
The identifier of the article.
is_active
boolean
Indicates if the article is active.
Default Value : true
is_set
boolean
item_id
integer
The ID of the item.
manufacturer
object (ManufacturerResponseSchema)
The manufacturer of the article.
ManufacturerResponseSchema
address
string
The address of the manufacturer.
is_default
boolean
Indicates if it is the default manufacturer.
name
string
The name of the manufacturer.
meta
object
Nullable
Additional metadata for the article.
modified_by
object (RequestUserSchema)
Nullable
The user who modified the article.
RequestUserSchema
_id
string
contact
string
uid
string
user_id
string
username
string
price
object (PriceMeta)
The price metadata of the article.
PriceMeta
currency
string
The currency used for the prices.
effective
number
The effective price.
marked
number
The marked price.
tp_notes
object
Additional notes for the transfer price.
transfer
number
The transfer price.
updated_at
string
| date-time
The date and time of the last update.
quantities
object (Quantities)
Quantities
damaged
object (QuantityBase)
QuantityBase
count
integer
updated_at
string
| date-time
not_available
object (QuantityBase)
QuantityBase
count
integer
updated_at
string
| date-time
order_committed
object (QuantityBase)
QuantityBase
count
integer
updated_at
string
| date-time
sellable
object (QuantityBase)
QuantityBase
count
integer
updated_at
string
| date-time
raw_meta
object
The raw metadata of the article.
return_config
object (InventoryReturnConfig)
InventoryReturnConfig
returnable
boolean
Indicates if the item is returnable.
Default Value : false
time
integer
| value >= 0
The return time in days or hours.
unit
string
The unit of return time.
Enum
seller_identifier
string
The seller identifier of the article.
set
object (InventorySet)
InventorySet
name
string
The name of the inventory set.
quantity
integer
The quantity of items available in the inventory set.
size_distribution
object (SizeDistribution)
SizeDistribution
sizes
array of object (SetSize)
Array of SetSize
pieces
integer
| value >= 1
| value <= 100
Number of pieces in the set.
size
string
Size of the item in the set.
size
string
The size of the article.
stage
string
The stage of the article.
store
object (StoreMeta)
The metadata of the store.
StoreMeta
id
integer
The unique identifier of the store.
tags
array of string
Nullable
The tags associated with the article.
tax_identifier
object (TaxIdentifier)
TaxIdentifier
hsn_code
string
hsn_code_id
string
reporting_hsn
string
total_quantity
integer
| value >= 0
The total quantity of the article.
trace_id
string
The trace ID of the article.
track_inventory
boolean
Indicates if the inventory is tracked for the article.
Default Value : true
trader
array of object (Trader)
Nullable
The traders associated with the article.
Array of Trader
address
array of string
List of addresses associated with the trader.
name
string
The name of the trader.
Minimum Length : 1
Maximum Length : 300
type
string
The role or type of the trader.
Enum
uid
string
The unique identifier of the article.
weight
object (WeightResponseSchema)
The weight of the article.
WeightResponseSchema
is_default
boolean
Indicates if it is the default weight.
shipping
number
The shipping weight.
unit
string
The unit of weight.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
Examples
Parameters
company_id:
1
application_id:
"63b6aa5558bf3ed100740c10"
item_id:
75779472
size_identifier:
410163085004
page_no:
1
page_size:
1
location_ids:
1
Was this section helpful?
GET
Response
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
slug
string
Required
The unique identifier of a product. i.e; `slug` of a product. You can retrieve these from the APIs that list products like "v1.0/products/"
Response
200
4XX
The Product object.
ProductDetail
attributes
object
Key-value pairs representing various product attributes.
brand
object (ProductBrand)
ProductBrand
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
logo
object (Media)
Media
meta
object
A metadata object containing additional information about the media, such as dimensions, format, or other relevant details.
type
string
The type of media.
Enum
url
string
The URL where the media can be accessed.
alt
string
The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed.
thumbnail
string
The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media.
name
string
uid
integer
description
string
Detailed description of the product.
grouped_attributes
array of object (ProductDetailGroupedAttribute)
Grouped attributes of the product, such as product details and specifications.
Array of ProductDetailGroupedAttribute
details
array of object (ProductDetailAttribute)
An array of individual product attributes belonging to this group.
Array of ProductDetailAttribute
key
string
The name or key of the attribute.
type
string
The type of the attribute.
value
string
The value of the attribute corresponding to the key.
title
string
The title or category name for the grouped attributes.
has_variant
boolean
Indicates whether the product has variants.
highlights
array of string
Array of highlight features for the product.
image_nature
string
The nature of the product's images.
item_code
string
Unique item code for the product.
item_type
string
Type of the item.
Enum
medias
array of object (Media)
Array of media objects such as images and videos for the product.
Array of Media
meta
object
A metadata object containing additional information about the media, such as dimensions, format, or other relevant details.
type
string
The type of media.
Enum
url
string
The URL where the media can be accessed.
alt
string
The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed.
thumbnail
string
The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media.
name
string
Name of the product.
product_online_date
string
| date-time
Date when the product was made available online.
promo_meta
object
Promotional metadata associated with the product.
rating
number
Average rating of the product.
rating_count
integer
Total number of ratings for the product.
short_description
string
A brief description of the product.
similars
array of string
Array of similar products.
slug
string
Unique slug for the product, used in URLs.
teaser_tag
object
Teaser tag information related to the product.
tryouts
array of string
Array of product tryout options.
type
string
The type of item.
uid
integer
Unique identifier for the product.
country_of_origin
string
Country where the product was manufactured.
categories
array of object (ApplicationProductCategoryItem)
Array of categories the product belongs to.
Array of ApplicationProductCategoryItem
id
integer
Unique identifier of the category.
uid
integer
Unique identifier of the category (UID).
name
string
Name of the category.
slug
string
Slug or unique key for the category.
logo
object (ApplicationProductMedia)
ApplicationProductMedia
type
string
Type of the media (e.g., image, video).
url
string
URL of the media item.
action
object (PageAction)
PageAction
page
object (ActionObject)
ActionObject
type
string
The type of action to be performed, such as navigating to a product or category.
query
object
The query parameters associated with the action.
type
string
The type of page action to be performed.
tags
array of string
Array of tags associated with the product.
no_of_boxes
integer
Number of boxes required for packaging the product.
custom_order
object (CustomOrder)
CustomOrder
manufacturing_time_unit
string
Unit of time for manufacturing (e.g., days, weeks).
is_custom_order
boolean
Indicates if the product is available for custom orders.
manufacturing_time
integer
Time required for manufacturing in the specified unit.
Examples
Parameters
company_id:
10
application_id:
"64c00b72c07acacc1357503b"
slug:
"75779472"
Was this section helpful?
GET
Response
A sales channel, also known as application, enables the seller to list and sell their products. Different types of sales channels are available namely - 1. Storefront websites - create your own custom storefront website with a free or your own domain. 2. Marketplaces integrations - upload product catalog on platform and sync it to external marketplaces like Myntra, Amazaon, Fynd, etc. You can use this resource to retrieve details of the current sales channel. To identify an application, we use the id as the application identifier and the associated token in the header, and then return the corresponding application details.
Operations
PATCH
# Update sales channel location
Parameters
company_id
integer
Required
Id of the company associated to location custom json.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
store_uid
integer
Required
store id for which the custom_json is associated.
Request body
_custom_json
object
Required
Custom JSON data for the store. It can contain any additional data specific to the store configuration.
Response
200
4XX
Returns a success response
SuccessResponseObject
success
boolean
Indicates whether the operation was successful or not.
uid
integer
A unique identifier associated with the successful operation.
Examples
Parameters
company_id:
47
application_id:
"000000000000000000000001"
store_uid:
113366
body:
body
Was this section helpful?
PATCH
Response
Sales Channel Cataloging is the customization of product listings, query filters, and catalog configuration for a sales channel. Sales Channel Configuration can be used for effectively tailoring sales strategies, improving product visibility, and optimising customer interactions across various sales channels. Build catalog for a sales channel by selecting multiple brands and other properties like imageless, verified/unverified, out-of-stock. Additionally, allow products available in certain companies or selling locations.
Operations
GET
# Get collection query filters
POST
# Update default sorting
GET
# Get listing configurations
POST
# Create listing configuration
GET
# Get group configurations
POST
# Create group configuration
DEL
# Delete group configuration
PUT
# Update group configuration
DEL
# Delete listing configuration
PUT
# Update listing configuration
GET
# Get configuration metadata
Retrieve query filters to configure a collection for a company and a sales channel.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Response
200
4XX
The attached items of an collection.
GetQueryFiltersResponseSchema
filters
array of object (CollectionProductFilters)
An array of filters to be applied on products while querying.
Array of CollectionProductFilters
key
object (ProductFiltersKey)
ProductFiltersKey
display
string
The display name of the filter key, used for showing on the UI.
kind
string
The kind or type of filter, defining the category of the filter.
logo
string
| url
A URL to the logo associated with the filter key.
name
string
The name of the filter key, used in the query.
operators
array of string
A list of supported operators for this filter key.
values
array of object (CollectionProductFiltersValue)
A list of possible values corresponding to the filter key. These values can be selected for filtering products.
Array of CollectionProductFiltersValue
display
string
Display name of the filter value.
count
integer
The number of products that match this filter value.
is_selected
boolean
Indicates whether the filter value is currently selected by the user.
value
string
The actual value for the filter, used in filtering queries.
logo
Undefined Type
anyOf Schema from below
operators
object
A map of operators available for product queries, where the key is the operator type and the value is a string.
sort_on
array of object (CollectionProductSortOn)
An array of sorting options to be applied to product queries.
Array of CollectionProductSortOn
is_selected
boolean
Indicates whether this sorting option is currently applied.
name
string
Display name of the sorting option.
value
string
Technical value of the sorting option used in queries.
logo
string
| url
URL to the logo image representing the sorting option.
Examples
Parameters
company_id:
"1"
application_id:
"64c00b72c07acacc1357503b"
Was this section helpful?
GET
Response
Modify the default sort key configuration for a company and an sales channel.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Request body
default_key
string
Required
The default key used for the requested operation.
Response
200
4XX
success message will tell whether the operation was successful.
ConfigSuccessResponseSchema
message
string
A message confirming the successful completion of the configuration operation.
Examples
Parameters
company_id:
"1"
application_id:
"832488340923kjdsbfkjhsbfk"
body:
body
Was this section helpful?
POST
Response
Retrieve product listing configurations based on specific config_type for a company and an sales channel.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
config_type
string
Required
A `config_type` is an identifier that defines a specific type of configuration.
Enum
page_no
integer
The page number to navigate through the given set of results.
page_size
integer
Number of items to retrieve in each page. Default is 12.
search
string
Get configuration list filtered by `search` string.
Response
200
4XX
configuration details for catalog.
GetConfigResponseSchema
data
array of object (ConfigItem)
Array of ConfigItem
app_id
string
Unique identifier for the application to which this configuration belongs.
attributes
array of object (AttributeConfig)
Array of AttributeConfig
display_type
string
The type of display used for the attribute (e.g., text, dropdown).
is_active
boolean
Indicates whether the attribute is currently active.
key
string
A unique key or identifier for the attribute.
name
string
The name of the attribute.
priority
integer
| value >= 1
The priority of the attribute.
slug
string
A URL-friendly identifier for the attribute.
id
string
Unique identifier for the configuration.
is_active
boolean
Indicates if this configuration is currently active for the application.
is_default
boolean
Specifies whether this is the default configuration for the application.
name
string
The name of the configuration group.
priority
integer
| value >= 1
The priority of this configuration group.
slug
string
A URL-friendly identifier for the configuration group.
template_slugs
array of string
A list of template slugs associated with this configuration.
page
object (PageResponseType)
PageResponseType
current
integer
has_next
boolean
next
integer
total_count
integer
Examples
Parameters
company_id:
"1"
application_id:
"sadasfadsfdfd234"
config_type:
"brands"
page_no:
1
page_size:
1
search:
"sample_slug"
Was this section helpful?
GET
Response
Add configuration for product catalog listing specific to a company and an sales channel.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
config_type
string
Required
A `config_type` is a unique identifier for a particular listing configuration type.
Enum
Request body
app_id
string
Required
Unique identifier for the application.
default_key
string
Required
The default configuration key for the app.
is_active
boolean
Required
Indicates whether the app configuration is currently active.
is_default
boolean
Required
Specifies if this is the default configuration for the app.
key
string
Required
The specific configuration key for the app.
logo
string
| url
URL of the app's logo.
name
string
Name of the application.
priority
integer
| value >= 1
Required
Defines the priority level for this configuration, with 1 being the highest.
Response
200
4XX
success flag will tell whether the operation was successful.
AppConfigurationsSort
app_id
string
Unique identifier for the application.
default_key
string
The default configuration key for the app.
is_active
boolean
Indicates whether the app configuration is currently active.
is_default
boolean
Specifies if this is the default configuration for the app.
key
string
The specific configuration key for the app.
logo
string
| url
URL of the app's logo.
name
string
Name of the application.
priority
integer
| value >= 1
Defines the priority level for this configuration, with 1 being the highest.
Examples
Parameters
company_id:
"11"
application_id:
"sadadkjasdkjhabd57"
config_type:
"filter"
body:
body
Was this section helpful?
POST
Response
Retrieve the details of product group configurations based on config types for a company and an sales channel.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
config_type
string
Required
A `config_type` is an identifier that defines a specific type of configuration.
Enum
page_no
integer
The page number to navigate through the given set of results.
page_size
integer
Number of items to retrieve in each page. Default is 12.
search
string
Get configuration list filtered by `search` string.
template_slug
string
Get configuration list filtered by `template_slug` string. This is for the details and comparision groups.
Response
200
4XX
configuration details for catalog.
GetConfigResponseSchema
data
array of object (ConfigItem)
Array of ConfigItem
app_id
string
Unique identifier for the application to which this configuration belongs.
attributes
array of object (AttributeConfig)
Array of AttributeConfig
display_type
string
The type of display used for the attribute (e.g., text, dropdown).
is_active
boolean
Indicates whether the attribute is currently active.
key
string
A unique key or identifier for the attribute.
name
string
The name of the attribute.
priority
integer
| value >= 1
The priority of the attribute.
slug
string
A URL-friendly identifier for the attribute.
id
string
Unique identifier for the configuration.
is_active
boolean
Indicates if this configuration is currently active for the application.
is_default
boolean
Specifies whether this is the default configuration for the application.
name
string
The name of the configuration group.
priority
integer
| value >= 1
The priority of this configuration group.
slug
string
A URL-friendly identifier for the configuration group.
template_slugs
array of string
A list of template slugs associated with this configuration.
page
object (PageResponseType)
PageResponseType
current
integer
has_next
boolean
next
integer
total_count
integer
Examples
Parameters
company_id:
"1"
application_id:
"asdasjkdbdh673t"
config_type:
"comparisons_groups"
page_no:
1
page_size:
12
search:
"comparisons_groups"
template_slug:
"comparisons_groups"
Was this section helpful?
GET
Response
Create group configuration for a specific config_type for a company and an sales channel.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
config_type
string
Required
A `config_type` is a unique identifier for a particular group configuration type.
Enum
Request body
app_id
string
Required
Unique identifier for the application to which this configuration belongs.
attributes
array of object (AttributeDetailsGroup)
A list of attribute groups associated with the app configuration. Each attribute group defines a set of attributes relevant to the app.
Minimum Items : 1
Array of AttributeDetailsGroup
display_type
string
Required
The type of display used for the attribute, such as text, dropdown, or image.
is_active
boolean
Required
Indicates if this attribute group is currently active.
key
string
A unique key or identifier for the attribute group.
logo
string
| url
URL of the logo image associated with this attribute group.
name
string
Required
The name of the attribute group.
priority
integer
| value >= 1
Required
The priority of the attribute group, determining the order in which it is displayed or processed.
slug
string
A URL-friendly identifier for the attribute group, often used in APIs for identification.
unit
string
The unit of measurement associated with the attribute, if applicable (e.g., cm, kg).
is_active
boolean
Required
Indicates whether this configuration is currently active for the application.
is_default
boolean
Required
Specifies if this configuration is the default setting for the application.
logo
string
| url
URL of the logo image associated with the application configuration.
name
string
The name of the application configuration.
priority
integer
| value >= 1
Required
The priority of this configuration compared to others. Higher priority configurations are given precedence.
slug
string
Required
template_slugs
array of string
A list of template slugs associated with this configuration, representing different templates that the configuration might use.
Response
200
4XX
success flag will tell whether the operation was successful.
AppConfigurationDetail
app_id
string
Unique identifier for the application to which this configuration belongs.
attributes
array of object (AttributeDetailsGroup)
A list of attribute groups associated with the app configuration. Each attribute group defines a set of attributes relevant to the app.
Minimum Items : 1
Array of AttributeDetailsGroup
display_type
string
The type of display used for the attribute, such as text, dropdown, or image.
is_active
boolean
Indicates if this attribute group is currently active.
key
string
A unique key or identifier for the attribute group.
logo
string
| url
URL of the logo image associated with this attribute group.
name
string
The name of the attribute group.
priority
integer
| value >= 1
The priority of the attribute group, determining the order in which it is displayed or processed.
slug
string
A URL-friendly identifier for the attribute group, often used in APIs for identification.
unit
string
The unit of measurement associated with the attribute, if applicable (e.g., cm, kg).
is_active
boolean
Indicates whether this configuration is currently active for the application.
is_default
boolean
Specifies if this configuration is the default setting for the application.
logo
string
| url
URL of the logo image associated with the application configuration.
name
string
The name of the application configuration.
priority
integer
| value >= 1
The priority of this configuration compared to others. Higher priority configurations are given precedence.
slug
string
template_slugs
array of string
A list of template slugs associated with this configuration, representing different templates that the configuration might use.
Examples
Parameters
company_id:
"1"
application_id:
"dsfnsdfjsdnf32323"
config_type:
"comparisons_groups"
body:
body
Was this section helpful?
POST
Response
Delete group configurations by its slug for a specific config_type for a company and an sales channel.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
config_type
string
Required
A `config_type` is a unique identifier for a particular group configuration type.
Enum
group_slug
string
Required
A `group_slug` is a unique identifier of a particular configuration.
Response
200
4XX
success message will tell whether the operation was successful.
ConfigSuccessResponseSchema
message
string
A message confirming the successful completion of the configuration operation.
Examples
Parameters
company_id:
"1"
application_id:
"dskfndkjfsdfd342"
config_type:
"seller_groups"
group_slug:
"sample-slug"
Was this section helpful?
DEL
Response
Modify group configurations by its slug for specific config_type for a company and an sales channel.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
config_type
string
Required
A `config_type` is a unique identifier for a particular group configuration type.
Enum
group_slug
string
Required
A `group_slug` is a unique identifier of a particular configuration.
Request body
app_id
string
Required
Unique identifier for the application to which this configuration belongs.
attributes
array of object (AttributeDetailsGroup)
A list of attribute groups associated with the app configuration. Each attribute group defines a set of attributes relevant to the app.
Minimum Items : 1
Array of AttributeDetailsGroup
display_type
string
Required
The type of display used for the attribute, such as text, dropdown, or image.
is_active
boolean
Required
Indicates if this attribute group is currently active.
key
string
A unique key or identifier for the attribute group.
logo
string
| url
URL of the logo image associated with this attribute group.
name
string
Required
The name of the attribute group.
priority
integer
| value >= 1
Required
The priority of the attribute group, determining the order in which it is displayed or processed.
slug
string
A URL-friendly identifier for the attribute group, often used in APIs for identification.
unit
string
The unit of measurement associated with the attribute, if applicable (e.g., cm, kg).
is_active
boolean
Required
Indicates whether this configuration is currently active for the application.
is_default
boolean
Required
Specifies if this configuration is the default setting for the application.
logo
string
| url
URL of the logo image associated with the application configuration.
name
string
The name of the application configuration.
priority
integer
| value >= 1
Required
The priority of this configuration compared to others. Higher priority configurations are given precedence.
slug
string
Required
template_slugs
array of string
A list of template slugs associated with this configuration, representing different templates that the configuration might use.
Response
200
4XX
success flag will tell whether the operation was successful.
AppConfigurationDetail
app_id
string
Unique identifier for the application to which this configuration belongs.
attributes
array of object (AttributeDetailsGroup)
A list of attribute groups associated with the app configuration. Each attribute group defines a set of attributes relevant to the app.
Minimum Items : 1
Array of AttributeDetailsGroup
display_type
string
The type of display used for the attribute, such as text, dropdown, or image.
is_active
boolean
Indicates if this attribute group is currently active.
key
string
A unique key or identifier for the attribute group.
logo
string
| url
URL of the logo image associated with this attribute group.
name
string
The name of the attribute group.
priority
integer
| value >= 1
The priority of the attribute group, determining the order in which it is displayed or processed.
slug
string
A URL-friendly identifier for the attribute group, often used in APIs for identification.
unit
string
The unit of measurement associated with the attribute, if applicable (e.g., cm, kg).
is_active
boolean
Indicates whether this configuration is currently active for the application.
is_default
boolean
Specifies if this configuration is the default setting for the application.
logo
string
| url
URL of the logo image associated with the application configuration.
name
string
The name of the application configuration.
priority
integer
| value >= 1
The priority of this configuration compared to others. Higher priority configurations are given precedence.
slug
string
template_slugs
array of string
A list of template slugs associated with this configuration, representing different templates that the configuration might use.
Examples
Parameters
company_id:
"1"
application_id:
"saknabahsjd6356563"
config_type:
"details_groups"
group_slug:
"sample-slug"
body:
body
Was this section helpful?
PUT
Response
Remove a specific product listing configuration by its config_id for a specific config_type for a company and an sales channel.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
config_type
string
Required
A `config_type` is a unique identifier for a particular listing configuration type.
Enum
config_id
string
Required
A `config_id` is a unique identifier of a particular configuration.
Response
200
4XX
success message will tell whether the operation was successful.
ConfigSuccessResponseSchema
message
string
A message confirming the successful completion of the configuration operation.
Examples
Parameters
company_id:
"1"
application_id:
"asdsadasdlkmdjaknd6757"
config_type:
"variant"
config_id:
"asdsa"
Was this section helpful?
DEL
Response
Modify a specific product listing configuration by its config_id for a specific config_type for a company and an sales channel.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
config_type
string
Required
A `config_type` is a unique identifier for a particular listing configuration type.
Enum
config_id
string
Required
A `config_id` is a unique identifier of a particular configuration.
Request body
app_id
string
Required
Unique identifier for the application.
default_key
string
Required
The default configuration key for the app.
is_active
boolean
Required
Indicates whether the app configuration is currently active.
is_default
boolean
Required
Specifies if this is the default configuration for the app.
key
string
Required
The specific configuration key for the app.
logo
string
| url
URL of the app's logo.
name
string
Name of the application.
priority
integer
| value >= 1
Required
Defines the priority level for this configuration, with 1 being the highest.
Response
200
4XX
success flag will tell whether the operation was successful.
AppConfigurationsSort
app_id
string
Unique identifier for the application.
default_key
string
The default configuration key for the app.
is_active
boolean
Indicates whether the app configuration is currently active.
is_default
boolean
Specifies if this is the default configuration for the app.
key
string
The specific configuration key for the app.
logo
string
| url
URL of the app's logo.
name
string
Name of the application.
priority
integer
| value >= 1
Defines the priority level for this configuration, with 1 being the highest.
Examples
Parameters
company_id:
"1"
application_id:
"asndbajsbdkasndlaksdn"
config_type:
"sort"
config_id:
"sample"
body:
body
Was this section helpful?
PUT
Response
Retrieve the configuraion metadata details for specific config_type for a company and an sales channel.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
config_type
string
Required
A `config_type` is an identifier that defines a specific type of configuration.
Enum
template_slug
string
Get configuration list filtered by `template_slug` string. This is for the details and comparision groups.
page_no
integer
The page number to navigate through the given set of results.
page_size
integer
Number of items to retrieve in each page.
q
string
Get configuration list filtered by `q` string.
Response
200
4XX
configuration details for catalog.
GetConfigMetadataResponseSchema
condition
array of object (ConditionItem)
Array of ConditionItem
key
string
display
string
data
array of object (DataItem)
Array of DataItem
key
string
display
string
filter_types
array of string
compatible_units
array of string
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.
values
object (GetConfigMetadataValues)
GetConfigMetadataValues
type
array of object (ValueTypeItem)
Array of ValueTypeItem
key
string
display
string
sort
array of object (SortTypeItem)
Array of SortTypeItem
key
string
display
string
Examples
Parameters
company_id:
"1"
application_id:
"jkfskdjfnskjdnfks3423"
config_type:
"variant"
template_slug:
"some-slug"
page_no:
1
page_size:
1
q:
"config"
Was this section helpful?
GET
Response
Sales channel product is used for management of all the product listed on the sales Channel. Sales channel products refer to all the products that are configured to be sold on your sales channels through your sales channel. With this resource, you can fetch and configure various aspects of Sales channel(application) product configurations, including: Minimum Quantity: Define the minimum quantity required for purchase of the product. Maximum Quantity: Set the maximum quantity that can be purchased for the product. Increment Unit: Specify the unit of increment for quantities, such as individual items or sets. SEO Configuration: Add search engine optimization (SEO) attributes to enhance product visibility and searchability. Cash on Delivery Option: Enable or disable the cash on delivery payment option for the product. Gift Option: Specify whether the product can be purchased as a gift, allowing users to select gift-related options during checkout.
Operations
GET
# Get sales channel product
PATCH
# Update sales channel product
GET
# List sales channel products
GET
# List sales channel products
Retrieve sales channel product details by its item_id and depending upon filters sent in request.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
item_id
string
Required
product id for a particular product.
Response
200
4XX
The Company Applicaton Product Data(MOQ/SEO).
OwnerAppItemResponseSchema
alt_text
object
Alternate text associated with the item, typically for accessibility purposes.
Default Value : [object Object]
is_cod
boolean
Indicates whether Cash on Delivery (COD) is available for this item.
Default Value : true
is_gift
boolean
Indicates whether the item is marked as a gift.
Default Value : false
moq
object (MOQData)
Minimum order quantity (MOQ) details for the item, including minimum units and increment units.
Default Value : [object Object]
MOQData
increment_unit
integer
The unit by which the quantity can be incremented after the minimum order quantity.
Default Value : 1
maximum
integer
The maximum number of units that can be ordered for the item.
minimum
integer
The minimum number of units required to place an order for the item.
Default Value : 1
seo
object (SEOData)
Search Engine Optimization (SEO) related information, including title, description, sitemap details, and meta tags.
Default Value : [object Object]
SEOData
description
string
A brief description of the item, primarily used for SEO purposes.
Default Value :
title
string
The title of the item, primarily used for SEO and displayed in search engine results.
Default Value :
sitemap
object (Sitemap)
Sitemap
priority
number
Indicates the priority of this URL relative to other URLs on the site. A value between 0.0 and 1.0, where 1.0 is the highest priority.
frequency
string
How frequently the content at the URL is likely to change.
breadcrumbs
array of object (ApplicationItemSeoBreadcrumbs)
An ordered list of links showing the hierarchy of the page, aiding navigation and SEO.
Array of ApplicationItemSeoBreadcrumbs
url
string
action
object (ApplicationItemSeoAction)
ApplicationItemSeoAction
page
object
type
string
meta_tags
array of object (Metatags)
A list of meta tags for the item, used for SEO optimization.
Array of Metatags
title
string
The title or heading for the meta tags section.
items
array of object (ApplicationItemSeoMetaTagItem)
An array of meta tag items, each consisting of key-value pairs.
Array of ApplicationItemSeoMetaTagItem
key
string
value
string
canonical_url
string
The canonical URL for the item, indicating the preferred URL for search engines to avoid duplicate content.
Default Value :
_custom_json
object
Custom JSON data for the item, allowing flexibility for additional item-specific information.
_custom_meta
array of object (MetaFields)
An array of custom meta fields associated with the item for extended metadata.
Array of MetaFields
key
string
The key of the metadata. Should be a non-empty string and length should not exceed 30 characters.
Minimum Length : 1
Maximum Length : 30
value
string
The value of the metadata. Should be a non-empty string and length should not exceed 100 characters.
Minimum Length : 1
Maximum Length : 100
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
item_id:
2
Was this section helpful?
GET
Response
Allows to update data associated to a item by its item_id for a sales channel.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
item_id
integer
Required
A `item_id` is a unique identifier for a particular item.
Request body
_custom_json
object
Custom JSON data for the item
_custom_meta
array of object (MetaFields)
Custom meta fields for the item
Array of MetaFields
key
string
Required
The key of the metadata. Should be a non-empty string and length should not exceed 30 characters.
Minimum Length : 1
Maximum Length : 30
value
string
Required
The value of the metadata. Should be a non-empty string and length should not exceed 100 characters.
Minimum Length : 1
Maximum Length : 100
alt_text
object
Alternative text for the item's images
is_cod
boolean
Whether the item is available for Cash on Delivery (COD) or not
is_gift
boolean
Whether the item is a gift or not
moq
object (ApplicationItemMOQ)
Minimum Order Quantity information for the item
ApplicationItemMOQ
increment_unit
integer
| value >= 1
The minimum quantity increment in which the item can be purchased.
Default Value : 1
maximum
integer
The maximum quantity allowed for purchase.
minimum
integer
| value >= 1
The minimum quantity required for purchase.
Default Value : 1
seo
object (ApplicationItemSEO)
Search Engine Optimization information for the item
ApplicationItemSEO
description
string
The SEO description of the item
title
string
The SEO title of the item
sitemap
object (ApplicationItemSeoSitemap)
ApplicationItemSeoSitemap
priority
number
Required
The SEO priority of the item
frequency
string
Required
The SEO frequency of the item
breadcrumbs
array of object (ApplicationItemSeoBreadcrumbs)
Array of ApplicationItemSeoBreadcrumbs
url
string
action
object (ApplicationItemSeoAction)
ApplicationItemSeoAction
page
object
type
string
Required
meta_tags
array of object (ApplicationItemSeoMetaTags)
Array of ApplicationItemSeoMetaTags
title
string
Required
items
array of object (ApplicationItemSeoMetaTagItem)
Array of ApplicationItemSeoMetaTagItem
key
string
Required
value
string
Required
canonical_url
string
size_promotion_threshold
object (SizePromotionThreshold)
Size level promotion limitation information for item
SizePromotionThreshold
threshold_type
string
The type of threshold that applies to the size promotion, such as 'quantity' or 'value'.
threshold_value
integer
The value of the threshold required to trigger the promotion, such as a minimum number of units.
Response
200
4XX
Returns a success response
SuccessResponseObject
success
boolean
Indicates whether the operation was successful or not.
uid
integer
A unique identifier associated with the successful operation.
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
item_id:
2
body:
body
Was this section helpful?
PATCH
Response
Retrieve products associated with the sales channel. List all the products associated with a brand, collection or category in a requested sort order.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
q
string
The search query. This can be a partial or complete name of a either a product, brand or category
f
string
The search filter parameters. All the parameter filtered from filter parameters will be passed in **f** parameter in this format. **?f=brand:voi-jeans||and:::category:t-shirts||shirts**
c
string
The search filter parameters for collection items. All the parameter filtered from filter parameters will be passed in **c** parameter in this format. **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
filters
boolean
Pass `filters` parameter to fetch the filter details. This flag is used to fetch all filters
Default Value : true
is_dependent
boolean
This query parameter is used to get the dependent products in the listing.
Default Value : true
sort_on
string
The order to sort the list of products on. The supported sort parameters are popularity, price, redemption and discount in either ascending or descending order. See the supported values below.
Enum
page_id
string
Each response will contain **page_id** param, which should be sent back to make pagination work.
page_size
integer
Number of items to retrieve in each page. Default is 12.
Default Value : 12
page_no
integer
If page_type is number then pass it to fetch page items. Default is 1.
Default Value : 1
page_type
string
For pagination type should be cursor or number. Default is cursor.
Default Value : cursor
Enum
item_ids
array of string
Item Ids of product
Response
200
4XX
List of Products.
ApplicationProductListingResponseSchema
filters
array of object (ProductFilters)
Array of ProductFilters
key
object (ProductFiltersKey)
ProductFiltersKey
display
string
The display name of the filter key, used for showing on the UI.
kind
string
The kind or type of filter, defining the category of the filter.
logo
string
| url
A URL to the logo associated with the filter key.
name
string
The name of the filter key, used in the query.
operators
array of string
A list of supported operators for this filter key.
values
array of object (ProductFiltersValue)
A list of possible values corresponding to the filter key. These values can be selected for filtering products.
Array of ProductFiltersValue
count
integer
The number of products that match this filter value.
currency_code
string
The currency code used if the filter is related to price.
currency_symbol
string
The symbol of the currency used in price-related filters.
display
string
The human-readable label for this filter value.
display_format
string
A format string that controls how the value is displayed, commonly used for numeric or price ranges.
is_selected
boolean
Indicates whether this filter value is currently selected by the user.
max
integer
The maximum value for a range filter (e.g., price range).
min
integer
The minimum value for a range filter (e.g., price range).
query_format
string
The format string used in the query for filtering by this value.
selected_max
integer
The maximum value selected by the user in a range filter.
selected_min
integer
The minimum value selected by the user in a range filter.
value
object
The actual value of the filter.
items
array of object (ApplicationProductsSchema)
Array of ApplicationProductsSchema
attributes
object
Additional attributes of the product, such as custom properties or features.
brand
object (ProductBrand)
ProductBrand
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
logo
object (Media)
Media
meta
object
A metadata object containing additional information about the media, such as dimensions, format, or other relevant details.
type
string
The type of media.
Enum
url
string
The URL where the media can be accessed.
alt
string
The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed.
thumbnail
string
The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media.
name
string
uid
integer
color
string
description
string
A detailed description of the product.
discount
string
The discount applied to the product.
has_variant
boolean
Indicates whether the product has variants, such as different sizes or colors.
highlights
array of string
Key highlights of the product.
image_nature
string
The nature of the product image, indicating if it's the default or a standard image.
Enum
item_code
string
A unique code assigned to the product item at company and brand level.
item_type
string
The type of the product, defining its nature.
Enum
medias
array of object (Media)
A list of media items associated with the product, such as images or videos.
Array of Media
meta
object
A metadata object containing additional information about the media, such as dimensions, format, or other relevant details.
type
string
The type of media.
Enum
url
string
The URL where the media can be accessed.
alt
string
The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed.
thumbnail
string
The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media.
name
string
The name of the product.
price
object (ProductListingPrice)
ProductListingPrice
effective
object (Price1)
Price1
currency_code
object (CurrencyCodeEnum)
Enum
currency_symbol
string
max
number
min
number
marked
object (Price1)
Price1
currency_code
object (CurrencyCodeEnum)
Enum
currency_symbol
string
max
number
min
number
selling
object (Price1)
Price1
currency_code
object (CurrencyCodeEnum)
Enum
currency_symbol
string
max
number
min
number
product_online_date
string
| date-time
The date and time when the product becomes available online.
promo_meta
object
Metadata related to any promotions associated with the product.
rating
number
The average rating of the product, typically based on customer reviews.
rating_count
integer
The total number of ratings the product has received.
sellable
boolean
Indicates whether the product is available for sale.
short_description
string
A brief description of the product.
similars
array of string
A list of similar products.
slug
string
A URL-friendly string representing the product.
teaser_tag
object
A teaser tag object providing short promotional information about the product.
tryouts
array of string
A list of tryout options or samples available for the product.
type
string
The type or category of the product.
uid
integer
A unique identifier for the product.
popularity
integer
A numerical value indicating the popularity of the product.
brand_uid
integer
The unique identifier for the brand associated with the product.
category_uid
integer
The unique identifier for the category to which the product belongs.
verification_status
integer
The verification status of the product, typically represented as an integer.
channel_identifier
string
The identifier for the sales channel through which the product is sold.
category_slug
string
A URL-friendly string representing the product's category.
size_guide
string
A guide or chart providing size information for the product.
l3_categories
array of integer
A list of L3 category IDs of the product.
store_ids
array of integer
A list of store IDs where the product is available.
company_ids
array of integer
A list of company IDs associated with the product.
departments
array of integer
A list of department IDs where the product is categorized.
tags
array of string
A list of tags or keywords associated with the product.
l3_category_names
array of string
A list of names of L3 categories of the product.
sizes
array of string
A list of available sizes for the product.
product_group_tag
array of string
Tags that group the product with other similar products.
multi_size
boolean
Indicates whether the product is available in multiple sizes.
is_gift
boolean
Indicates whether the product can be considered as a gift.
is_cod
boolean
Indicates whether the product is eligible for cash on delivery (COD).
is_dependent
boolean
Indicates whether the product depends on another product.
is_available
boolean
Indicates whether the product is currently available for purchase.
moq
object (ApplicationItemMOQ)
ApplicationItemMOQ
increment_unit
integer
| value >= 1
The minimum quantity increment in which the item can be purchased.
Default Value : 1
maximum
integer
The maximum quantity allowed for purchase.
minimum
integer
| value >= 1
The minimum quantity required for purchase.
Default Value : 1
seo
object (ApplicationItemSEO)
ApplicationItemSEO
description
string
The SEO description of the item
title
string
The SEO title of the item
sitemap
object (ApplicationItemSeoSitemap)
ApplicationItemSeoSitemap
priority
number
The SEO priority of the item
frequency
string
The SEO frequency of the item
breadcrumbs
array of object (ApplicationItemSeoBreadcrumbs)
Array of ApplicationItemSeoBreadcrumbs
url
string
action
object (ApplicationItemSeoAction)
ApplicationItemSeoAction
page
object
type
string
meta_tags
array of object (ApplicationItemSeoMetaTags)
Array of ApplicationItemSeoMetaTags
title
string
items
array of object (ApplicationItemSeoMetaTagItem)
Array of ApplicationItemSeoMetaTagItem
key
string
value
string
canonical_url
string
variants
object
An object containing details about the product variants.
variant_media
object
Media items specific to the product variants.
variant_group
object
A group identifier for products that are variants of one another.
multi_categories
array of object (MultiCategoriesSchema)
Array of MultiCategoriesSchema
l1
integer
The ID of the Level 1 (L1) category of the product.
l2
integer
The ID of the Level 2 (L2) category of the product.
l3
integer
The ID of the Level 3 (L3) category of the product.
is_active
boolean
Indicates whether the L3 category of the product is currently active.
department
integer
The department associated with the L3 category of the product.
template_tag
string
Tag used for categorizing or templating purposes.
net_quantity
object
Net quantity details for the product.
custom_order
object (CustomOrder)
CustomOrder
manufacturing_time_unit
string
Unit of time for manufacturing (e.g., days, weeks).
is_custom_order
boolean
Indicates if the product is available for custom orders.
manufacturing_time
integer
Time required for manufacturing in the specified unit.
country_of_origin
string
Country where the product is manufactured or sourced from.
_custom_json
object
Custom JSON data associated with the product.
identifiers
array of string
Identifiers associated with the product.
item_id
integer
Unique identifier for the item.
_custom_meta
array of object (CustomMeta)
Custom meta associated with the product.
Array of CustomMeta
key
string
The key of the metadata. Should be a non-empty string and length should not exceed 30 characters.
Minimum Length : 1
Maximum Length : 30
value
string
The value of the metadata. Should be a non-empty string and length should not exceed 100 characters.
Minimum Length : 1
Maximum Length : 100
discount_percentage
integer
The discount applied to the product in percentage.
operators
object
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
sort_on
array of object (ProductSortOn)
Array of ProductSortOn
is_selected
boolean
Indicates whether this sorting option is currently selected.
name
string
The display name of the sorting option, used to show on the UI.
value
string
The value representing the sorting option.
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
q:
"laptop"
f:
"item_code:LGLAPTOPSLEEVE5"
c:
"item_code:in:LGLAPTOPSLEEVE5"
filters:
true
is_dependent:
true
sort_on:
"price_asc"
page_id:
"*"
page_size:
1
page_no:
1
page_type:
"number"
item_ids:
"10"
Was this section helpful?
GET
Response
Retrieve products specific to the sales channel, with filtering options available for brand, category, department, tags, item IDs, product name, and pagination support
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
brand_ids
array of integer
Get multiple products filtered by Brand Ids
category_ids
array of integer
Get multiple products filtered by Category Ids
department_ids
array of integer
Get multiple products filtered by Department Ids
tags
array of string
Get multiple products filtered by tags
item_ids
array of integer
Get multiple products filtered by Item Ids
page_no
integer
The page number to navigate through the given set of results
page_size
integer
Number of items to retrieve in each page. Default is 10.
Default Value : 10
q
string
Search with Item Code, Name, Slug or Identifier.
Response
200
4XX
The Product object.
RawProductListingResponseSchema
items
array of object (RawProduct)
A list of raw product items.
Array of RawProduct
_custom_json
object
Custom JSON data for the product.
all_company_ids
array of integer
List of company IDs associated with the product.
all_identifiers
array of string
List of all identifiers associated with the product.
all_sizes
array of object
List of sizes available for the product.
attributes
object
Additional attributes for the product.
brand
object (Brand)
Brand
logo
object (Logo)
Logo
aspect_ratio
string
Aspect ratio of the logo image, typically expressed as a string (e.g., '16:9').
aspect_ratio_f
integer
Numeric representation of the aspect ratio for scaling purposes.
secure_url
string
Secure URL to the logo image.
url
string
URL to the logo image.
name
string
The name of the brand.
uid
integer
Unique identifier for the brand.
brand_uid
integer
Unique identifier of the brand.
category
object
Category details of the product.
category_slug
string
Slug representing the category of the product.
category_uid
integer
Unique identifier for the product category.
company_id
integer
Unique identifier of the company associated with the product.
country_of_origin
string
Country where the product is manufactured.
created_by
object
Details of the user who created the product.
created_on
string
| date-time
Timestamp when the product was created.
currency
string
Currency in which the product is priced.
custom_order
object
Custom order details for the product.
departments
array of integer
List of department IDs associated with the product.
description
string
Detailed description of the product.
highlights
array of string
List of highlights for the product.
hsn_code
string
HSN code associated with the product for tax purposes.
id
string
Unique identifier of the product.
image_nature
string
Nature or type of product images.
images
array of string
List of image URLs for the product.
is_active
boolean
Indicates whether the product is active.
is_dependent
boolean
Indicates if the product is dependent on another product.
is_expirable
boolean
Indicates if the product has an expiration date.
is_image_less_product
boolean
Indicates if the product does not have associated images.
is_physical
boolean
Indicates if the product is a physical item.
is_set
boolean
Indicates if the product is part of a set.
item_code
string
Unique code representing the item.
item_type
string
Type of the item, such as 'standard'.
Enum
l3_mapping
array of string
L3 category mapping for the product.
media
array of object (Media)
Media associated with the product, such as images or videos.
Array of Media
meta
object
A metadata object containing additional information about the media, such as dimensions, format, or other relevant details.
type
string
The type of media.
Enum
url
string
The URL where the media can be accessed.
alt
string
The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed.
thumbnail
string
The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media.
modified_by
object
Details of the user who last modified the product.
modified_on
string
| date-time
Timestamp when the product was last modified.
moq
object
Minimum order quantity details for the product.
multi_size
boolean
Indicates if the product supports multiple sizes.
name
string
Name of the product.
net_quantity
object (NetQuantityResponseSchema)
NetQuantityResponseSchema
unit
string
The unit of measurement for the net quantity.
value
number
The actual quantity of the product in the specified unit.
no_of_boxes
integer
Number of boxes required for packaging the product.
pending
string
Pending state of the product, such as pending approval.
primary_color
string
Primary color of the product.
product_group_tag
array of string
Tags associated with the product group.
product_publish
object (ProductPublished)
ProductPublished
is_set
boolean
Indicates whether the product is part of a set.
product_online_date
integer
Timestamp when the product is scheduled to go live online.
return_config
object (ReturnConfigResponseSchema)
ReturnConfigResponseSchema
returnable
boolean
Indicates if the product is eligible for return.
time
integer
The duration within which the product can be returned.
unit
string
The time unit for the return duration, e.g., 'days' or 'hours'.
short_description
string
Short description of the product.
size_guide
string
Size guide for the product.
sizes
array of object
List of available sizes for the product.
slug
string
Unique slug identifier for the product.
stage
string
Current stage of the product (e.g., pending, verified).
tags
array of string
List of tags associated with the product.
tax_identifier
object (TaxIdentifier)
TaxIdentifier
hsn_code
string
hsn_code_id
string
reporting_hsn
string
teaser_tag
object
Teaser tags for the product.
template_tag
string
Template tag associated with the product.
trader
array of object (Trader)
List of traders associated with the product.
Array of Trader
address
array of string
List of addresses associated with the trader.
name
string
The name of the trader.
Minimum Length : 1
Maximum Length : 300
type
string
The role or type of the trader.
Enum
uid
integer
Unique identifier for the product.
variant_group
object
Variant group details for the product.
variant_media
object
Media related to product variants.
variants
object
Product variants information.
verified_by
object (VerifiedBy)
VerifiedBy
user_id
string
The unique identifier of the user who verified the product.
username
string
The username of the user who verified the product.
verified_on
string
| date-time
Timestamp when the product was verified.
store_id_list
array of string
List of store IDs where the product is available.
action
string
Action to be performed on the product.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
Examples
Parameters
company_id:
1
application_id:
"655b09a916628f2bf9203e3b"
brand_ids:
1
category_ids:
1
department_ids:
1
tags:
""
item_ids:
1
page_no:
1
page_size:
1
q:
"test"
Was this section helpful?
GET
Response
A selling location represents a geographical location where your stores, pop-up stores, headquarters, and warehouses exist. Find in-stock locations for products Additionally, the API retrieves detailed location information by ID, offering comprehensive store details for enhanced user convenience
Operations
GET
# List sales channels
Retrieve all stores associated with a sales channel, with support for searching by store name and filtering by store type and status.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
store_type
string
Helps to sort the location list on the basis of location type.
Enum
uid
array of integer
Helps to sort the location list on the basis of uid list.
q
string
Query that is to be searched.
stage
string
to filter companies on basis of verified or unverified companies.
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 is 20.
Default Value : 20
tags
array of string
Get locations filtered by tags.
store_types
array of string
Get locations filtered by store types.
Response
200
4XX
Company profile object.
LocationListSchema
items
array of object (GetLocationSchema)
Array of GetLocationSchema
_custom_json
object
Custom JSON data specific to the location.
address
object (GetAddressSchema)
GetAddressSchema
address1
string
Primary address line, typically including street name, building number, or apartment details.
address2
string
Secondary address line, used for additional location details such as locality, neighborhood, or landmark.
address_type
string
The type of address.
city
string
The city where the address is located.
country
string
The country where the address is located.
country_code
string
The country code representing the country, such as 'IN' for India.
landmark
string
A nearby landmark that helps identify the address location.
latitude
number
The latitude coordinate of the address, used for geolocation purposes.
longitude
number
The longitude coordinate of the address, used for geolocation purposes.
pincode
integer
The postal code or ZIP code associated with the address.
state
string
The state or region where the address is located.
store_code
string
Unique identifier code for the store.
company
object (GetCompanySchema)
GetCompanySchema
addresses
array of object (GetAddressSchema)
List of addresses associated with the company.
Array of GetAddressSchema
address1
string
Primary address line, typically including street name, building number, or apartment details.
address2
string
Secondary address line, used for additional location details such as locality, neighborhood, or landmark.
address_type
string
The type of address.
city
string
The city where the address is located.
country
string
The country where the address is located.
country_code
string
The country code representing the country, such as 'IN' for India.
landmark
string
A nearby landmark that helps identify the address location.
latitude
number
The latitude coordinate of the address, used for geolocation purposes.
longitude
number
The longitude coordinate of the address, used for geolocation purposes.
pincode
integer
The postal code or ZIP code associated with the address.
state
string
The state or region where the address is located.
business_type
string
Specifies the business model or legal structure of the company, such as 'LLC', 'Corporation', or 'Proprietorship'.
company_type
string
Indicates the type of company, such as 'manufacturer-owner', 'retailer', or 'wholesaler'.
Enum
created_by
object (UserSchema)
UserSchema
contact
string
The contact information of the user.
user_id
string
The unique ID of the user.
username
string
The username of the user.
created_on
string
| date-time
The date and time when the company record was created.
modified_by
object (UserSchema)
UserSchema
contact
string
The contact information of the user.
user_id
string
The unique ID of the user.
username
string
The username of the user.
modified_on
string
| date-time
The date and time when the company record was last updated.
name
string
The registered name of the company.
reject_reason
string
If applicable, the reason why the company's application or status was rejected.
stage
string
Current operational stage of the company, such as 'active', 'pending', or 'rejected'.
uid
integer
Unique identifier for the company within the system.
verified_by
object (UserSchema)
UserSchema
contact
string
The contact information of the user.
user_id
string
The unique ID of the user.
username
string
The username of the user.
verified_on
string
| date-time
The date and time when the company's details were verified.
contact_numbers
array of object (SellerPhoneNumber)
List of contact numbers associated with the store.
Array of SellerPhoneNumber
country_code
integer
The country code for the phone number, typically represented as an integer (e.g., 91 for India).
number
string
The phone number associated with the seller, without the country code.
Maximum Length : 12
created_by
object (UserSchema)
UserSchema
contact
string
The contact information of the user.
user_id
string
The unique ID of the user.
username
string
The username of the user.
created_on
string
| date-time
Timestamp indicating when the location was created.
display_name
string
Display name of the location for easier identification.
documents
array of object (Document)
Documents related to the store location.
Array of Document
legal_name
string
The official legal name associated with the document.
type
string
The type of document.
url
string
| url
A URL link to the document, typically pointing to where the document is stored.
value
string
The actual value or identifier associated with the document, such as a GST number or PAN number.
verified
boolean
Indicates whether the document has been verified as valid.
gst_credentials
object (InvoiceDetailsSchema)
InvoiceDetailsSchema
e_invoice
object (InvoiceCredSchema)
InvoiceCredSchema
enabled
boolean
Indicates whether the invoice credentials are enabled for use.
password
string
The password associated with the invoice credentials.
username
string
The username or identifier used for the invoice credentials.
e_waybill
object (InvoiceCredSchema)
InvoiceCredSchema
enabled
boolean
Indicates whether the invoice credentials are enabled for use.
password
string
The password associated with the invoice credentials.
username
string
The username or identifier used for the invoice credentials.
integration_type
object (LocationIntegrationType)
LocationIntegrationType
inventory
string
The system used to manage inventory integration for the location.
Enum
order
string
The system used to manage order integration for the location.
Enum
manager
object (LocationManagerSchema)
LocationManagerSchema
email
string
| email
Email address of the location manager.
mobile_no
object (SellerPhoneNumber)
SellerPhoneNumber
country_code
integer
The country code for the phone number, typically represented as an integer (e.g., 91 for India).
number
string
The phone number associated with the seller, without the country code.
Maximum Length : 12
name
string
Full name of the location manager.
modified_by
object (UserSchema)
UserSchema
contact
string
The contact information of the user.
user_id
string
The unique ID of the user.
username
string
The username of the user.
modified_on
string
| date-time
Timestamp indicating when the location details were last modified.
name
string
Name of the store location.
notification_emails
array of string
Email addresses for sending notifications related to this store.
phone_number
string
Primary phone number for contacting the store.
product_return_config
object (ProductReturnConfigSchema)
ProductReturnConfigSchema
on_same_store
boolean
Indicates if the product return is allowed only at the same store where it was purchased.
store_uid
integer
Unique identifier for the store where the product can be returned.
stage
string
Current operational stage of the store.
store_type
string
Type of store.
Enum
timing
array of object (LocationDayWiseSchema)
The daily operational timings for the store.
Array of LocationDayWiseSchema
closing
object (LocationTimingSchema)
LocationTimingSchema
hour
integer
The hour component of the time, represented in 24-hour format.
minute
integer
The minute component of the time.
open
boolean
Indicates whether the store or location is open on the specified day.
opening
object (LocationTimingSchema)
LocationTimingSchema
hour
integer
The hour component of the time, represented in 24-hour format.
minute
integer
The minute component of the time.
weekday
string
The day of the week for which the store timings are defined.
Enum
uid
integer
Unique identifier for the store.
verified_by
object (UserSchema)
UserSchema
contact
string
The contact information of the user.
user_id
string
The unique ID of the user.
username
string
The username of the user.
verified_on
string
| date-time
Timestamp when the store location was verified.
warnings
object
Warnings or issues associated with the store, if any.
company_id
integer
ID of the company to which this store belongs.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
Examples
Parameters
company_id:
1
application_id:
"655b09a916628f2bf9203e3b"
store_type:
"high_street"
uid:
1
q:
"test"
stage:
"verified"
page_no:
1
page_size:
1
tags:
"test"
store_types:
"test"
Was this section helpful?
GET
Response