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 template brand
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
pageNo
integer
Optional
The page number to navigate through the given set of results
pageSize
integer
Optional
Number of items to retrieve in each page. Default is 12.
Default Value : 12
q
string
Optional
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)
Optional
Array of BrandItem
page
object (Page)
Page
Examples
Parameters
pageNo:
0
pageSize:
0
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
brandUid
string
brand id for which the custom_json is associated.
body
object (ApplicationBrandJson)
custom json object that needs to be added.
ApplicationBrandJson
_custom_json
object
Response
200
4XX
Returns a success response
SuccessResponse1
success
boolean
Optional
uid
integer
Optional
Examples
Parameters
brandUid:
"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
department
string
Optional
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
pageNo
integer
Optional
The page number to navigate through the given set of results
pageSize
integer
Optional
Number of items to retrieve in each page. Default is 12.
Default Value : 12
q
string
Optional
Search query with brand name.Use this parameter to search brands by brand name.
brandId
array of integer
Optional
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)
Optional
Array of BrandItem
page
object (Page)
Page
Examples
Parameters
department:
"value"
pageNo:
0
pageSize:
0
q:
"value"
brandId:
0,1
Was this section helpful?
GET
Loading...
Response
Loading...
List brands
getApplicationBrands
GET
List template brand
Retrieve values related to template brand types for a specific company. The filter type query parameter defines what type of data to return.
Parameters
filter
string
A `filter` is the unique identifier of the type of value required.
templateTag
string
Optional
A `template_tag` is the identifier of the type of template required.
itemType
string
Optional
A `item_type` is the identifier of the type of template required.
Response
200
4XX
See example below or refer `ProductConfigurationDownloadsSchema` for details
ProductConfigurationDownloads
data
array of object
Optional
multivalue
boolean
Optional
Examples
Parameters
filter:
"value"
templateTag:
"value"
itemType:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List template brand
listTemplateBrandTypeValues
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
POST
# Create categories
GET
# Get category by uid
PUT
# Update category
GET
List categories
Retrieve a list of categories associated to company and sales channel. user can filter on departments.
Parameters
department
string
Optional
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)
Optional
Array of DepartmentCategoryTree
departments
array of object (DepartmentIdentifier)
Optional
Array of DepartmentIdentifier
Examples
Parameters
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
departmentId
integer
Optional
A `department_id` is a unique identifier for a particular department.
pageNo
integer
Optional
The page number to navigate through the given set of results
pageSize
integer
Optional
Number of items to retrieve in each page. Default is 12.
Default Value : 12
q
string
Optional
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)
Optional
Array of BrandItem
page
object (Page)
Page
Examples
Parameters
departmentId:
0
pageNo:
0
pageSize:
0
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
categoryUid
string
category id for which the custom_json is associated.
body
object (ApplicationCategoryJson)
custom json object that needs to be added.
ApplicationCategoryJson
_custom_json
object
Response
200
4XX
Returns a success response
SuccessResponse1
success
boolean
Optional
uid
integer
Optional
Examples
Parameters
categoryUid:
"value"
body:
body
Was this section helpful?
PATCH
Loading...
Response
Loading...
Update sales channel category
updateAppCategory
GET
List categories
Retrieve a list of categories data associated to a specific company and queries passed in the request.
Parameters
level
string
Optional
Get category for multiple levels
department
integer
Optional
Get category for multiple departments filtered
q
string
Optional
Get multiple categories filtered by search string
pageNo
integer
Optional
The page number to navigate through the given set of results
pageSize
integer
Optional
Number of items to retrieve in each page. Default is 10.
Default Value : 12
uids
array of integer
Optional
Get multiple categories filtered by category uids.
Maximum Items : 100
slug
string
Optional
Get category by slug
Response
200
4XX
Category Meta. See example below or refer `CategoryResponse` for details
CategoryResponse
items
array of object (Category)
Optional
Array of Category
page
object (Page)
Optional
Page
Examples
Parameters
level:
"value"
department:
0
q:
"value"
pageNo:
0
pageSize:
0
uids:
0,1
slug:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List categories
listCategories
POST
Create categories
Allows to create product categories for specific company.
Parameters
body
object (CategoryRequestBody)
CategoryRequestBody
departments
array of integer
It is the list of unique department the category belongs to.
hierarchy
array of object (Hierarchy)
Optional
It is the list of category hierarchies for each department of an L3 category.
Array of Hierarchy
is_active
boolean
It is the flag indicating if the category is active.
level
integer
It is the level of category
marketplaces
object (CategoryMapping)
Optional
It is the mapping of the category in different marketplaces.
CategoryMapping
media
object (Media1)
Optional
It is the details of the media such as banner and logo..
Media1
name
string
It is the name of the category
priority
integer
Optional
It is the priority of the category.
slug
string
Optional
It is the slug of the category.
synonyms
array of string
Optional
It is the list of synonyms.
tryouts
array of string
Optional
It is the list of tryouts.
Response
200
4XX
Category Meta. See example below or refer `CategoryCreateResponse` for details
CategoryCreateResponse
message
string
Optional
It is the message of the response from the category.
uid
integer
Optional
It is the unique identifier of the category.
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create categories
createCategories
GET
Get category by uid
Retrieve detailed information about a specific category by its uid for a specific company.
Parameters
uid
string
Category unique id
Response
200
4XX
Get Data for one category. See example below or refer `CategoryResponse` for details
SingleCategoryResponse
data
object (Category)
Optional
Category
Examples
Parameters
uid:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get category by uid
getCategoryData
PUT
Update category
Modify data for an existing category by its uid for a specific company.
Parameters
uid
string
Category unique id
body
object (CategoryRequestBody)
CategoryRequestBody
departments
array of integer
It is the list of unique department the category belongs to.
hierarchy
array of object (Hierarchy)
Optional
It is the list of category hierarchies for each department of an L3 category.
Array of Hierarchy
is_active
boolean
It is the flag indicating if the category is active.
level
integer
It is the level of category
marketplaces
object (CategoryMapping)
Optional
It is the mapping of the category in different marketplaces.
CategoryMapping
media
object (Media1)
Optional
It is the details of the media such as banner and logo..
Media1
name
string
It is the name of the category
priority
integer
Optional
It is the priority of the category.
slug
string
Optional
It is the slug of the category.
synonyms
array of string
Optional
It is the list of synonyms.
tryouts
array of string
Optional
It is the list of tryouts.
Response
200
4XX
Category Meta. See example below or refer `CategoryUpdateResponse` for details
CategoryUpdateResponse
message
string
Optional
It is the message of the response from the category.
success
boolean
Optional
It is the flag indication the success response.
Examples
Parameters
uid:
"value"
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Update category
updateCategory
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
GET
# List filter keys
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
q
string
Optional
Get collection list filtered by q string,
scheduleStatus
string
Optional
Get collection list filtered by scheduled status,
Enum
type
string
Optional
type of the collections
tags
array of string
Optional
Each response will contain next_id param, which should be sent back to make pagination work.
isActive
boolean
Optional
get collections filtered by active status.
pageNo
integer
Optional
The page number to navigate through the given set of results.
pageSize
integer
Optional
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)
Optional
CollectionListingFilter
items
array of object (GetCollectionDetailNest)
Optional
Array of GetCollectionDetailNest
page
object (Page)
Optional
Page
Examples
Parameters
q:
"value"
scheduleStatus:
"value"
type:
"value"
tags:
"lorem","ipsum"
isActive:
false
pageNo:
0
pageSize:
0
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
body
object (CreateCollection)
A Collection object that needs to be added
CreateCollection
_custom_json
object
Optional
Default Value : [object Object]
_locale_language
object
Optional
Default Value : [object Object]
_schedule
object (CollectionSchedule)
Optional
CollectionSchedule
allow_facets
boolean
Optional
Default Value : true
allow_sort
boolean
Optional
Default Value : true
app_id
string
badge
object (CollectionBadge)
Optional
CollectionBadge
banners
object (CollectionBanner)
CollectionBanner
created_by
object (UserInfo)
Nullable
Optional
UserInfo
description
string
Optional
is_active
boolean
Optional
Default Value : true
is_visible
boolean
Optional
Default Value : true
logo
object (CollectionImage)
CollectionImage
meta
object
Optional
Default Value : [object Object]
modified_by
object (UserInfo)
Nullable
Optional
UserInfo
name
string
priority
integer
Optional
Default Value : 99999
published
boolean
Optional
Default Value : true
query
array of object (CollectionQuery)
Optional
Default Value :
Array of CollectionQuery
seo
object (SeoDetail)
Optional
SeoDetail
slug
string
sort_on
string
Optional
Default Value : popular
tags
array of string
Optional
type
string
Enum
visible_facets_keys
array of string
Optional
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
Optional
_schedule
object
Optional
allow_facets
boolean
Optional
allow_sort
boolean
Optional
app_id
string
Optional
badge
object
Optional
banners
object (ImageUrls)
Optional
ImageUrls
cron
object
Optional
description
string
Optional
is_active
boolean
Optional
logo
object (BannerImage)
Optional
BannerImage
meta
object
Optional
name
string
Optional
priority
integer
Optional
query
array of object (CollectionQuery)
Optional
Array of CollectionQuery
slug
string
Optional
sort_on
string
Optional
tag
array of string
Optional
type
string
Optional
visible_facets_keys
array of string
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create a collection
createCollection
GET
List filter keys
Retrieve the details of all applicable product filters, such as Color, Brand, and Category, indicating the criteria keys where filters can be applied.
Parameters
c
string
Optional
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**
Response
200
4XX
The attached items of an collection. See example below or refer `GetQueryFiltersKeysResponse` for details
GetQueryFiltersKeysResponse
filters
array of object (ProductFiltersKeysOnly)
Optional
Array of ProductFiltersKeysOnly
operators
object
sort_on
array of object (ProductSortOn)
Optional
Array of ProductSortOn
Examples
Parameters
c:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List filter keys
getApplicationFilterKeys
DEL
Delete a collection
Delete a collection by it's id. Returns an object that tells whether the collection was deleted successfully
Parameters
id
string
A `id` is a unique identifier of a collection.
Response
200
4XX
Status object. Tells whether the operation was successful.
CommonResponseSchemaCollection
message
string
Optional
Examples
Parameters
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
id
string
A `id` is a unique identifier of a collection.
body
object (UpdateCollection)
UpdateCollection
_custom_json
object
Optional
_locale_language
object
Optional
_schedule
object (CollectionSchedule)
Optional
CollectionSchedule
allow_facets
boolean
Optional
allow_sort
boolean
Optional
badge
object (CollectionBadge)
Optional
CollectionBadge
banners
object (CollectionBanner)
Optional
CollectionBanner
description
string
Optional
is_active
boolean
Optional
is_visible
boolean
Optional
logo
object (CollectionImage)
Optional
CollectionImage
meta
object
Optional
modified_by
object (UserInfo)
Nullable
Optional
User info.
UserInfo
name
string
Optional
priority
integer
Optional
published
boolean
Optional
query
array of object (CollectionQuery)
Optional
Array of CollectionQuery
seo
object (SeoDetail)
Optional
SeoDetail
slug
string
Optional
sort_on
string
Optional
tags
array of string
Optional
type
string
Optional
visible_facets_keys
array of string
Optional
Response
200
4XX
The Collection object. See example below or refer `UpdateCollectionSchema` for details.
UpdateCollection
_custom_json
object
Optional
_locale_language
object
Optional
_schedule
object (CollectionSchedule)
Optional
CollectionSchedule
allow_facets
boolean
Optional
allow_sort
boolean
Optional
badge
object (CollectionBadge)
Optional
CollectionBadge
banners
object (CollectionBanner)
Optional
CollectionBanner
description
string
Optional
is_active
boolean
Optional
is_visible
boolean
Optional
logo
object (CollectionImage)
Optional
CollectionImage
meta
object
Optional
modified_by
object (UserInfo)
Nullable
Optional
User info.
UserInfo
name
string
Optional
priority
integer
Optional
published
boolean
Optional
query
array of object (CollectionQuery)
Optional
Array of CollectionQuery
seo
object (SeoDetail)
Optional
SeoDetail
slug
string
Optional
sort_on
string
Optional
tags
array of string
Optional
type
string
Optional
visible_facets_keys
array of string
Optional
Examples
Parameters
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
id
string
A `id` is a unique identifier of a collection.
sortOn
string
Optional
Each response will contain sort_on param, which should be sent back to make pagination work.
pageId
string
Optional
Each response will contain next_id param, which should be sent back to make pagination work.
pageSize
integer
Optional
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)
Optional
Array of ProductFilters
items
array of object (ProductListingDetail)
Optional
Array of ProductListingDetail
page
object (Page)
Optional
Page
sort_on
array of object (ProductSortOn)
Optional
Array of ProductSortOn
Examples
Parameters
id:
"value"
sortOn:
"value"
pageId:
"value"
pageSize:
0
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
id
string
A `id` is a unique identifier of a collection.
body
object (CollectionItemUpdateSchema)
The attributes needed to add items to an collection. See details below
CollectionItemUpdateSchema
allow_facets
boolean
Optional
allow_sort
boolean
Optional
items
array of object (CollectionItemSchemaV2)
Optional
Array of CollectionItemSchemaV2
query
array of object (CollectionQuerySchemaV2)
Optional
Array of CollectionQuerySchemaV2
type
string
visible_facets_keys
array of string
Optional
Response
200
4XX
Status object. Tells whether the operation was successful.
CommonResponseSchemaCollection
message
string
Optional
Examples
Parameters
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
slug
string
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
Optional
_locale_language
object
Optional
_schedule
object (CollectionSchedule)
Optional
CollectionSchedule
action
object
Optional
allow_facets
boolean
Optional
allow_sort
boolean
Optional
app_id
string
Optional
badge
object (CollectionBadge)
Optional
CollectionBadge
banners
object (ImageUrls)
Optional
ImageUrls
description
string
Optional
is_active
boolean
Optional
is_visible
boolean
Optional
logo
object (Media)
Optional
Media
meta
object
Optional
name
string
Optional
priority
integer
Optional
published
boolean
Optional
query
array of object (CollectionQuery)
Optional
Array of CollectionQuery
seo
object (SeoDetail)
Optional
SeoDetail
slug
string
Optional
sort_on
string
Optional
tags
array of string
Optional
type
string
Optional
uid
string
Optional
visible_facets_keys
array of string
Optional
additionalProperties
Optional
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
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 company department
POST
# Create departments
GET
# Get department by uid
PUT
# Update department
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
pageNo
integer
Optional
The page number to navigate through the given set of results
pageSize
integer
Optional
Number of items to retrieve in each page. Default is 12.
Default Value : 12
q
string
Optional
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)
Optional
Array of ApplicationDepartment
page
object (Page)
Page
Examples
Parameters
pageNo:
0
pageSize:
0
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
departmentUid
string
department id for which the custom_json is associated.
body
object (ApplicationDepartmentJson)
custom json object that needs to be added.
ApplicationDepartmentJson
_custom_json
object
Response
200
4XX
Returns a success response
SuccessResponse1
success
boolean
Optional
uid
integer
Optional
Examples
Parameters
departmentUid:
"value"
body:
body
Was this section helpful?
PATCH
Loading...
Response
Loading...
Update sales channel department
updateAppDepartment
GET
List departments
Retrieve a list of departments associated with a comapny and sales channel.
Parameters
No Parameters
Response
200
4XX
List of Departments. See example below or refer `DepartmentResponse` for details.
DepartmentResponse
items
array of object (Department)
Optional
Array of Department
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
List departments
getDepartments
GET
List company department
Allows you to list all departments data for a specific company.
Parameters
pageNo
integer
Optional
The page number to navigate through the given set of results
itemType
string
Optional
A `item_type` is a type of product eg. set, standard, digital
pageSize
integer
Optional
Number of items to retrieve in each page. Default is 10.
name
string
Optional
Can search departments by passing name.
search
string
Optional
Can search departments by passing name of the department in search parameter.
isActive
boolean
Optional
Can query for departments based on whether they are active or inactive.
slug
string
Optional
Can filter by slug
Response
200
4XX
List of departments data. See example below or refer `DepartmentsResponse` for details
DepartmentsResponse
items
array of object (GetDepartment)
Optional
Array of GetDepartment
page
object (Page)
Optional
Page
Examples
Parameters
pageNo:
0
itemType:
"value"
pageSize:
0
name:
"value"
search:
"value"
isActive:
false
slug:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List company department
listDepartmentsData
POST
Create departments
Create departments for a specific company.
Parameters
body
object (DepartmentCreateUpdate)
the data of the departments that needs to be added
DepartmentCreateUpdate
_cls
string
Optional
_custom_json
object
Optional
is_active
boolean
Optional
logo
string
name
string
platforms
object
Optional
priority_order
integer
slug
string
Optional
synonyms
array of string
Optional
tags
array of string
Optional
uid
integer
Optional
Response
200
4XX
Success Response. See example below or refer `DepartmentCreateResponseSchema` for details
DepartmentCreateResponse
message
string
uid
integer
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create departments
createDepartments
GET
Get department by uid
Retrieve detailed information about a specific department for a specific company by uid.
Parameters
uid
string
A `uid` is a unique identifier of a department.
Response
200
4XX
Departments Data. See example below or refer `DepartmentsResponse` for details
DepartmentsResponse
items
array of object (GetDepartment)
Optional
Array of GetDepartment
page
object (Page)
Optional
Page
Examples
Parameters
uid:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get department by uid
getDepartmentData
PUT
Update department
Modify the department data by their uid for a specifc company.
Parameters
uid
string
A `uid` is a unique identifier of a department.
body
object (DepartmentCreateUpdate)
Data of the department that needs to be added
DepartmentCreateUpdate
_cls
string
Optional
_custom_json
object
Optional
is_active
boolean
Optional
logo
string
name
string
platforms
object
Optional
priority_order
integer
slug
string
Optional
synonyms
array of string
Optional
tags
array of string
Optional
uid
integer
Optional
Response
200
4XX
Success Response. See example below or refer `DepartmentCreateResponseSchema` for details
DepartmentModel
_cls
string
Optional
_custom_json
object
Optional
_id
string
Optional
created_by
object (UserDetail)
Optional
User details of the creator of the document
UserDetail
created_on
string
| date-time
Timestamp of the creation of the document
is_active
boolean
Optional
Whether the department is currently active
logo
string
The URL of the department's logo
modified_by
object (UserDetail)
Optional
User details of the last modifier of the document
UserDetail
modified_on
string
| date-time
Timestamp of the last modification of the document
name
string
The name of the department
priority_order
integer
The priority order of the department
slug
string
The unique slug identifier for the department
synonyms
array of string
Optional
A list of synonyms for the department name
uid
integer
The unique ID for the department
verified_by
object (UserDetail)
Optional
User details of the verifier of the document, if applicable
UserDetail
verified_on
string
| date-time
Optional
Timestamp of when the document was verified, if applicable
Examples
Parameters
uid:
"value"
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Update department
updateDepartment
HSN Code
The HSN code focuses on managing Harmonized System of Nomenclature (HSN) codes, which are internationally recognized codes used for classifying goods in trade and commerce. Each HSN code corresponds to a specific product or category, facilitating uniformity and accuracy in customs declarations, taxation, and regulatory compliance. The HSN code resource is used to retrieve a list of available HSN codes.
Operations
GET
# List HSN codes
GET
List HSN codes
Retrieve a list of Harmonized System Nomenclature (HSN) codes for a company.
Parameters
No Parameters
Response
200
4XX
List of all HSN Codes. See example below or refer `HSNCodesResponse` for details
HSNCodesResponse
data
object (HSNData)
Optional
HSNData
message
string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
List HSN codes
listHSNCodes
Insights and Metrics
The Insights and Metrics offers valuable data insights and metrics concerning your catalog information, specifically focusing on products, brands, departments, and categories that have been activated according to your application's settings. This resource enables you to access metrics such as the count of live catalog data for products and sellers, providing essential key performance indicators (KPIs) to monitor and evaluate your catalog's performance and effectiveness.
Operations
GET
# Get catalog counts
GET
# Get seller catalog counts
GET
Get catalog counts
Retrieve the count of catalog related data like products, brands, departments and categories that have been made live as per configuration of the sales channel.
Parameters
brand
string
Optional
Brand slug
Response
200
4XX
Response Data
CatalogInsightResponse
brand_distribution
object (CatalogInsightBrand)
Optional
CatalogInsightBrand
item
object (CatalogInsightItem)
Optional
CatalogInsightItem
Examples
Parameters
brand:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get catalog counts
getCatalogInsights
GET
Get seller catalog counts
Retrieve the count of catalog related data for sellers.
Parameters
sellerAppId
string
Id of the seller application which is serving the invetory/catalog of the company
Response
200
4XX
Response Data
CrossSellingResponse
brand_distribution
object (CatalogInsightBrand)
Optional
CatalogInsightBrand
data
object (CrossSellingData)
Optional
CrossSellingData
Examples
Parameters
sellerAppId:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get seller catalog counts
getSellerInsights
Marketplaces
A Marketplace is a sales platform where products from various sales channel and companies are listed, offering customers a wide range of options. These platforms serve as intermediaries, facilitating transactions between sellers and buyers. The marketplaces can be used by companies to manage their presence and configurations across different sales channels. This resource allows fetching opt-in information for a company, accessing details of associated brands and companies within marketplaces, creating and updating opt-in settings, retrieving information about all marketplaces available, and updating marketplace opt-ins using unique identifiers.Marketplace resource allows strategically participate in marketplaces, customize their product listings, and enhance visibility.
Operations
GET
# Get opt-in
GET
# list Company Brand of Optin
GET
# Get Company
POST
# Create or Update opt-in infomation
GET
# List marketplaces
PUT
# Update marketplace optin
GET
Get opt-in
Allows to fetch opt-in information for a company.
Parameters
No Parameters
Response
200
4XX
See example below or refer `GetOptInPlatformSchema` for details.
GetOptInPlatform
items
array of object (CompanyOptIn)
Array of CompanyOptIn
page
object (Page)
Page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
Get opt-in
getMarketplaceOptinDetail
GET
list Company Brand of Optin
Get the details of the Brands associated with the given company_id passed which has opt-in.
Parameters
isActive
boolean
Optional
The is_active status for the optin id.
q
string
Optional
The search value to filter the list.
pageNo
integer
Optional
The number of page for the company id.
pageSize
integer
Optional
Number of records that can be seen on the page for the company id.
marketplace
string
Optional
The marketplace platform associated with the company id.
Response
200
4XX
See example below or refer `OptinCompanyBrandDetailsView` for details
OptinCompanyBrandDetailsView
items
array of object (CompanyBrandDetail)
Optional
Array of CompanyBrandDetail
page
object (Page)
Optional
Page
Examples
Parameters
isActive:
false
q:
"value"
pageNo:
0
pageSize:
0
marketplace:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
list Company Brand of Optin
getCompanyBrandDetail
GET
Get Company
Get the details of the company associated with the given company_id passed which has opt-in.
Parameters
No Parameters
Response
200
4XX
See example below or refer `OptinCompanyDetailSchema` for details
OptinCompanyDetail
business_type
string
Optional
company_type
string
Optional
name
string
Optional
uid
integer
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
Get Company
getCompanyDetail
POST
Create or Update opt-in infomation
Allows to create and update opt-in information for a specific company.
Parameters
marketplace
string
The marketplace for which the detail needs to be retrieved.
body
object (OptInPostRequest)
Metadata for Optin
OptInPostRequest
brand_ids
array of integer
Optional
company_id
integer
Optional
enabled
boolean
Optional
Default Value : true
opt_level
string
platform
string
Optional
store_ids
array of integer
Optional
Response
200
4XX
See example below or refer `UpdatedResponse` for details.
UpdatedResponse
items_not_updated
array of integer
Optional
message
string
Optional
Examples
Parameters
marketplace:
"value"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create or Update opt-in infomation
createMarketplaceOptin
GET
List marketplaces
Allows to get all marketplaces information for a company.
Parameters
No Parameters
Response
200
4XX
List all Marketplace details.
GetAllMarketplaces
items
array of object (Marketplaces)
Optional
Array of Marketplaces
page
object (Page)
Optional
Page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
List marketplaces
getMarketplaces
PUT
Update marketplace optin
Allows to update marketplace optin for a company by marketplace_slug.
Parameters
marketplaceSlug
string
Slug of the marketplace .
body
object (UpdateMarketplaceOptinRequest)
Marketplace object that needs to be created.
UpdateMarketplaceOptinRequest
brand_ids
array of integer
Optional
company_id
integer
Optional
enabled
boolean
Optional
opt_level
string
Optional
platform
string
Optional
store_ids
array of integer
Optional
Response
200
4XX
Update marketplace optin config.
UpdateMarketplaceOptinResponse
brand_ids
array of integer
Optional
company_id
integer
Optional
app_id
string
Optional
enabled
boolean
Optional
opt_level
string
Optional
platform
string
Optional
store_ids
array of integer
Optional
created_by
object (CreatedBy)
Optional
CreatedBy
modified_by
object (CreatedBy)
Optional
CreatedBy
Examples
Parameters
marketplaceSlug:
"value"
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Update marketplace optin
updateMarketplaceOptin
Product
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 product filters
GET
# List sales channel inventory
GET
# Get discounted inventory
GET
# Get product details
POST
# Create Bulk update HSN
GET
# List HSN code
PUT
# Update HSN code
GET
# List Inventory
GET
# List bulk inventory upload history
POST
# Create bulk inventory upload job
DEL
# Delete inventory bulk upload job
POST
# Create bulk inventory
GET
# list product inventory
POST
# Create inventory export job
GET
# Get export inventory configuration
GET
# Get product assets
POST
# Create product assets in bulk
GET
# List product bulk upload history
POST
# Create products bulk upload
DEL
# Delete product bulk-upload job
POST
# Create products in bulk
GET
# List product tags
GET
# Get valid products
GET
# List inventory by size
GET
# List product size
DEL
# Delete product size
GET
# List inventory by size
POST
# Create Inventory
GET
# Get variants
GET
# List product HSN codes
GET
# Get product HSN code
POST
# Update inventories
GET
# List inventory export jobs
POST
# Create inventory export
GET
# List products
POST
# Create product
POST
# Upload bulk products
GET
# Get product export jobs
POST
# Create product export job
DEL
# Delete product
GET
# Get a product
PUT
# Update a product
GET
# Get product sizes
DEL
# Delete an inventory
POST
# Update an inventory
GET
List product filters
This API is designed to retrieve the filter values for all available options within the selected filter, such as "red" for color.
Parameters
filterKey
string
A `filter_key` is a filter key for a for which all the available filter values will returned. channel.
c
string
Optional
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**
collectionId
string
Optional
A `collection_id` is a unique identifier for a particular collection. channel.
pageNo
integer
Optional
The page number to navigate through the given set of results
pageSize
integer
Optional
Number of items to retrieve in each page. Default is 10.
Default Value : 10
q
string
Optional
Get Values filtered by q string
Response
200
4XX
The attached items of an collection. See example below or refer `GetQueryFiltersValuesResponse` for details
GetQueryFiltersValuesResponse
values
array of object (ProductFiltersValue)
Array of ProductFiltersValue
page
object (Page)
Page
Examples
Parameters
filterKey:
"value"
c:
"value"
collectionId:
"value"
pageNo:
0
pageSize:
0
q:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List product filters
getApplicationFilterValues
GET
List sales channel inventory
Retrieve inventory data related to the sales channel. this can be used to get the Inventory status of products with the filters of timestamp, store_ids, brand_ids, item_id, Items, Pagination.
Parameters
itemIds
array of integer
Optional
The Item Id of the product.
storeIds
array of integer
Optional
The Store Id of products to fetch inventory.
brandIds
array of integer
Optional
The Brand Id of products to fetch inventory.
sellerIdentifiers
array of string
Optional
Unique seller_identifier of the product.
timestamp
string
Optional
Timestamp in UTC format (2020-07-23T10:27:50Z)
pageSize
integer
Optional
The number of items to retrieve in each page.
Default Value : 12
pageId
string
Optional
Page ID to retrieve next set of results.
Response
200
4XX
Success. Returns the article/stock of the product stock.
InventoryStockResponse
items
array of object
Optional
Default Value :
page
object (InventoryPage)
InventoryPage
Examples
Parameters
itemIds:
0,1
storeIds:
0,1
brandIds:
0,1
sellerIdentifiers:
"lorem","ipsum"
timestamp:
"value"
pageSize:
0
pageId:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List sales channel inventory
getAppInventory
GET
Get discounted inventory
Allows to retrieve Inventory data for particular company grouped by size and store.
Parameters
itemId
integer
Item code of the product of which size is to be get.
sizeIdentifier
string
Size Identifier (Seller Identifier or Primary Identifier) of which inventory is to get.
pageNo
integer
Optional
The page number to navigate through the given set of results
pageSize
integer
Optional
Number of items to retrieve in each page. Default is 12.
Default Value : 12
q
string
Optional
Search with help of store code.
locationIds
array of integer
Optional
Search by store ids.
Response
200
4XX
returns a list of all inventory grouped by size and store
InventorySellerIdentifierResponsePaginated
items
array of object (InventorySellerResponse)
Optional
Array of InventorySellerResponse
page
object (Page)
Optional
Page
Examples
Parameters
itemId:
0
sizeIdentifier:
"value"
pageNo:
0
pageSize:
0
q:
"value"
locationIds:
0,1
Was this section helpful?
GET
Loading...
Response
Loading...
Get discounted inventory
getDiscountedInventoryBySizeIdentifier
GET
Get product details
Retrieve detailed product information using a product slug.
Parameters
slug
string
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. See example below or refer `ProductDetail` for details.
ProductDetail
attributes
object
Optional
brand
object (ProductBrand)
Optional
ProductBrand
color
string
Optional
description
string
Optional
grouped_attributes
array of object (ProductDetailGroupedAttribute)
Optional
Array of ProductDetailGroupedAttribute
has_variant
boolean
Optional
highlights
array of string
Optional
image_nature
string
Optional
item_code
string
Optional
item_type
string
Optional
medias
array of object (Media)
Optional
Array of Media
name
string
Optional
product_online_date
string
| date-time
Optional
promo_meta
object
Optional
rating
number
Optional
rating_count
integer
Optional
short_description
string
Optional
similars
array of string
Optional
slug
string
teaser_tag
object
Optional
tryouts
array of string
Optional
type
string
Optional
uid
integer
Optional
Examples
Parameters
slug:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get product details
getProductDetailBySlug
POST
Create Bulk update HSN
Execute bulk updates for HSN codes across multiple products.
Parameters
body
object (BulkHsnUpsert)
Bulk Create or Update Hsn Schema
BulkHsnUpsert
data
array of object (HsnUpsert)
Array of HsnUpsert
Response
200
4XX
See example below for details
BulkHsnResponse
success
boolean
Optional
Flag indicating the success status of the bulk HSN operation.
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create Bulk update HSN
bulkHsnCode
GET
List HSN code
Retrieve the HSN code for a product.
Parameters
id
string
Unique id
Response
200
4XX
See example below details
HsnCode
data
object (HsnCodesObject)
Optional
The HSN code data.
HsnCodesObject
Examples
Parameters
id:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List HSN code
getHsnCode
PUT
Update HSN code
Modify the HSN code associated with a product.
Parameters
id
string
Unique id
body
object (HsnUpsert)
Update Hsn Schema
HsnUpsert
company_id
integer
The ID of the company.
hs2_code
string
Nullable
The HS2 code.
hsn_code
string
The HSN code.
is_active
boolean
Optional
Flag indicating whether the entry is active.
tax1
number
The first tax rate.
Enum
tax2
number
Optional
The second tax rate.
Default Value : 0
Enum
tax_on_esp
boolean
Optional
Flag indicating whether tax is applicable on ESP.
Default Value : false
tax_on_mrp
boolean
Flag indicating whether tax is applicable on MRP.
threshold1
number
| value <= 999999
The threshold for the first tax rate.
threshold2
number
| value <= 999999
Optional
The threshold for the second tax rate.
uid
integer
Optional
The unique identifier.
Response
200
4XX
See example below for details
HsnCode
data
object (HsnCodesObject)
Optional
The HSN code data.
HsnCodesObject
Examples
Parameters
id:
"value"
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Update HSN code
updateHsnCode
GET
List Inventory
Allows to get Inventories data for particular company.
Parameters
itemId
string
Optional
Item code of the product of which size is to be get.
size
string
Optional
Size of which inventory is to get.
pageNo
integer
Optional
The page number to navigate through the given set of results
pageSize
integer
Optional
Number of items to retrieve in each page. Default is 12.
Default Value : 12
q
string
Optional
Search with help of store code.
sellable
boolean
Optional
Filter on whether product is in stock or not.
Default Value : false
storeIds
array of integer
Optional
The Store Id of products to fetch inventory.
sizeIdentifier
string
Optional
Size Identifier (Seller Identifier or Primary Identifier) of which inventory is to get.
Response
200
4XX
returns a list of all inventory grouped by size and store
GetInventoriesResponse
items
array of object (GetInventories)
Optional
Array of GetInventories
page
object (Page)
Optional
Page
Examples
Parameters
itemId:
"value"
size:
"value"
pageNo:
0
pageSize:
0
q:
"value"
sellable:
false
storeIds:
0,1
sizeIdentifier:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List Inventory
getInventories
GET
List bulk inventory upload history
Helps to get bulk Inventory upload jobs status.
Parameters
pageNo
integer
Optional
The page number to navigate through the given set of results
pageSize
integer
Optional
Number of items to retrieve in each page. Default is 12.
Default Value : 12
Response
200
4XX
List of bulk Inventory upload jobs. See `BulkInventoryGetSchema` for details
BulkInventoryGet
items
array of object (BulkInventoryGetItems)
Optional
Array of BulkInventoryGetItems
page
object (Page)
Optional
Page
Examples
Parameters
pageNo:
0
pageSize:
0
Was this section helpful?
GET
Loading...
Response
Loading...
List bulk inventory upload history
getInventoryBulkUploadHistory
POST
Create bulk inventory upload job
Helps to create a bulk Inventory upload job.
Parameters
body
object (BulkJob)
Bulk Inventory data that needs to be uploaded
BulkJob
cancelled
integer
Optional
Default Value : 0
cancelled_records
array of object
Optional
Default Value :
company_id
integer
created_by
object (UserInfo1)
Optional
The user who created the item.
UserInfo1
created_on
string
| date-time
The date and time when the item was created.
custom_template_tag
string
Optional
failed
integer
Optional
Default Value : 0
failed_records
array of object
Optional
Default Value :
file_path
string
Optional
is_active
boolean
Optional
Whether the item is active or not.
Default Value : true
modified_by
object (UserInfo1)
Nullable
Optional
The user who last modified the item.
UserInfo1
modified_on
string
| date-time
Optional
The date and time when the item was last modified.
Default Value : 2023-08-16T12:07:13.817Z
stage
string
Optional
Default Value : pending
Enum
succeed
integer
Optional
Default Value : 0
template_tag
string
Optional
total
integer
Optional
Default Value : 0
tracking_url
string
| url
Optional
Response
200
4XX
Returns a success response
BulkResponse
batch_id
string
created_by
object (UserInfo1)
Optional
The user who created the item.
UserInfo1
created_on
string
| date-time
The date and time when the item was created.
is_active
boolean
Optional
Whether the item is active or not.
Default Value : true
modified_by
object (UserInfo1)
Nullable
Optional
The user who last modified the item.
UserInfo1
modified_on
string
| date-time
Optional
The date and time when the item was last modified.
Default Value : 2023-08-16T12:07:13.817Z
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create bulk inventory upload job
createBulkInventoryJob
DEL
Delete inventory bulk upload job
Allows to delete bulk Inventory job associated with company.
Parameters
batchId
string
Batch Id of the bulk delete job.
Response
200
4XX
Returns a success response
SuccessResponse
success
boolean
Optional
Examples
Parameters
batchId:
"value"
Was this section helpful?
DEL
Loading...
Response
Loading...
Delete inventory bulk upload job
deleteBulkInventoryJob
POST
Create bulk inventory
Helps to create products in bulk push to kafka for approval/creation.
Parameters
batchId
string
Batch Id of the bulk create job.
body
object (InventoryBulkRequest)
Bulk Inventory Upload data that needs to be uploaded
InventoryBulkRequest
batch_id
string
company_id
integer
sizes
array of object (InventoryJobPayload)
Array of InventoryJobPayload
user
object
Optional
Response
200
4XX
Returns a success response
SuccessResponse
success
boolean
Optional
Examples
Parameters
batchId:
"value"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create bulk inventory
createBulkInventory
GET
list product inventory
Retrieves inventory for all products for that particular company
Parameters
No Parameters
Response
200
4XX
Returns a list of inventory export jobs
InventoryExportJob
completed_on
string
| date-time
Optional
Completion datetime of the job.
filters
object (InventoryExportAdvanceOption)
Optional
The filters that needs to be exported.
InventoryExportAdvanceOption
notification_emails
array of string
Optional
The notification emails for the job.
seller_id
integer
The seller id that needs to be exported.
status
string
Optional
The status of the job.
Enum
task_id
string
The task id of the job.
type
string
The type of file that needs to be exported.
url
string
| url
Optional
URL odf the exported file.
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
list product inventory
getInventoryExport
POST
Create inventory export job
Helps to create a Inventory export job.
Parameters
body
object (InventoryExportRequest)
Inventory export job object.
InventoryExportRequest
brand
array of integer
Optional
store
array of integer
Optional
type
string
Nullable
Optional
Default Value : csv
Enum
Response
200
4XX
Returns a success response
InventoryExportResponse
created_by
string
| date-time
Optional
The user that created the job.
created_on
string
| date-time
Optional
Creation datetime of the job
filters
object
Optional
The filters that needs to be exported.
modified_on
string
| date-time
Optional
Modification date of the job
notification_emails
array of string
Optional
The notification emails for the job.
seller_id
integer
The seller id that needs to be exported.
status
string
Optional
The status of the job.
Enum
task_id
string
The task id of the job.
type
string
Optional
The type of file that needs to be exported.
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create inventory export job
createInventoryExportJob
GET
Get export inventory configuration
Retrieve List of different filters like brand, store, and type for inventory export.
Parameters
filterType
string
Optional
filter type from any one of ['brand', 'store', 'type']
Response
200
4XX
returns filters configuration for inventory export
InventoryConfig
data
array of object (FilerList)
Optional
Array of FilerList
multivalues
boolean
Optional
Examples
Parameters
filterType:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get export inventory configuration
exportInventoryConfig
GET
Get product assets
Helps to retrieve bulk asset jobs data associated to a particular company.
Parameters
pageNo
integer
Optional
The page number to navigate through the given set of results
pageSize
integer
Optional
Number of items to retrieve in each page. Default is 12.
Default Value : 12
Response
200
4XX
List of bulk asset jobs List. See `BulkUtil.modify_batch_response` for details
BulkAssetResponse
items
array of object (Items)
Optional
Array of Items
page
object (Page)
Optional
Page
Examples
Parameters
pageNo:
0
pageSize:
0
Was this section helpful?
GET
Loading...
Response
Loading...
Get product assets
getProductAssetsInBulk
POST
Create product assets in bulk
Helps to create a bulk asset upload job.
Parameters
body
object (ProductBulkAssets)
Product Bulk asset upload object.
ProductBulkAssets
batch_id
string
Optional
company_id
integer
Optional
url
string
| url
user
object
Response
200
4XX
Returns a success response
SuccessResponse
success
boolean
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create product assets in bulk
createProductAssetsInBulk
GET
List product bulk upload history
Helps to get bulk product upload jobs data.
Parameters
search
string
Optional
Search string to filter the results by batch id
pageNo
integer
Optional
The page number to navigate through the given set of results
pageSize
integer
Optional
Number of items to retrieve in each page. Default is 12.
Default Value : 12
Response
200
4XX
List of bulk product upload jobs. See `BulkRequestGetSchema` for details
ProductBulkRequestList
items
array of object (ProductBulkRequest)
Optional
Array of ProductBulkRequest
page
object (Page)
Optional
Page
Examples
Parameters
search:
"value"
pageNo:
0
pageSize:
0
Was this section helpful?
GET
Loading...
Response
Loading...
List product bulk upload history
getProductBulkUploadHistory
POST
Create products bulk upload
This API helps to create a bulk products upload job.
Parameters
body
object (BulkJob)
Bulk Product Upload data that needs to be uploaded
BulkJob
cancelled
integer
Optional
Default Value : 0
cancelled_records
array of object
Optional
Default Value :
company_id
integer
created_by
object (UserInfo1)
Optional
The user who created the item.
UserInfo1
created_on
string
| date-time
The date and time when the item was created.
custom_template_tag
string
Optional
failed
integer
Optional
Default Value : 0
failed_records
array of object
Optional
Default Value :
file_path
string
Optional
is_active
boolean
Optional
Whether the item is active or not.
Default Value : true
modified_by
object (UserInfo1)
Nullable
Optional
The user who last modified the item.
UserInfo1
modified_on
string
| date-time
Optional
The date and time when the item was last modified.
Default Value : 2023-08-16T12:07:13.817Z
stage
string
Optional
Default Value : pending
Enum
succeed
integer
Optional
Default Value : 0
template_tag
string
Optional
total
integer
Optional
Default Value : 0
tracking_url
string
| url
Optional
Response
200
4XX
Returns a success response
BulkResponse
batch_id
string
created_by
object (UserInfo1)
Optional
The user who created the item.
UserInfo1
created_on
string
| date-time
The date and time when the item was created.
is_active
boolean
Optional
Whether the item is active or not.
Default Value : true
modified_by
object (UserInfo1)
Nullable
Optional
The user who last modified the item.
UserInfo1
modified_on
string
| date-time
Optional
The date and time when the item was last modified.
Default Value : 2023-08-16T12:07:13.817Z
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create products bulk upload
createBulkProductUploadJob
DEL
Delete product bulk-upload job
Allows to delete bulk product job associated with company.
Parameters
batchId
integer
Batch Id of the bulk product job to be deleted.
Response
200
4XX
Returns a success response
SuccessResponse
success
boolean
Optional
Examples
Parameters
batchId:
0
Was this section helpful?
DEL
Loading...
Response
Loading...
Delete product bulk-upload job
deleteProductBulkJob
POST
Create products in bulk
Helps to create products in bulk push to kafka for approval/creation.
Parameters
batchId
string
Batch Id in which assets to be uploaded.
body
object (BulkProductRequest)
Bulk Product Upload data that needs to be uploaded
BulkProductRequest
batch_id
string
company_id
integer
data
array of object
template_tag
string
Response
200
4XX
Returns a success response
SuccessResponse
success
boolean
Optional
Examples
Parameters
batchId:
"value"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create products in bulk
createProductsInBulk
GET
List product tags
Retrieve tags data associated to a particular company.
Parameters
No Parameters
Response
200
4XX
Tag List. See example below for details
ProductTagsViewResponse
items
array of string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
List product tags
getProductTags
GET
Get valid products
Retrieve validation data for products at company level.
Parameters
No Parameters
Response
200
4XX
Validate Meta. See example below for details
ValidateProduct
valid
boolean
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
Get valid products
getProductValidation
GET
List inventory by size
Retrieve inventory data for a specific company, item ID, and seller identifier. The API supports search capabilities using store codes and location IDs.
Parameters
itemId
integer
Item code of the product of which size is to be get.
sizeIdentifier
string
Size Identifier (Seller Identifier or Primary Identifier) of which inventory is to get.
pageNo
integer
Optional
The page number to navigate through the given set of results
pageSize
integer
Optional
Number of items to retrieve in each page. Default is 12.
Default Value : 12
q
string
Optional
Search with help of store code.
locationIds
array of integer
Optional
Search by store ids.
Response
200
4XX
returns a list of all inventory grouped by size and store
InventorySellerIdentifierResponsePaginated
items
array of object (InventorySellerResponse)
Optional
Array of InventorySellerResponse
page
object (Page)
Optional
Page
Examples
Parameters
itemId:
0
sizeIdentifier:
"value"
pageNo:
0
pageSize:
0
q:
"value"
locationIds:
0,1
Was this section helpful?
GET
Loading...
Response
Loading...
List inventory by size
getInventoryBySizeIdentifier
GET
List product size
Retrieve data associated to a particular product size.
Parameters
itemCode
string
Optional
Item code of the product size.
itemId
integer
Item Id of the product size.
brandUid
integer
Optional
Brand Id of the product size.
uid
integer
Optional
Id of the product size.
Response
200
4XX
Product object. See example below for details
ProductListingResponse
items
array of object (Product)
Optional
Array of Product
page
object (Page)
Optional
Page
Examples
Parameters
itemCode:
"value"
itemId:
0
brandUid:
0
uid:
0
Was this section helpful?
GET
Loading...
Response
Loading...
List product size
getProductSize
DEL
Delete product size
Allows to delete size associated with product.
Parameters
itemId
integer
Item Id of the product associated with size to be deleted.
size
string
size to be deleted.
Response
200
4XX
Returns a success response
ProductSizeDeleteResponse
data
object (ProductSizeDeleteDataResponse)
Optional
ProductSizeDeleteDataResponse
success
boolean
Optional
Examples
Parameters
itemId:
0
size:
"value"
Was this section helpful?
DEL
Loading...
Response
Loading...
Delete product size
deleteSize
GET
List inventory by size
Retrieve inventory data for a specific company, item ID, and size. The API supports search capabilities based on selling location (store) code and product availability (in stock or not)."
Parameters
itemId
integer
Item code of the product of which size is to be get.
size
string
Size of which inventory is to get.
pageNo
integer
Optional
The page number to navigate through the given set of results
pageSize
integer
Optional
Number of items to retrieve in each page. Default is 12.
Default Value : 12
q
string
Optional
Search with help of store code.
sellable
boolean
Optional
Filter on whether product is in stock or not.
Default Value : false
Response
200
4XX
returns a list of all inventory grouped by size and store
InventoryResponsePaginated
items
array of object (InventoryResponse)
Optional
Array of InventoryResponse
page
object (Page)
Optional
Page
Examples
Parameters
itemId:
0
size:
"value"
pageNo:
0
pageSize:
0
q:
"value"
sellable:
false
Was this section helpful?
GET
Loading...
Response
Loading...
List inventory by size
getInventoryBySize
POST
Create Inventory
Allows add Inventory for particular size and selling location.
Parameters
itemId
integer
Item code of the product of which size is to be get.
size
string
Size in which inventory is to be added.
body
object (InventoryRequest)
Product object that needs to be created.
InventoryRequest
company_id
integer
item
object (ItemQuery)
ItemQuery
sizes
array of object (InvSize)
Array of InvSize
Response
200
4XX
Returns a success response
SuccessResponse
success
boolean
Optional
Examples
Parameters
itemId:
0
size:
"value"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create Inventory
addInventory
GET
Get variants
Retrieve variants of a specific product.
Parameters
itemId
integer
Get list of variants of item Id
variantType
string
Get multiple products filtered by variant type
pageNo
integer
Optional
The page number to navigate through the given set of results
pageSize
integer
Optional
Number of items to retrieve in each page. Default is 10.
Default Value : 10
Response
200
4XX
Product Meta. See example below for details
ProductVariantsResponse
page
object (Page)
Optional
Page
variants
array of object (ProductVariants)
Optional
Array of ProductVariants
Examples
Parameters
itemId:
0
variantType:
"value"
pageNo:
0
pageSize:
0
Was this section helpful?
GET
Loading...
Response
Loading...
Get variants
getVariantsOfProducts
GET
List product HSN codes
Retrieve all HSN codes associated with company products and provide search capabilities based on HSN code, reporting HSN, etc
Parameters
pageNo
integer
Optional
page no
Default Value : 1
pageSize
integer
Optional
page size
Default Value : 12
q
string
Optional
search using hsn code, description, reporting_hsn
type
string
Optional
search using type
Response
200
4XX
List of all HSN Codes. See example below or refer `HsnCodesListingResponseSchema` for details
HsnCodesListingResponseSchemaV2
items
array of object (HSNDataInsertV2)
Optional
Array of HSNDataInsertV2
page
object (PageResponse)
Optional
PageResponse
Examples
Parameters
pageNo:
0
pageSize:
0
q:
"value"
type:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List product HSN codes
getAllProductHsnCodes
GET
Get product HSN code
Retrieve HSN details associated with company ID and reporting HSN
Parameters
reportingHsn
string
reporting_hsn
Response
200
4XX
Get specific HSN details. See example below or refer `HsnCodesListingResponseSchema` for details
HSNDataInsertV2
country_code
string
Country code.
created_by
object
Optional
Details of the user who created the HSN data.
created_on
string
| date-time
Optional
Date and time when the HSN data was created.
description
string
Description of the HSN data.
hsn_code
string
HSN code.
Minimum Length : 4
Maximum Length : 11
hsn_code_id
string
Optional
Unique identifier of the HSN code.
modified_by
object
Optional
Details of the user who last modified the HSN data.
modified_on
string
| date-time
Optional
Date and time when the HSN data was last modified.
reporting_hsn
string
HSN code.
taxes
array of object (TaxSlab)
List of tax slabs.
Array of TaxSlab
type
string
Type of HSN data (goods or services).
Enum
Examples
Parameters
reportingHsn:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get product HSN code
getSingleProductHSNCode
POST
Update inventories
Allows to add Inventory for particular size and selling location. for associated companies
Parameters
body
object (InventoryRequestSchemaV2)
Product object that needs to be created.
InventoryRequestSchemaV2
company_id
integer
The ID of the company.
meta
object
Optional
Additional metadata for the inventory request.
Default Value : [object Object]
payload
array of object (InventoryPayload)
Optional
The list of inventory payloads.
Maximum Items : 50
Array of InventoryPayload
Response
200
400
Returns a success or partial success response
InventoryUpdateResponse
items
array of object (InventoryResponseItem)
Optional
Array of InventoryResponseItem
message
string
It is the success message of the inventory update.
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Update inventories
updateInventories
GET
List inventory export jobs
Retrieve the history of inventory export jobs associated with the company
Parameters
status
string
Optional
Status of the export job.
fromDate
string
Optional
Inventory export history filtered according to from_date.
toDate
string
Optional
Inventory export history filtered according to from_date.
q
string
Optional
Inventory export history filtered according to task ID.
Response
200
4XX
Returns a list of inventory export jobs
InventoryExportJobListResponse
items
object (InventoryJobDetailResponse)
This is the list/history of all the jobs.
InventoryJobDetailResponse
Examples
Parameters
status:
"value"
fromDate:
"value"
toDate:
"value"
q:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List inventory export jobs
listInventoryExport
POST
Create inventory export
creates export job for inventory data associated with a company
Parameters
body
object (InventoryCreateRequest)
Inventory export job object.
InventoryCreateRequest
data
array of string
Optional
The list of attributes that you want to extract in the export job.
Default Value :
filters
object (InventoryExportFilter)
This filters that are applied for the export of the inventory.
InventoryExportFilter
notification_emails
array of string
Optional
The list of the emails to be notified after the completion of the job.
type
string
Nullable
Optional
The type of file that needs to be exported.
Default Value : csv
Enum
Response
200
4XX
Returns a success response
InventoryExportResponse
created_by
string
| date-time
Optional
The user that created the job.
created_on
string
| date-time
Optional
Creation datetime of the job
filters
object
Optional
The filters that needs to be exported.
modified_on
string
| date-time
Optional
Modification date of the job
notification_emails
array of string
Optional
The notification emails for the job.
seller_id
integer
The seller id that needs to be exported.
status
string
Optional
The status of the job.
Enum
task_id
string
The task id of the job.
type
string
Optional
The type of file that needs to be exported.
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create inventory export
createInventoryExport
GET
List products
Retrieve a list of available products
Parameters
brandIds
array of integer
Optional
Get multiple products filtered by Brand Ids
categoryIds
array of integer
Optional
Get multiple products filtered by Category Ids
itemIds
array of integer
Optional
Get multiple products filtered by Item Ids
departmentIds
array of integer
Optional
Get multiple products filtered by Department Ids
itemCode
array of string
Optional
Get multiple products filtered by Item Code
q
string
Optional
Get multiple products filtered by q string
tags
array of string
Optional
Get multiple products filtered by tags
pageNo
integer
Optional
The page number to navigate through the given set of results
pageSize
integer
Optional
Number of items to retrieve in each page. Default is 10.
Default Value : 10
Response
200
4XX
Product Meta. See example below for details
ProductListingResponseV2
items
array of object (ProductSchemaV2)
Optional
Array of ProductSchemaV2
page
object (Page)
Optional
Page
Examples
Parameters
brandIds:
0,1
categoryIds:
0,1
itemIds:
0,1
departmentIds:
0,1
itemCode:
"lorem","ipsum"
q:
"value"
tags:
"lorem","ipsum"
pageNo:
0
pageSize:
0
Was this section helpful?
GET
Loading...
Response
Loading...
List products
getProducts
POST
Create product
Users can create a product using this API, associating it with the provided company ID
Parameters
body
object (ProductCreateUpdateSchemaV2)
Product object that needs to be created.
ProductCreateUpdateSchemaV2
_custom_json
object
Optional
action
string
Optional
Enum
attributes
object
Optional
brand_uid
integer
bulk_job_id
string
Optional
category_slug
string
change_request_id
string
Nullable
Optional
company_id
integer
country_of_origin
string
currency
string
custom_order
object (CustomOrder)
Optional
CustomOrder
departments
array of integer
description
string
Optional
highlights
array of string
Nullable
Optional
is_active
boolean
Optional
Default Value : true
is_dependent
boolean
Optional
Default Value : false
is_image_less_product
boolean
Optional
Default Value : false
is_set
boolean
Optional
Default Value : false
item_code
string
item_type
string
Enum
media
array of object (Media)
Nullable
Optional
Array of Media
multi_size
boolean
Optional
Default Value : true
name
string
net_quantity
object (NetQuantity)
Optional
NetQuantity
no_of_boxes
integer
| value >= 1
Optional
Default Value : 1
product_group_tag
array of string
Optional
product_publish
object (ProductPublish1)
Optional
ProductPublish1
requester
string
Optional
Default Value : user
Enum
return_config
object (ReturnConfig)
ReturnConfig
short_description
string
Optional
size_guide
string
Optional
sizes
array of object
slug
string
tags
array of string
Optional
tax_identifier
object (TaxIdentifier)
TaxIdentifier
teaser_tag
object (TeaserTag)
Optional
TeaserTag
template_tag
string
trader
array of object (Trader)
Array of Trader
uid
integer
Nullable
Optional
variant_group
object
Optional
variant_media
object
Optional
variants
object
Optional
Response
200
4XX
Returns a success response
SuccessResponse1
success
boolean
Optional
uid
integer
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create product
createProduct
POST
Upload bulk products
Users can create multiple products by providing the required information needed for product creation in a CSV or Excel file format.
Parameters
department
string
Department of the product to be uploaded.
productType
string
Product type of the product to be uploaded i.e. set, standard , digital.
body
object (BulkJob)
Bulk Product Upload data that needs to be uploaded
BulkJob
cancelled
integer
Optional
Default Value : 0
cancelled_records
array of object
Optional
Default Value :
company_id
integer
created_by
object (UserInfo1)
Optional
The user who created the item.
UserInfo1
created_on
string
| date-time
The date and time when the item was created.
custom_template_tag
string
Optional
failed
integer
Optional
Default Value : 0
failed_records
array of object
Optional
Default Value :
file_path
string
Optional
is_active
boolean
Optional
Whether the item is active or not.
Default Value : true
modified_by
object (UserInfo1)
Nullable
Optional
The user who last modified the item.
UserInfo1
modified_on
string
| date-time
Optional
The date and time when the item was last modified.
Default Value : 2023-08-16T12:07:13.817Z
stage
string
Optional
Default Value : pending
Enum
succeed
integer
Optional
Default Value : 0
template_tag
string
Optional
total
integer
Optional
Default Value : 0
tracking_url
string
| url
Optional
Response
200
4XX
Returns a success response
BulkResponse
batch_id
string
created_by
object (UserInfo1)
Optional
The user who created the item.
UserInfo1
created_on
string
| date-time
The date and time when the item was created.
is_active
boolean
Optional
Whether the item is active or not.
Default Value : true
modified_by
object (UserInfo1)
Nullable
Optional
The user who last modified the item.
UserInfo1
modified_on
string
| date-time
Optional
The date and time when the item was last modified.
Default Value : 2023-08-16T12:07:13.817Z
Examples
Parameters
department:
"value"
productType:
"value"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Upload bulk products
uploadBulkProducts
GET
Get product export jobs
Get product export jobs specific to a company based on queries like query param, date range and status. View details including trigger data, task id , etc.
Parameters
status
string
Optional
This is a parameter used to find all the jobs with the specified status.
fromDate
string
| date
Optional
This is a parameter used to find the job from the date specified to the current date.
toDate
string
| date
Optional
This is a parameter used to find the job from the from_date specified to the to_date.
q
string
Optional
It is a query parameter to search the export job with the task ID.
Response
200
4XX
List of Product Downloads Data. See example below or refer `ProductDownloadsResponse` for details
ProductDownloadsResponse
items
array of object (ProductTemplateExportResponse)
Optional
The items of the job.
Array of ProductTemplateExportResponse
Examples
Parameters
status:
"value"
fromDate:
"value"
toDate:
"value"
q:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get product export jobs
getProductExportJobs
POST
Create product export job
Allows to create a product export job for a company.
Parameters
body
object (ProductTemplateDownloadsExport)
Product export job object.
ProductTemplateDownloadsExport
filters
object (ProductTemplateExportFilterRequest)
Optional
This is the filters of the file for the export.
ProductTemplateExportFilterRequest
notification_emails
array of string
Optional
The list of the emails to be notified after the completion of the job.
type
string
Nullable
Optional
This is the type of the file for the export.
Response
200
4XX
Returns a success response
ProductDownloadsResponse
items
array of object (ProductTemplateExportResponse)
Optional
The items of the job.
Array of ProductTemplateExportResponse
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create product export job
createProductExportJob
DEL
Delete product
Users can delete a product using this by providing the itemid.
Parameters
itemId
integer
Id of the product to be updated.
Response
200
4XX
Returns a success response
SuccessResponse
success
boolean
Optional
Examples
Parameters
itemId:
0
Was this section helpful?
DEL
Loading...
Response
Loading...
Delete product
deleteProduct
GET
Get a product
Retrieve data associated to a particular product.
Parameters
itemId
integer
Item Id of the product.
brandUid
integer
Optional
Brand Id of the product.
itemCode
string
Optional
Item code of the product.
Response
200
4XX
Product object. See example below or refer `product.utils.format_product_response` for details
SingleProductResponse
data
object (ProductSchemaV2)
Optional
ProductSchemaV2
Examples
Parameters
itemId:
0
brandUid:
0
itemCode:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get a product
getProduct
PUT
Update a product
Modify the details and settings of an existing product in the catalog.
Parameters
itemId
integer
Id of the product to be updated.
body
object (ProductCreateUpdateSchemaV2)
Product object that needs to be updated.
ProductCreateUpdateSchemaV2
_custom_json
object
Optional
action
string
Optional
Enum
attributes
object
Optional
brand_uid
integer
bulk_job_id
string
Optional
category_slug
string
change_request_id
string
Nullable
Optional
company_id
integer
country_of_origin
string
currency
string
custom_order
object (CustomOrder)
Optional
CustomOrder
departments
array of integer
description
string
Optional
highlights
array of string
Nullable
Optional
is_active
boolean
Optional
Default Value : true
is_dependent
boolean
Optional
Default Value : false
is_image_less_product
boolean
Optional
Default Value : false
is_set
boolean
Optional
Default Value : false
item_code
string
item_type
string
Enum
media
array of object (Media)
Nullable
Optional
Array of Media
multi_size
boolean
Optional
Default Value : true
name
string
net_quantity
object (NetQuantity)
Optional
NetQuantity
no_of_boxes
integer
| value >= 1
Optional
Default Value : 1
product_group_tag
array of string
Optional
product_publish
object (ProductPublish1)
Optional
ProductPublish1
requester
string
Optional
Default Value : user
Enum
return_config
object (ReturnConfig)
ReturnConfig
short_description
string
Optional
size_guide
string
Optional
sizes
array of object
slug
string
tags
array of string
Optional
tax_identifier
object (TaxIdentifier)
TaxIdentifier
teaser_tag
object (TeaserTag)
Optional
TeaserTag
template_tag
string
trader
array of object (Trader)
Array of Trader
uid
integer
Nullable
Optional
variant_group
object
Optional
variant_media
object
Optional
variants
object
Optional
Response
200
4XX
Returns a success response
SuccessResponse
success
boolean
Optional
Examples
Parameters
itemId:
0
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Update a product
editProduct
GET
Get product sizes
Retrieve all available sizes for a product.
Parameters
itemId
integer
Id of the product to be updated.
Response
200
4XX
List Product Sizes. See example below or refer `AllSizes` for details
GetAllSizes
all_sizes
array of object (AllSizes)
Optional
Array of AllSizes
Examples
Parameters
itemId:
0
Was this section helpful?
GET
Loading...
Response
Loading...
Get product sizes
allSizes
DEL
Delete an inventory
You can use this API to delete inventory linked to a particular product size. When you make the API call, the inventory associated with that size will be removed as part of api process.
Parameters
itemId
integer
Item code of the product of which size is to be get.
sellerIdentifier
string
Size Identifier (Seller Identifier or Primary Identifier) of which inventory is to get.
body
object (InventoryRequestSchemaV2)
Product object that needs to be created.
InventoryRequestSchemaV2
company_id
integer
The ID of the company.
meta
object
Optional
Additional metadata for the inventory request.
Default Value : [object Object]
payload
array of object (InventoryPayload)
Optional
The list of inventory payloads.
Maximum Items : 50
Array of InventoryPayload
Response
200
400
Returns a success response
InventoryUpdateResponse
items
array of object (InventoryResponseItem)
Optional
Array of InventoryResponseItem
message
string
It is the success message of the inventory update.
Examples
Parameters
itemId:
0
sellerIdentifier:
"value"
body:
body
Was this section helpful?
DEL
Loading...
Response
Loading...
Delete an inventory
deleteRealtimeInventory
POST
Update an inventory
enables you to add inventory for a specific size and selling location (store). The inventory updates will be reflected instantly after the API call.
Parameters
itemId
integer
Item code of the product of which size is to be get.
sellerIdentifier
string
Size Identifier (Seller Identifier or Primary Identifier) of which inventory is to get.
body
object (InventoryRequestSchemaV2)
Product object that needs to be created.
InventoryRequestSchemaV2
company_id
integer
The ID of the company.
meta
object
Optional
Additional metadata for the inventory request.
Default Value : [object Object]
payload
array of object (InventoryPayload)
Optional
The list of inventory payloads.
Maximum Items : 50
Array of InventoryPayload
Response
200
400
Returns a success response
InventoryUpdateResponse
items
array of object (InventoryResponseItem)
Optional
Array of InventoryResponseItem
message
string
It is the success message of the inventory update.
Examples
Parameters
itemId:
0
sellerIdentifier:
"value"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Update an inventory
updateRealtimeInventory
Product Attribute
Product Attribute are attributes associated with products, providing a structured way to define and categorize product characteristics. These attributes can include details such as size, color, material, and any other relevant product features. Using this resource, users can create, retrieve, update, and delete product attributes, enabling them to maintain accurate and detailed product information. Attributes can be assigned to products to provide a comprehensive description, aiding in product categorization, searchability, and customization.
Operations
GET
# List product attributes
GET
# Get gender attribute by slug
GET
List product attributes
Retrieve attributes attached to products based on their L3 category.
Parameters
category
string
It is the name of the l3 cateogry
filter
boolean
Optional
If true, returns filtered values, else returns all the attributes
Response
200
4XX
Size guide object. See example below or refer `ProductAttributesResponseSchema` for details
ProductAttributesResponse
items
array of object (AttributeMasterSerializer)
Array of AttributeMasterSerializer
Examples
Parameters
category:
"value"
filter:
false
Was this section helpful?
GET
Loading...
Response
Loading...
List product attributes
getProductAttributes
GET
Get gender attribute by slug
Retrieve the gender attribute for catalog listings by attribute slug passed for a specific company.
Parameters
attributeSlug
string
slug of the attribute for which you want to view the genders
Response
200
4XX
Size guide object. See example below or refer `GenderDetailSchema` for details
GenderDetail
departments
array of string
Optional
description
string
Optional
details
object (AttributeMasterDetails)
Optional
AttributeMasterDetails
enabled_for_end_consumer
boolean
Optional
filters
object (AttributeMasterFilter)
Optional
AttributeMasterFilter
id
string
Optional
is_nested
boolean
Optional
logo
string
| url
Optional
meta
object (AttributeMasterMeta)
Optional
AttributeMasterMeta
name
string
Optional
schema
object (AttributeMaster)
Optional
AttributeMaster
slug
string
Optional
Examples
Parameters
attributeSlug:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get gender attribute by slug
getGenderAttribute
Product Bundle
The Product Bundle is dedicated to facilitating the creation, updating, and retrieval of various product bundles for a specific company within the system. A product bundle is a collection of multiple products or services offered together as a package deal, often at a discounted or special price. These bundles are designed to enhance customer value by combining complementary items or services into a single offering. Product Bundle provide comprehensive functionalities to manage product bundles efficiently. Product Bundle can access and retrieve a list of all product bundles associated with a company, allowing for easy navigation and management of bundled offerings. Additionally, users can retrieve detailed information about a single product bundle, including its contents and pricing details.
Operations
GET
# List product bundles
POST
# Create product bundle
GET
# Get product bundle
PUT
# Update product bundle
GET
List product bundles
Retrieve a list of product bundles available in the catalog associated to a specific company.
Parameters
q
string
Optional
A search string that is searched with product bundle name.
slug
array of string
Optional
slugs of bundles to be retrieved.
Response
200
4XX
List of bundle configured for a company. See example below or refer `GetProductBundleListingResponse` for details
GetProductBundleListingResponse
items
array of object (GetProductBundleCreateResponse)
Optional
Array of GetProductBundleCreateResponse
page
object (Page)
Optional
Page
Examples
Parameters
q:
"value"
slug:
"lorem","ipsum"
Was this section helpful?
GET
Loading...
Response
Loading...
List product bundles
getProductBundle
POST
Create product bundle
Create product bundle in the catalog associated to a specific company
Parameters
body
object (ProductBundleRequest)
A bundle object that needs to be added
ProductBundleRequest
choice
string
company_id
integer
Optional
created_by
object
Optional
created_on
string
| date-time
Optional
is_active
boolean
logo
string
Nullable
Optional
meta
object
Optional
modified_by
object
Optional
modified_on
string
| date-time
Optional
name
string
page_visibility
array of string
Optional
Enum
products
array of object (ProductBundleItem)
Array of ProductBundleItem
same_store_assignment
boolean
Optional
Default Value : true
slug
string
Response
200
4XX
Get bundle with id that is added. See example below or refer `GetProductBundleCreateResponse` for details
GetProductBundleCreateResponse
choice
string
company_id
integer
Optional
created_by
object
Optional
created_on
string
| date-time
Optional
id
string
Optional
is_active
boolean
logo
string
Nullable
Optional
meta
object
Optional
modified_by
object
Optional
modified_on
string
| date-time
Optional
name
string
page_visibility
array of string
Optional
Enum
products
array of object (ProductBundleItem)
Array of ProductBundleItem
same_store_assignment
boolean
Optional
Default Value : true
slug
string
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create product bundle
createProductBundle
GET
Get product bundle
Retrieve detailed information about a specific product bundle associated to a specific company.
Parameters
id
string
A `id` is a unique identifier for a particular detail. Pass the `id` of the keywords which you want to retrieve.
Response
200
4XX
The Collection object. See example below or refer `GetProductBundleResponse` for details
GetProductBundleResponse
choice
string
Optional
company_id
integer
Optional
is_active
boolean
Optional
logo
string
Optional
meta
object
Optional
name
string
Optional
page_visibility
array of string
Optional
products
array of object (GetProducts)
Optional
Array of GetProducts
same_store_assignment
boolean
Optional
slug
string
Optional
Examples
Parameters
id:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get product bundle
getProductBundleDetail
PUT
Update product bundle
Modify the details of an existing product bundle in the catalog associated to a specific company.
Parameters
id
string
A `id` is a unique identifier for a particular detail. Pass the `id` of the keywords which you want to delete.
body
object (ProductBundleUpdateRequest)
A bundle object that needs to be updated
ProductBundleUpdateRequest
choice
string
company_id
integer
Optional
is_active
boolean
logo
string
Nullable
Optional
meta
object
Optional
modified_by
object
Optional
modified_on
string
| date-time
Optional
name
string
page_visibility
array of string
Optional
Enum
products
array of object (ProductBundleItem)
Array of ProductBundleItem
same_store_assignment
boolean
Optional
Default Value : true
slug
string
Response
200
4XX
The Collection object. See example below or refer `GetProductBundleCreateResponse` for details.
GetProductBundleCreateResponse
choice
string
company_id
integer
Optional
created_by
object
Optional
created_on
string
| date-time
Optional
id
string
Optional
is_active
boolean
logo
string
Nullable
Optional
meta
object
Optional
modified_by
object
Optional
modified_on
string
| date-time
Optional
name
string
page_visibility
array of string
Optional
Enum
products
array of object (ProductBundleItem)
Array of ProductBundleItem
same_store_assignment
boolean
Optional
Default Value : true
slug
string
Examples
Parameters
id:
"value"
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Update product bundle
updateProductBundle
Product Template
The Product Template used for efficient product data organization through predefined templates . Product templates serve as structured blueprints, ensuring uniformity and accuracy in product listings.
Operations
GET
# Download inventory template data
GET
# Validate product template schema
GET
# List export product templates
GET
# List product templates
GET
# List product template categories
GET
# Download product template view
GET
# Validate product template
GET
Download inventory template data
Allows you to download inventory product template data for a specific company in formats like csv and excel.
Parameters
itemType
string
An `item_type` defines the type of item.
Response
200
4XX
CSV File of product template data.
Examples
Parameters
itemType:
"value"
Was this section helpful?
GET
Loading...
Response
Example response not available.
Download inventory template data
downloadInventoryTemplateView
GET
Validate product template schema
Allows you to list all product templates validation values for all the fields present in the database for a specific company.
Parameters
itemType
string
An `item_type` defines the type of item. The default value is standard.
Response
200
4XX
List of fields and validation values fro each. See example below or refer `InventoryValidationResponse` for details
InventoryValidationResponse
data
object
Optional
message
string
Optional
Examples
Parameters
itemType:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Validate product template schema
validateProductTemplateSchema
GET
List export product templates
Retrieve export details related to product templates for a specific company. Can view details including trigger data, task id , etc.
Parameters
No Parameters
Response
200
4XX
List of Product Downloads Data. See example below or refer `ProductDownloadsResponse` for details
ProductDownloadsResponse
items
array of object (ProductTemplateExportResponse)
Optional
The items of the job.
Array of ProductTemplateExportResponse
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
List export product templates
listProductTemplateExportDetails
GET
List product templates
Allows you to list all product templates for a specific company. also can filter by department.
Parameters
department
string
A `department` is the name of a particular department.
Response
200
4XX
List of product templates. See example below or refer `TemplatesResponse` for details
TemplatesResponse
items
object (ProductTemplate)
Optional
ProductTemplate
page
object (Page)
Optional
Page
Examples
Parameters
department:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List product templates
listProductTemplate
GET
List product template categories
Allows you to list all product template categories values for the departments specified for a specific company.
Parameters
departments
string
A `department` is name of a departments whose category needs to be listed. Can specify multiple departments.
itemType
string
An `item_type` is the type of item, it can be `set`, `standard`, `digital`, etc.
Response
200
4XX
List of all categories attached to departments specified. See example below or refer `ProdcutTemplateCategoriesResponse` for details
ProdcutTemplateCategoriesResponse
items
array of object (CategoriesResponse)
Optional
Array of CategoriesResponse
page
object (Page)
Optional
Page
Examples
Parameters
departments:
"value"
itemType:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List product template categories
listProductTemplateCategories
GET
Download product template view
Allows you to download product template data by its slug for a specific company.
Parameters
slug
string
A `slug` is a unique identifier for a particular template.
itemType
string
Optional
An `item_type` defines the type of item. The default value is standard.
type
string
Optional
Format type of the sample file. The default value is excel.
Response
200
4XX
CSV File of product template data. See example below or refer `TemplatesResponse` for details
Examples
Parameters
slug:
"value"
itemType:
"value"
type:
"value"
Was this section helpful?
GET
Loading...
Response
Example response not available.
Download product template view
downloadProductTemplateViews
GET
Validate product template
Allows you to list all product templates validation values by its slug for all the fields present in the database for a specific company.
Parameters
slug
string
A `slug` is a unique identifier for a particular template.
itemType
string
Optional
An `item_type` defines the type of item. The default value is standard.
bulk
boolean
Optional
This specification determines the schema type to be retrieved. When set to true, it will return the schema for bulk data; when set to false, it will provide the schema for a single product. The default value is false.
Response
200
4XX
List of fields and validation values fro each. See example below or refer `TemplatesValidationResponse` for details
TemplatesValidationResponse
data
object (TemplateValidationData)
Optional
TemplateValidationData
template_details
object (TemplateDetails)
Optional
TemplateDetails
Examples
Parameters
slug:
"value"
itemType:
"value"
bulk:
false
Was this section helpful?
GET
Loading...
Response
Loading...
Validate product template
validateProductTemplate
Sales Channel
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
PATCH
Update sales channel location
Modify location data related to the sales channel.
Parameters
storeUid
string
store id for which the custom_json is associated.
body
object (ApplicationStoreJson)
custom json object that needs to be added.
ApplicationStoreJson
_custom_json
object
Response
200
4XX
Returns a success response
SuccessResponse1
success
boolean
Optional
uid
integer
Optional
Examples
Parameters
storeUid:
"value"
body:
body
Was this section helpful?
PATCH
Loading...
Response
Loading...
Update sales channel location
updateAppLocation
Sales Channel Cataloging
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
GET
# Get product configurations
POST
# Create product listing configuration
GET
# Get catalog configuration meta data
GET
# Get configuration
POST
# Create configuration
GET
# get product-return configuration
POST
# Create product return configuration
PUT
# Update product return configuration
DEL
# Delete product return configuration
GET
# Get category return configuration
POST
# Create return configuration
PUT
# Update return Configuration
POST
# Update 'Allow Single' setting
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
GET
Get collection query filters
Retrieve query filters to configure a collection for a company and a sales channel.
Parameters
No Parameters
Response
200
4XX
The attached items of an collection. See example below or refer `GetQueryFiltersResponse` for details
GetQueryFiltersResponse
filters
array of object (ProductFilters)
Optional
Array of ProductFilters
operators
object
sort_on
array of object (ProductSortOn)
Optional
Array of ProductSortOn
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
Get collection query filters
getQueryFilters
GET
Get product configurations
Retrieve a detailed configurations for product catalog specific to a company and an sales channel.
Parameters
No Parameters
Response
200
4XX
Get application level configured catalog details. See example below or refer `GetAppCatalogConfigurationSchema` for details
GetAppCatalogConfiguration
data
object (AppCatalogConfiguration)
Optional
AppCatalogConfiguration
is_default
boolean
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
Get product configurations
getConfigurations
POST
Create product listing configuration
Add configuration for products & listing specific to a company and an sales channel.
Parameters
body
object (AppConfiguration)
The configuration for products & listings. See details below
AppConfiguration
app_id
string
config_id
string
Optional
config_type
string
created_by
object
Optional
created_on
string
| date-time
Optional
listing
object (ConfigurationListing)
Optional
ConfigurationListing
modified_by
object
Optional
modified_on
string
| date-time
Optional
product
object (ConfigurationProduct)
Optional
ConfigurationProduct
type
string
Optional
Response
200
4XX
success flag will tell whether the operation was successful.
GetAppCatalogConfiguration
data
object (AppCatalogConfiguration)
Optional
AppCatalogConfiguration
is_default
boolean
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create product listing configuration
createConfigurationProductListing
GET
Get catalog configuration meta data
Retrieve configuration meta data for the catalog specific to a company and an sales channel.
Parameters
No Parameters
Response
200
4XX
configuration details for catalog. See example below or refer `GetCatalogConfigurationMetaDataSchema` for details
GetCatalogConfigurationMetaData
listing
object (MetaDataListingResponse)
Optional
MetaDataListingResponse
product
object (GetCatalogConfigurationDetailsProduct)
Optional
GetCatalogConfigurationDetailsProduct
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
Get catalog configuration meta data
getCatalogConfiguration
GET
Get configuration
Retrieve configuration details based on a specific type in the catalog for a company and an sales channel.
Parameters
type
string
type can be brands, categories etc.
Response
200
4XX
Get application level configured catalog details. See example below or refer `GetAppCatalogEntityConfigurationSchema` for details
GetAppCatalogEntityConfiguration
data
object (EntityConfiguration)
Optional
EntityConfiguration
is_default
boolean
Optional
Examples
Parameters
type:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get configuration
getConfigurationByType
POST
Create configuration
Add configuration details based on a specific type in the catalog for a company and an sales channel.
Parameters
type
string
type can be brands, categories etc.
body
object (AppConfiguration)
The configuration for categories & brands. See details below
AppConfiguration
app_id
string
config_id
string
Optional
config_type
string
created_by
object
Optional
created_on
string
| date-time
Optional
listing
object (ConfigurationListing)
Optional
ConfigurationListing
modified_by
object
Optional
modified_on
string
| date-time
Optional
product
object (ConfigurationProduct)
Optional
ConfigurationProduct
type
string
Optional
Response
200
4XX
success flag will tell whether the operation was successful.
GetAppCatalogConfiguration
data
object (AppCatalogConfiguration)
Optional
AppCatalogConfiguration
is_default
boolean
Optional
Examples
Parameters
type:
"value"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create configuration
createConfigurationByType
GET
get product-return configuration
Get Product Return configuration set at an sales channel level
Parameters
No Parameters
Response
200
4XX
success message will tell whether the operation was successful.
AppReturnConfigResponse
app_id
string
Optional
Channel identifier
category_count
integer
Optional
Count of L3 category return config set for application
company_id
integer
Optional
Unique identifer of company
created_by
object
Optional
User details
modified_by
object
Optional
User details
modified_on
string
| date-time
Optional
Modification date
return_config_level
string
Optional
configuration level of return window category|product|no-return
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
get product-return configuration
getAppReturnConfiguration
POST
Create product return configuration
This allows you to configure all return-related settings, such as is_returnable and return window etc. for sales channel level
Parameters
body
object (CreateUpdateAppReturnConfig)
The configuration for listings. See details below
CreateUpdateAppReturnConfig
app_id
string
Channel identifier
company_id
integer
Unique identifer of company
return_config_level
string
Return configurtion Level category|product|no-return
Enum
Response
200
4XX
success message will tell whether the operation was successful.
SuccessResponse1
success
boolean
Optional
uid
integer
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create product return configuration
createAppReturnConfiguration
PUT
Update product return configuration
Update Return configuration level set for an sales channel.
Parameters
body
object (CreateUpdateAppReturnConfig)
The configuration for listings. See details below
CreateUpdateAppReturnConfig
app_id
string
Channel identifier
company_id
integer
Unique identifer of company
return_config_level
string
Return configurtion Level category|product|no-return
Enum
Response
200
4XX
success message will tell whether the operation was successful.
SuccessResponse1
success
boolean
Optional
uid
integer
Optional
Examples
Parameters
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Update product return configuration
updateAppReturnConfiguration
DEL
Delete product return configuration
Delete Category level sales channel Return Configuration setttings
Parameters
body
object (DeleteAppCategoryReturnConfig)
The configuration for listings. See details below
DeleteAppCategoryReturnConfig
app_id
string
Channel identifier
category_ids
array of integer
List of category_ids to be deleted.
Maximum Items : 50
company_id
integer
Unique identifer of company
Response
200
4XX
success message will tell whether the operation was successful.
SuccessResponse
success
boolean
Optional
Examples
Parameters
body:
body
Was this section helpful?
DEL
Loading...
Response
Loading...
Delete product return configuration
deleteAppCategoryReturnConfiguration
GET
Get category return configuration
Get all category level configuration level set for an sales channel.
Parameters
No Parameters
Response
200
4XX
success message will tell whether the operation was successful.
BaseAppCategoryReturnConfigResponse
data
array of object (AppCategoryReturnConfigResponse)
Optional
Array of AppCategoryReturnConfigResponse
page
object (PageResponse)
Optional
PageResponse
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
Get category return configuration
getAppCategoryReturnConfig
POST
Create return configuration
Create Category level sales channel Return Configuration setttings
Parameters
body
object (BaseAppCategoryReturnConfig)
The configuration for listings. See details below
BaseAppCategoryReturnConfig
app_id
string
Channel identifier
company_id
integer
Unique identifer of company
data
array of object (AppCategoryReturnConfig)
Category level return config details
Maximum Items : 50
Array of AppCategoryReturnConfig
Response
200
4XX
success message will tell whether the operation was successful.
SuccessResponse1
success
boolean
Optional
uid
integer
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create return configuration
createAppCategoryReturnConfiguration
PUT
Update return Configuration
Update Category level sales channel Return Configuration setttings
Parameters
body
object (BaseAppCategoryReturnConfig)
The configuration for listings. See details below
BaseAppCategoryReturnConfig
app_id
string
Channel identifier
company_id
integer
Unique identifer of company
data
array of object (AppCategoryReturnConfig)
Category level return config details
Maximum Items : 50
Array of AppCategoryReturnConfig
Response
200
4XX
success message will tell whether the operation was successful.
SuccessResponse
success
boolean
Optional
Examples
Parameters
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Update return Configuration
updateAppCategoryReturnConfiguration
POST
Update 'Allow Single' setting
Modify allow single flag for filters of the sales channel for a company and an sales channel.
Parameters
body
object (AllowSingleRequest)
The allow single flag. See details below
AllowSingleRequest
allow_single
boolean
Response
200
4XX
success message will tell whether the operation was successful.
ConfigSuccessResponse
message
string
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Update 'Allow Single' setting
updateAllowSingle
POST
Update default sorting
Modify the default sort key configuration for a company and an sales channel.
Parameters
body
object (DefaultKeyRequest)
The default sort key. See details below
DefaultKeyRequest
default_key
string
Response
200
4XX
success message will tell whether the operation was successful.
ConfigSuccessResponse
message
string
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Update default sorting
updateDefaultSort
GET
Get listing configurations
Retrieve product listing configurations based on specific config_type for a company and an sales channel.
Parameters
configType
string
A `config_type` is an identifier that defines a specific type of configuration.
Enum
pageNo
integer
Optional
The page number to navigate through the given set of results.
pageSize
integer
Optional
Number of items to retrieve in each page. Default is 12.
search
string
Optional
Get configuration list filtered by `search` string.
Response
200
4XX
configuration details for catalog. See example below or refer `GetConfigResponseSchema` for details
GetConfigResponse
data
array of object
page
object (PageResponseType)
PageResponseType
Examples
Parameters
configType:
"value"
pageNo:
0
pageSize:
0
search:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get listing configurations
getListingConfigurations
POST
Create listing configuration
Add configuration for product catalog listing specific to a company and an sales channel.
Parameters
configType
string
A `config_type` is a unique identifier for a particular listing configuration type.
Enum
body
object (AppConfigurationsSort)
The configuration for listings. See details below
AppConfigurationsSort
app_id
string
default_key
string
is_active
boolean
is_default
boolean
key
string
logo
string
| url
Optional
name
string
Optional
priority
integer
| value >= 1
Response
200
4XX
success flag will tell whether the operation was successful.
AppConfigurationsSort
app_id
string
default_key
string
is_active
boolean
is_default
boolean
key
string
logo
string
| url
Optional
name
string
Optional
priority
integer
| value >= 1
Examples
Parameters
configType:
"value"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create listing configuration
createListingConfiguration
GET
Get group configurations
Retrieve the details of product group configurations based on config types for a company and an sales channel.
Parameters
configType
string
A `config_type` is an identifier that defines a specific type of configuration.
Enum
pageNo
integer
Optional
The page number to navigate through the given set of results.
pageSize
integer
Optional
Number of items to retrieve in each page. Default is 12.
search
string
Optional
Get configuration list filtered by `search` string.
templateSlug
string
Optional
Get configuration list filtered by `template_slug` string. This is for the details and comparision groups.
Response
200
4XX
configuration details for catalog. See example below or refer `GetConfigResponseSchema` for details
GetConfigResponse
data
array of object
page
object (PageResponseType)
PageResponseType
Examples
Parameters
configType:
"value"
pageNo:
0
pageSize:
0
search:
"value"
templateSlug:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get group configurations
getGroupConfigurations
POST
Create group configuration
Create group configuration for a specific config_type for a company and an sales channel.
Parameters
configType
string
A `config_type` is a unique identifier for a particular group configuration type.
Enum
body
object (AppConfigurationDetail)
The configuration for groups. See details below
AppConfigurationDetail
app_id
string
attributes
array of object (AttributeDetailsGroup)
Optional
Array of AttributeDetailsGroup
is_active
boolean
is_default
boolean
logo
string
| url
Optional
name
string
Optional
priority
integer
| value >= 1
slug
string
template_slugs
array of string
Optional
Response
200
4XX
success flag will tell whether the operation was successful.
AppConfigurationDetail
app_id
string
attributes
array of object (AttributeDetailsGroup)
Optional
Array of AttributeDetailsGroup
is_active
boolean
is_default
boolean
logo
string
| url
Optional
name
string
Optional
priority
integer
| value >= 1
slug
string
template_slugs
array of string
Optional
Examples
Parameters
configType:
"value"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create group configuration
createGroupConfiguration
DEL
Delete group configuration
Delete group configurations by its slug for a specific config_type for a company and an sales channel.
Parameters
configType
string
A `config_type` is a unique identifier for a particular group configuration type.
Enum
groupSlug
string
A `group_slug` is a unique identifier of a particular configuration.
Response
200
4XX
success message will tell whether the operation was successful.
ConfigSuccessResponse
message
string
Examples
Parameters
configType:
"value"
groupSlug:
"value"
Was this section helpful?
DEL
Loading...
Response
Loading...
Delete group configuration
deleteGroupConfiguration
PUT
Update group configuration
Modify group configurations by its slug for specific config_type for a company and an sales channel.
Parameters
configType
string
A `config_type` is a unique identifier for a particular group configuration type.
Enum
groupSlug
string
A `group_slug` is a unique identifier of a particular configuration.
body
object (AppConfigurationDetail)
The configuration for groups. See details below
AppConfigurationDetail
app_id
string
attributes
array of object (AttributeDetailsGroup)
Optional
Array of AttributeDetailsGroup
is_active
boolean
is_default
boolean
logo
string
| url
Optional
name
string
Optional
priority
integer
| value >= 1
slug
string
template_slugs
array of string
Optional
Response
200
4XX
success flag will tell whether the operation was successful.
AppConfigurationDetail
app_id
string
attributes
array of object (AttributeDetailsGroup)
Optional
Array of AttributeDetailsGroup
is_active
boolean
is_default
boolean
logo
string
| url
Optional
name
string
Optional
priority
integer
| value >= 1
slug
string
template_slugs
array of string
Optional
Examples
Parameters
configType:
"value"
groupSlug:
"value"
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Update group configuration
updateGroupConfiguration
DEL
Delete listing configuration
Remove a specific product listing configuration by its config_id for a specific config_type for a company and an sales channel.
Parameters
configType
string
A `config_type` is a unique identifier for a particular listing configuration type.
Enum
configId
string
A `config_id` is a unique identifier of a particular configuration.
Response
200
4XX
success message will tell whether the operation was successful.
ConfigSuccessResponse
message
string
Examples
Parameters
configType:
"value"
configId:
"value"
Was this section helpful?
DEL
Loading...
Response
Loading...
Delete listing configuration
deleteListingConfiguration
PUT
Update listing configuration
Modify a specific product listing configuration by its config_id for a specific config_type for a company and an sales channel.
Parameters
configType
string
A `config_type` is a unique identifier for a particular listing configuration type.
Enum
configId
string
A `config_id` is a unique identifier of a particular configuration.
body
object (AppConfigurationsSort)
The configuration for listings. See details below
AppConfigurationsSort
app_id
string
default_key
string
is_active
boolean
is_default
boolean
key
string
logo
string
| url
Optional
name
string
Optional
priority
integer
| value >= 1
Response
200
4XX
success flag will tell whether the operation was successful.
AppConfigurationsSort
app_id
string
default_key
string
is_active
boolean
is_default
boolean
key
string
logo
string
| url
Optional
name
string
Optional
priority
integer
| value >= 1
Examples
Parameters
configType:
"value"
configId:
"value"
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Update listing configuration
updateListingConfiguration
GET
Get configuration metadata
Retrieve the configuraion metadata details for specific config_type for a company and an sales channel.
Parameters
configType
string
A `config_type` is an identifier that defines a specific type of configuration.
Enum
templateSlug
string
Optional
Get configuration list filtered by `template_slug` string. This is for the details and comparision groups.
pageNo
integer
Optional
The page number to navigate through the given set of results.
pageSize
integer
Optional
Number of items to retrieve in each page.
q
string
Optional
Get configuration list filtered by `q` string.
Response
200
4XX
configuration details for catalog. See example below or refer `GetConfigMetadataResponseSchema` for details
GetConfigMetadataResponse
condition
array of object
Optional
data
array of object
page
object (Page)
Optional
Page
values
array of object
Optional
Examples
Parameters
configType:
"value"
templateSlug:
"value"
pageNo:
0
pageSize:
0
q:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get configuration metadata
getConfigurationMetadata
Sales Channel Product
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
GET
Get sales channel product
Retrieve sales channel product details by its item_id and depending upon filters sent in request.
Parameters
itemId
string
product id for a particular product.
Response
200
4XX
The Company Applicaton Product Data(MOQ/SEO).
OwnerAppItemResponse
alt_text
object
Optional
Default Value : [object Object]
is_cod
boolean
Optional
Default Value : true
is_gift
boolean
Optional
Default Value : false
moq
object (MOQData)
Optional
Default Value : [object Object]
MOQData
seo
object (SEOData)
Optional
Default Value : [object Object]
SEOData
_custom_json
object
Optional
Custom JSON data for the item
_custom_meta
array of object (MetaFields)
Optional
Custom meta fields for the item
Array of MetaFields
Examples
Parameters
itemId:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get sales channel product
getAppProduct
PATCH
Update sales channel product
Allows to update data associated to a item by its item_id for an sales channel.
Parameters
itemId
string
product id for which the custom_meta is associated.
body
object (ApplicationItemMeta)
custom meta object that needs to be added.
ApplicationItemMeta
_custom_json
object
Optional
Custom JSON data for the item
_custom_meta
array of object (MetaFields)
Optional
Custom meta fields for the item
Array of MetaFields
alt_text
object
Optional
Alternative text for the item's images
is_cod
boolean
Optional
Whether the item is available for Cash on Delivery (COD) or not
is_gift
boolean
Optional
Whether the item is a gift or not
moq
object (ApplicationItemMOQ)
Optional
Minimum Order Quantity information for the item
ApplicationItemMOQ
seo
object (ApplicationItemSEO)
Optional
Search Engine Optimization information for the item
ApplicationItemSEO
size_promotion_threshold
object (SizePromotionThreshold)
Optional
Size level promotion limitation information for item
SizePromotionThreshold
Response
200
4XX
Returns a success response
SuccessResponse1
success
boolean
Optional
uid
integer
Optional
Examples
Parameters
itemId:
"value"
body:
body
Was this section helpful?
PATCH
Loading...
Response
Loading...
Update sales channel product
updateAppProduct
GET
List sales channel products
Retrieve products associated with the sales channel. List all the products associated with a brand, collection or category in a requested sort order.
Parameters
q
string
Optional
The search query. This can be a partial or complete name of a either a product, brand or category
f
string
Optional
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
Optional
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
Optional
Pass `filters` parameter to fetch the filter details. This flag is used to fetch all filters
Default Value : true
isDependent
boolean
Optional
This query parameter is used to get the dependent products in the listing.
Default Value : true
sortOn
string
Optional
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
pageId
string
Optional
Each response will contain **page_id** param, which should be sent back to make pagination work.
pageSize
integer
Optional
Number of items to retrieve in each page. Default is 12.
Default Value : 12
pageNo
integer
Optional
If page_type is number then pass it to fetch page items. Default is 1.
Default Value : 1
pageType
string
Optional
For pagination type should be cursor or number. Default is cursor.
Default Value : cursor
itemIds
array of integer
Optional
Item Ids of product
Response
200
4XX
List of Products. See example below or refer `ApplicationProductListingResponse` for details
ApplicationProductListingResponse
filters
array of object (ProductFilters)
Optional
Array of ProductFilters
items
array of object (ProductListingDetail)
Optional
Array of ProductListingDetail
operators
object
Optional
page
object (Page)
Page
sort_on
array of object (ProductSortOn)
Optional
Array of ProductSortOn
Examples
Parameters
q:
"value"
f:
"value"
c:
"value"
filters:
false
isDependent:
false
sortOn:
"value"
pageId:
"value"
pageSize:
0
pageNo:
0
pageType:
"value"
itemIds:
0,1
Was this section helpful?
GET
Loading...
Response
Loading...
List sales channel products
getAppicationProducts
GET
List sales channel products
Retrieve products specific to the sales channel, with filtering options available for brand, category, department, tags, item IDs, product name, and pagination support
Parameters
brandIds
array of integer
Optional
Get multiple products filtered by Brand Ids
categoryIds
array of integer
Optional
Get multiple products filtered by Category Ids
departmentIds
array of integer
Optional
Get multiple products filtered by Department Ids
tags
array of string
Optional
Get multiple products filtered by tags
itemIds
array of integer
Optional
Get multiple products filtered by Item Ids
pageNo
integer
Optional
The page number to navigate through the given set of results
pageSize
integer
Optional
Number of items to retrieve in each page. Default is 10.
Default Value : 10
q
string
Optional
Search with Item Code, Name, Slug or Identifier.
Response
200
4XX
The Product object. See example below or refer `ApplicationProductListingResponseDatabasePowered` for details.
RawProductListingResponse
items
array of object (RawProduct)
Optional
Array of RawProduct
page
object (Page)
Optional
Page
Examples
Parameters
brandIds:
0,1
categoryIds:
0,1
departmentIds:
0,1
tags:
"lorem","ipsum"
itemIds:
0,1
pageNo:
0
pageSize:
0
q:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List sales channel products
getAppProducts
Search Keywords and Autocomplete
This resource efficiently manage search keywords and autocomplete features. It offers intuitive functionalities such as deleting, updating, and retrieving search keywords, ensuring precise search results.the resource can be used to tailor the search experience by creating custom keywords and rules, providing greater flexibility in organizing and accessing information. Additionally, the resource allows to fine-tune autocomplete behavior, enhancing the overall search experience for a smoother and more intuitive user journey
Operations
GET
# Get autocomplete configuration
POST
# Create autocomplete configurations
DEL
# Delete autocomplete keyword
GET
# Get autocomplete keyword
PUT
# Update autocomplete keyword
DEL
# Delete search configuration
GET
# Get Search configuration
POST
# Create search configuration
PUT
# Update search configuration
GET
# List search keywords
POST
# Create search keywords
DEL
# Delete search keywords
GET
# Get search keywords
PUT
# Update search keywords
GET
Get autocomplete configuration
Get custom autocomplete keyword configuration for a specific sales channel which allows you to map any endpoint with these keywords to give you the ultimate suggestion results.
Parameters
No Parameters
Response
200
4XX
List of custom autocomplete keywords. See example below or refer `GetAutocompleteWordsResponseSchema` for details
GetAutocompleteWordsResponse
items
array of object (GetAutocompleteWordsData)
Optional
Array of GetAutocompleteWordsData
page
object (Page)
Optional
Page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
Get autocomplete configuration
getAutocompleteConfig
POST
Create autocomplete configurations
Create custom autocomplete keyword configurations for a specific sales channel to map any endpoint with these keywords.
Parameters
body
object (CreateAutocompleteKeyword)
A Search Keywords object that needs to be added
CreateAutocompleteKeyword
_custom_json
object
Optional
Default Value : [object Object]
app_id
string
Optional
is_active
boolean
Optional
Default Value : true
results
array of object (AutocompleteResult)
Optional
Array of AutocompleteResult
words
array of string
Optional
Response
200
4XX
List of all the collections including the one you added. See example below or refer `CreateAutocompleteWordsResponseSchema` for details
CreateAutocompleteWordsResponse
_custom_json
object
Optional
app_id
string
Optional
results
array of object
Optional
words
array of string
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create autocomplete configurations
createCustomAutocompleteRule
DEL
Delete autocomplete keyword
Delete custom autocomplete keyword configurations for a specific sales channel by its id.
Parameters
id
string
A `id` is a unique identifier for a particular detail. Pass the `id` of the keywords which you want to delete.
Response
200
4XX
Status object. Tells whether the operation was successful. See example below or refer `DeleteResponse`
DeleteResponse
message
string
Optional
Examples
Parameters
id:
"value"
Was this section helpful?
DEL
Loading...
Response
Loading...
Delete autocomplete keyword
deleteAutocompleteKeyword
GET
Get autocomplete keyword
Retrieve detailed information about a specific autocomplete keyword for a specific sales channel by its id.
Parameters
id
string
A `id` is a unique identifier for a particular detail. Pass the `id` of the keywords which you want to retrieve.
Response
200
4XX
The mapping object. See example below or refer `GetAutocompleteWordsResponseSchema` for details
GetAutocompleteWordsResponse
items
array of object (GetAutocompleteWordsData)
Optional
Array of GetAutocompleteWordsData
page
object (Page)
Optional
Page
Examples
Parameters
id:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get autocomplete keyword
getAutocompleteKeywordDetail
PUT
Update autocomplete keyword
Update a specific autocomplete keyword configuration by its id for a specific sales channel.
Parameters
id
string
A `id` is a unique identifier for a particular detail. Pass the `id` of the keywords which you want to delete.
body
object (CreateAutocompleteKeyword)
A Autocomplete object that needs to be updated
CreateAutocompleteKeyword
_custom_json
object
Optional
Default Value : [object Object]
app_id
string
Optional
is_active
boolean
Optional
Default Value : true
results
array of object (AutocompleteResult)
Optional
Array of AutocompleteResult
words
array of string
Optional
Response
200
4XX
The Mapping object. See example below or refer `GetAutocompleteWordsResponseSchema` for details.
GetAutocompleteWordsResponse
items
array of object (GetAutocompleteWordsData)
Optional
Array of GetAutocompleteWordsData
page
object (Page)
Optional
Page
Examples
Parameters
id:
"value"
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Update autocomplete keyword
updateAutocompleteKeyword
DEL
Delete search configuration
Delete Search Configuration for a specific sales channel.
Parameters
No Parameters
Response
200
4XX
Status of the delete operation. See `DeleteSearchConfigurationResponse` for details
DeleteSearchConfigurationResponse
success
boolean
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
DEL
Loading...
Response
Loading...
Delete search configuration
deleteSearchConfiguration
GET
Get Search configuration
Get search configuration for a specific company and sales channel.
Parameters
No Parameters
Response
200
4XX
Search configuration for the specified application. See example below or refer `GetSearchConfigurationResponse` for details
GetSearchConfigurationResponse
application_id
string
The application id where custom search configuration is set
company_id
integer
The company id where custom search configuration is set
created_by
object (UserSerializer)
Optional
The user who created the search configuration.
UserSerializer
created_on
string
| date-time
Optional
The date and time when the search configuration was created.
is_proximity_enabled
boolean
Optional
Flag indicating if proximity search is enabled for this attribute.
Default Value : false
modified_by
object (UserSerializer)
Optional
The user who modified the search configuration.
UserSerializer
modified_on
string
| date-time
Optional
The date and time when the search configuration was last modified.
proximity
integer
Optional
Proximity distance configuration
Default Value : 1
searchable_attributes
array of object (SearchableAttribute)
Optional
The searchable attributes defined on the application.
Array of SearchableAttribute
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
Get Search configuration
getSearchConfiguration
POST
Create search configuration
Create search configuration for the catalog for a specific company and sales channel.
Parameters
body
object (CreateSearchConfigurationRequest)
Search configuration that needs to be created. See `CreateSearchConfigurationRequest` for details
CreateSearchConfigurationRequest
application_id
string
The application id where custom search configuration is set
company_id
integer
The company id where custom search configuration is set
created_by
object (UserSerializer)
Optional
The user who created the search configuration.
UserSerializer
created_on
string
| date-time
Optional
The date and time when the search configuration was created.
is_proximity_enabled
boolean
Optional
Flag indicating if proximity search is enabled for this attribute.
Default Value : false
modified_by
object (UserSerializer)
Optional
The user who modified the search configuration.
UserSerializer
modified_on
string
| date-time
Optional
The date and time when the search configuration was last modified.
proximity
integer
Optional
Proximity distance configuration
Default Value : 1
searchable_attributes
array of object (SearchableAttribute)
Optional
The searchable attributes defined on the application.
Array of SearchableAttribute
Response
200
4XX
List of custom search keywords. See example below or refer `CreateSearchConfigurationResponse` for details
CreateSearchConfigurationResponse
success
boolean
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create search configuration
createSearchConfiguration
PUT
Update search configuration
Allows you to modify searchable attributes for an sales channel. searchable attributes are the fields on which the products are searched.
Parameters
body
object (UpdateSearchConfigurationRequest)
Search configuration that needs to be updated. See `UpdateSearchConfigurationRequest` for details
UpdateSearchConfigurationRequest
application_id
string
The application id where custom search configuration is set
company_id
integer
The company id where custom search configuration is set
created_by
object (UserSerializer)
Optional
The user who created the search configuration.
UserSerializer
created_on
string
| date-time
Optional
The date and time when the search configuration was created.
is_proximity_enabled
boolean
Optional
Flag indicating if proximity search is enabled for this attribute.
Default Value : false
modified_by
object (UserSerializer)
Optional
The user who modified the search configuration.
UserSerializer
modified_on
string
| date-time
Optional
The date and time when the search configuration was last modified.
proximity
integer
Optional
Proximity distance configuration
Default Value : 1
searchable_attributes
array of object (SearchableAttribute)
Optional
The searchable attributes defined on the application.
Array of SearchableAttribute
Response
200
4XX
List of custom search keywords. See example below or refer `UpdateSearchConfigurationResponse` for details
UpdateSearchConfigurationResponse
success
boolean
Optional
Examples
Parameters
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Update search configuration
updateSearchConfiguration
GET
List search keywords
Get all custom search keywords for a specific company and sales channel allows you to map certain conditions with the keywords to give you ultimate results.
Parameters
No Parameters
Response
200
4XX
List of custom search keywords. See example below or refer `GetSearchWordsResponseSchema` for details
GetSearchWordsResponse
items
array of object (GetSearchWordsData)
Optional
Array of GetSearchWordsData
page
object (Page)
Optional
Page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
List search keywords
getAllSearchKeyword
POST
Create search keywords
Create a Custom Search Keywords for a specific company and sales channel allows you to map certail conditions with the keywords to give you ultimate results.
Parameters
body
object (CreateSearchKeyword)
A Search Keywords object that needs to be added
CreateSearchKeyword
_custom_json
object
Optional
Default Value : [object Object]
app_id
string
Optional
is_active
boolean
Optional
Default Value : true
result
object (SearchKeywordResult)
SearchKeywordResult
words
array of string
Optional
Response
200
4XX
Get keyword object with id that is added. See example below or refer `GetSearchWordsDataSchema` for details
GetSearchWordsData
_custom_json
object
Optional
app_id
string
Optional
is_active
boolean
Optional
result
object
Optional
uid
string
Optional
words
array of string
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create search keywords
createCustomKeyword
DEL
Delete search keywords
Delete a search keywords by its id for a specific company and sales channel.
Parameters
id
string
A `id` is a unique identifier for a particular detail. Pass the `id` of the keywords which you want to delete.
Response
200
4XX
Status object. Tells whether the operation was successful. See example below or refer `DeleteResponse`
DeleteResponse
message
string
Optional
Examples
Parameters
id:
"value"
Was this section helpful?
DEL
Loading...
Response
Loading...
Delete search keywords
deleteSearchKeywords
GET
Get search keywords
Retrieve a list of a specific list of keywords by its id for a specific company and sales channel.
Parameters
id
string
A `id` is a unique identifier for a particular detail. Pass the `id` of the keywords which you want to retrieve.
Response
200
4XX
The Collection object. See example below or refer `GetSearchWordsDetailResponseSchema` for details
GetSearchWordsDetailResponse
items
object (GetSearchWordsData)
Optional
GetSearchWordsData
page
object (Page)
Optional
Page
Examples
Parameters
id:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get search keywords
getSearchKeywords
PUT
Update search keywords
Update a specific search keyword by its id for a specific company and sales channel.
Parameters
id
string
A `id` is a unique identifier for a particular detail. Pass the `id` of the keywords which you want to delete.
body
object (CreateSearchKeyword)
A Search Keywords object that needs to be added
CreateSearchKeyword
_custom_json
object
Optional
Default Value : [object Object]
app_id
string
Optional
is_active
boolean
Optional
Default Value : true
result
object (SearchKeywordResult)
SearchKeywordResult
words
array of string
Optional
Response
200
4XX
The Collection object. See example below or refer `GetSearchWordsDataSchema` for details.
GetSearchWordsData
_custom_json
object
Optional
app_id
string
Optional
is_active
boolean
Optional
result
object
Optional
uid
string
Optional
words
array of string
Optional
Examples
Parameters
id:
"value"
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Update search keywords
updateSearchKeywords
Seller Onboarding
The Seller Onboarding used for management of seller accounts and provide insights into company metrics related to brand and store status, verified and unverified products, as well as company and store documents. Seller Onboarding can access company metrics, gaining valuable information on the performance and compliance status of seller accounts. Seller Onboarding accrss company profiles associated with seller accounts, allowing for a deeper understanding of the business, products, and services offered. Seller Onboarding enables users to edit and update company profiles directly, ensuring that the information reflected across platforms remains accurate and up-to-date.
Operations
GET
# Get company metrics
GET
Get company metrics
Allows viewing company metrics, including brand and store status, as well as the number of verified and unverified products, company documents, and store documents.
Parameters
No Parameters
Response
200
4XX
See example below or refer `OptinCompanyMetrics` for details
OptinCompanyMetrics
brand
integer
Optional
company
string
Optional
store
integer
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
Loading...
Response
Loading...
Get company metrics
getCompanyMetrics
Selling Location
A selling location represents a geographical location where your stores, pop-up stores, headquarters, and warehouses exist. Find in-stock locations for products Additionally, the API retrieves detailed location information by ID, offering comprehensive store details for enhanced user convenience
Operations
GET
# List sales channels
POST
# Get optimal locations
GET
# Get selling location
GET
List sales channels
Retrieve all stores associated with an sales channel, with support for searching by store name and filtering by store type and status (verified/unverified)
Parameters
storeType
string
Optional
Helps to sort the location list on the basis of location type.
uid
array of integer
Optional
Helps to sort the location list on the basis of uid list.
q
string
Optional
Query that is to be searched.
stage
string
Optional
to filter companies on basis of verified or unverified companies.
pageNo
integer
Optional
The page number to navigate through the given set of results
Default Value : 1
pageSize
integer
Optional
Number of items to retrieve in each page. Default is 20.
Default Value : 20
tags
array of string
Optional
Get locations filtered by tags.
storeTypes
array of string
Optional
Get locations filtered by store types.
Response
200
4XX
Company profile object. See example below or refer `LocationListSerializer` for details
LocationListSerializer
items
array of object (GetLocationSerializer)
Optional
Array of GetLocationSerializer
page
object (Page)
Optional
Page
Examples
Parameters
storeType:
"value"
uid:
0,1
q:
"value"
stage:
"value"
pageNo:
0
pageSize:
0
tags:
"lorem","ipsum"
storeTypes:
"lorem","ipsum"
Was this section helpful?
GET
Loading...
Response
Loading...
List sales channels
getAppLocations
POST
Get optimal locations
This API returns the optimal locations where inventory is available for the given articles.
Parameters
body
object (AssignStore)
Object that needs to be added.
AssignStore
app_id
string
articles
array of object (AssignStoreArticle)
Array of AssignStoreArticle
channel_identifier
string
Optional
channel_type
string
Optional
company_id
integer
Optional
pincode
string
store_ids
array of integer
Optional
Response
200
4XX
Returns a success response
StoreAssignResponse
_id
string
Optional
article_assignment
object (ArticleAssignment1)
ArticleAssignment1
company_id
integer
Optional
group_id
string
Optional
index
integer
Optional
item_id
integer
meta
object
Optional
price_effective
integer
Optional
price_marked
integer
Optional
quantity
integer
s_city
string
Optional
size
string
status
boolean
store_id
integer
Optional
store_pincode
integer
Optional
strategy_wise_listing
array of object
Optional
Default Value :
uid
string
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Get optimal locations
getOptimalLocations
GET
Get selling location
Retrieve the details of the selling location (store) associated with a specific company passed.
Parameters
q
string
Optional
The search related the store for the company id.
pageNo
integer
Optional
The number of page for the company id.
pageSize
integer
Optional
Number of records that can be seen on the page for the company id.
Response
200
4XX
See example below or refer `OptinStoreDetailsSchema` for details
OptinStoreDetails
items
array of object (StoreDetail)
Optional
Array of StoreDetail
page
object (Page)
Optional
Page
Examples
Parameters
q:
"value"
pageNo:
0
pageSize:
0
Was this section helpful?
GET
Loading...
Response
Loading...
Get selling location
getStoreDetail
Size Guide
Size Guide facilitates the management of size-related information for products, aiding customers in making informed purchasing decisions. A size guide includes measurements, fit guides, and size conversion charts. Size Guide can create new size guides, retrieve a list of available size guides, update existing guides, and obtain specific details about a size guide. This functionality ensures that sizing information remains accurate and accessible.
Operations
GET
# List size guides
POST
# Create size guide
GET
# Get size guide
PUT
# Update size guide
GET
List size guides
Allows to view all the size guides associated to the seller. Each size guide contains meta deta like header values like for shoulder, head, etc. and measurement unit like cm and values contains sizes for the same.
Parameters
active
boolean
Optional
filter size guide on basis of active, in-active
q
string
Optional
Query that is to be searched.
tag
string
Optional
to filter size guide on basis of tag.
pageNo
integer
Optional
The page number to navigate through the given set of results
pageSize
integer
Optional
Number of items to retrieve in each page. Default is 10.
Default Value : 10
brandId
integer
Optional
Brand id that is to be searched.
Response
200
4XX
Size guide object. See example below or refer `ListSizeGuide` for details
ListSizeGuide
items
array of object
Optional
page
object
Optional
Examples
Parameters
active:
false
q:
"value"
tag:
"value"
pageNo:
0
pageSize:
0
brandId:
0
Was this section helpful?
GET
Loading...
Response
Loading...
List size guides
getSizeGuides
POST
Create size guide
Allows to create a size guide associated to a seller
Parameters
body
object (ValidateSizeGuide)
Size guide object that needs to be added.
ValidateSizeGuide
active
boolean
Optional
brand_id
integer
Optional
company_id
integer
Optional
created_by
object
Optional
created_on
string
| date-time
Optional
description
string
Optional
guide
object (Guide)
Optional
Guide
id
string
Optional
image
string
| url
Optional
modified_by
object
Optional
modified_on
string
| date-time
Optional
name
string
subtitle
string
Optional
tag
string
Optional
title
string
Response
200
4XX
Returns a success response
SuccessResponse
success
boolean
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create size guide
createSizeGuide
GET
Get size guide
Retrieve data associated about a specific size guide. It contains meta deta like header values like for shoulder, head, etc. and measurement unit like cm and values contains sizes for the same.
Parameters
id
string
Id of the size guide to be viewed.
Response
200
4XX
Brand object. See example below or refer `SizeGuideResponseSchema` for details
SizeGuideResponse
active
boolean
Optional
brand_id
integer
Optional
company_id
integer
Optional
created_by
object
Optional
created_on
string
Optional
guide
object
Optional
id
string
Optional
modified_by
object
Optional
modified_on
string
Optional
name
string
Optional
subtitle
string
Optional
tag
string
Optional
title
string
Optional
Examples
Parameters
id:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get size guide
getSizeGuide
PUT
Update size guide
Allows to edit a specific size guide.
Parameters
id
string
Mongo id of the size guide to be edited
body
object (ValidateSizeGuide)
Onboard object that needs to be added.
ValidateSizeGuide
active
boolean
Optional
brand_id
integer
Optional
company_id
integer
Optional
created_by
object
Optional
created_on
string
| date-time
Optional
description
string
Optional
guide
object (Guide)
Optional
Guide
id
string
Optional
image
string
| url
Optional
modified_by
object
Optional
modified_on
string
| date-time
Optional
name
string
subtitle
string
Optional
tag
string
Optional
title
string
Response
200
4XX
Returns a success response
SuccessResponse
success
boolean
Optional
Examples
Parameters
id:
"value"
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...