Catalog
Manages product catalogs, including adding, updating, and deleting products, as well as categorizing them.
Brand
A brand represents a specific brand or manufacturer associated with a product. Brands help customers identify and differentiate products based on their manufacturer or designer. Each brand typically has a unique identifier and a name. For example, a clothing platform might have brands such as Nike, Adidas, Gucci, Zara, etc. Brand APIs facilitate access to brand-related data, offering functionalities such as retrieving list of available brands and obtaining detailed information about a specific brand using its unique slug.
Operations
GET
# List sales channel brands
PATCH
# Update sales channel brand
GET
# List brands
GET
List sales channel brands
Retrieve brand listings related to the sales channel. A brand is the name under which a product is being sold
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
page_no
integer
The page number to navigate through the given set of results
page_size
integer
Number of items to retrieve in each page. Default is 12.
Default Value : 12
q
string
Search query with brand name.Use this parameter to search brands by brand name.
Response
200
4XX
List of Brands. See example below or refer `BrandListingResponse` for details
BrandListingResponse
items
array of object (BrandItem)
Array of BrandItem
page
object (Page)
Page
Examples
Parameters
companyId:
"value"
applicationId:
"value"
pageNo:
1
pageSize:
1
q:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List sales channel brands
getApplicationBrandListing
PATCH
Update sales channel brand
Modify data associated to the brand for that particular sales channel.
Parameters
company_id
string
Required
Id of the company associated to brand custom json.
application_id
string
Required
application id for which the custom_json is associated.
brand_uid
string
Required
brand id for which the custom_json is associated.
Request body
_custom_json
object
Required
Response
200
4XX
Returns a success response
SuccessResponse1
success
boolean
uid
integer
Examples
Parameters
companyId:
"value"
applicationId:
"value"
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
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
department
string
The name of the department. Use this parameter to filter products by a particular department. See below the list of available departments. You can retrieve available departments from the **v1.0/departments/** API
Enum
page_no
integer
The page number to navigate through the given set of results
page_size
integer
Number of items to retrieve in each page. Default is 12.
Default Value : 12
q
string
Search query with brand name.Use this parameter to search brands by brand name.
brand_id
array of integer
Helps to sort the brands list on the basis of uid list.
Response
200
4XX
List of Brands. See example below or refer `BrandListingResponse` for details
BrandListingResponse
items
array of object (BrandItem)
Array of BrandItem
page
object (Page)
Page
Examples
Parameters
companyId:
"value"
applicationId:
"value"
department:
"value"
pageNo:
1
pageSize:
1
q:
"value"
brandId:
0,1
Was this section helpful?
GET
Loading...
Response
Loading...
List brands
getApplicationBrands
Category
Categories are hierarchical structure that enables a systematic organization of products for better discoverability of products on storefront. Categories are structured into three levels: L1, L2, and L3, with L1 representing the top-level category, followed by L2 and L3. For example - Clothing(L1) >> Shirts(L2) >> Formal Shirts(L3) A single L1 category can encompass multiple L2 categories underneath it, and similarly, an L2 category can contain multiple L3 categories within it. Category is a sales-channel specific configuration. While categories are common across all companies, sales channel can configure L3 category names tailored to their unique requirements.
Operations
GET
# List categories
GET
# List sales channel categories
PATCH
# Update sales channel category
GET
List categories
Retrieve a list of categories associated to company and sales channel. user can filter on departments.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
department
string
The name of the department. Use this parameter to filter products by a particular department. See below the list of available departments. You can retrieve available departments from the **v1.0/departments/** API
Enum
Response
200
4XX
List of Categories. See example below or refer `CategoryListingResponse` for details.
CategoryListingResponse
data
array of object (DepartmentCategoryTree)
Array of DepartmentCategoryTree
departments
array of object (DepartmentIdentifier)
Array of DepartmentIdentifier
Examples
Parameters
companyId:
"value"
applicationId:
"value"
department:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List categories
getCategories
GET
List sales channel categories
Retrieve category listings related to the sales channel , with the ability to filter results based on department ,category names etc.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
department_id
integer
A `department_id` is a unique identifier for a particular department.
page_no
integer
The page number to navigate through the given set of results
page_size
integer
Number of items to retrieve in each page. Default is 12.
Default Value : 12
q
string
Search query with brand name.Use this parameter to search brands by brand name.
Response
200
4XX
List of Brands. See example below or refer `BrandListingResponse` for details
BrandListingResponse
items
array of object (BrandItem)
Array of BrandItem
page
object (Page)
Page
Examples
Parameters
companyId:
"value"
applicationId:
"value"
departmentId:
1
pageNo:
1
pageSize:
1
q:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List sales channel categories
getApplicationCategoryListing
PATCH
Update sales channel category
Modify category data related to the sales channel .
Parameters
company_id
string
Required
Id of the company associated to category custom json.
application_id
string
Required
application id for which the custom_json is associated.
category_uid
string
Required
category id for which the custom_json is associated.
Request body
_custom_json
object
Required
Response
200
4XX
Returns a success response
SuccessResponse1
success
boolean
uid
integer
Examples
Parameters
companyId:
"value"
applicationId:
"value"
categoryUid:
"value"
body:
body
Was this section helpful?
PATCH
Loading...
Response
Loading...
Update sales channel category
updateAppCategory
Collection
The Collection is grouping of products together within an e-commerce platform, enabling sellers to curate and showcase these collections on the product listing page. Collections serve as a means to organize and highlight related products. Two types of collections basic and handpicked collections are availble. Basic Collections: These collections are configured based on predefined criteria such as brand, category, department, or a combination thereof. Sellers can create basic collections to showcase products that share common attributes.For example, a basic collection can include all products from a specific brand, a particular category, or a combination of brands and categories. Handpicked Collections: In contrast to basic collections, handpicked collections allow sellers to manually select products regardless of their categorization. This type of collection enables sellers to curate unique assortments that may not fit within predefined categories or brands. Sellers have the flexibility to include products based on their individual preferences, promotions, or seasonal themes, creating curated collections that resonate with their target audience.
Operations
GET
# List collections
POST
# Create a collection
DEL
# Delete a collection
PUT
# Update a collection
GET
# List items of collection
POST
# Create items in a collection
GET
# Get a collection
GET
List collections
Retrieve all collections based on criteria such as collection name, schedule status, and active status.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
q
string
Get collection list filtered by q string,
schedule_status
string
Get collection list filtered by scheduled status,
Enum
type
string
type of the collections
tags
array of string
Each response will contain next_id param, which should be sent back to make pagination work.
is_active
boolean
get collections filtered by active status.
page_no
integer
The page number to navigate through the given set of results.
page_size
integer
Number of items to retrieve in each page. Default is 12.
Response
200
4XX
List of collections. See example below or refer `GetCollectionListingResponse` for details
GetCollectionListingResponse
filters
object (CollectionListingFilter)
CollectionListingFilter
items
array of object (GetCollectionDetailNest)
Array of GetCollectionDetailNest
page
object (Page)
Page
Examples
Parameters
companyId:
"value"
applicationId:
"value"
q:
"value"
scheduleStatus:
"value"
type:
"value"
tags:
"lorem","ipsum"
isActive:
false
pageNo:
1
pageSize:
1
Was this section helpful?
GET
Loading...
Response
Loading...
List collections
getAllCollections
POST
Create a collection
Create a collection for a sales channel linked to a company.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Request body
_custom_json
object
Default Value : [object Object]
_locale_language
object
Default Value : [object Object]
_schedule
object (CollectionSchedule)
CollectionSchedule
allow_facets
boolean
Default Value : true
allow_sort
boolean
Default Value : true
app_id
string
Required
badge
object (CollectionBadge)
CollectionBadge
banners
object (CollectionBanner)
Required
CollectionBanner
created_by
object (UserInfo)
Nullable
UserInfo
description
string
is_active
boolean
Default Value : true
is_visible
boolean
Default Value : true
logo
object (CollectionImage)
Required
CollectionImage
meta
object
Default Value : [object Object]
modified_by
object (UserInfo)
Nullable
UserInfo
name
string
Required
priority
integer
Default Value : 99999
published
boolean
Default Value : true
query
array of object (CollectionQuery)
Default Value :
Array of CollectionQuery
seo
object (SeoDetail)
SeoDetail
slug
string
Required
sort_on
string
Default Value : popular
tags
array of string
type
string
Required
Enum
visible_facets_keys
array of string
Default Value :
Response
200
4XX
List of all the collections including the one you added. See example below or refer `CollectionCreateResponse` for details
CollectionCreateResponse
uid
string
_schedule
object
allow_facets
boolean
allow_sort
boolean
app_id
string
badge
object
banners
object (ImageUrls)
ImageUrls
cron
object
description
string
is_active
boolean
logo
object (BannerImage)
BannerImage
meta
object
name
string
priority
integer
query
array of object (CollectionQuery)
Array of CollectionQuery
slug
string
sort_on
string
tag
array of string
type
string
visible_facets_keys
array of string
Examples
Parameters
companyId:
"value"
applicationId:
"value"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create a collection
createCollection
DEL
Delete a collection
Delete a collection by it's id. Returns an object that tells whether the collection was deleted successfully
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
id
string
Required
A `id` is a unique identifier of a collection.
Response
200
4XX
Status object. Tells whether the operation was successful.
CommonResponseSchemaCollection
message
string
Examples
Parameters
companyId:
"value"
applicationId:
"value"
id:
"value"
Was this section helpful?
DEL
Loading...
Response
Loading...
Delete a collection
deleteCollection
PUT
Update a collection
Update a collection by it's id. On successful request, returns the updated collection
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
id
string
Required
A `id` is a unique identifier of a collection.
Request body
_custom_json
object
_locale_language
object
_schedule
object (CollectionSchedule)
CollectionSchedule
allow_facets
boolean
allow_sort
boolean
badge
object (CollectionBadge)
CollectionBadge
banners
object (CollectionBanner)
CollectionBanner
description
string
is_active
boolean
is_visible
boolean
logo
object (CollectionImage)
CollectionImage
meta
object
modified_by
object (UserInfo)
Nullable
User info.
UserInfo
name
string
priority
integer
published
boolean
query
array of object (CollectionQuery)
Array of CollectionQuery
seo
object (SeoDetail)
SeoDetail
slug
string
sort_on
string
tags
array of string
type
string
visible_facets_keys
array of string
Response
200
4XX
The Collection object. See example below or refer `UpdateCollectionSchema` for details.
UpdateCollection
_custom_json
object
_locale_language
object
_schedule
object (CollectionSchedule)
CollectionSchedule
allow_facets
boolean
allow_sort
boolean
badge
object (CollectionBadge)
CollectionBadge
banners
object (CollectionBanner)
CollectionBanner
description
string
is_active
boolean
is_visible
boolean
logo
object (CollectionImage)
CollectionImage
meta
object
modified_by
object (UserInfo)
Nullable
User info.
UserInfo
name
string
priority
integer
published
boolean
query
array of object (CollectionQuery)
Array of CollectionQuery
seo
object (SeoDetail)
SeoDetail
slug
string
sort_on
string
tags
array of string
type
string
visible_facets_keys
array of string
Examples
Parameters
companyId:
"value"
applicationId:
"value"
id:
"value"
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Update a collection
updateCollection
GET
List items of collection
Get items from a collection specified by its id.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
id
string
Required
A `id` is a unique identifier of a collection.
sort_on
string
Each response will contain sort_on param, which should be sent back to make pagination work.
page_id
string
Each response will contain next_id param, which should be sent back to make pagination work.
page_size
integer
Number of items to retrieve in each page. Default is 12.
Response
200
4XX
The attached items of an collection. See example below or refer `GetCollectionItemsResponse` for details
GetCollectionItemsResponse
filters
array of object (ProductFilters)
Array of ProductFilters
items
array of object (ProductListingDetail)
Array of ProductListingDetail
page
object (Page)
Page
sort_on
array of object (ProductSortOn)
Array of ProductSortOn
Examples
Parameters
companyId:
"value"
applicationId:
"value"
id:
"value"
sortOn:
"value"
pageId:
"value"
pageSize:
1
Was this section helpful?
GET
Loading...
Response
Loading...
List items of collection
getCollectionItems
POST
Create items in a collection
Adds items to a collection specified by its id
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
id
string
Required
A `id` is a unique identifier of a collection.
Request body
allow_facets
boolean
allow_sort
boolean
items
array of object (CollectionItemSchemaV2)
Array of CollectionItemSchemaV2
query
array of object (CollectionQuerySchemaV2)
Array of CollectionQuerySchemaV2
type
string
Required
visible_facets_keys
array of string
Response
200
4XX
Status object. Tells whether the operation was successful.
CommonResponseSchemaCollection
message
string
Examples
Parameters
companyId:
"value"
applicationId:
"value"
id:
"value"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create items in a collection
addCollectionItems
GET
Get a collection
Get the details of a collection by its slug.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
slug
string
Required
A `slug` is a human readable, URL friendly unique identifier of an object. Pass the `slug` of the collection which you want to retrieve.
Response
200
4XX
The Collection object. See example below or refer `GetCollectionDetailResponse` for details
GetCollectionDetailResponse
_custom_json
object
_locale_language
object
_schedule
object (CollectionSchedule)
CollectionSchedule
action
object
allow_facets
boolean
allow_sort
boolean
app_id
string
badge
object (CollectionBadge)
CollectionBadge
banners
object (ImageUrls)
ImageUrls
description
string
is_active
boolean
is_visible
boolean
logo
object (Media)
Media
meta
object
name
string
priority
integer
published
boolean
query
array of object (CollectionQuery)
Array of CollectionQuery
seo
object (SeoDetail)
SeoDetail
slug
string
sort_on
string
tags
array of string
type
string
uid
string
visible_facets_keys
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
companyId:
"value"
applicationId:
"value"
slug:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get a collection
getCollectionDetail
Department
A department categorizes products into different sections or categories based on their type or purpose. Departments help organize products in a logical manner, making it easier for customers to navigate the product catalog. Each department typically has a unique identifier and a name. For example, a clothing ecommerce platform might have departments such as Men's Clothing, Women's Clothing, Accessories, Footwear, etc. You can retrieve a list of all departments associated with available products, facilitating easy navigation and organization of products based on departmental categorization. Additionally, the APIs allow you to list all products associated with a specific brand, collection, or category in a random order, enhancing user engagement and discovery within your application
Operations
GET
# List sales channel departments
PATCH
# Update sales channel department
GET
# List departments
GET
List sales channel departments
Retrieve department listings related to the sales channel. Departments are used to categorize similar products, and you can filter the results based on department names
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
page_no
integer
The page number to navigate through the given set of results
page_size
integer
Number of items to retrieve in each page. Default is 12.
Default Value : 12
q
string
Search query with brand name.Use this parameter to search department by name.
Response
200
4XX
List of Departments. See example below or refer `BrandListingResponse` for details
ApplicationDepartmentListingResponse
items
array of object (ApplicationDepartment)
Array of ApplicationDepartment
page
object (Page)
Page
Examples
Parameters
companyId:
"value"
applicationId:
"value"
pageNo:
1
pageSize:
1
q:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List sales channel departments
getApplicationDepartmentListing
PATCH
Update sales channel department
Modify department data associated to the sales channel.
Parameters
company_id
string
Required
Id of the company associated to department custom json.
application_id
string
Required
application id for which the custom_json is associated.
department_uid
string
Required
department id for which the custom_json is associated.
Request body
_custom_json
object
Required
Response
200
4XX
Returns a success response
SuccessResponse1
success
boolean
uid
integer
Examples
Parameters
companyId:
"value"
applicationId:
"value"
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
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Response
200
4XX
List of Departments. See example below or refer `DepartmentResponse` for details.
DepartmentResponse
items
array of object (Department)
Array of Department
Examples
Parameters
companyId:
"value"
applicationId:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List departments
getDepartments
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 sales channel inventory
GET
# Get discounted inventory
GET
# Get product details
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
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
item_ids
array of integer
The Item Id of the product.
store_ids
array of integer
The Store Id of products to fetch inventory.
brand_ids
array of integer
The Brand Id of products to fetch inventory.
seller_identifiers
array of string
Unique seller_identifier of the product.
timestamp
string
Timestamp in UTC format (2020-07-23T10:27:50Z)
page_size
integer
The number of items to retrieve in each page.
Default Value : 12
page_id
string
Page ID to retrieve next set of results.
qty_gt
integer
This field allows you to filter for inventories that have quantity greater than to the specified value based on qty_type filter.
qty_lt
integer
This field allows you to filter for inventories that have a quantity less than to the specified value based on qty_type filter.
qty_type
string
This field provides flexibility in selecting filter for inventory quantity counts and date queries. For example, you might use this field to specify "total" or "sellable" quantity.
Enum
from_date
string
| date-time
Inventory updated on filter to get inventories greater then or equal to provided date based on qty_type value.
to_date
string
| date-time
Inventory updated on filter to get inventories less then or equal to provided date based on qty_type value.
Response
200
4XX
Success. Returns the article/stock of the product stock.
InventoryStockResponse
items
array of object
Default Value :
page
object (InventoryPage)
InventoryPage
Examples
Parameters
companyId:
"value"
applicationId:
"value"
itemIds:
0,1
storeIds:
0,1
brandIds:
0,1
sellerIdentifiers:
"lorem","ipsum"
timestamp:
"value"
pageSize:
1
pageId:
"value"
qtyGt:
1
qtyLt:
1
qtyType:
"value"
fromDate:
"value"
toDate:
"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
company_id
integer
Required
Id of the company associated to product that is to be viewed.
application_id
string
Required
Uniquer Application ID.
item_id
integer
Required
Item code of the product of which size is to be get.
size_identifier
string
Required
Size Identifier (Seller Identifier or Primary Identifier) of which inventory is to get.
page_no
integer
The page number to navigate through the given set of results
page_size
integer
Number of items to retrieve in each page. Default is 12.
Default Value : 12
q
string
Search with help of store code.
location_ids
array of integer
Search by store ids.
Response
200
4XX
returns a list of all inventory grouped by size and store
InventorySellerIdentifierResponsePaginated
items
array of object (InventorySellerResponse)
Array of InventorySellerResponse
page
object (Page)
Page
Examples
Parameters
companyId:
1
applicationId:
"value"
itemId:
1
sizeIdentifier:
"value"
pageNo:
1
pageSize:
1
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
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
slug
string
Required
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
brand
object (ProductBrand)
ProductBrand
color
string
description
string
grouped_attributes
array of object (ProductDetailGroupedAttribute)
Array of ProductDetailGroupedAttribute
has_variant
boolean
highlights
array of string
image_nature
string
item_code
string
item_type
string
medias
array of object (Media)
Array of Media
name
string
product_online_date
string
| date-time
promo_meta
object
rating
number
rating_count
integer
short_description
string
similars
array of string
slug
string
teaser_tag
object
tryouts
array of string
type
string
uid
integer
Examples
Parameters
companyId:
"value"
applicationId:
"value"
slug:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get product details
getProductDetailBySlug
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
company_id
string
Required
Id of the company associated to location custom json.
application_id
string
Required
application id for which the custom_json is associated.
store_uid
string
Required
store id for which the custom_json is associated.
Request body
_custom_json
object
Required
Response
200
4XX
Returns a success response
SuccessResponse1
success
boolean
uid
integer
Examples
Parameters
companyId:
"value"
applicationId:
"value"
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
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
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Response
200
4XX
The attached items of an collection. See example below or refer `GetQueryFiltersResponse` for details
GetQueryFiltersResponse
filters
array of object (ProductFilters)
Array of ProductFilters
operators
object
sort_on
array of object (ProductSortOn)
Array of ProductSortOn
Examples
Parameters
companyId:
"value"
applicationId:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get collection query filters
getQueryFilters
POST
Update default sorting
Modify the default sort key configuration for a company and an sales channel.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Request body
default_key
string
Required
Response
200
4XX
success message will tell whether the operation was successful.
ConfigSuccessResponse
message
string
Examples
Parameters
companyId:
"value"
applicationId:
"value"
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
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
config_type
string
Required
A `config_type` is an identifier that defines a specific type of configuration.
Enum
page_no
integer
The page number to navigate through the given set of results.
page_size
integer
Number of items to retrieve in each page. Default is 12.
search
string
Get configuration list filtered by `search` string.
Response
200
4XX
configuration details for catalog. See example below or refer `GetConfigResponseSchema` for details
GetConfigResponse
data
array of object
page
object (PageResponseType)
PageResponseType
Examples
Parameters
companyId:
"value"
applicationId:
"value"
configType:
"value"
pageNo:
1
pageSize:
1
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
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
config_type
string
Required
A `config_type` is a unique identifier for a particular listing configuration type.
Enum
Request body
app_id
string
Required
default_key
string
Required
is_active
boolean
Required
is_default
boolean
Required
key
string
Required
logo
string
| url
name
string
priority
integer
| value >= 1
Required
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
name
string
priority
integer
| value >= 1
Examples
Parameters
companyId:
"value"
applicationId:
"value"
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
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
config_type
string
Required
A `config_type` is an identifier that defines a specific type of configuration.
Enum
page_no
integer
The page number to navigate through the given set of results.
page_size
integer
Number of items to retrieve in each page. Default is 12.
search
string
Get configuration list filtered by `search` string.
template_slug
string
Get configuration list filtered by `template_slug` string. This is for the details and comparision groups.
Response
200
4XX
configuration details for catalog. See example below or refer `GetConfigResponseSchema` for details
GetConfigResponse
data
array of object
page
object (PageResponseType)
PageResponseType
Examples
Parameters
companyId:
"value"
applicationId:
"value"
configType:
"value"
pageNo:
1
pageSize:
1
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
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
config_type
string
Required
A `config_type` is a unique identifier for a particular group configuration type.
Enum
Request body
app_id
string
Required
attributes
array of object (AttributeDetailsGroup)
Array of AttributeDetailsGroup
is_active
boolean
Required
is_default
boolean
Required
logo
string
| url
name
string
priority
integer
| value >= 1
Required
slug
string
Required
template_slugs
array of string
Response
200
4XX
success flag will tell whether the operation was successful.
AppConfigurationDetail
app_id
string
attributes
array of object (AttributeDetailsGroup)
Array of AttributeDetailsGroup
is_active
boolean
is_default
boolean
logo
string
| url
name
string
priority
integer
| value >= 1
slug
string
template_slugs
array of string
Examples
Parameters
companyId:
"value"
applicationId:
"value"
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
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
config_type
string
Required
A `config_type` is a unique identifier for a particular group configuration type.
Enum
group_slug
string
Required
A `group_slug` is a unique identifier of a particular configuration.
Response
200
4XX
success message will tell whether the operation was successful.
ConfigSuccessResponse
message
string
Examples
Parameters
companyId:
"value"
applicationId:
"value"
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
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
config_type
string
Required
A `config_type` is a unique identifier for a particular group configuration type.
Enum
group_slug
string
Required
A `group_slug` is a unique identifier of a particular configuration.
Request body
app_id
string
Required
attributes
array of object (AttributeDetailsGroup)
Array of AttributeDetailsGroup
is_active
boolean
Required
is_default
boolean
Required
logo
string
| url
name
string
priority
integer
| value >= 1
Required
slug
string
Required
template_slugs
array of string
Response
200
4XX
success flag will tell whether the operation was successful.
AppConfigurationDetail
app_id
string
attributes
array of object (AttributeDetailsGroup)
Array of AttributeDetailsGroup
is_active
boolean
is_default
boolean
logo
string
| url
name
string
priority
integer
| value >= 1
slug
string
template_slugs
array of string
Examples
Parameters
companyId:
"value"
applicationId:
"value"
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
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
config_type
string
Required
A `config_type` is a unique identifier for a particular listing configuration type.
Enum
config_id
string
Required
A `config_id` is a unique identifier of a particular configuration.
Response
200
4XX
success message will tell whether the operation was successful.
ConfigSuccessResponse
message
string
Examples
Parameters
companyId:
"value"
applicationId:
"value"
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
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
config_type
string
Required
A `config_type` is a unique identifier for a particular listing configuration type.
Enum
config_id
string
Required
A `config_id` is a unique identifier of a particular configuration.
Request body
app_id
string
Required
default_key
string
Required
is_active
boolean
Required
is_default
boolean
Required
key
string
Required
logo
string
| url
name
string
priority
integer
| value >= 1
Required
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
name
string
priority
integer
| value >= 1
Examples
Parameters
companyId:
"value"
applicationId:
"value"
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
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
config_type
string
Required
A `config_type` is an identifier that defines a specific type of configuration.
Enum
template_slug
string
Get configuration list filtered by `template_slug` string. This is for the details and comparision groups.
page_no
integer
The page number to navigate through the given set of results.
page_size
integer
Number of items to retrieve in each page.
q
string
Get configuration list filtered by `q` string.
Response
200
4XX
configuration details for catalog. See example below or refer `GetConfigMetadataResponseSchema` for details
GetConfigMetadataResponse
condition
array of object (ConditionItem)
Array of ConditionItem
data
array of object (DataItem)
Array of DataItem
page
object (Page)
Page
values
object (GetConfigMetadataValues)
GetConfigMetadataValues
Examples
Parameters
companyId:
"value"
applicationId:
"value"
configType:
"value"
templateSlug:
"value"
pageNo:
1
pageSize:
1
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
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
item_id
string
Required
product id for a particular product.
Response
200
4XX
The Company Applicaton Product Data(MOQ/SEO).
OwnerAppItemResponse
alt_text
object
Default Value : [object Object]
is_cod
boolean
Default Value : true
is_gift
boolean
Default Value : false
moq
object (MOQData)
Default Value : [object Object]
MOQData
seo
object (SEOData)
Default Value : [object Object]
SEOData
_custom_json
object
Custom JSON data for the item
_custom_meta
array of object (MetaFields)
Custom meta fields for the item
Array of MetaFields
Examples
Parameters
companyId:
"value"
applicationId:
"value"
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
company_id
string
Required
Id of the company associated to custom meta.
application_id
string
Required
application id for which the custom_meta is associated.
item_id
string
Required
product id for which the custom_meta is associated.
Request body
_custom_json
object
Custom JSON data for the item
_custom_meta
array of object (MetaFields)
Custom meta fields for the item
Array of MetaFields
alt_text
object
Alternative text for the item's images
is_cod
boolean
Whether the item is available for Cash on Delivery (COD) or not
is_gift
boolean
Whether the item is a gift or not
moq
object (ApplicationItemMOQ)
Minimum Order Quantity information for the item
ApplicationItemMOQ
seo
object (ApplicationItemSEO)
Search Engine Optimization information for the item
ApplicationItemSEO
size_promotion_threshold
object (SizePromotionThreshold)
Size level promotion limitation information for item
SizePromotionThreshold
Response
200
4XX
Returns a success response
SuccessResponse1
success
boolean
uid
integer
Examples
Parameters
companyId:
"value"
applicationId:
"value"
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
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
q
string
The search query. This can be a partial or complete name of a either a product, brand or category
f
string
The search filter parameters. All the parameter filtered from filter parameters will be passed in **f** parameter in this format. **?f=brand:voi-jeans||and:::category:t-shirts||shirts**
c
string
The search filter parameters for collection items. All the parameter filtered from filter parameters will be passed in **c** parameter in this format. **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
filters
boolean
Pass `filters` parameter to fetch the filter details. This flag is used to fetch all filters
Default Value : true
is_dependent
boolean
This query parameter is used to get the dependent products in the listing.
Default Value : true
sort_on
string
The order to sort the list of products on. The supported sort parameters are popularity, price, redemption and discount in either ascending or descending order. See the supported values below.
Enum
page_id
string
Each response will contain **page_id** param, which should be sent back to make pagination work.
page_size
integer
Number of items to retrieve in each page. Default is 12.
Default Value : 12
page_no
integer
If page_type is number then pass it to fetch page items. Default is 1.
Default Value : 1
page_type
string
For pagination type should be cursor or number. Default is cursor.
Default Value : cursor
item_ids
array of integer
Item Ids of product
Response
200
4XX
List of Products. See example below or refer `ApplicationProductListingResponse` for details
ApplicationProductListingResponse
filters
array of object (ProductFilters)
Array of ProductFilters
items
array of object (ProductListingDetail)
Array of ProductListingDetail
operators
object
page
object (Page)
Page
sort_on
array of object (ProductSortOn)
Array of ProductSortOn
Examples
Parameters
companyId:
"value"
applicationId:
"value"
q:
"value"
f:
"value"
c:
"value"
filters:
false
isDependent:
false
sortOn:
"value"
pageId:
"value"
pageSize:
1
pageNo:
1
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
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
brand_ids
array of integer
Get multiple products filtered by Brand Ids
category_ids
array of integer
Get multiple products filtered by Category Ids
department_ids
array of integer
Get multiple products filtered by Department Ids
tags
array of string
Get multiple products filtered by tags
item_ids
array of integer
Get multiple products filtered by Item Ids
page_no
integer
The page number to navigate through the given set of results
page_size
integer
Number of items to retrieve in each page. Default is 10.
Default Value : 10
q
string
Search with Item Code, Name, Slug or Identifier.
Response
200
4XX
The Product object. See example below or refer `ApplicationProductListingResponseDatabasePowered` for details.
RawProductListingResponse
items
array of object (RawProduct)
Array of RawProduct
page
object (Page)
Page
Examples
Parameters
companyId:
"value"
applicationId:
"value"
brandIds:
0,1
categoryIds:
0,1
departmentIds:
0,1
tags:
"lorem","ipsum"
itemIds:
0,1
pageNo:
1
pageSize:
1
q:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List sales channel products
getAppProducts
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
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
company_id
string
Required
Id of the company whose locations are to fetched
application_id
string
Required
Id of the application whose locations are to fetched
store_type
string
Helps to sort the location list on the basis of location type.
uid
array of integer
Helps to sort the location list on the basis of uid list.
q
string
Query that is to be searched.
stage
string
to filter companies on basis of verified or unverified companies.
page_no
integer
The page number to navigate through the given set of results
Default Value : 1
page_size
integer
Number of items to retrieve in each page. Default is 20.
Default Value : 20
tags
array of string
Get locations filtered by tags.
store_types
array of string
Get locations filtered by store types.
Response
200
4XX
Company profile object. See example below or refer `LocationListSerializer` for details
LocationListSerializer
items
array of object (GetLocationSerializer)
Array of GetLocationSerializer
page
object (Page)
Page
Examples
Parameters
companyId:
"value"
applicationId:
"value"
storeType:
"value"
uid:
0,1
q:
"value"
stage:
"value"
pageNo:
1
pageSize:
1
tags:
"lorem","ipsum"
storeTypes:
"lorem","ipsum"
Was this section helpful?
GET
Loading...
Response
Loading...