Catalog
Manages product catalogs, including adding, updating, and deleting products, as well as categorizing them.
Brand
A brand represents a specific brand or manufacturer associated with a product. Brands help customers identify and differentiate products based on their manufacturer or designer. Each brand typically has a unique identifier and a name. For example, a clothing platform might have brands such as Nike, Adidas, Gucci, 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
GET
List sales channel 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. See example below or refer `BrandListingResponse` for details
BrandListingResponse
items
array of object (BrandItem)
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
type
string
url
string
| url
portrait
object (BannerImage)
BannerImage
aspect_ratio
string
type
string
url
string
| url
departments
array of string
discount
string
logo
object (Media2)
Media2
aspect_ratio
string
type
string
url
string
name
string
slug
string
uid
integer
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:
"value"
application_id:
"value"
page_no:
1
page_size:
1
q:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List sales channel brands
getApplicationBrandListing
PATCH
Update sales channel brand
Modify data associated to the brand for that particular sales channel.
Parameters
company_id
string
Required
Id of the company associated to brand custom json.
application_id
string
Required
application id for which the custom_json is associated.
brand_uid
string
Required
brand id for which the custom_json is associated.
Request body
_custom_json
object
Required
Response
200
4XX
Returns a success response
SuccessResponse1
success
boolean
uid
integer
Examples
Parameters
company_id:
"value"
application_id:
"value"
brand_uid:
"value"
body:
body
Was this section helpful?
PATCH
Loading...
Response
Loading...
Update sales channel brand
updateAppBrand
GET
List brands
List all the brands, and have search capabilities on brand uid, name 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
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
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.
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. See example below or refer `BrandListingResponse` for details
BrandListingResponse
items
array of object (BrandItem)
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
type
string
url
string
| url
portrait
object (BannerImage)
BannerImage
aspect_ratio
string
type
string
url
string
| url
departments
array of string
discount
string
logo
object (Media2)
Media2
aspect_ratio
string
type
string
url
string
name
string
slug
string
uid
integer
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:
"value"
application_id:
"value"
department:
"value"
page_no:
1
page_size:
1
q:
"value"
brand_id:
0,1
Was this section helpful?
GET
Loading...
Response
Loading...
List brands
getApplicationBrands
Category
Categories are hierarchical structure that enables a systematic organization of products for better discoverability of products on storefront. Categories are structured into three levels: L1, L2, and L3, with L1 representing the top-level category, followed by L2 and L3. For example - Clothing(L1) >> Shirts(L2) >> Formal Shirts(L3) A single L1 category can encompass multiple L2 categories underneath it, and similarly, an L2 category can contain multiple L3 categories within it. Category is a sales-channel specific configuration. While categories are common across all companies, sales channel can configure L3 category names tailored to their unique requirements.
Operations
GET
# List categories
GET
# List sales channel categories
PATCH
# Update sales channel category
GET
List categories
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
Enum
Response
200
4XX
List of Categories. See example below or refer `CategoryListingResponse` for details.
CategoryListingResponse
data
array of object (DepartmentCategoryTree)
Array of DepartmentCategoryTree
department
string
items
array of object (CategoryItems)
Array of CategoryItems
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
type
string
url
string
| url
portrait
object (BannerImage)
BannerImage
aspect_ratio
string
type
string
url
string
| url
childs
array of object (Child)
Array of Child
_custom_json
object
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
type
string
url
string
| url
portrait
object (BannerImage)
BannerImage
aspect_ratio
string
type
string
url
string
| url
childs
array of object (SecondLevelChild)
Array of SecondLevelChild
_custom_json
object
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
type
string
url
string
| url
portrait
object (BannerImage)
BannerImage
aspect_ratio
string
type
string
url
string
| url
childs
array of object (ThirdLevelChild)
Array of ThirdLevelChild
_custom_json
object
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
type
string
url
string
| url
portrait
object (BannerImage)
BannerImage
aspect_ratio
string
type
string
url
string
| url
childs
array of object
name
string
slug
string
uid
integer
name
string
slug
string
uid
integer
name
string
slug
string
uid
integer
name
string
slug
string
uid
integer
departments
array of object (DepartmentIdentifier)
Array of DepartmentIdentifier
slug
string
uid
integer
Examples
Parameters
company_id:
"value"
application_id:
"value"
department:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List categories
getCategories
GET
List sales channel categories
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
Search query with brand name.Use this parameter to search brands by brand name.
Response
200
4XX
List of Brands. See example below or refer `BrandListingResponse` for details
BrandListingResponse
items
array of object (BrandItem)
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
type
string
url
string
| url
portrait
object (BannerImage)
BannerImage
aspect_ratio
string
type
string
url
string
| url
departments
array of string
discount
string
logo
object (Media2)
Media2
aspect_ratio
string
type
string
url
string
name
string
slug
string
uid
integer
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:
"value"
application_id:
"value"
department_id:
1
page_no:
1
page_size:
1
q:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List sales channel categories
getApplicationCategoryListing
PATCH
Update sales channel category
Modify category data related to the sales channel .
Parameters
company_id
string
Required
Id of the company associated to category custom json.
application_id
string
Required
application id for which the custom_json is associated.
category_uid
string
Required
category id for which the custom_json is associated.
Request body
_custom_json
object
Required
Response
200
4XX
Returns a success response
SuccessResponse1
success
boolean
uid
integer
Examples
Parameters
company_id:
"value"
application_id:
"value"
category_uid:
"value"
body:
body
Was this section helpful?
PATCH
Loading...
Response
Loading...
Update sales channel category
updateAppCategory
Collection
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
GET
List collections
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. See example below or refer `GetCollectionListingResponse` for details
GetCollectionListingResponse
filters
object (CollectionListingFilter)
CollectionListingFilter
tags
array of object (CollectionListingFilterTag)
Array of CollectionListingFilterTag
display
string
is_selected
boolean
name
string
type
array of object (CollectionListingFilterType)
Array of CollectionListingFilterType
display
string
is_selected
boolean
name
string
items
array of object (GetCollectionDetailNest)
Array of GetCollectionDetailNest
_schedule
object
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
allow_sort
boolean
app_id
string
badge
object
banners
object (ImageUrls)
ImageUrls
landscape
object (BannerImage)
BannerImage
aspect_ratio
string
type
string
url
string
| url
portrait
object (BannerImage)
BannerImage
aspect_ratio
string
type
string
url
string
| url
cron
object
description
string
is_active
boolean
logo
object (Media)
Media
meta
object
type
string
url
string
meta
object
name
string
priority
integer
query
array of object (CollectionQuery)
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
tag
array of string
type
string
uid
string
visible_facets_keys
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
Examples
Parameters
company_id:
"value"
application_id:
"value"
q:
"value"
schedule_status:
"value"
type:
"value"
tags:
"lorem","ipsum"
is_active:
false
page_no:
1
page_size:
1
Was this section helpful?
GET
Loading...
Response
Loading...
List collections
getAllCollections
POST
Create a collection
Create a collection for a sales channel linked to a company.
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
_custom_json
object
Default Value : [object Object]
_locale_language
object
Default Value : [object Object]
_schedule
object (CollectionSchedule)
CollectionSchedule
cron
string
Nullable
duration
integer
Nullable
end
string
| date-time
Nullable
next_schedule
array of object (NextSchedule)
Array of NextSchedule
end
string
| date-time
Nullable
start
string
| date-time
start
string
| date-time
allow_facets
boolean
Default Value : true
allow_sort
boolean
Default Value : true
app_id
string
Required
badge
object (CollectionBadge)
CollectionBadge
color
string
text
string
banners
object (CollectionBanner)
Required
CollectionBanner
landscape
object (CollectionImage)
Required
CollectionImage
aspect_ratio
string
Required
url
string
Required
portrait
object (CollectionImage)
Required
CollectionImage
aspect_ratio
string
Required
url
string
Required
created_by
object (UserInfo)
Nullable
UserInfo
email
string
| email
uid
string
user_id
string
username
string
description
string
is_active
boolean
Default Value : true
is_visible
boolean
Default Value : true
logo
object (CollectionImage)
Required
CollectionImage
aspect_ratio
string
Required
url
string
Required
meta
object
Default Value : [object Object]
modified_by
object (UserInfo)
Nullable
UserInfo
email
string
| email
uid
string
user_id
string
username
string
name
string
Required
priority
integer
Default Value : 99999
published
boolean
Default Value : true
query
array of object (CollectionQuery)
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
title
string
sitemap
object
breadcrumbs
array of object (ApplicationItemSeoBreadcrumbs)
Array of ApplicationItemSeoBreadcrumbs
url
string
action
array of object (ApplicationItemSeoAction)
Array of ApplicationItemSeoAction
page
object
type
string
Required
meta_tags
array of object (Metatags)
Array of Metatags
title
string
items
array of object (ApplicationItemSeoMetaTagItem)
Array of ApplicationItemSeoMetaTagItem
key
string
Required
value
string
Required
canonical_url
string
slug
string
Required
sort_on
string
Default Value : popular
tags
array of string
type
string
Required
Enum
visible_facets_keys
array of string
Default Value :
Response
200
4XX
List of all the collections including the one you added. See example below or refer `CollectionCreateResponse` for details
CollectionCreateResponse
uid
string
_schedule
object
allow_facets
boolean
allow_sort
boolean
app_id
string
badge
object
banners
object (ImageUrls)
ImageUrls
landscape
object (BannerImage)
BannerImage
aspect_ratio
string
type
string
url
string
| url
portrait
object (BannerImage)
BannerImage
aspect_ratio
string
type
string
url
string
| url
cron
object
description
string
is_active
boolean
logo
object (BannerImage)
BannerImage
aspect_ratio
string
type
string
url
string
| url
meta
object
name
string
priority
integer
query
array of object (CollectionQuery)
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
sort_on
string
tag
array of string
type
string
visible_facets_keys
array of string
Examples
Parameters
company_id:
"value"
application_id:
"value"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create a collection
createCollection
DEL
Delete a collection
Delete a collection by it's id. Returns an object that tells whether the collection was deleted successfully
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.
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
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
Was this section helpful?
DEL
Loading...
Response
Loading...
Delete a collection
deleteCollection
PUT
Update a collection
Update a collection by it's id. On successful request, returns the updated collection
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.
id
string
Required
A `id` is a unique identifier of a collection.
Request body
_custom_json
object
_locale_language
object
_schedule
object (CollectionSchedule)
CollectionSchedule
cron
string
Nullable
duration
integer
Nullable
end
string
| date-time
Nullable
next_schedule
array of object (NextSchedule)
Array of NextSchedule
end
string
| date-time
Nullable
start
string
| date-time
start
string
| date-time
allow_facets
boolean
allow_sort
boolean
badge
object (CollectionBadge)
CollectionBadge
color
string
text
string
banners
object (CollectionBanner)
CollectionBanner
landscape
object (CollectionImage)
Required
CollectionImage
aspect_ratio
string
Required
url
string
Required
portrait
object (CollectionImage)
Required
CollectionImage
aspect_ratio
string
Required
url
string
Required
description
string
is_active
boolean
is_visible
boolean
logo
object (CollectionImage)
CollectionImage
aspect_ratio
string
Required
url
string
Required
meta
object
modified_by
object (UserInfo)
Nullable
User info.
UserInfo
email
string
| email
uid
string
user_id
string
username
string
name
string
priority
integer
published
boolean
query
array of object (CollectionQuery)
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
title
string
sitemap
object
breadcrumbs
array of object (ApplicationItemSeoBreadcrumbs)
Array of ApplicationItemSeoBreadcrumbs
url
string
action
array of object (ApplicationItemSeoAction)
Array of ApplicationItemSeoAction
page
object
type
string
Required
meta_tags
array of object (Metatags)
Array of Metatags
title
string
items
array of object (ApplicationItemSeoMetaTagItem)
Array of ApplicationItemSeoMetaTagItem
key
string
Required
value
string
Required
canonical_url
string
slug
string
sort_on
string
tags
array of string
type
string
visible_facets_keys
array of string
Response
200
4XX
The Collection object. See example below or refer `UpdateCollectionSchema` for details.
UpdateCollection
_custom_json
object
_locale_language
object
_schedule
object (CollectionSchedule)
CollectionSchedule
cron
string
Nullable
duration
integer
Nullable
end
string
| date-time
Nullable
next_schedule
array of object (NextSchedule)
Array of NextSchedule
end
string
| date-time
Nullable
start
string
| date-time
start
string
| date-time
allow_facets
boolean
allow_sort
boolean
badge
object (CollectionBadge)
CollectionBadge
color
string
text
string
banners
object (CollectionBanner)
CollectionBanner
landscape
object (CollectionImage)
CollectionImage
aspect_ratio
string
url
string
portrait
object (CollectionImage)
CollectionImage
aspect_ratio
string
url
string
description
string
is_active
boolean
is_visible
boolean
logo
object (CollectionImage)
CollectionImage
aspect_ratio
string
url
string
meta
object
modified_by
object (UserInfo)
Nullable
User info.
UserInfo
email
string
| email
uid
string
user_id
string
username
string
name
string
priority
integer
published
boolean
query
array of object (CollectionQuery)
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
title
string
sitemap
object
breadcrumbs
array of object (ApplicationItemSeoBreadcrumbs)
Array of ApplicationItemSeoBreadcrumbs
url
string
action
array of object (ApplicationItemSeoAction)
Array of ApplicationItemSeoAction
page
object
type
string
meta_tags
array of object (Metatags)
Array of Metatags
title
string
items
array of object (ApplicationItemSeoMetaTagItem)
Array of ApplicationItemSeoMetaTagItem
key
string
value
string
canonical_url
string
slug
string
sort_on
string
tags
array of string
type
string
visible_facets_keys
array of string
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Update a collection
updateCollection
GET
List items of collection
Get items from a collection specified by its id.
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.
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.
Response
200
4XX
The attached items of an collection. See example below or refer `GetCollectionItemsResponse` for details
GetCollectionItemsResponse
filters
array of object (ProductFilters)
Array of ProductFilters
key
object (ProductFiltersKey)
ProductFiltersKey
display
string
kind
string
logo
string
| url
name
string
operators
array of string
values
array of object (ProductFiltersValue)
Array of ProductFiltersValue
count
integer
currency_code
string
currency_symbol
string
display
string
display_format
string
is_selected
boolean
max
integer
min
integer
query_format
string
selected_max
integer
selected_min
integer
value
Undefined Type
items
array of object (ProductListingDetail)
Array of ProductListingDetail
attributes
object
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
type
string
url
string
name
string
uid
integer
color
string
description
string
discount
string
grouped_attributes
array of object (ProductDetailGroupedAttribute)
Array of ProductDetailGroupedAttribute
details
array of object (ProductDetailAttribute)
Array of ProductDetailAttribute
key
string
type
string
value
string
title
string
has_variant
boolean
highlights
array of string
image_nature
string
item_code
string
item_type
string
medias
array of object (Media)
Array of Media
meta
object
type
string
url
string
name
string
price
object (ProductListingPrice)
ProductListingPrice
effective
object (Price1)
Price1
currency_code
string
currency_symbol
string
max
number
min
number
marked
object (Price1)
Price1
currency_code
string
currency_symbol
string
max
number
min
number
product_online_date
string
| date-time
promo_meta
object
rating
number
rating_count
integer
sellable
boolean
short_description
string
similars
array of string
slug
string
teaser_tag
object
tryouts
array of string
type
string
uid
integer
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
name
string
value
string
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
sort_on:
"value"
page_id:
"value"
page_size:
1
Was this section helpful?
GET
Loading...
Response
Loading...
List items of collection
getCollectionItems
POST
Create items in a collection
Adds items to a collection specified by its id
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.
id
string
Required
A `id` is a unique identifier of a collection.
Request body
allow_facets
boolean
allow_sort
boolean
items
array of object (CollectionItemSchemaV2)
Array of CollectionItemSchemaV2
action
string
Required
Enum
item_id
integer
Required
priority
integer
query
array of object (CollectionQuerySchemaV2)
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
visible_facets_keys
array of string
Response
200
4XX
Status object. Tells whether the operation was successful.
CommonResponseSchemaCollection
message
string
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create items in a collection
addCollectionItems
GET
Get a collection
Get the details of a collection by its slug.
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.
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. See example below or refer `GetCollectionDetailResponse` for details
GetCollectionDetailResponse
_custom_json
object
_locale_language
object
_schedule
object (CollectionSchedule)
CollectionSchedule
cron
string
Nullable
duration
integer
Nullable
end
string
| date-time
Nullable
next_schedule
array of object (NextSchedule)
Array of NextSchedule
end
string
| date-time
Nullable
start
string
| date-time
start
string
| date-time
action
object
allow_facets
boolean
allow_sort
boolean
app_id
string
badge
object (CollectionBadge)
CollectionBadge
color
string
text
string
banners
object (ImageUrls)
ImageUrls
landscape
object (BannerImage)
BannerImage
aspect_ratio
string
type
string
url
string
| url
portrait
object (BannerImage)
BannerImage
aspect_ratio
string
type
string
url
string
| url
description
string
is_active
boolean
is_visible
boolean
logo
object (Media)
Media
meta
object
type
string
url
string
meta
object
name
string
priority
integer
published
boolean
query
array of object (CollectionQuery)
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
title
string
sitemap
object
breadcrumbs
array of object (ApplicationItemSeoBreadcrumbs)
Array of ApplicationItemSeoBreadcrumbs
url
string
action
array of object (ApplicationItemSeoAction)
Array of ApplicationItemSeoAction
page
object
type
string
meta_tags
array of object (Metatags)
Array of Metatags
title
string
items
array of object (ApplicationItemSeoMetaTagItem)
Array of ApplicationItemSeoMetaTagItem
key
string
value
string
canonical_url
string
slug
string
sort_on
string
tags
array of string
type
string
uid
string
visible_facets_keys
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
"value"
application_id:
"value"
slug:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get a collection
getCollectionDetail
Department
A department categorizes products into different sections or categories based on their type or purpose. Departments help organize products in a logical manner, making it easier for customers to navigate the product catalog. Each department typically has a unique identifier and a name. For example, a clothing ecommerce platform might have departments such as Men's Clothing, Women's Clothing, Accessories, 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
GET
List sales channel 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
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 department by name.
Response
200
4XX
List of Departments. See example below or refer `BrandListingResponse` for details
ApplicationDepartmentListingResponse
items
array of object (ApplicationDepartment)
Array of ApplicationDepartment
_custom_json
object
app_id
string
is_active
boolean
logo
string
name
string
uid
integer
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:
"value"
application_id:
"value"
page_no:
1
page_size:
1
q:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List sales channel departments
getApplicationDepartmentListing
PATCH
Update sales channel department
Modify department data associated to the sales channel.
Parameters
company_id
string
Required
Id of the company associated to department custom json.
application_id
string
Required
application id for which the custom_json is associated.
department_uid
string
Required
department id for which the custom_json is associated.