Catalog
The Catalog - Platform Front APIs allow you to access a list of products, prices, seller details, similar features, variants, and many other useful resources.
Manage and interact with app-specific products. You can update app products and retrieve information about these products.
Operations
GET
# Get values of the selected value for the filter options.
GET
# Get filters keys of the filter options.
GET
# Get filter details for application
GET
# Retrieve application product data.
PATCH
# Update application product data.
GET
# Get Return configuration level set for an application
POST
# Create Return configuration level set for an application
PUT
# Update Return configuration level set for an application
DEL
# Delete Category level Application Return Configuration setttings
GET
# Get all category level configuration level set for an application
POST
# Create Category level Application Return Configuration setttings
PUT
# Update Category level Application Return Configuration setttings
POST
# Create price factory
GET
# Get price factory
GET
# Get price factory
PUT
# Edit a price factory
POST
# Add products to price factory
GET
# Get products listed in price factory
POST
# Add products in price factory in bulk
GET
# Poll bulk job for adding products in price factory.
POST
# Validate bulk job for adding products in price factory.
POST
# Process bulk job for adding products in price factory.
POST
# Export products of price factory.
GET
# poll job for adding products in price factory
GET
# Get product prices
Get query filters keys to configure a collection
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
filter_key
string
Required
A `filter_key` is a filter key for a for which all the available filter values will returned. channel.
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"
collection_id
string
A `collection_id` is a unique identifier for a particular collection. 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 10.
Default Value : 10
q
string
The `q` parameter allows you to search and filter specific data within the filter options. It acts as a query keyword that can refine the results by matching relevant filter values, such as a category name or any other applicable filter criteria.
Response
200
The attached items of an collection.
GetQueryFiltersValuesResponseSchema
values
array of object (ProductQueryFiltersValue)
A list of filter values that can be used for querying products.
Array of ProductQueryFiltersValue
display
string
The human-readable name of the category to be displayed.
count
integer
The number of items or products associated with this category.
is_selected
boolean
Indicates whether this category is currently selected by the user.
value
string
The internal value or identifier representing this category.
logo
string
| url
URL of the logo image associated with the category.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
1
application_id:
"64c00b72c07acacc1357503b"
filter_key:
"category"
c:
"department:in:department11"
collection_id:
"65620443a7d23306c5d75df2"
page_no:
4
page_size:
4
q:
"category"
Was this section helpful?
GET
Response
Get values of the selected value for the filter options.
getApplicationFilterValues
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
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"
Response
200
The attached items of an collection.
GetQueryFiltersKeysResponseSchema
filters
array of object (ProductFiltersKeysOnly)
An array of available filter keys for querying products.
Array of ProductFiltersKeysOnly
key
object (ProductFiltersKey)
ProductFiltersKey
display
string
kind
string
logo
string
| url
name
string
operators
array of string
operators
object
A map of available operators that can be used for querying, where the key is the operator type and the value is a string.
sort_on
array of object (ProductSortOn)
An array of sorting options available for the products.
Array of ProductSortOn
is_selected
boolean
Indicates whether this sorting option is currently selected.
name
string
The display name of the sorting option, used to show on the UI.
value
string
The value representing the sorting option.
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
c:
"department:in:department11"
Was this section helpful?
GET
Response
Get filters keys of the filter options.
getApplicationFilterKeys
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
filter
string
Required
Filter whose values needs to be fetched.
Response
200
Get application level filter details for metadata. See example below or refer `FilterResponseSchema` for details
FilterResponseSchema
values
array of object (ValueItem)
Array of ValueItem
text
string
value
string
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
filter:
"image_nature"
Was this section helpful?
GET
Response
Get filter details for application
getConfigurationsFilterMetadata
Products are the core resource of an application. If successful, returns a Company Application Product resource in the response body depending upon filter sent.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
item_id
integer
Required
product id for a particular product.
Response
200
The Company Applicaton Product Data(MOQ/SEO).
OwnerAppItemResponseSchema
alt_text
object
Alternate text associated with the item, typically for accessibility purposes.
Default Value : [object Object]
is_cod
boolean
Indicates whether Cash on Delivery (COD) is available for this item.
Default Value : true
is_gift
boolean
Indicates whether the item is marked as a gift.
Default Value : false
moq
object (MOQData)
Minimum order quantity (MOQ) details for the item, including minimum units and increment units.
Default Value : [object Object]
MOQData
increment_unit
integer
The unit by which the quantity can be incremented after the minimum order quantity.
Default Value : 1
maximum
integer
The maximum number of units that can be ordered for the item.
minimum
integer
The minimum number of units required to place an order for the item.
Default Value : 1
seo
object (SEOData)
Search Engine Optimization (SEO) related information, including title, description, sitemap details, and meta tags.
Default Value : [object Object]
SEOData
description
string
A brief description of the item, primarily used for SEO purposes.
Default Value :
title
string
The title of the item, primarily used for SEO and displayed in search engine results.
Default Value :
sitemap
object (Sitemap)
Sitemap
priority
number
frequency
string
breadcrumbs
array of object (ApplicationItemSeoBreadcrumbs)
An ordered list of links showing the hierarchy of the page, aiding navigation and SEO.
Array of ApplicationItemSeoBreadcrumbs
url
string
action
array of object (ApplicationItemSeoAction)
Array of ApplicationItemSeoAction
page
object
type
string
meta_tags
array of object (Metatags)
A list of meta tags for the item, used for SEO optimization.
Array of Metatags
title
string
items
array of object (ApplicationItemSeoMetaTags)
Array of ApplicationItemSeoMetaTags
title
string
items
array of object (ApplicationItemSeoMetaTagItem)
Array of ApplicationItemSeoMetaTagItem
key
string
value
string
canonical_url
string
The canonical URL for the item, indicating the preferred URL for search engines to avoid duplicate content.
Default Value :
_custom_json
object
Custom JSON data for the item, allowing flexibility for additional item-specific information.
_custom_meta
array of object (MetaFields)
An array of custom meta fields associated with the item for extended metadata.
Array of MetaFields
key
string
The key of the metadata. Should be a non-empty string and length should not exceed 30 characters.
Minimum Length : 1
Maximum Length : 30
value
string
The value of the metadata. Should be a non-empty string and length should not exceed 100 characters.
Minimum Length : 1
Maximum Length : 100
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
item_id:
2
Was this section helpful?
GET
Response
Retrieve application product data.
getAppProduct
Allows to update data associated to a item by its item_id for a sales
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
item_id
integer
Required
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
key
string
Required
The key of the metadata. Should be a non-empty string and length should not exceed 30 characters.
Minimum Length : 1
Maximum Length : 30
value
string
Required
The value of the metadata. Should be a non-empty string and length should not exceed 100 characters.
Minimum Length : 1
Maximum Length : 100
alt_text
object
Alternative text for the item's images
is_cod
boolean
Whether the item is available for Cash on Delivery (COD) or not
is_gift
boolean
Whether the item is a gift or not
moq
object (ApplicationItemMOQ)
ApplicationItemMOQ
increment_unit
integer
| value >= 1
The minimum quantity increment in which the item can be purchased.
Default Value : 1
maximum
integer
The maximum quantity allowed for purchase.
minimum
integer
| value >= 1
The minimum quantity required for purchase.
Default Value : 1
seo
object (ApplicationItemSEO)
ApplicationItemSEO
description
string
The SEO description of the item
title
string
The SEO title of the item
sitemap
object (ApplicationItemSeoSitemap)
ApplicationItemSeoSitemap
priority
number
Required
The SEO priority of the item
frequency
string
Required
The SEO frequency of the item
breadcrumbs
array of object (ApplicationItemSeoBreadcrumbs)
Array of ApplicationItemSeoBreadcrumbs
url
string
action
array of object (ApplicationItemSeoAction)
Array of ApplicationItemSeoAction
page
object
type
string
Required
meta_tags
array of object (ApplicationItemSeoMetaTags)
Array of ApplicationItemSeoMetaTags
title
string
Required
items
array of object (ApplicationItemSeoMetaTagItem)
Array of ApplicationItemSeoMetaTagItem
key
string
Required
value
string
Required
canonical_url
string
size_promotion_threshold
object (SizePromotionThreshold)
SizePromotionThreshold
threshold_type
string
The type of threshold that applies to the size promotion, such as 'quantity' or 'value'.
threshold_value
integer
The value of the threshold required to trigger the promotion, such as a minimum number of units.
Response
200
400
Returns a success response
SuccessResponse1Schema
success
boolean
uid
integer
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
item_id:
2
body:
body
Was this section helpful?
PATCH
Response
Update application product data.
updateAppProduct
Get Product Return configuration set at an application level
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Response
200
success message will tell whether the operation was successful.
AppReturnConfigResponseSchema
created_by
object (UserInfo)
UserInfo
email
string
| email
The email address of the user.
uid
string
The unique ID of the user.
user_id
string
The ID of the user.
username
string
The username of the user.
modified_by
object (UserInfo)
UserInfo
email
string
| email
The email address of the user.
uid
string
The unique ID of the user.
user_id
string
The ID of the user.
username
string
The username of the user.
app_id
string
Channel identifier
category_count
integer
Count of L3 category return config set for application
company_id
integer
Unique identifer of company
modified_on
string
| date-time
Modification date
return_config_level
string
configuration level of return window category|product|no-return
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
Was this section helpful?
GET
Response
Get Return configuration level set for an application
getAppReturnConfiguration
Create Return configuration level set for an application.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Request body
app_id
string
company_id
integer
return_config_level
string
Required
Return configurtion Level category|product|no-return
Enum
Response
200
400
success message will tell whether the operation was successful.
SuccessResponse1Schema
success
boolean
uid
integer
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
body:
body
Was this section helpful?
POST
Response
Create Return configuration level set for an application
createAppReturnConfiguration
Update Return configuration level set for an application.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Request body
app_id
string
company_id
integer
return_config_level
string
Required
Return configurtion Level category|product|no-return
Enum
Response
200
400
success message will tell whether the operation was successful.
SuccessResponse1Schema
success
boolean
uid
integer
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
body:
body
Was this section helpful?
PUT
Response
Update Return configuration level set for an application
updateAppReturnConfiguration
Delete Category level Application Return Configuration setttings
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Request body
category_ids
array of integer
Required
List of category_ids to be deleted.
Maximum Items : 50
Response
200
400
success message will tell whether the operation was successful.
SuccessResponseSchema
success
boolean
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
body:
body
Was this section helpful?
DEL
Response
Delete Category level Application Return Configuration setttings
deleteAppCategoryReturnConfiguration
Get all category level configuration level set for an application.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sales channel.
q
string
Get return configurations for categories by matching the search string with category names.
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 10.
Default Value : 12
Response
200
success message will tell whether the operation was successful.
BaseAppCategoryReturnConfigResponseSchema
data
array of object (AppCategoryReturnConfigResponseSchema)
Array of AppCategoryReturnConfigResponseSchema
app_id
string
Channel identifier
category_id
integer
Unique identifer of L3 category
logo
string
name
string
Name of L3 category
return_config
object (ProductReturnConfigBaseSchema)
ProductReturnConfigBaseSchema
returnable
boolean
Boolean Flag for item returnable
time
integer
Valid return time for an item
unit
string
Unit of return config days|hours
Enum
page
object (PageResponseSchema)
PageResponseSchema
current
integer
It is the current page of the page response schema.
has_next
boolean
It is the bool indicates if there is a next page.
has_previous
boolean
It is the bool indicates if there is a previous page.
item_total
integer
It is the total number of item present for the filter.
size
integer
It is the size of each page.
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
q:
"Black Jeans"
page_no:
2
page_size:
50
Was this section helpful?
GET
Response
Get all category level configuration level set for an application
getAppCategoryReturnConfig
Create Category level Application Return Configuration setttings
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Request body
data
array of object (AppCategoryReturnConfig)
Required
Category level return config details
Maximum Items : 50
Array of AppCategoryReturnConfig
category_id
integer
Required
Unique identifier for L3 category
return_config
object (ProductReturnConfigBaseSchema)
Required
ProductReturnConfigBaseSchema
returnable
boolean
Required
Boolean Flag for item returnable
time
integer
Required
Valid return time for an item
unit
string
Required
Unit of return config days|hours
Enum
Response
200
400
success message will tell whether the operation was successful.
SuccessResponse1Schema
success
boolean
uid
integer
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
body:
body
Was this section helpful?
POST
Response
Create Category level Application Return Configuration setttings
createAppCategoryReturnConfiguration
Update Category level Application Return Configuration setttings
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Request body
data
array of object (AppCategoryReturnConfig)
Required
Category level return config details
Maximum Items : 50
Array of AppCategoryReturnConfig
category_id
integer
Required
Unique identifier for L3 category
return_config
object (ProductReturnConfigBaseSchema)
Required
ProductReturnConfigBaseSchema
returnable
boolean
Required
Boolean Flag for item returnable
time
integer
Required
Valid return time for an item
unit
string
Required
Unit of return config days|hours
Enum
Response
200
400
success message will tell whether the operation was successful.
SuccessResponseSchema
success
boolean
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
body:
body
Was this section helpful?
PUT
Response
Update Category level Application Return Configuration setttings
updateAppCategoryReturnConfiguration
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular company.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Request body
name
string
code
string
is_active
boolean
factory_type_ids
array of string
department_ids
array of integer
application_id
string
factory_type
string
currency
string
currency_symbol
string
Response
200
400
Returns a success response
CreateAppPriceFactoryResponseSchema
factory_type
string
Type of the factory.
is_active
boolean
Indicates whether the factory is active or not.
code
string
Code associated with the factory.
factory_type_ids
array of string
Array of unique identifiers associated with the factory type.
currency
string
Currency associated with the factory.
application_id
string
Unique identifier for the application.
created_on
string
| date-time
Date and time when the factory was created.
created_by
object (UserInfo)
UserInfo
email
string
| email
The email address of the user.
uid
string
The unique ID of the user.
user_id
string
The ID of the user.
username
string
The username of the user.
modified_by
object (UserInfo)
UserInfo
email
string
| email
The email address of the user.
uid
string
The unique ID of the user.
user_id
string
The ID of the user.
username
string
The username of the user.
name
string
Name of the factory.
department_ids
array of integer
Array of department identifiers associated with the factory.
modified_on
string
| date-time
Date and time when the factory was last modified.
_id
string
Unique identifier for the factory.
Examples
Parameters
company_id:
1
application_id:
"507f1f77bcf86cd799439011"
body:
body
Was this section helpful?
POST
Response
Create price factory
createAppPriceFactory
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular company.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
is_active
boolean
gets price factory filtered by active status.
factory_type_id
string
gets price factory filtered by factory_type_id.
code
string
gets price factory filtered by pricezone code.
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
Returns a success response
GetAppPriceFactoryResponseSchema
items
array of object (AppPriceFactory)
Array of AppPriceFactory
_id
string
application_id
string
department_ids
array of integer
factory_type
string
Enum
factory_type_ids
array of string
code
string
name
string
is_active
boolean
currency
string
created_by
object (UserInfo)
UserInfo
email
string
| email
The email address of the user.
uid
string
The unique ID of the user.
user_id
string
The ID of the user.
username
string
The username of the user.
modified_by
object (UserInfo)
UserInfo
email
string
| email
The email address of the user.
uid
string
The unique ID of the user.
user_id
string
The ID of the user.
username
string
The username of the user.
created_on
string
| date-time
modified_on
string
| date-time
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
1
application_id:
"507f1f77bcf86cd799439011"
is_active:
true
factory_type_id:
"507f1f77bcf86cd799439011"
code:
"pricezone"
page_no:
1
page_size:
12
Was this section helpful?
GET
Response
Get price factory
getAppPriceFactories
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular company.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
id
string
Required
An `id` is a unique identifier for a particular price factory.
Response
200
Returns a success response
AppPriceFactory
_id
string
application_id
string
department_ids
array of integer
factory_type
string
Enum
factory_type_ids
array of string
code
string
name
string
is_active
boolean
currency
string
created_by
object (UserInfo)
UserInfo
email
string
| email
The email address of the user.
uid
string
The unique ID of the user.
user_id
string
The ID of the user.
username
string
The username of the user.
modified_by
object (UserInfo)
UserInfo
email
string
| email
The email address of the user.
uid
string
The unique ID of the user.
user_id
string
The ID of the user.
username
string
The username of the user.
created_on
string
| date-time
modified_on
string
| date-time
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
application_id:
"507f1f77bcf86cd799439011"
id:
"507f1f77bcf86cd799439011"
Was this section helpful?
GET
Response
Get price factory
getAppPriceFactory
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular company.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
id
string
Required
An `id` is a unique identifier for a particular price factory.
Request body
name
string
code
string
is_active
boolean
factory_type_ids
array of string
department_ids
array of integer
application_id
string
factory_type
string
currency
string
currency_symbol
string
Response
200
Success response
AppPriceFactory
_id
string
application_id
string
department_ids
array of integer
factory_type
string
Enum
factory_type_ids
array of string
code
string
name
string
is_active
boolean
currency
string
created_by
object (UserInfo)
UserInfo
email
string
| email
The email address of the user.
uid
string
The unique ID of the user.
user_id
string
The ID of the user.
username
string
The username of the user.
modified_by
object (UserInfo)
UserInfo
email
string
| email
The email address of the user.
uid
string
The unique ID of the user.
user_id
string
The ID of the user.
username
string
The username of the user.
created_on
string
| date-time
modified_on
string
| date-time
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
application_id:
"507f1f77bcf86cd799439011"
id:
"507f1f77bcf86cd799439011"
body:
body
Was this section helpful?
PUT
Response
Edit a price factory
editAppPriceFactory
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular company.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
id
string
Required
An `id` is a unique identifier for a particular price factory.
Request body
items
array of object (CreateAppPriceFactoryProductItem)
Array of CreateAppPriceFactoryProductItem
name
string
item_id
integer
seller_identifier
string
marked_price
number
selling_price
number
zone
string
command
string
Response
200
400
Success response
CreatePriceFactoryProductResponseSchema
total_records
integer
success_records
integer
failed_records
integer
failed_records_data
array of object (FailedRecordsData)
Array of FailedRecordsData
item_id
integer
error
string
stage
string
Examples
Parameters
company_id:
1
application_id:
"507f1f77bcf86cd799439011"
id:
"507f1f77bcf86cd799439011"
body:
body
Was this section helpful?
POST
Response
Add products to price factory
addProductsInPriceFactoryByZoneId
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular company.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
id
string
Required
An `id` is a unique identifier for a particular price factory.
zone_id
string
Required
An `zone_id` is a unique identifier for a particular price factory zone.
item_id
number
gets price factory filtered by item_id.
q
string
gets price factory filtered by search query.
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
Success response
CreateAppPriceFactoryProductsResponseSchema
items
array of object (CreateAppPriceFactoryProductResponseSchema)
Array of CreateAppPriceFactoryProductResponseSchema
item_id
integer
item_name
string
item_code
string
brand
string
category
string
factory_type_id
array of string
media
array of object (Media)
Array of Media
meta
object
A metadata object containing additional information about the media, such as dimensions, format, or other relevant details.
type
string
The type of media.
Enum
url
string
The URL where the media can be accessed.
alt
string
The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed.
thumbnail
string
The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media.
sizes
array of object (PriceFactorySizes)
Array of PriceFactorySizes
size_name
string
seller_identifier
string
marked_price
number
selling_price
number
currency
string
is_active
boolean
company_sizes
array of object (CompanySizes)
Array of CompanySizes
size_name
string
seller_identifier
string
marked_price
number
selling_price
number
currency
string
is_active
boolean
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
1
application_id:
"507f1f77bcf86cd799439011"
id:
"507f1f77bcf86cd799439011"
zone_id:
"507f1f77bcf86cd799439011"
item_id:
1234
q:
"test"
page_no:
1
page_size:
12
Was this section helpful?
GET
Response
Get products listed in price factory
getProductsInPriceFactoryByZoneId
This API allows to create bulk job for adding products in price factory.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular company.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
id
string
Required
An `id` is a unique identifier for a particular price factory.
Request body
file_path
string
file_type
string
job_type
string
Response
200
Success response
CreateAppPriceFactoryProductBulkJobResponseSchema
job_id
string
status
string
file_type
string
stage
string
created_by
object (UserInfo)
UserInfo
email
string
| email
The email address of the user.
uid
string
The unique ID of the user.
user_id
string
The ID of the user.
username
string
The username of the user.
company_id
integer
job_type
string
total_records
integer
is_active
boolean
modified_on
string
| date-time
application_id
string
factory_id
string
modified_by
object (UserInfo)
UserInfo
email
string
| email
The email address of the user.
uid
string
The unique ID of the user.
user_id
string
The ID of the user.
username
string
The username of the user.
created_on
string
| date-time
failed_records
integer
file_path
string
success_records
integer
_id
string
Examples
Parameters
company_id:
1
application_id:
"507f1f77bcf86cd799439011"
id:
"507f1f77bcf86cd799439011"
body:
body
Was this section helpful?
POST
Response
Add products in price factory in bulk
createProductPriceFactoryBulkJob
This API allows to poll bulk job for adding products in price factory.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular company.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
id
string
Required
An `id` is a unique identifier for a particular price factory.
job_id
string
Required
A `job_id` is a unique identifier for a particular bulk job.
Response
200
Success response
CreateAppPriceFactoryProductBulkJobPollResponseSchema
status
string
total_records
integer
success_records
integer
failed_records
integer
error_file
string
created_on
string
| date-time
modified_on
string
| date-time
created_by
object (UserInfo)
UserInfo
email
string
| email
The email address of the user.
uid
string
The unique ID of the user.
user_id
string
The ID of the user.
username
string
The username of the user.
modified_by
object (UserInfo)
UserInfo
email
string
| email
The email address of the user.
uid
string
The unique ID of the user.
user_id
string
The ID of the user.
username
string
The username of the user.
stage
string
Current stage of the process
is_active
boolean
Flag indicating if is active
_id
string
Unique identifier for the response
error_file_url
string
Nullable
URL to the error file, if any
Examples
Parameters
company_id:
1
application_id:
"507f1f77bcf86cd799439011"
id:
"507f1f77bcf86cd799439011"
job_id:
"507f1f77bcf86cd799439011"
Was this section helpful?
GET
Response
Poll bulk job for adding products in price factory.
pollProductPriceFactoryBulkJob
This API allows to validate bulk job for adding products in price factory.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular company.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
id
string
Required
An `id` is a unique identifier for a particular price factory.
job_id
string
Required
A `job_id` is a unique identifier for a particular bulk job.
Request body
file_path
string
file_type
string
job_type
string
Response
200
400
Success response
CreateAppPriceFactoryProductBulkJobValidateResponseSchema
job_type
string
file_type
string
file_path
string
| uri
job_id
string
status
string
created_on
string
| date-time
modified_on
string
| date-time
created_by
object (UserInfo)
UserInfo
email
string
| email
The email address of the user.
uid
string
The unique ID of the user.
user_id
string
The ID of the user.
username
string
The username of the user.
modified_by
object (UserInfo)
UserInfo
email
string
| email
The email address of the user.
uid
string
The unique ID of the user.
user_id
string
The ID of the user.
username
string
The username of the user.
Examples
Parameters
company_id:
1
application_id:
"507f1f77bcf86cd799439011"
id:
"507f1f77bcf86cd799439011"
job_id:
"507f1f77bcf86cd799439011"
body:
body
Was this section helpful?
POST
Response
Validate bulk job for adding products in price factory.
validateProductPriceFactoryBulkJob
This API allows to process bulk job for adding products in price factory.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular company.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
id
string
Required
An `id` is a unique identifier for a particular price factory.
job_id
string
Required
A `job_id` is a unique identifier for a particular bulk job.
Request body
file_path
string
file_type
string
job_type
string
Response
200
400
Success response
CreateAppPriceFactoryProductBulkJobResponseSchema
job_id
string
status
string
file_type
string
stage
string
created_by
object (UserInfo)
UserInfo
email
string
| email
The email address of the user.
uid
string
The unique ID of the user.
user_id
string
The ID of the user.
username
string
The username of the user.
company_id
integer
job_type
string
total_records
integer
is_active
boolean
modified_on
string
| date-time
application_id
string
factory_id
string
modified_by
object (UserInfo)
UserInfo
email
string
| email
The email address of the user.
uid
string
The unique ID of the user.
user_id
string
The ID of the user.
username
string
The username of the user.
created_on
string
| date-time
failed_records
integer
file_path
string
success_records
integer
_id
string
Examples
Parameters
company_id:
1
application_id:
"507f1f77bcf86cd799439011"
id:
"507f1f77bcf86cd799439011"
job_id:
"507f1f77bcf86cd799439011"
body:
body
Was this section helpful?
POST
Response
Process bulk job for adding products in price factory.
processProductPriceFactoryBulkJob
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular company.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
id
string
Required
An `id` is a unique identifier for a particular price factory.
Request body
sample_with_data
boolean
Response
200
400
Success response
CreateAppPriceFactoryProductExportJobResponseSchema
job_type
string
company_id
integer
file_type
string
_id
string
created_on
string
| date-time
modified_on
string
| date-time
created_by
object (UserInfo)
UserInfo
email
string
| email
The email address of the user.
uid
string
The unique ID of the user.
user_id
string
The ID of the user.
username
string
The username of the user.
modified_by
object (UserInfo)
UserInfo
email
string
| email
The email address of the user.
uid
string
The unique ID of the user.
user_id
string
The ID of the user.
username
string
The username of the user.
success_records
integer
application_id
string
total_records
integer
factory_id
string
is_active
boolean
stage
string
failed_records
integer
Examples
Parameters
company_id:
1
application_id:
"507f1f77bcf86cd799439011"
id:
"507f1f77bcf86cd799439011"
body:
body
Was this section helpful?
POST
Response
Export products of price factory.
exportProductsInPriceFactory
This API allows to poll job for adding products in price factory.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular company.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
id
string
Required
An `id` is a unique identifier for a particular price factory.
start_date
string
| date
Date that filters the jobs created after this date
end_date
string
| date
Date that filters the jobs created before this date
stage
array of string
Filter jobs by the stage
Enum
is_active
boolean
Filter active or inactive jobs
q
string
Pass unique identifier for a particular job to poll
type
array of string
Pass type for a particular job to poll
Enum
Response
200
Success response
CreateAppPriceFactoryProductExportJobPollResponseSchema
items
array of object (AppPriceFactoryProductExportPollJobResponseSchema)
Array of AppPriceFactoryProductExportPollJobResponseSchema
id
string
stage
string
is_active
boolean
created_on
string
| date-time
total_records
integer
success_records
integer
failed_records
integer
job_type
string
Enum
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
1
application_id:
"507f1f77bcf86cd799439011"
id:
"507f1f77bcf86cd799439011"
start_date:
"2024-03-08"
end_date:
"2024-03-08"
stage:
"pending"
is_active:
true
q:
"507f1f77bcf86cd799439011"
type:
"upload"
Was this section helpful?
GET
Response
poll job for adding products in price factory
pollPriceFactoryJobs
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular company.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
item_ids
array of integer
List of item ids to get product prices filtered by items.
factory_type_ids
array of string
List of factory type ids to get product prices filtered by factory type id.
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 10.
Default Value : 12
Response
200
Returns a success response
ProductPrices
data
array of object (ProductPriceItem)
Array of ProductPriceItem
discount_meta
object (DiscountMeta)
DiscountMeta
start
string
end
string
timer
boolean
product_name
string
item_id
number
factory_type_id
string
price
object (ProductPrice)
ProductPrice
selling
object (ProductMinMaxPrice)
ProductMinMaxPrice
min
number
max
number
effective
object (ProductMinMaxPrice)
ProductMinMaxPrice
min
number
max
number
marked
object (ProductMinMaxPrice)
ProductMinMaxPrice
min
number
max
number
currency
string
store_id
number
is_sellable
boolean
seller_id
number
delivery_zone_ids
array of string
sizes
array of string
page
object (ProductPricesPage)
ProductPricesPage
type
string
current
number
size
number
item_total
number
has_previous
boolean
has_next
boolean
Examples
Parameters
company_id:
1
application_id:
"507f1f77bcf86cd799439011"
item_ids:
7633128
factory_type_ids:
"65c0790dccf2ef52e9ed5d53"
page_no:
1
page_size:
1
Was this section helpful?
GET
Response
Get product prices
getAppProductPrices
Access application-related data, including brands, categories, departments, and locations. Perform various operations like retrieving product details by slug, managing brand listings, updating brand information, handling category listings, updating category details, managing department listings, and updating department information.
Operations
GET
# Get application brand listing.
PATCH
# Update application brand.
GET
# Get application brands.
GET
# Get categories.
GET
# Get application category listing.
PATCH
# Update application category.
GET
# Get application department listing.
PATCH
# Update application department.
GET
# Get departments.
GET
# Get application inventory.
GET
# Get application locations.
GET
# Get application products.
GET
# Get product details by slug.
GET
# Get application products.
PATCH
# Update application location.
Retrieve brand listings related to the application. 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
400
List of Brands.
ApplicationBrandListingSchema
items
array of object (ApplicationBrandListingItemSchema)
Array of ApplicationBrandListingItemSchema
_custom_json
object
Custom JSON object for additional data.
_locale_language
object
Custom object for locale-specific language data.
Default Value : [object Object]
brand_banner_portrait_url
string
URL of the brand's portrait banner.
brand_banner_url
string
URL of the brand's landscape banner.
brand_logo_url
string
URL of the brand's logo.
description
string
Description of the brand.
name
string
Name of the brand.
slug_key
string
Unique slug key for the brand.
priority
integer
Priority of the brand in listing.
uid
integer
Unique identifier of the brand.
created_on
string
| date-time
Timestamp when the category was created.
last_updated
string
| date-time
Timestamp when the category was created.
is_active
boolean
Indicates if the brand is active.
departments
array of integer
List of department IDs associated with the brand.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
"1"
application_id:
"64aed475db2cfb5b8a9f623d"
page_no:
1
page_size:
1
q:
"test"
Was this section helpful?
GET
Response
Get application brand listing.
getApplicationBrandListing
Parameters
company_id
integer
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
integer
Required
brand id for which the custom_json is associated.
Request body
_custom_json
object
Required
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
400
Returns a success response
SuccessResponse1Schema
success
boolean
uid
integer
Examples
Parameters
company_id:
1
application_id:
"64aed475db2cfb5b8a9f623d"
brand_uid:
1
body:
body
Was this section helpful?
PATCH
Response
Update application brand.
updateAppBrand
List all the brands. A brand is the name under which a product is being sold.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
department
string
The name of the department. Use this parameter to filter products by a particular department. See below the list of available departments. You can retrieve available departments from the **v1.0/departments/** API
page_no
integer
The page number to navigate through the given set of results
page_size
integer
Number of items to retrieve in each page. Default is 12.
Default Value : 12
q
string
Search query with brand name.Use this parameter to search brands by brand name.
brand_id
array of integer
Helps to sort the brands list on the basis of uid list.
Response
200
400
List of Brands.
BrandListingResponseSchema
items
array of object (BrandItem)
Array of BrandItem
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
banners
object (ImageUrls)
ImageUrls
landscape
object (BannerImage)
BannerImage
aspect_ratio
string
type
string
url
string
| url
portrait
object (BannerImage)
BannerImage
aspect_ratio
string
type
string
url
string
| url
departments
array of integer
discount
string
logo
object (BrandLogo)
BrandLogo
url
string
type
string
name
string
slug
string
uid
integer
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
department:
"electronics"
page_no:
1
page_size:
1
q:
"test"
brand_id:
2
Was this section helpful?
GET
Response
Get application brands.
getApplicationBrands
Retrieve a list of categories. Optionally pass filter the brands by the department.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
department
string
The name of the department. Use this parameter to filter products by a particular department. See below the list of available departments. You can retrieve available departments from the **v1.0/departments/** API
Response
200
List of Categories.
CategoryListingResponseSchema
data
array of object (DepartmentCategoryTree)
Array of DepartmentCategoryTree
department
string
items
array of object (CategoryItems)
Array of CategoryItems
_custom_json
object
Nullable
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
banners
object (ImageUrls)
ImageUrls
landscape
object (BannerImage)
BannerImage
aspect_ratio
string
type
string
url
string
| url
portrait
object (BannerImage)
BannerImage
aspect_ratio
string
type
string
url
string
| url
childs
array of object (Child)
Array of Child
_custom_json
object
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
banners
object (ImageUrls)
ImageUrls
landscape
object (BannerImage)
BannerImage
aspect_ratio
string
type
string
url
string
| url
portrait
object (BannerImage)
BannerImage
aspect_ratio
string
type
string
url
string
| url
childs
array of object (SecondLevelChild)
Array of SecondLevelChild
_custom_json
object
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
banners
object (ImageUrls)
ImageUrls
landscape
object (BannerImage)
BannerImage
aspect_ratio
string
type
string
url
string
| url
portrait
object (BannerImage)
BannerImage
aspect_ratio
string
type
string
url
string
| url
childs
array of object (ThirdLevelChild)
Array of ThirdLevelChild
_custom_json
object
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
banners
object (ImageUrls)
ImageUrls
landscape
object (BannerImage)
BannerImage
aspect_ratio
string
type
string
url
string
| url
portrait
object (BannerImage)
BannerImage
aspect_ratio
string
type
string
url
string
| url
childs
array of object
name
string
slug
string
uid
integer
name
string
slug
string
uid
integer
name
string
slug
string
uid
integer
name
string
slug
string
uid
integer
departments
array of object (DepartmentIdentifier)
Array of DepartmentIdentifier
name
string
slug
string
uid
integer
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
department:
"electronics"
Was this section helpful?
GET
Response
Get categories.
getCategories
Retrieve category listings related to the application. A brand is the name under which a product is being sold.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
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
List of Brands.
ApplicationCategoryListingSchema
items
array of object (ApplicationCategoryListingItemSchema)
Array of ApplicationCategoryListingItemSchema
name
string
Name of the category.
logo
string
URL of the category's logo.
departments
array of integer
List of department IDs.
attr_name
string
Attribute name of the category.
landscape_url
string
URL of the landscape banner.
portrait_url
string
URL of the portrait banner.
_custom_json
object
Custom JSON object for additional data.
priority
integer
Priority of the category.
created_by
object (UserInfo)
UserInfo
email
string
| email
The email address of the user.
uid
string
The unique ID of the user.
user_id
string
The ID of the user.
username
string
The username of the user.
created_on
string
| date-time
Timestamp when the category was created.
modified_by
object (UserInfo)
UserInfo
email
string
| email
The email address of the user.
uid
string
The unique ID of the user.
user_id
string
The ID of the user.
username
string
The username of the user.
modified_on
string
| date-time
Timestamp when the category was last modified.
app_id
string
Application ID associated with the category.
is_active
boolean
Indicates whether the category is active.
uid
integer
Unique identifier of the category.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
1
application_id:
"64aed475db2cfb5b8a9f623d"
department_id:
1
page_no:
1
page_size:
1
q:
"test"
Was this section helpful?
GET
Response
Get application category listing.
getApplicationCategoryListing
Modify category data related to the application. Helps to update data associated to a item custom meta.
Parameters
company_id
integer
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
integer
Required
category id for which the custom_json is associated.
Request body
_custom_json
object
Required
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
400
Returns a success response
SuccessResponse1Schema
success
boolean
uid
integer
Examples
Parameters
company_id:
1
application_id:
"64aed475db2cfb5b8a9f623d"
category_uid:
1
body:
body
Was this section helpful?
PATCH
Response
Update application category.
updateAppCategory
Retrieve department listings related to the application. Departments are a way to categorise similar products. A product can lie in multiple departments.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
page_no
integer
The page number to navigate through the given set of results
page_size
integer
Number of items to retrieve in each page. Default is 12.
Default Value : 12
q
string
Search query with brand name.Use this parameter to search department by name.
Response
200
List of Departments.
ApplicationDepartmentListingResponseSchema
items
array of object (ApplicationDepartment)
Array of ApplicationDepartment
_custom_json
object
Custom JSON data specific to the department, used to store additional attributes or configurations.
app_id
string
Unique identifier for the application to which the department belongs.
is_active
boolean
Indicates whether the department is currently active within the application.
logo
string
URL or path to the logo representing the department.
name
string
Name of the department within the application.
uid
integer
Unique identifier for the department.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
1
application_id:
"64c00b72c07acacc1357503b"
page_no:
1
page_size:
1
q:
"test"
Was this section helpful?
GET
Response
Get application department listing.
getApplicationDepartmentListing
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
application id for which the custom_json is associated.
department_uid
integer
Required
department id for which the custom_json is associated.
Request body
_custom_json
object
Required
A custom JSON object containing additional details or configurations specific to the application department.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
400
Returns a success response
SuccessResponse1Schema
success
boolean
uid
integer
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
department_uid:
4
body:
body
Was this section helpful?
PATCH
Response
Update application department.
updateAppDepartment
Retrieve a list of departments. Departments are a way to categorise similar products. A product can lie in multiple departments.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Response
200
List of Departments.
DepartmentResponseSchema
items
array of object (Department)
Array of Department
logo
object (DepartmentMedia)
DepartmentMedia
aspect_ratio
string
The aspect ratio of the media, typically represented as width:height (e.g., '16:9').
type
string
The type of media, such as 'image', 'video', or other supported media formats.
url
string
The URL where the media resource is hosted and can be accessed.
name
string
The name of the department, used to identify it within the application.
priority_order
integer
Defines the priority or order in which the department should appear in listings.
slug
string
A URL-friendly string used to uniquely identify the department.
uid
integer
A unique identifier for the department.
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
Was this section helpful?
GET
Response
Get departments.
getDepartments
Retrieve inventory data related to the sales channel. this can be used to get the Inventory status of products.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
item_ids
array of integer
The Item Id of the product.
store_ids
array of integer
The Store Id of products to fetch inventory.
brand_ids
array of integer
The Brand Id of products to fetch inventory.
seller_identifiers
array of string
Unique seller_identifier of the product.
timestamp
string
Timestamp in UTC format (2020-07-23T10:27:50Z)
page_size
integer
The number of items to retrieve in each page.
Default Value : 12
page_id
string
Page ID to retrieve next set of results.
qty_gt
integer
This field allows you to filter for inventories that have quantity greater than to the specified value based on qty_type filter.
qty_lt
integer
This field allows you to filter for inventories that have a quantity less than to the specified value based on qty_type filter.
qty_type
string
This field provides flexibility in selecting filter for inventory quantity counts and date queries. For example, you might use this field to specify "total" or "sellable" quantity.
Enum
from_date
string
| date-time
Inventory updated on filter to get inventories greater then or equal to provided date based on qty_type value.
to_date
string
| date-time
Inventory updated on filter to get inventories less then or equal to provided date based on qty_type value.
Response
200
400
Success. Returns the article/stock of the product stock.
InventoryStockResponseSchema
items
array of object
An array of inventory stock items. Each item represents a stock entry for a specific product or SKU.
Default Value :
page
object (InventoryPage)
InventoryPage
has_next
boolean
Indicates whether there is a next page of results.
has_previous
boolean
Indicates whether there is a previous page of results.
item_total
integer
The total number of items available in the inventory.
next_id
string
Nullable
The identifier for fetching the next set of results. If null, there are no more results.
type
string
The type of pagination being used, often indicating the method or strategy for paginating the results.
Examples
Parameters
company_id:
1
application_id:
"655b09a916628f2bf9203e3b"
item_ids:
1
store_ids:
1
brand_ids:
4
seller_identifiers:
"TEST"
timestamp:
"2020-07-23T10:27:50Z"
page_size:
1
page_id:
"636a4c5c295d937d233826a5"
qty_gt:
1
qty_lt:
1
qty_type:
"sellable"
from_date:
"2024-01-20T09:40:58Z"
to_date:
"2024-07-20T09:40:58Z"
Was this section helpful?
GET
Response
Get application inventory.
getAppInventory
Retrieve all stores associated with a sales channel, with support for searching by store name and filtering by store type and status.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
store_type
string
Helps to sort the location list on the basis of location type.
Enum
uid
array of integer
Helps to sort the location list on the basis of uid list.
q
string
Query that is to be searched.
stage
string
to filter companies on basis of verified or unverified companies.
page_no
integer
The page number to navigate through the given set of results
Default Value : 1
page_size
integer
Number of items to retrieve in each page. Default is 20.
Default Value : 20
tags
array of string
Get locations filtered by tags.
store_types
array of string
Get locations filtered by store types.
company_uids
array of integer
Filter stores by company IDs available in the application.
Response
200
Company profile object.
LocationListSchema
filters
array of object
items
array of object (GetLocationSchema)
Array of GetLocationSchema
_custom_json
object
Custom JSON data specific to the location.
address
object (GetAddressSchema)
GetAddressSchema
address1
string
Primary address line, typically including street name, building number, or apartment details.
address2
string
Secondary address line, used for additional location details such as locality, neighborhood, or landmark.
address_type
string
The type of address.
city
string
The city where the address is located.
country
string
The country where the address is located.
country_code
string
The country code representing the country, such as 'IN' for India.
landmark
string
A nearby landmark that helps identify the address location.
latitude
number
The latitude coordinate of the address, used for geolocation purposes.
longitude
number
The longitude coordinate of the address, used for geolocation purposes.
pincode
integer
The postal code or ZIP code associated with the address.
state
string
The state or region where the address is located.
store_code
string
Unique identifier code for the store.
company
object (GetCompanySchema)
GetCompanySchema
addresses
array of object (GetAddressSchema)
Array of GetAddressSchema
address1
string
Primary address line, typically including street name, building number, or apartment details.
address2
string
Secondary address line, used for additional location details such as locality, neighborhood, or landmark.
address_type
string
The type of address.
city
string
The city where the address is located.
country
string
The country where the address is located.
country_code
string
The country code representing the country, such as 'IN' for India.
landmark
string
A nearby landmark that helps identify the address location.
latitude
number
The latitude coordinate of the address, used for geolocation purposes.
longitude
number
The longitude coordinate of the address, used for geolocation purposes.
pincode
integer
The postal code or ZIP code associated with the address.
state
string
The state or region where the address is located.
business_type
string
company_type
string
created_by
object (UserSchema)
UserSchema
_id
string
contact
string
The contact information of the user.
uid
string
user_id
string
The unique ID of the user.
username
string
The username of the user.
created_on
string
| date-time
modified_by
object (UserSchema)
UserSchema
_id
string
contact
string
The contact information of the user.
uid
string
user_id
string
The unique ID of the user.
username
string
The username of the user.
modified_on
string
| date-time
name
string
reject_reason
string
stage
string
uid
integer
verified_by
object (UserSchema)
UserSchema
_id
string
contact
string
The contact information of the user.
uid
string
user_id
string
The unique ID of the user.
username
string
The username of the user.
verified_on
string
contact_numbers
array of object (SellerPhoneNumber)
List of contact numbers associated with the store.
Array of SellerPhoneNumber
country_code
integer
The country code for the phone number, typically represented as an integer (e.g., 91 for India).
number
string
created_by
object (UserSchema)
UserSchema
_id
string
contact
string
The contact information of the user.
uid
string
user_id
string
The unique ID of the user.
username
string
The username of the user.
created_on
string
| date-time
Timestamp indicating when the location was created.
display_name
string
Display name of the location for easier identification.
documents
array of object (Document)
Documents related to the store location.
Array of Document
legal_name
string
The official legal name associated with the document.
type
string
The type of document.
url
string
| url
A URL link to the document, typically pointing to where the document is stored.
value
string
The actual value or identifier associated with the document, such as a GST number or PAN number.
verified
boolean
Indicates whether the document has been verified as valid.
gst_credentials
object (InvoiceDetailsSchema)
InvoiceDetailsSchema
e_invoice
object (InvoiceCredSchema)
InvoiceCredSchema
enabled
boolean
Indicates whether the invoice credentials are enabled for use.
password
string
The password associated with the invoice credentials.
username
string
The username or identifier used for the invoice credentials.
e_waybill
object (InvoiceCredSchema)
InvoiceCredSchema
enabled
boolean
Indicates whether the invoice credentials are enabled for use.
password
string
The password associated with the invoice credentials.
username
string
The username or identifier used for the invoice credentials.
integration_type
object (LocationIntegrationType)
LocationIntegrationType
inventory
string
The system used to manage inventory integration for the location.
Enum
order
string
The system used to manage order integration for the location.
Enum
manager
object (LocationManagerSchema)
LocationManagerSchema
email
string
| email
Email address of the location manager.
mobile_no
object (SellerPhoneNumber)
SellerPhoneNumber
country_code
integer
The country code for the phone number, typically represented as an integer (e.g., 91 for India).
number
string
name
string
Full name of the location manager.
modified_by
object (UserSchema)
UserSchema
_id
string
contact
string
The contact information of the user.
uid
string
user_id
string
The unique ID of the user.
username
string
The username of the user.
modified_on
string
| date-time
Timestamp indicating when the location details were last modified.
name
string
Name of the store location.
notification_emails
array of string
Email addresses for sending notifications related to this store.
phone_number
string
Primary phone number for contacting the store.
product_return_config
object (ProductReturnConfigSchema)
ProductReturnConfigSchema
on_same_store
boolean
Indicates if the product return is allowed only at the same store where it was purchased.
store_uid
integer
Unique identifier for the store where the product can be returned.
stage
string
Current operational stage of the store.
store_type
string
Type of store.
Enum
timing
array of object (LocationDayWiseSchema)
The daily operational timings for the store.
Array of LocationDayWiseSchema
closing
object (LocationTimingSchema)
LocationTimingSchema
hour
integer
The hour component of the time, represented in 24-hour format.
minute
integer
The minute component of the time.
open
boolean
Indicates whether the store or location is open on the specified day.
opening
object (LocationTimingSchema)
LocationTimingSchema
hour
integer
The hour component of the time, represented in 24-hour format.
minute
integer
The minute component of the time.
weekday
string
The day of the week for which the store timings are defined.
Enum
uid
integer
Unique identifier for the store.
verified_by
object (UserSchema)
UserSchema
_id
string
contact
string
The contact information of the user.
uid
string
user_id
string
The unique ID of the user.
username
string
The username of the user.
verified_on
string
| date-time
Timestamp when the store location was verified.
warnings
object
Warnings or issues associated with the store, if any.
company_id
integer
ID of the company to which this store belongs.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
1
application_id:
"655b09a916628f2bf9203e3b"
store_type:
"high_street"
uid:
1
q:
"test"
stage:
"verified"
page_no:
1
page_size:
1
tags:
"test"
store_types:
"test"
company_uids:
1
Was this section helpful?
GET
Response
Get application locations.
getAppLocations
Retrieve products associated with the application. List all the products associated with a brand, collection or category in a requested sort order.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
q
string
The search query. This can be a partial or complete name of a either a product, brand or category
f
string
The search filter parameters. All the parameter filtered from filter parameters will be passed in **f** parameter in this format. **?f=brand:voi-jeans||and:::category:t-shirts||shirts**
c
string
The search filter parameters for collection items. All the parameter filtered from filter parameters will be passed in "c" parameter in this format. "?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts"
filters
boolean
Pass `filters` parameter to fetch the filter details. This flag is used to fetch all filters
Default Value : true
is_dependent
boolean
This query parameter is used to get the dependent products in the listing.
Default Value : true
sort_on
string
The order to sort the list of products on. The supported sort parameters are popularity, price, redemption and discount in either ascending or descending order. See the supported values below.
Enum
page_id
string
Each response will contain **page_id** param, which should be sent back to make pagination work.
page_size
integer
Number of items to retrieve in each page. Default is 12.
Default Value : 12
page_no
integer
If page_type is number then pass it to fetch page items. Default is 1.
Default Value : 1
page_type
string
For pagination type should be cursor or number. Default is cursor.
Default Value : cursor
item_ids
array of string
Item Ids of product
Response
200
400
List of Products.
ApplicationProductListingResponseSchema
filters
array of object (ProductFilters)
Array of ProductFilters
key
object (ProductFiltersKey)
ProductFiltersKey
display
string
kind
string
logo
string
| url
name
string
operators
array of string
values
array of object (ProductFiltersValue)
A list of possible values corresponding to the filter key. These values can be selected for filtering products.
Array of ProductFiltersValue
count
integer
The number of products that match this filter value.
currency_code
string
The currency code used if the filter is related to price.
currency_symbol
string
The symbol of the currency used in price-related filters.
display
string
The human-readable label for this filter value.
display_format
string
A format string that controls how the value is displayed, commonly used for numeric or price ranges.
is_selected
boolean
Indicates whether this filter value is currently selected by the user.
max
integer
The maximum value for a range filter (e.g., price range).
min
integer
The minimum value for a range filter (e.g., price range).
query_format
string
The format string used in the query for filtering by this value.
selected_max
integer
The maximum value selected by the user in a range filter.
selected_min
integer
The minimum value selected by the user in a range filter.
value
object
The actual value of the filter.
items
array of object (ApplicationProductsSchema)
Array of ApplicationProductsSchema
attributes
object
Additional attributes of the product, such as custom properties or features.
brand
object (ProductBrand)
ProductBrand
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
logo
object (Media)
Media
meta
object
A metadata object containing additional information about the media, such as dimensions, format, or other relevant details.
type
string
The type of media.
Enum
url
string
The URL where the media can be accessed.
alt
string
The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed.
thumbnail
string
The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media.
name
string
uid
integer
color
string
description
string
A detailed description of the product.
discount
string
The discount applied to the product.
has_variant
boolean
Indicates whether the product has variants, such as different sizes or colors.
highlights
array of string
Key highlights of the product.
image_nature
string
The nature of the product image, indicating if it's the default or a standard image.
Enum
item_code
string
A unique code assigned to the product item at company and brand level.
item_type
string
The type of the product, defining its nature.
Enum
medias
array of object (Media)
A list of media items associated with the product, such as images or videos.
Array of Media
meta
object
A metadata object containing additional information about the media, such as dimensions, format, or other relevant details.
type
string
The type of media.
Enum
url
string
The URL where the media can be accessed.
alt
string
The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed.
thumbnail
string
The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media.
name
string
The name of the product.
price
object (ProductListingPrice)
ProductListingPrice
effective
object (Price1)
Price1
currency_code
object (CurrencyCodeEnum)
Enum
currency_symbol
string
max
number
min
number
marked
object (Price1)
Price1
currency_code
object (CurrencyCodeEnum)
Enum
currency_symbol
string
max
number
min
number
selling
object (Price1)
Price1
currency_code
object (CurrencyCodeEnum)
Enum
currency_symbol
string
max
number
min
number
product_online_date
string
| date-time
The date and time when the product becomes available online.
promo_meta
object
Metadata related to any promotions associated with the product.
rating
number
The average rating of the product, typically based on customer reviews.
rating_count
integer
The total number of ratings the product has received.
sellable
boolean
Indicates whether the product is available for sale.
short_description
string
A brief description of the product.
similars
array of string
A list of similar products.
slug
string
A URL-friendly string representing the product.
teaser_tag
object
A teaser tag object providing short promotional information about the product.
tryouts
array of string
A list of tryout options or samples available for the product.
type
string
The type or category of the product.
uid
integer
A unique identifier for the product.
popularity
integer
A numerical value indicating the popularity of the product.
brand_uid
integer
The unique identifier for the brand associated with the product.
category_uid
integer
The unique identifier for the category to which the product belongs.
verification_status
integer
The verification status of the product, typically represented as an integer.
channel_identifier
string
The identifier for the sales channel through which the product is sold.
category_slug
string
A URL-friendly string representing the product's category.
size_guide
string
A guide or chart providing size information for the product.
l3_categories
array of integer
A list of L3 category IDs of the product.
store_ids
array of integer
A list of store IDs where the product is available.
company_ids
array of integer
A list of company IDs associated with the product.
departments
array of integer
A list of department IDs where the product is categorized.
tags
array of string
A list of tags or keywords associated with the product.
l3_category_names
array of string
A list of names of L3 categories of the product.
sizes
array of string
A list of available sizes for the product.
product_group_tag
array of string
Tags that group the product with other similar products.
multi_size
boolean
Indicates whether the product is available in multiple sizes.
is_gift
boolean
Indicates whether the product can be considered as a gift.
is_cod
boolean
Indicates whether the product is eligible for cash on delivery (COD).
is_dependent
boolean
Indicates whether the product depends on another product.
is_available
boolean
Indicates whether the product is currently available for purchase.
moq
object (ApplicationItemMOQ)
ApplicationItemMOQ
increment_unit
integer
| value >= 1
The minimum quantity increment in which the item can be purchased.
Default Value : 1
maximum
integer
The maximum quantity allowed for purchase.
minimum
integer
| value >= 1
The minimum quantity required for purchase.
Default Value : 1
seo
object (ApplicationItemSEO)
ApplicationItemSEO
description
string
The SEO description of the item
title
string
The SEO title of the item
sitemap
object (ApplicationItemSeoSitemap)
ApplicationItemSeoSitemap
priority
number
The SEO priority of the item
frequency
string
The SEO frequency of the item
breadcrumbs
array of object (ApplicationItemSeoBreadcrumbs)
Array of ApplicationItemSeoBreadcrumbs
url
string
action
array of object (ApplicationItemSeoAction)
Array of ApplicationItemSeoAction
page
object
type
string
meta_tags
array of object (ApplicationItemSeoMetaTags)
Array of ApplicationItemSeoMetaTags
title
string
items
array of object (ApplicationItemSeoMetaTagItem)
Array of ApplicationItemSeoMetaTagItem
key
string
value
string
canonical_url
string
variants
object
An object containing details about the product variants.
variant_media
object
Media items specific to the product variants.
variant_group
object
A group identifier for products that are variants of one another.
multi_categories
array of object (MultiCategoriesSchema)
Array of MultiCategoriesSchema
l1
integer
The ID of the Level 1 (L1) category of the product.
l2
integer
The ID of the Level 2 (L2) category of the product.
l3
integer
The ID of the Level 3 (L3) category of the product.
is_active
boolean
Indicates whether the L3 category of the product is currently active.
department
integer
The department associated with the L3 category of the product.
template_tag
string
Tag used for categorizing or templating purposes.
net_quantity
object
Net quantity details for the product.
custom_order
object (CustomOrder)
CustomOrder
manufacturing_time_unit
string
Unit of time for manufacturing (e.g., days, weeks).
is_custom_order
boolean
Indicates if the product is available for custom orders.
manufacturing_time
integer
Time required for manufacturing in the specified unit.
country_of_origin
string
Country where the product is manufactured or sourced from.
_custom_json
object
Custom JSON data associated with the product.
identifiers
array of string
Identifiers associated with the product.
item_id
integer
Unique identifier for the item.
_custom_meta
array of object (CustomMeta)
Custom meta associated with the product.
Array of CustomMeta
key
string
The key of the metadata. Should be a non-empty string and length should not exceed 30 characters.
Minimum Length : 1
Maximum Length : 30
value
string
The value of the metadata. Should be a non-empty string and length should not exceed 100 characters.
Minimum Length : 1
Maximum Length : 100
discount_percentage
integer
The discount applied to the product in percentage.
operators
object (OperatorsResponseSchema)
OperatorsResponseSchema
btw
string
lte
string
gte
string
gt
string
lt
string
nin
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
sort_on
array of object (ProductSortOn)
Array of ProductSortOn
is_selected
boolean
Indicates whether this sorting option is currently selected.
name
string
The display name of the sorting option, used to show on the UI.
value
string
The value representing the sorting option.
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
q:
"laptop"
f:
"item_code:LGLAPTOPSLEEVE5"
c:
"item_code:in:LGLAPTOPSLEEVE5"
filters:
true
is_dependent:
true
sort_on:
"price_asc"
page_id:
"*"
page_size:
1
page_no:
1
page_type:
"number"
item_ids:
"10"
Was this section helpful?
GET
Response
Get application products.
getApplicationProducts
Retrieve detailed product information using a product slug. Products are the core resource of an application. Products can be associated by categories, collections, brands and more.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
slug
string
Required
The unique identifier of a product. i.e; `slug` of a product. You can retrieve these from the APIs that list products like "v1.0/products/"
Response
200
404
The Product object.
ProductDetail
attributes
object
Key-value pairs representing various product attributes.
brand
object (ProductBrand)
ProductBrand
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
logo
object (Media)
Media
meta
object
A metadata object containing additional information about the media, such as dimensions, format, or other relevant details.
type
string
The type of media.
Enum
url
string
The URL where the media can be accessed.
alt
string
The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed.
thumbnail
string
The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media.
name
string
uid
integer
description
string
Detailed description of the product.
grouped_attributes
array of object (ProductDetailGroupedAttribute)
Grouped attributes of the product, such as product details and specifications.
Array of ProductDetailGroupedAttribute
details
array of object (ProductDetailAttribute)
An array of individual product attributes belonging to this group.
Array of ProductDetailAttribute
key
string
The name or key of the attribute.
type
string
The type of the attribute.
value
string
The value of the attribute corresponding to the key.
title
string
The title or category name for the grouped attributes.
has_variant
boolean
Indicates whether the product has variants.
highlights
array of string
Array of highlight features for the product.
image_nature
string
The nature of the product's images.
item_code
string
Unique item code for the product.
item_type
string
Type of the item.
Enum
medias
array of object (Media)
Array of media objects such as images and videos for the product.
Array of Media
meta
object
A metadata object containing additional information about the media, such as dimensions, format, or other relevant details.
type
string
The type of media.
Enum
url
string
The URL where the media can be accessed.
alt
string
The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed.
thumbnail
string
The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media.
name
string
Name of the product.
product_online_date
string
| date-time
Date when the product was made available online.
promo_meta
object
Promotional metadata associated with the product.
rating
number
Average rating of the product.
rating_count
integer
Total number of ratings for the product.
short_description
string
A brief description of the product.
similars
array of string
Array of similar products.
slug
string
Unique slug for the product, used in URLs.
teaser_tag
object
Teaser tag information related to the product.
tryouts
array of string
Array of product tryout options.
type
string
The type of item.
uid
integer
Unique identifier for the product.
country_of_origin
string
Country where the product was manufactured.
categories
array of object (ApplicationProductCategoryItem)
Array of categories the product belongs to.
Array of ApplicationProductCategoryItem
id
integer
Unique identifier of the category.
uid
integer
Unique identifier of the category (UID).
name
string
Name of the category.
slug
string
Slug or unique key for the category.
logo
object (ApplicationProductMedia)
ApplicationProductMedia
type
string
Type of the media (e.g., image, video).
url
string
URL of the media item.
action
object (PageAction)
PageAction
page
object (ActionObject)
ActionObject
type
string
The type of action to be performed, such as navigating to a product or category.
query
object
The query parameters associated with the action.
type
string
The type of page action to be performed.
tags
array of string
Array of tags associated with the product.
no_of_boxes
integer
Number of boxes required for packaging the product.
custom_order
object (CustomOrder)
CustomOrder
manufacturing_time_unit
string
Unit of time for manufacturing (e.g., days, weeks).
is_custom_order
boolean
Indicates if the product is available for custom orders.
manufacturing_time
integer
Time required for manufacturing in the specified unit.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
10
application_id:
"64c00b72c07acacc1357503b"
slug:
"75779472"
Was this section helpful?
GET
Response
Get product details by slug.
getProductDetailBySlug
Retrieve products specific to the application. Products are the core resource of an application. Products can be associated by categories, collections, brands and more.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
brand_ids
array of integer
Get multiple products filtered by Brand Ids
category_ids
array of integer
Get multiple products filtered by Category Ids
department_ids
array of integer
Get multiple products filtered by Department Ids
tags
array of string
Get multiple products filtered by tags
item_ids
array of integer
Get multiple products filtered by Item Ids
page_no
integer
The page number to navigate through the given set of results
page_size
integer
Number of items to retrieve in each page. Default is 10.
Default Value : 10
q
string
Search with Item Code, Name, Slug or Identifier.
Response
200
The Product object.
RawProductListingResponseSchema
items
array of object (RawProduct)
A list of raw product items.
Array of RawProduct
_custom_json
object
Custom JSON data for the product.
all_company_ids
array of integer
List of company IDs associated with the product.
all_identifiers
array of string
List of all identifiers associated with the product.
all_sizes
array of object
List of sizes available for the product.
attributes
object
Additional attributes for the product.
brand
object (Brand)
Brand
logo
object (Logo)
Logo
aspect_ratio
string
Aspect ratio of the logo image, typically expressed as a string (e.g., '16:9').
aspect_ratio_f
integer
Numeric representation of the aspect ratio for scaling purposes.
secure_url
string
Secure URL to the logo image.
url
string
URL to the logo image.
name
string
The name of the brand.
uid
integer
Unique identifier for the brand.
brand_uid
integer
Unique identifier of the brand.
category
object
Category details of the product.
category_slug
string
Slug representing the category of the product.
category_uid
integer
Unique identifier for the product category.
company_id
integer
Unique identifier of the company associated with the product.
country_of_origin
string
Country where the product is manufactured.
created_by
object
Details of the user who created the product.
created_on
string
| date-time
Timestamp when the product was created.
currency
string
Currency in which the product is priced.
custom_order
object
Custom order details for the product.
departments
array of integer
List of department IDs associated with the product.
description
string
Detailed description of the product.
highlights
array of string
List of highlights for the product.
hsn_code
string
HSN code associated with the product for tax purposes.
id
string
Unique identifier of the product.
image_nature
string
Nature or type of product images.
images
array of string
List of image URLs for the product.
is_active
boolean
Indicates whether the product is active.
is_dependent
boolean
Indicates if the product is dependent on another product.
is_expirable
boolean
Indicates if the product has an expiration date.
is_image_less_product
boolean
Indicates if the product does not have associated images.
is_physical
boolean
Indicates if the product is a physical item.
is_set
boolean
Indicates if the product is part of a set.
item_code
string
Unique code representing the item.
item_type
string
Type of the item, such as 'standard'.
Enum
l3_mapping
array of string
L3 category mapping for the product.
media
array of object (Media)
Media associated with the product, such as images or videos.
Array of Media
meta
object
A metadata object containing additional information about the media, such as dimensions, format, or other relevant details.
type
string
The type of media.
Enum
url
string
The URL where the media can be accessed.
alt
string
The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed.
thumbnail
string
The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media.
modified_by
object
Details of the user who last modified the product.
modified_on
string
| date-time
Timestamp when the product was last modified.
moq
object
Minimum order quantity details for the product.
multi_size
boolean
Indicates if the product supports multiple sizes.
name
string
Name of the product.
net_quantity
object (NetQuantityResponseSchema)
NetQuantityResponseSchema
unit
string
The unit of measurement for the net quantity.
value
number
The actual quantity of the product in the specified unit.
no_of_boxes
integer
Number of boxes required for packaging the product.
pending
string
Pending state of the product, such as pending approval.
primary_color
string
Primary color of the product.
product_group_tag
array of string
Tags associated with the product group.
product_publish
object (ProductPublished)
ProductPublished
is_set
boolean
Indicates whether the product is part of a set.
product_online_date
integer
Timestamp when the product is scheduled to go live online.
return_config
object (ReturnConfigResponseSchema)
ReturnConfigResponseSchema
returnable
boolean
time
integer
unit
string
short_description
string
Short description of the product.
size_guide
string
Size guide for the product.
sizes
array of object
List of available sizes for the product.
slug
string
Unique slug identifier for the product.
stage
string
Current stage of the product (e.g., pending, verified).
tags
array of string
List of tags associated with the product.
tax_identifier
object (TaxIdentifier)
TaxIdentifier
hsn_code
string
hsn_code_id
string
reporting_hsn
string
teaser_tag
object
Teaser tags for the product.
template_tag
string
Template tag associated with the product.
trader
array of object (Trader)
List of traders associated with the product.
Array of Trader
address
array of string
List of addresses associated with the trader.
name
string
The name of the trader.
Minimum Length : 1
Maximum Length : 300
type
string
The role or type of the trader.
Enum
uid
integer
Unique identifier for the product.
variant_group
object
Variant group details for the product.
variant_media
object
Media related to product variants.
variants
object
Product variants information.
verified_by
object (VerifiedBy)
VerifiedBy
user_id
string
The unique identifier of the user who verified the product.
username
string
The username of the user who verified the product.
verified_on
string
| date-time
Timestamp when the product was verified.
store_id_list
array of string
List of store IDs where the product is available.
action
string
Action to be performed on the product.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
1
application_id:
"655b09a916628f2bf9203e3b"
brand_ids:
1
category_ids:
1
department_ids:
1
tags:
""
item_ids:
1
page_no:
1
page_size:
1
q:
"test"
Was this section helpful?
GET
Response
Get application products.
getAppProducts
Modify location data related to the application. Helps to update data associated to a item custom meta
Parameters
company_id
integer
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
integer
Required
store id for which the custom_json is associated.
Request body
_custom_json
object
Required
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
400
Returns a success response
SuccessResponse1Schema
success
boolean
uid
integer
Examples
Parameters
company_id:
47
application_id:
"000000000000000000000001"
store_uid:
113366
body:
body
Was this section helpful?
PATCH
Response
Update application location.
updateAppLocation
Manage Application Search Management functionality. You can delete, update, and retrieve search keywords using functions like delete Search Keywords, update Search Keywords, and get Search Keywords. Additionally, you can create custom keywords and rules with create Custom Keyword and create Custom Auto complete Rule. Furthermore, it allows you to control autocomplete behavior with functions like delete Autocomplete Keyword, updateAutocompleteKeyword, and getAutocompleteKeywordDetail. Overall, this resource enhances search and autocomplete functionality for a better user experience.
Operations
POST
# Create custom autocomplete rules.
GET
# Get autocomplete configuration.
GET
# Get autocomplete keyword details.
PUT
# Update autocomplete keywords.
DEL
# Delete autocomplete keywords.
POST
# Create search rerank for an application
GET
# Get search rerank for an application
GET
# Get search rerank for an application
PUT
# Update search rerank for an application
DEL
# Delete search rerank configuration for an application
POST
# Create search configuration
GET
# Get Search Configuration
PUT
# Update search configuration for an application
DEL
# Delete Search Configuration
POST
# Create custom search keywords.
GET
# Get all search keywords.
GET
# Retrieve search keywords.
PUT
# Update search keywords.
DEL
# Delete search keywords.
POST
# Create autocomplete settings config for an application
GET
# Get autocomplete settings config for an application
PUT
# Update autocomplete settings config for an application
GET
# Get autocomplete suggestions as per config for an application
POST
# Create Merchandising Rule's action details
PUT
# Update Merchandising Rule's action details
GET
# Get Merchandising Rule's action details
POST
# Create Merchandising Rule's Hide action details
PUT
# Update Merchandising Rule's Hide action details
GET
# Get Merchandising Rule's Hide action details
POST
# Create Merchandising Rule's Boost action details
PUT
# Update Merchandising Rule's Boost action details
GET
# Get Merchandising Rule's Boost action details
POST
# Get Merchandising Rule's Bury action details
PUT
# Update Merchandising Rule's Bury action details
GET
# Get Merchandising Rule's Bury action details
POST
# Create a Merchandising Rule's query
GET
# Get Merchandising Rule's query details
PUT
# Update a Merchandising Rule's query
POST
# Save a Merchandising Rule
DEL
# Delete a Merchandising Rule
GET
# Get list of all Merchandising Rule's details
DEL
# Delete a Merchandising Rule's preview
GET
# Get live preview of a Merchandising Rule
GET
# List search synonyms for an application
POST
# create oneway/ twoway search synonyms for an application
PUT
# Update synonym attributes for an application
DEL
# Delete synonym for an application.
POST
# Export synonym for an application.
GET
# Get sample file for bulk synonyms upload
POST
# Upload csv/xls/xlsx file with synonyms
POST
# Validate csv/xls/xlsx file with synonyms
POST
# process csv/xls/xlsx file with synonyms and insert onto db
GET
# poll a particular synonym bulk job for status
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Request body
_custom_json
object
Default Value : [object Object]
app_id
string
is_active
boolean
Default Value : true
results
array of object (AutocompleteResult)
Array of AutocompleteResult
_custom_json
object
Default Value : [object Object]
action
object (AutocompleteAction)
AutocompleteAction
page
object (AutocompletePageAction)
AutocompletePageAction
params
object
query
object
type
string
url
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
type
string
display
string
logo
object (AutoCompleteMedia)
AutoCompleteMedia
aspect_ratio
string
type
string
url
string
| url
words
array of string
action
object (AutocompleteAction)
AutocompleteAction
page
object (AutocompletePageAction)
AutocompletePageAction
params
object
query
object
type
string
url
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
type
string
Response
200
400
List of all the collections including the one you added. See example below or refer `CreateAutocompleteWordsResponseSchemaSchema` for details
CreateAutocompleteWordsResponseSchema
uid
string
is_active
boolean
Default Value : true
results
array of object (AutocompleteResult)
Array of AutocompleteResult
_custom_json
object
Default Value : [object Object]
action
object (AutocompleteAction)
AutocompleteAction
page
object (AutocompletePageAction)
AutocompletePageAction
params
object
query
object
type
string
url
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
type
string
display
string
logo
object (AutoCompleteMedia)
AutoCompleteMedia
aspect_ratio
string
type
string
url
string
| url
_custom_json
object
app_id
string
words
array of string
Examples
Parameters
company_id:
1
application_id:
"64aed377b1fd04565d0dff30"
body:
body
Was this section helpful?
POST
Response
Create custom autocomplete rules.
createCustomAutocompleteRule
Custom Autocomplete Keyword allows you to map conditions with keywords to give you the ultimate results
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
page_no
integer
The page number to navigate through the given set of results
page_size
integer
Number of items to retrieve in each page. Default is 12.
Default Value : 12
q
string
Search query with words name.Use this parameter to search keywords by words.
is_active
boolean
Can query for keywords based on whether they are active or inactive.
Response
200
List of custom autocomplete keywords.
GetAutocompleteWordsResponseSchema
items
array of object (GetAutocompleteWordsData)
Array of GetAutocompleteWordsData
results
array of object (AutocompleteResult)
Array of AutocompleteResult
_custom_json
object
Default Value : [object Object]
action
object (AutocompleteAction)
AutocompleteAction
page
object (AutocompletePageAction)
AutocompletePageAction
params
object
query
object
type
string
url
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
type
string
display
string
logo
object (AutoCompleteMedia)
AutoCompleteMedia
aspect_ratio
string
type
string
url
string
| url
app_id
string
words
array of string
is_active
boolean
uid
string
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
1
application_id:
"64aed377b1fd04565d0dff30"
page_no:
1
page_size:
1
q:
"fx"
is_active:
true
Was this section helpful?
GET
Response
Get autocomplete configuration.
getAutocompleteConfig
Retrieve detailed information about a specific autocomplete keyword.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
id
string
Required
A `id` is a unique identifier for a particular detail. Pass the `id` of the keywords which you want to retrieve.
Response
200
The mapping object.
GetAutocompleteWordsData
results
array of object (AutocompleteResult)
Array of AutocompleteResult
_custom_json
object
Default Value : [object Object]
action
object (AutocompleteAction)
AutocompleteAction
page
object (AutocompletePageAction)
AutocompletePageAction
params
object
query
object
type
string
url
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
type
string
display
string
logo
object (AutoCompleteMedia)
AutoCompleteMedia
aspect_ratio
string
type
string
url
string
| url
app_id
string
words
array of string
is_active
boolean
uid
string
Examples
Parameters
company_id:
1
application_id:
"64aed377b1fd04565d0dff30"
id:
"6569804246bf2fe018bf9d01"
Was this section helpful?
GET
Response
Get autocomplete keyword details.
getAutocompleteKeywordDetail
Update a mapping by it's id. On successful request, returns the updated Keyword mapping
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
id
string
Required
A `id` is a unique identifier for a particular detail. Pass the `id` of the keywords which you want to delete.
Request body
_custom_json
object
Default Value : [object Object]
app_id
string
is_active
boolean
Default Value : true
results
array of object (AutocompleteResult)
Array of AutocompleteResult
_custom_json
object
Default Value : [object Object]
action
object (AutocompleteAction)
AutocompleteAction
page
object (AutocompletePageAction)
AutocompletePageAction
params
object
query
object
type
string
url
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
type
string
display
string
logo
object (AutoCompleteMedia)
AutoCompleteMedia
aspect_ratio
string
type
string
url
string
| url
words
array of string
action
object (AutocompleteAction)
AutocompleteAction
page
object (AutocompletePageAction)
AutocompletePageAction
params
object
query
object
type
string
url
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
type
string
Response
200
400
The Mapping object.
GetAutocompleteWordsData
results
array of object (AutocompleteResult)
Array of AutocompleteResult
_custom_json
object
Default Value : [object Object]
action
object (AutocompleteAction)
AutocompleteAction
page
object (AutocompletePageAction)
AutocompletePageAction
params
object
query
object
type
string
url
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
type
string
display
string
logo
object (AutoCompleteMedia)
AutoCompleteMedia
aspect_ratio
string
type
string
url
string
| url
app_id
string
words
array of string
is_active
boolean
uid
string
Examples
Parameters
company_id:
1
application_id:
"64aed377b1fd04565d0dff30"
id:
"6569804246bf2fe018bf9d01"
body:
body
Was this section helpful?
PUT
Response
Update autocomplete keywords.
updateAutocompleteKeyword
Delete a keywords by it's id. Returns an object that tells whether the keywords was deleted successfully
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
id
string
Required
A `id` is a unique identifier for a particular detail. Pass the `id` of the keywords which you want to delete.
Response
200
400
Status object. Tells whether the operation was successful. See example below or refer `DeleteResponseSchema`
DeleteResponseSchema
message
string
Examples
Parameters
company_id:
1
application_id:
"64aed377b1fd04565d0dff30"
id:
"6569804246bf2fe018bf9d01"
Was this section helpful?
DEL
Response
Delete autocomplete keywords.
deleteAutocompleteKeyword
This view allows you to create search rerank attributes for an application
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Request body
words
array of string
is_active
boolean
application_id
string
ranking
object (RerankingBoostItems)
RerankingBoostItems
boost
array of object (BoostItem)
Array of BoostItem
attribute_key
string
attribute_value
string
Response
200
400
List of custom search keywords.
CreateSearchRerankResponseSchema
words
array of string
app_id
string
ranking
object (RerankingBoostItems)
RerankingBoostItems
boost
array of object (BoostItem)
Array of BoostItem
attribute_key
string
attribute_value
string
is_active
boolean
created_on
string
| date-time
created_by
object (UserInfo)
UserInfo
email
string
| email
The email address of the user.
uid
string
The unique ID of the user.
user_id
string
The ID of the user.
username
string
The username of the user.
modified_on
string
| date-time
modified_by
object (UserInfo)
UserInfo
email
string
| email
The email address of the user.
uid
string
The unique ID of the user.
user_id
string
The ID of the user.
username
string
The username of the user.
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
body:
body
Was this section helpful?
POST
Response
Create search rerank for an application
createSearchRerank
This view allows you to create search rerank attributes for an application
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Response
200
List of custom search keywords.
GetSearchRerankResponseSchema
items
array of object (GetSearchRerankItemResponseSchema)
Array of GetSearchRerankItemResponseSchema
created_on
string
| date-time
modified_on
string
| date-time
words
array of string
app_id
string
modified_by
object (UserInfo)
UserInfo
email
string
| email
The email address of the user.
uid
string
The unique ID of the user.
user_id
string
The ID of the user.
username
string
The username of the user.
ranking
object (RerankingBoostItems)
RerankingBoostItems
boost
array of object (BoostItem)
Array of BoostItem
attribute_key
string
attribute_value
string
created_by
object (UserInfo)
UserInfo
email
string
| email
The email address of the user.
uid
string
The unique ID of the user.
user_id
string
The ID of the user.
username
string
The username of the user.
is_active
boolean
id
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
page
object (PageResponseSchema)
PageResponseSchema
current
integer
It is the current page of the page response schema.
has_next
boolean
It is the bool indicates if there is a next page.
has_previous
boolean
It is the bool indicates if there is a previous page.
item_total
integer
It is the total number of item present for the filter.
size
integer
It is the size of each page.
Examples
Parameters
company_id:
1
application_id:
"64aed475db2cfb5b8a9f623d"
Was this section helpful?
GET
Response
Get search rerank for an application
getSearchRerank
This view allows you to retrieve search rerank attribute detail for an application
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sales channel.
id
string
Required
An `id` is the identifier for a particular search rerank configuration. channel.
Response
200
Create search rerank configuration.
GetSearchRerankDetailResponseSchema
ranking
object (RerankingBoostItems)
RerankingBoostItems
boost
array of object (BoostItem)
Array of BoostItem
attribute_key
string
attribute_value
string
is_active
boolean
modified_by
object (UserInfo)
UserInfo
email
string
| email
The email address of the user.
uid
string
The unique ID of the user.
user_id
string
The ID of the user.
username
string
The username of the user.
created_by
object (UserInfo)
UserInfo
email
string
| email
The email address of the user.
uid
string
The unique ID of the user.
user_id
string
The ID of the user.
username
string
The username of the user.
words
array of string
app_id
string
modified_on
string
| date-time
created_on
string
| date-time
id
string
Examples
Parameters
company_id:
1
application_id:
"64aed475db2cfb5b8a9f623d"
id:
"6589a91055565ca43767b2e2"
Was this section helpful?
GET
Response
Get search rerank for an application
getSearchRerankDetail
This view allows you to update search rerank attribute for an application
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
id
string
Required
An `id` is the identifier for a particular search rerank configuration. channel.
Request body
words
array of string
is_active
boolean
application_id
string
ranking
object (RerankingBoostItems)
RerankingBoostItems
boost
array of object (BoostItem)
Array of BoostItem
attribute_key
string
attribute_value
string
Response
200
400
Update search rerank configuration.
UpdateSearchRerankResponseSchema
words
array of string
app_id
string
ranking
object (RerankingBoostItems)
RerankingBoostItems
boost
array of object (BoostItem)
Array of BoostItem
attribute_key
string
attribute_value
string
is_active
boolean
created_on
string
| date-time
created_by
object (UserInfo)
UserInfo
email
string
| email
The email address of the user.
uid
string
The unique ID of the user.
user_id
string
The ID of the user.
username
string
The username of the user.
modified_on
string
| date-time
modified_by
object (UserInfo)
UserInfo
email
string
| email
The email address of the user.
uid
string
The unique ID of the user.
user_id
string
The ID of the user.
username
string
The username of the user.
Examples
Parameters
company_id:
1
application_id:
"64aed475db2cfb5b8a9f623d"
id:
"6589a91055565ca43767b2e2"
body:
body
Was this section helpful?
PUT
Response
Update search rerank for an application
updateSearchRerankConfiguration
This view allows you to delete search rerank configuration for an application
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
id
string
Required
An `id` is the identifier for a particular search rerank configuration. channel.
Response
200
400
Status of the delete operation. See `DeleteSearchRerankConfigurationResponseSchema` for details
DeleteSearchRerankConfigurationResponseSchema
success
boolean
message
string
Examples
Parameters
company_id:
1
application_id:
"64aed475db2cfb5b8a9f623d"
id:
"6589a91055565ca43767b2e2"
Was this section helpful?
DEL
Response
Delete search rerank configuration for an application
deleteSearchRerankConfiguration
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Request body
application_id
string
Required
The application id where custom search configuration is set
company_id
integer
Required
The company id where custom search configuration is set
created_by
object (UserSchema)
UserSchema
_id
string
contact
string
The contact information of the user.
uid
string
user_id
string
The unique ID of the user.
username
string
The username of the user.
created_on
string
| date-time
The date and time when the search configuration was created.
is_proximity_enabled
boolean
Flag indicating if proximity search is enabled for this attribute.
Default Value : false
modified_by
object (UserSchema)
UserSchema
_id
string
contact
string
The contact information of the user.
uid
string
user_id
string
The unique ID of the user.
username
string
The username of the user.
modified_on
string
| date-time
The date and time when the search configuration was last modified.
proximity
integer
Proximity distance configuration
Default Value : 1
searchable_attributes
array of object (SearchableAttribute)
The searchable attributes defined on the application.
Array of SearchableAttribute
key
string
Required
The attribute key to search on. This key matches the solr document key
name
string
Required
The name of key to search on. This is for displaying purposes on platform
priority
number
Required
Order in which the searchable attribute should kick in. Higher the priority, higher the weight considered while searching
Response
200
List of custom search keywords.
CreateSearchConfigurationResponseSchema
success
boolean
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
body:
body
Was this section helpful?
POST
Response
Create search configuration
createSearchConfiguration
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Response
200
Search configuration for the specified application. See example below or refer `GetSearchConfigurationResponseSchema` for details
GetSearchConfigurationResponseSchema
_id
string
The id of the search configuration.
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 (UserSchema)
UserSchema
_id
string
contact
string
The contact information of the user.
uid
string
user_id
string
The unique ID of the user.
username
string
The username of the user.
created_on
string
| date-time
The date and time when the search configuration was created.
is_proximity_enabled
boolean
Flag indicating if proximity search is enabled for this attribute.
Default Value : false
modified_by
object (UserSchema)
UserSchema
_id
string
contact
string
The contact information of the user.
uid
string
user_id
string
The unique ID of the user.
username
string
The username of the user.
modified_on
string
| date-time
The date and time when the search configuration was last modified.
proximity
integer
Proximity distance configuration
Default Value : 1
searchable_attributes
array of object (SearchableAttribute)
The searchable attributes defined on the application.
Array of SearchableAttribute
key
string
The attribute key to search on. This key matches the solr document key
name
string
The name of key to search on. This is for displaying purposes on platform
priority
number
Order in which the searchable attribute should kick in. Higher the priority, higher the weight considered while searching
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
Was this section helpful?
GET
Response
Get Search Configuration
getSearchConfiguration
This view allows you to modify searchable attributes for an application
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Request body
application_id
string
Required
The application id where custom search configuration is set
company_id
integer
Required
The company id where custom search configuration is set
created_by
object (UserInfo)
UserInfo
email
string
| email
The email address of the user.
uid
string
The unique ID of the user.
user_id
string
The ID of the user.
username
string
The username of the user.
created_on
string
| date-time
The date and time when the search configuration was created.
is_proximity_enabled
boolean
Flag indicating if proximity search is enabled for this attribute.
Default Value : false
modified_by
object (UserInfo)
UserInfo
email
string
| email
The email address of the user.
uid
string
The unique ID of the user.
user_id
string
The ID of the user.
username
string
The username of the user.
modified_on
string
| date-time
The date and time when the search configuration was last modified.
proximity
integer
Proximity distance configuration
Default Value : 1
searchable_attributes
array of object (SearchableAttribute)
The searchable attributes defined on the application.
Array of SearchableAttribute
key
string
Required
The attribute key to search on. This key matches the solr document key
name
string
Required
The name of key to search on. This is for displaying purposes on platform
priority
number
Required
Order in which the searchable attribute should kick in. Higher the priority, higher the weight considered while searching
Response
200
List of custom search keywords.
UpdateSearchConfigurationResponseSchema
success
boolean
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
body:
body
Was this section helpful?
PUT
Response
Update search configuration for an application
updateSearchConfiguration
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Response
200
Status of the delete operation.
DeleteSearchConfigurationResponseSchema
success
boolean
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
Was this section helpful?
DEL
Response
Delete Search Configuration
deleteSearchConfiguration
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Request body
_custom_json
object
Default Value : [object Object]
app_id
string
is_active
boolean
Default Value : true
result
object (SearchKeywordResult)
Required
SearchKeywordResult
query
object
Required
sort_on
string
Required
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
words
array of string
Response
200
400
Get keyword object with id that is added.
GetSearchWordsData
query
object
sort_on
string
_custom_json
object
app_id
string
is_active
boolean
result
object
uid
string
words
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
application_id:
"64aed475db2cfb5b8a9f623d"
body:
body
Was this section helpful?
POST
Response
Create custom search keywords.
createCustomKeyword
Custom Search Keyword allows you to map conditions with keywords to give you the ultimate results
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
page_no
integer
The page number to navigate through the given set of results
page_size
integer
Number of items to retrieve in each page. Default is 12.
Default Value : 12
q
string
Search query with words name.Use this parameter to search keywords by words.
is_active
boolean
Can query for keywords based on whether they are active or inactive.
Response
200
List of custom search keywords.
GetSearchWordsResponseSchema
items
array of object (GetSearchWordsData)
Array of GetSearchWordsData
query
object
sort_on
string
_custom_json
object
app_id
string
is_active
boolean
result
object
uid
string
words
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
1
application_id:
"64aed475db2cfb5b8a9f623d"
page_no:
1
page_size:
1
q:
"fx"
is_active:
true
Was this section helpful?
GET
Response
Get all search keywords.
getAllSearchKeyword
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
id
string
Required
A `id` is a unique identifier for a particular detail. Pass the `id` of the keywords which you want to retrieve.
Response
200
The Collection object.
GetSearchWordsData
query
object
sort_on
string
_custom_json
object
app_id
string
is_active
boolean
result
object
uid
string
words
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
application_id:
"64aed475db2cfb5b8a9f623d"
id:
"65685b181dfa866c6e8349cf"
Was this section helpful?
GET
Response
Retrieve search keywords.
getSearchKeywords
Update Search Keyword by its id. On successful request, returns the updated collection
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
id
string
Required
A `id` is a unique identifier for a particular detail. Pass the `id` of the keywords which you want to delete.
Request body
_custom_json
object
Default Value : [object Object]
app_id
string
is_active
boolean
Default Value : true
result
object (SearchKeywordResult)
Required
SearchKeywordResult
query
object
Required
sort_on
string
Required
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
words
array of string
Response
200
400
The Collection object.
GetSearchWordsData
query
object
sort_on
string
_custom_json
object
app_id
string
is_active
boolean
result
object
uid
string
words
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
application_id:
"64aed475db2cfb5b8a9f623d"
id:
"65685b181dfa866c6e8349cf"
body:
body
Was this section helpful?
PUT
Response
Update search keywords.
updateSearchKeywords
Delete a keywords by it's id. Returns an object that tells whether the keywords was deleted successfully
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
id
string
Required
A `id` is a unique identifier for a particular detail. Pass the `id` of the keywords which you want to delete.
Response
200
400
Status object. Tells whether the operation was successful. See example below or refer `DeleteResponseSchema`
DeleteResponseSchema
message
string
Examples
Parameters
company_id:
1
application_id:
"64aed475db2cfb5b8a9f623d"
id:
"65685b181dfa866c6e8349cf"
Was this section helpful?
DEL
Response
Delete search keywords.
deleteSearchKeywords
This API allows to create autocomplete settings for an application.
Parameters
application_id
string
Required
The company id for which the autocomplete settings is being referenced
company_id
integer
Required
The application id for which the autocomplete settings is being referenced
Request body
query_suggestion
object
product_suggestion
object
collection_suggestion
object
brand_suggestion
object
category_suggestion
object
Response
200
400
return success true/false based on create operation
AutocompleteUpsertResponseSchema
message
string
id
string
success
boolean
Examples
Parameters
application_id:
"000000000000000000000001"
company_id:
1
body:
body
Was this section helpful?
POST
Response
Create autocomplete settings config for an application
createAutocompleteSettings
This API allows to get autocomplete settings config for an application.
Parameters
application_id
string
Required
The company id for which the autocomplete settings is being referenced
company_id
integer
Required
The application id for which the autocomplete settings is being referenced
Response
200
Object of autocomplete settings config
AutocompleteResponseSchema
id
string
query_suggestion
object
product_suggestion
object
collection_suggestion
object
brand_suggestion
object
category_suggestion
object
Examples
Parameters
application_id:
"000000000000000000000001"
company_id:
1
Was this section helpful?
GET
Response
Get autocomplete settings config for an application
getAutocompleteSettings
This API allows to update autocomplete settings for an application.
Parameters
application_id
string
Required
The company id for which the autocomplete settings is being referenced
company_id
integer
Required
The application id for which the autocomplete settings is being referenced
id
string
Required
An `id` is a unique identifier for a particular autocomplete settings config.
Request body
query_suggestion
object
product_suggestion
object
collection_suggestion
object
brand_suggestion
object
category_suggestion
object
Response
200
400
return success true/false based on update operation
AutocompleteUpsertResponseSchema
message
string
id
string
success
boolean
Examples
Parameters
application_id:
"000000000000000000000001"
company_id:
1
id:
"000000000000000000000001"
body:
body
Was this section helpful?
PUT
Response
Update autocomplete settings config for an application
updateAutocompleteSettings
This API allows to get autocomplete suggestions as per config.
Parameters
application_id
string
Required
The company id for which the autocomplete settings is being referenced
company_id
integer
Required
The application id for which the autocomplete settings is being referenced
q
string
Get suggestions related to `q` string.
category_suggestion
integer
For getting related category suggestions.
brand_suggestion
integer
For getting related brand suggestions.
collection_suggestion
integer
For getting collection suggestions.
product_suggestion
integer
For getting product suggestions.
query_suggestion
integer
For getting query suggestions.
Response
200
return autocomplete suggestions
AutocompletePreviewResponseSchema
items
array of object (AutocompleteItem)
Array of AutocompleteItem
logo
object (Media)
Media
meta
object
A metadata object containing additional information about the media, such as dimensions, format, or other relevant details.
type
string
The type of media.
Enum
url
string
The URL where the media can be accessed.
alt
string
The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed.
thumbnail
string
The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media.
display
string
type
string
_custom_json
object
action
object (ProductListingAction)
ProductListingAction
type
string
page
object (ProductListingActionPage)
ProductListingActionPage
type
string
query
object
params
object
Examples
Parameters
application_id:
"000000000000000000000001"
company_id:
1
q:
"word"
category_suggestion:
1
brand_suggestion:
1
collection_suggestion:
1
product_suggestion:
1
query_suggestion:
1
Was this section helpful?
GET
Response
Get autocomplete suggestions as per config for an application
getAutocompletePreview
This allows you to create pin action of a merchandising rule.
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.
merchandising_rule_id
string
Required
A `merchandising_rule_id` is a unique identifier for a particular merchandising rule.
Request body
action_value
array of object (PinItemRequestSchema)
Array of PinItemRequestSchema
action
string
Required
item_id
string
Required
position
integer
Required
Response
200
400
List of pinned items.
SuccessResponseMerchandising
message
string
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
merchandising_rule_id:
"xsb1w2wjxb"
body:
body
Was this section helpful?
POST
Response
Create Merchandising Rule's action details
createMerchandisingRulePinAction
This allows you to update pin action of a merchandising rule.
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.
merchandising_rule_id
string
Required
A `merchandising_rule_id` is a unique identifier for a particular merchandising rule.
Request body
action_value
array of object (PinItemRequestSchema)
Array of PinItemRequestSchema
action
string
Required
item_id
string
Required
position
integer
Required
Response
200
400
List of pinned items.
SuccessResponseMerchandising
message
string
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
merchandising_rule_id:
"xsb1w2wjxb"
body:
body
Was this section helpful?
PUT
Response
Update Merchandising Rule's action details
updateMerchandisingRulePinAction
This allows you to get details of pin action of a merchandising rule.
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.
merchandising_rule_id
string
Required
A `merchandising_rule_id` is a unique identifier for a particular merchandising rule.
Response
200
400
List of pinned items.
PinResponseSchema
data
array of object (PinItem)
Array of PinItem
name
string
uid
integer
position
integer
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
merchandising_rule_id:
"xsb1w2wjxb"
Was this section helpful?
GET
Response
Get Merchandising Rule's action details
getMerchandisingRulePinAction
This allows you to create hide action of a merchandising rule.
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.
merchandising_rule_id
string
Required
A `merchandising_rule_id` is a unique identifier for a particular merchandising rule.
Request body
action_value
array of object (HideAttributeRequestSchema)
Array of HideAttributeRequestSchema
action
string
item_id
integer
Response
200
400
List of hide items.
SuccessResponseMerchandising
message
string
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
merchandising_rule_id:
"xsb1w2wjxb"
body:
body
Was this section helpful?
POST
Response
Create Merchandising Rule's Hide action details
createMerchandisingRuleHideAction
This allows you to update hide action of a merchandising rule.
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.
merchandising_rule_id
string
Required
A `merchandising_rule_id` is a unique identifier for a particular merchandising rule.
Request body
action_value
array of object (HideAttributeRequestSchema)
Array of HideAttributeRequestSchema
action
string
item_id
integer
Response
200
400
List of hide items.
SuccessResponseMerchandising
message
string
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
merchandising_rule_id:
"xsb1w2wjxb"
body:
body
Was this section helpful?
PUT
Response
Update Merchandising Rule's Hide action details
updateMerchandisingRuleHideAction
This allows you to get details of hide action of a merchandising rule.
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.
merchandising_rule_id
string
Required
A `merchandising_rule_id` is a unique identifier for a particular merchandising rule.
Response
200
400
List of hide items.
HideResponseSchema
data
array of object (HideAttribute)
Array of HideAttribute
name
string
uid
integer
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
merchandising_rule_id:
"xsb1w2wjxb"
Was this section helpful?
GET
Response
Get Merchandising Rule's Hide action details
getMerchandisingRuleHideAction
This allows you to create Boost action of a merchandising rule.
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.
merchandising_rule_id
string
Required
A `merchandising_rule_id` is a unique identifier for a particular merchandising rule.
Request body
action_value
array of object (PostBoostAttribute)
Array of PostBoostAttribute
attribute
string
Required
value
string
Required
strength
integer
Required
action
string
Required
Response
200
400
List of Boost conditions.
SuccessResponseMerchandising
message
string
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
merchandising_rule_id:
"xsb1w2wjxb"
body:
body
Was this section helpful?
POST
Response
Create Merchandising Rule's Boost action details
createMerchandisingRuleBoostAction
This allows you to update Boost action of a merchandising rule.
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.
merchandising_rule_id
string
Required
A `merchandising_rule_id` is a unique identifier for a particular merchandising rule.
Request body
action_value
array of object (PostBoostAttribute)
Array of PostBoostAttribute
attribute
string
Required
value
string
Required
strength
integer
Required
action
string
Required
Response
200
400
List of Boost conditions.
SuccessResponseMerchandising
message
string
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
merchandising_rule_id:
"xsb1w2wjxb"
body:
body
Was this section helpful?
PUT
Response
Update Merchandising Rule's Boost action details
updateMerchandisingRuleBoostAction
This allows you to get details of Boost action of a merchandising rule.
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.
merchandising_rule_id
string
Required
A `merchandising_rule_id` is a unique identifier for a particular merchandising rule.
Response
200
400
List of Boost conditions.
GetMerchandisingRuleBoostAction
data
array of object (BoostAttribute)
Array of BoostAttribute
attribute
string
value
string
strength
integer
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
merchandising_rule_id:
"xsb1w2wjxb"
Was this section helpful?
GET
Response
Get Merchandising Rule's Boost action details
getMerchandisingRuleBoostAction
This allows you to create Bury action of a merchandising rule.
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.
merchandising_rule_id
string
Required
A `merchandising_rule_id` is a unique identifier for a particular merchandising rule.
Request body
action_value
array of object (PostBoostAttribute)
Array of PostBoostAttribute
attribute
string
Required
value
string
Required
strength
integer
Required
action
string
Required
Response
200
400
List of Bury conditions.
SuccessResponseMerchandising
message
string
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
merchandising_rule_id:
"xsb1w2wjxb"
body:
body
Was this section helpful?
POST
Response
Get Merchandising Rule's Bury action details
createMerchandisingRuleBuryAction
This allows you to update Bury action of a merchandising rule.
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.
merchandising_rule_id
string
Required
A `merchandising_rule_id` is a unique identifier for a particular merchandising rule.
Request body
action_value
array of object (PostBoostAttribute)
Array of PostBoostAttribute
attribute
string
Required
value
string
Required
strength
integer
Required
action
string
Required
Response
200
400
List of Bury conditions.
SuccessResponseMerchandising
message
string
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
merchandising_rule_id:
"xsb1w2wjxb"
body:
body
Was this section helpful?
PUT
Response
Update Merchandising Rule's Bury action details
updateMerchandisingRuleBuryAction
This allows you to get details of Bury action of a merchandising rule.
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.
merchandising_rule_id
string
Required
A `merchandising_rule_id` is a unique identifier for a particular merchandising rule.
Response
200
400
List of Bury conditions.
GetMerchandisingRuleBuryAction
data
array of object (BoostAttribute)
Array of BoostAttribute
attribute
string
value
string
strength
integer
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
merchandising_rule_id:
"xsb1w2wjxb"
Was this section helpful?
GET
Response
Get Merchandising Rule's Bury action details
getMerchandisingRuleBuryAction
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Request body
query
object (MerchandisingRuleQueryPart)
MerchandisingRuleQueryPart
filter
array of object (Filter)
Array of Filter
attribute
string
value
string
query_condition
string
query
object (MerchandisingRuleQuery)
MerchandisingRuleQuery
condition
string
Required
search_query
string
Required
synonyms
boolean
Required
zone_id
string
Response
200
Update a merchandise rule's query.
MerchandiseQueryResponseSchema
message
string
merchandising_rule_id
string
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
body:
body
Was this section helpful?
POST
Response
Create a Merchandising Rule's query
createMerchandisingRuleQuery
This allows you to get details of a merchandising rule's query.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
merchandising_rule_id
string
Required
A `merchandising_rule_id` is a unique identifier for a particular merchandising rule.
Response
200
Details of merchandise query.
SearchResponseSchema
_id
string
query
object (MerchandisingQuery)
MerchandisingQuery
query_condition
string
query
object (MerchandisingSearchQuery)
MerchandisingSearchQuery
condition
string
search_query
string
synonyms
string
filter
array of object (MerchandisingFilter)
Array of MerchandisingFilter
attribute
string
value
string
is_active
boolean
merchandising_rule_id
string
rule_name
string
application_id
string
status
string
zone_id
string
_schedule
object
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
merchandising_rule_id:
"xsb1w2wjxb"
Was this section helpful?
GET
Response
Get Merchandising Rule's query details
getMerchandisingQuery
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
merchandising_rule_id
string
Required
A `merchandising_rule_id` is a unique identifier for a particular merchandising rule.
Request body
query
object (MerchandisingRuleQueryPart)
MerchandisingRuleQueryPart
filter
array of object (Filter)
Array of Filter
attribute
string
value
string
query_condition
string
query
object (MerchandisingRuleQuery)
MerchandisingRuleQuery
condition
string
Required
search_query
string
Required
synonyms
boolean
Required
zone_id
string
Response
200
Update a merchandise rule's query.
SuccessResponseMerchandising
message
string
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
merchandising_rule_id:
"xsb1w2wjxb"
body:
body
Was this section helpful?
PUT
Response
Update a Merchandising Rule's query
updateMerchandisingRuleQuery
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.
merchandising_rule_id
string
Required
A `merchandising_rule_id` is a unique identifier for a particular merchandising rule.
Request body
rule_name
string
Required
_schedule
object (CollectionSchedule)
Required
CollectionSchedule
cron
string
Nullable
duration
integer
Nullable
end
string
Nullable
next_schedule
array of object (NextSchedule)
Array of NextSchedule
end
string
Nullable
start
string
start
string
is_active
boolean
Required
Response
200
Update a merchandise rule's query.
SuccessResponseMerchandising
message
string
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
merchandising_rule_id:
"xsb1w2wjxb"
body:
body
Was this section helpful?
POST
Response
Save a Merchandising Rule
saveMerchandisingRules
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.
merchandising_rule_id
string
Required
A `merchandising_rule_id` is a unique identifier for a particular merchandising rule.
Response
200
400
Delete a merchandise rule's query.
SuccessResponseMerchandising
message
string
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
merchandising_rule_id:
"xsb1w2wjxb"
Was this section helpful?
DEL
Response
Delete a Merchandising Rule
deleteMerchandisingRule
This allows you to get details of all merchandising rule's details.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
page_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
Details of all merchandise rule's details. See example below or refer `MerchandisingRulesList` for details
MerchandisingRulesList
data
array of object (MerchDataItem)
Array of MerchDataItem
query
object (MerchSearchQuery)
MerchSearchQuery
query_condition
string
query
object (MerchQueryCondition)
MerchQueryCondition
condition
string
search_query
string
synonyms
string
filter
array of object (MerchFilter)
Array of MerchFilter
attribute
string
value
string
action
array of string
is_active
boolean
merchandising_rule_id
string
rule_name
string
status
string
zone_id
string
application_id
string
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
page_id:
1
page_size:
1
Was this section helpful?
GET
Response
Get list of all Merchandising Rule's details
getMerchandisingRules
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.
merchandising_rule_id
string
Required
A `merchandising_rule_id` is a unique identifier for a particular merchandising rule.
Response
200
400
Delete a merchandise rule's query.
SuccessResponseMerchandising
message
string
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
merchandising_rule_id:
"kgv1euym26"
Was this section helpful?
DEL
Response
Delete a Merchandising Rule's preview
deleteMerchandisingRulesPreview
This allows you to get live preview of a merchandising rule.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
merchandising_rule_id
string
Required
A `merchandising_rule_id` is a unique identifier for a particular merchandising rule.
search_keyword
string
A sample query that can be used to get a live preview of the merchandising rule.
Response
200
Get live preview of a merchandise rule.
ProductListingResponseSchema
items
array of object (Product)
Array of Product
_custom_json
object
A custom JSON object that can hold any additional key-value pairs specific to the product.
all_company_ids
array of integer
List of company IDs associated with the product.
all_identifiers
array of string
List of identifiers such as SKU, barcode, etc.
all_sizes
array of object
List of available sizes for the product.
attributes
object
Additional attributes of the product such as material, color, pattern, etc.
brand
object (Brand)
Brand
logo
object (Logo)
Logo
aspect_ratio
string
Aspect ratio of the logo image, typically expressed as a string (e.g., '16:9').
aspect_ratio_f
integer
Numeric representation of the aspect ratio for scaling purposes.
secure_url
string
Secure URL to the logo image.
url
string
URL to the logo image.
name
string
The name of the brand.
uid
integer
Unique identifier for the brand.
brand_uid
integer
Unique ID of the brand associated with the product.
category
object
Details about the category the product belongs to.
category_slug
string
unique slug representing the category.
category_uid
integer
Unique ID of the product category.
color
string
Primary color of the product.
company_id
integer
ID of the company managing the product.
country_of_origin
string
The country where the product was manufactured.
created_by
object
Details of the user or entity that created the product.
created_on
string
| date-time
Timestamp indicating when the product was created.
currency
string
The currency used for pricing the product.
custom_order
object
Information related to custom orders, including lead time and production details.
departments
array of integer
List of department IDs related to the product.
description
string
Full description of the product.
highlights
array of string
List of key highlights of the product.
hsn_code
string
HSN (Harmonized System Nomenclature) code for tax classification.
id
string
Unique identifier for the product in the system.
image_nature
string
Nature of the product image, for example, 'standard' or 'custom'.
images
array of object (Image)
List of images associated with the product.
Array of Image
aspect_ratio
string
aspect_ratio_f
number
secure_url
string
url
string
is_active
boolean
Indicates whether the product is currently active or not.
is_dependent
boolean
Indicates whether the product depends on other products for its availability or configuration.
is_expirable
boolean
Indicates if the product has an expiration date.
is_image_less_product
boolean
Indicates if the product does not have an image associated.
is_physical
boolean
Specifies if the product is a physical item.
is_set
boolean
Indicates if the product is part of a set.
item_code
string
item_type
string
Enum
l3_mapping
array of string
List of category mappings for the product (level 3 categories).
media
array of object (Media)
Media objects associated with the product, such as videos or additional images.
Array of Media
meta
object
A metadata object containing additional information about the media, such as dimensions, format, or other relevant details.
type
string
The type of media.
Enum
url
string
The URL where the media can be accessed.
alt
string
The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed.
thumbnail
string
The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media.
modified_by
object
Details of the user or entity that last modified the product.
modified_on
string
| date-time
Timestamp indicating the last time the product was modified.
moq
object
Minimum Order Quantity (MOQ) details for the product.
name
string
Name of the product.
net_quantity
object (NetQuantityResponseSchema)
NetQuantityResponseSchema
unit
string
The unit of measurement for the net quantity.
value
number
The actual quantity of the product in the specified unit.
no_of_boxes
integer
Number of boxes required to pack the product.
pending
string
Status indicating if there are pending actions or updates required for the product.
primary_color
string
Primary color of the product.
product_group_tag
array of string
Tags for grouping the product in categories.
product_publish
object (ProductPublished)
ProductPublished
is_set
boolean
Indicates whether the product is part of a set.
product_online_date
integer
Timestamp when the product is scheduled to go live online.
return_config
object (ReturnConfigResponseSchema)
ReturnConfigResponseSchema
returnable
boolean
time
integer
unit
string
short_description
string
A brief description of the product.
size_guide
string
Link or identifier for the product's size guide.
sizes
array of object
List of available sizes for the product along with pricing and identifier information.
slug
string
URL slug for the product page.
stage
string
The current stage of the product in the system workflow (e.g., pending, verified).
tags
array of string
Tags or keywords associated with the product for search and categorization.
tax_identifier
object (TaxIdentifier)
TaxIdentifier
hsn_code
string
hsn_code_id
string
reporting_hsn
string
teaser_tag
object
A short promotional tag or label for the product.
template_tag
string
Tag representing the template used for the product listing.
trader
array of object (Trader)
List of traders or sellers associated with the product.
Array of Trader
address
array of string
List of addresses associated with the trader.
name
string
The name of the trader.
Minimum Length : 1
Maximum Length : 300
type
string
The role or type of the trader.
Enum
uid
integer
Unique identifier for the product.
variant_group
object
Details about the product's variant grouping (e.g., color or size variants).
variant_media
object
Media associated with specific variants of the product.
variants
object
Details about the product's available variants.
verified_by
object (VerifiedBy)
VerifiedBy
user_id
string
The unique identifier of the user who verified the product.
username
string
The username of the user who verified the product.
verified_on
string
| date-time
Timestamp indicating when the product was verified.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
merchandising_rule_id:
"xsb1w2wjxb"
search_keyword:
"test"
Was this section helpful?
GET
Response
Get live preview of a Merchandising Rule
getLivePreview
This view allows you to list down the available synonyms for an application
Parameters
company_id
integer
Required
The company id for which the synonym is being referenced
application_id
string
Required
The application id for which the synonym is being referenced
id
string
Mongo id of the particular synonym
name
string
Synonym name
type
string
Synonym type - oneway/twoway
Response
200
Returns a success response
SynonymListResponseSchema
items
array of object (SynonymResponseSchema)
Array of SynonymResponseSchema
created_on
string
| date-time
_id
string
type
string
synonyms
array of string
key
string
app_id
string
modified_on
string
| date-time
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
1
application_id:
"1"
id:
"63734731995437c3bfd243b2"
name:
"maggie"
type:
"oneway"
Was this section helpful?
GET
Response
List search synonyms for an application
getSynonyms
This view allows you to create search synonyms for an application
Parameters
application_id
integer
Required
The company id for which the synonym is being referenced
company_id
integer
Required
The application id for which the synonym is being referenced
Request body
type
string
key
string
synonyms
array of string
Response
200
400
List of custom search keywords
SynonymCreateResponseSchema
status
boolean
_id
string
message
string
Examples
Parameters
application_id:
"1"
company_id:
1
body:
body
Was this section helpful?
POST
Response
create oneway/ twoway search synonyms for an application
createSynonyms
This view allows you to modify synonym attributes for a particular application
Parameters
company_id
string
Required
The company id for which the synonym is being referenced
application_id
string
Required
The application id for which the synonym is being referenced channel.
id
string
Required
An `id` is a unique identifier for a particular synonym channel.
Request body
type
string
key
string
synonyms
array of string
Response
200
return true/false based on the mongo db operation
SynonymUpdateResponseSchema
success
boolean
message
string
Examples
Parameters
company_id:
"1"
application_id:
"64aed475db2cfb5b8a9f623d"
id:
"65f15a798458d1d40f1f415c"
body:
body
Was this section helpful?
PUT
Response
Update synonym attributes for an application
updateSynonyms
Parameters
company_id
string
Required
The company id for which the synonym is being referenced account.
application_id
string
Required
The application id for which the synonym is being referenced channel.
id
string
Required
A `id` is a unique identifier of a synonym that is to be deleted.
Response
200
Success object. Tells whether the operation was successful.
SynonymDeleteResponseSchemaSchema
message
string
success
boolean
Examples
Parameters
company_id:
"1"
application_id:
"64aed475db2cfb5b8a9f623d"
id:
"63734731995437c3bfd243b2"
Was this section helpful?
DEL
Response
Delete synonym for an application.
deleteSynonym
This API allows you to start a job creates a csv file containing all the synonyms for that application
Parameters
application_id
string
Required
The application id where custom search configuration is set
company_id
integer
Required
Id of the company associated to product that is to be viewed
Response
200
Returns a success response
SynonymExportResponseSchema
job_type
string
stage
string
created_on
string
| date-time
modified_on
string
| date-time
id
string
application_id
string
Examples
Parameters
application_id:
"64aed475db2cfb5b8a9f623d"
company_id:
1
Was this section helpful?
POST
Response
Export synonym for an application.
exportSynonyms
This api return you the sample file for bulk synonyms upload
Parameters
type
string
Required
Type of the file
application_id
string
Required
The application id where custom search configuration is set
company_id
integer
Required
Id of the company associated to product that is to be viewed
Response
200
Returns a success response
Examples
Parameters
type:
"csv"
application_id:
"1"
company_id:
1
Was this section helpful?
GET
Response
Get sample file for bulk synonyms upload
sampleBulkSynonymsFile
This API allows you to upload a list of one-way/two-way synonyms
Parameters
application_id
string
Required
The application id where custom search configuration is set
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
Request body
tracking_url
string
file_type
string
job_type
string
Response
200
400
Returns a success response
SynonymUploadResponseSchema
job_type
string
file_type
string
tracking_url
string
stage
string
is_active
boolean
total_records
integer
success_records
integer
failed_records
integer
created_on
string
| date-time
modified_on
string
| date-time
id
string
Examples
Parameters
application_id:
"64aed475db2cfb5b8a9f623d"
company_id:
1
body:
body
Was this section helpful?
POST
Response
Upload csv/xls/xlsx file with synonyms
uploadSynonyms
This view allows you to validate the file uploaded for synonyms
Parameters
application_id
string
Required
The application id where custom search configuration is set
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
Request body
job_id
string
tracking_url
string
file_type
string
job_type
string
Response
200
Returns a success response
SynonymBulkValidateResponseSchema
job_id
string
message
string
Examples
Parameters
application_id:
"64aed475db2cfb5b8a9f623d"
company_id:
1
body:
body
Was this section helpful?
POST
Response
Validate csv/xls/xlsx file with synonyms
validateBulkSynonyms
This view allows you to process a list of one-way/two-way synonyms
Parameters
application_id
string
Required
The application id where custom search configuration is set
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
Request body
job_id
string
tracking_url
string
file_type
string
job_type
string
Response
200
Returns a success response
SynonymBulkProcessResponseSchema
job_id
string
message
string
Examples
Parameters
application_id:
"64aed475db2cfb5b8a9f623d"
company_id:
1
body:
body
Was this section helpful?
POST
Response
process csv/xls/xlsx file with synonyms and insert onto db
processBulkSynonyms
This view allows you to poll for the status of the respective bulk upload job
Parameters
application_id
string
Required
The application id where custom search configuration is set
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
id
string
Required
Id of the bulk job that needs to be polled.
Response
200
Returns a success response
SynonymBulkPollResponseSchema
total_records
integer
success_records
integer
failed_records
integer
stage
string
error_url
string
message
string
Examples
Parameters
application_id:
"64aed475db2cfb5b8a9f623d"
company_id:
1
id:
"63734731995437c3bfd243b2"
Was this section helpful?
GET
Response
poll a particular synonym bulk job for status
pollBulkSynonyms
Create, retrieve, update, and delete collections. Add and retrieve items within collections for organized content management.
Operations
POST
# Add a Collection
GET
# Retrieve all collections.
GET
# Get the items for a collection
DEL
# Clear priorities set for collection items.
POST
# Add items to a collection
GET
# Get collection details.
PUT
# Update a collection
DEL
# Delete a collection.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Request body
_custom_json
object
Default Value : [object Object]
_locale_language
object
Default Value : [object Object]
_schedule
object (CollectionSchedule)
CollectionSchedule
cron
string
Nullable
duration
integer
Nullable
end
string
Nullable
next_schedule
array of object (NextSchedule)
Array of NextSchedule
end
string
Nullable
start
string
start
string
allow_facets
boolean
Default Value : true
allow_sort
boolean
Default Value : true
app_id
string
badge
object (CollectionBadge)
CollectionBadge
color
string
The color of the badge displayed with the collection, typically represented as a string (e.g., a hex code or color name).
text
string
The text displayed on the badge, which may indicate a label or promotion related to the collection.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
banners
object (CollectionBanner)
Required
CollectionBanner
landscape
object (CollectionImage)
Required
CollectionImage
aspect_ratio
string
url
string
secure_url
string
type
string
portrait
object (CollectionImage)
Required
CollectionImage
aspect_ratio
string
url
string
secure_url
string
type
string
created_by
object (UserInfo)
UserInfo
email
string
| email
The email address of the user.
uid
string
The unique ID of the user.
user_id
string
The ID of the user.
username
string
The username of the user.
description
string
is_active
boolean
Default Value : true
is_visible
boolean
Default Value : true
logo
object (CollectionImage)
Required
CollectionImage
aspect_ratio
string
url
string
secure_url
string
type
string
meta
object
Default Value : [object Object]
modified_by
object (UserInfo)
UserInfo
email
string
| email
The email address of the user.
uid
string
The unique ID of the user.
user_id
string
The ID of the user.
username
string
The username of the user.
name
string
Required
priority
integer
Default Value : 99999
published
boolean
Default Value : true
query
array of object (CollectionQuery)
Default Value :
Array of CollectionQuery
attribute
string
Required
The attribute of the collection query
op
string
Required
The operation to be performed on the attribute of the collection query
Enum
value
array of string
Required
The value of the attribute of the collection query
seo
object (SeoDetail)
SeoDetail
description
string
title
string
sitemap
object (SitemapDetail)
SitemapDetail
priority
number
frequency
string
breadcrumbs
array of object (ApplicationItemSeoBreadcrumbs)
Array of ApplicationItemSeoBreadcrumbs
url
string
action
array of object (ApplicationItemSeoAction)
Array of ApplicationItemSeoAction
page
object
type
string
Required
meta_tags
array of object (Metatags)
Array of Metatags
title
string
items
array of object (ApplicationItemSeoMetaTags)
Array of ApplicationItemSeoMetaTags
title
string
Required
items
array of object (ApplicationItemSeoMetaTagItem)
Array of ApplicationItemSeoMetaTagItem
key
string
Required
value
string
Required
canonical_url
string
slug
string
Required
is_searchable
boolean
sort_on
string
Default Value : popular
tags
array of string
type
string
Required
visible_facets_keys
array of string
Default Value :
Response
200
400
List of all the collections including the one you added. See example below or refer `CollectionCreateResponseSchema` for details
CollectionCreateResponseSchema
badge
object (CollectionBadge)
CollectionBadge
color
string
The color of the badge displayed with the collection, typically represented as a string (e.g., a hex code or color name).
text
string
The text displayed on the badge, which may indicate a label or promotion related to the collection.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
banners
object (CollectionBannerResponseSchema)
CollectionBannerResponseSchema
landscape
object (CollectionImageResponseSchema)
CollectionImageResponseSchema
type
string
url
string
portrait
object (CollectionImageResponseSchema)
CollectionImageResponseSchema
type
string
url
string
cron
object
description
string
is_active
boolean
Default Value : true
is_visible
boolean
Default Value : true
logo
object (CollectionImageResponseSchema)
CollectionImageResponseSchema
type
string
url
string
meta
object
Default Value : [object Object]
name
string
is_searchable
boolean
priority
integer
Default Value : 99999
published
boolean
Default Value : true
query
array of object (CollectionQuery)
Default Value :
Array of CollectionQuery
attribute
string
The attribute of the collection query
op
string
The operation to be performed on the attribute of the collection query
Enum
value
array of string
The value of the attribute of the collection query
seo
object (SeoDetail)
SeoDetail
description
string
title
string
sitemap
object (SitemapDetail)
SitemapDetail
priority
number
frequency
string
breadcrumbs
array of object (ApplicationItemSeoBreadcrumbs)
Array of ApplicationItemSeoBreadcrumbs
url
string
action
array of object (ApplicationItemSeoAction)
Array of ApplicationItemSeoAction
page
object
type
string
meta_tags
array of object (Metatags)
Array of Metatags
title
string
items
array of object (ApplicationItemSeoMetaTags)
Array of ApplicationItemSeoMetaTags
title
string
items
array of object (ApplicationItemSeoMetaTagItem)
Array of ApplicationItemSeoMetaTagItem
key
string
value
string
canonical_url
string
_custom_json
object
Default Value : [object Object]
_locale_language
object
Default Value : [object Object]
_schedule
object (CollectionSchedule)
CollectionSchedule
cron
string
Nullable
duration
integer
Nullable
end
string
Nullable
next_schedule
array of object (NextSchedule)
Array of NextSchedule
end
string
Nullable
start
string
start
string
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
uid
string
allow_facets
boolean
allow_sort
boolean
app_id
string
slug
string
sort_on
string
tags
array of string
type
string
visible_facets_keys
array of string
Examples
Parameters
company_id:
1
application_id:
"64c00b72c07acacc1357503b"
body:
body
Was this section helpful?
POST
Response
Add a Collection
createCollection
A Collection allows you to organize your products into hierarchical groups.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
q
string
Get collection list filtered by q string,
schedule_status
string
Get collection list filtered by scheduled status,
Enum
type
string
type of the collections
tag
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
List of collections.
GetCollectionListingResponseSchema
filters
object (CollectionListingFilter)
CollectionListingFilter
tags
array of object (CollectionListingFilterTag)
Array of CollectionListingFilterTag
display
string
is_selected
boolean
name
string
type
array of object (CollectionListingFilterType)
Array of CollectionListingFilterType
display
string
is_selected
boolean
name
string
items
array of object (GetCollectionDetailNest)
Array of GetCollectionDetailNest
_schedule
object (CollectionSchedule)
CollectionSchedule
cron
string
Nullable
duration
integer
Nullable
end
string
Nullable
next_schedule
array of object (NextSchedule)
Array of NextSchedule
end
string
Nullable
start
string
start
string
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
allow_facets
boolean
allow_sort
boolean
app_id
string
badge
object
banners
object (ImageUrls)
ImageUrls
landscape
object (BannerImage)
BannerImage
aspect_ratio
string
type
string
url
string
| url
portrait
object (BannerImage)
BannerImage
aspect_ratio
string
type
string
url
string
| url
cron
object
description
string
is_active
boolean
logo
object (Media)
Media
meta
object
A metadata object containing additional information about the media, such as dimensions, format, or other relevant details.
type
string
The type of media.
Enum
url
string
The URL where the media can be accessed.
alt
string
The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed.
thumbnail
string
The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media.
meta
object
name
string
priority
integer
query
array of object (CollectionQuery)
Array of CollectionQuery
attribute
string
The attribute of the collection query
op
string
The operation to be performed on the attribute of the collection query
Enum
value
array of string
The value of the attribute of the collection query
slug
string
tag
array of string
type
string
uid
string
visible_facets_keys
array of string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
1
application_id:
"64c00b72c07acacc1357503b"
q:
"test"
schedule_status:
"live"
type:
"query"
tag:
"Test Collection 123"
is_active:
true
page_no:
1
page_size:
1
Was this section helpful?
GET
Response
Retrieve all collections.
getAllCollections
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
id
string
Required
A `id` is a unique identifier of a collection.
sort_on
string
Each response will contain sort_on param, which should be sent back to make pagination work.
page_size
integer
Number of items to retrieve in each page. Default is 12.
page_no
integer
Identifies the specific page of results being requested.
is_pinned
boolean
Number of items that are pinned and have priority in each page. Default is 12.
q
string
Get multiple products filtered by q string
is_excluded
boolean
Number of items that are excluded from collections in each page. Default is 12.
Response
200
400
The attached items of an collection.
GetCollectionItemsResponseSchema
items
array of object (ApplicationProductsSchema)
An array of products that belong to the collection.
Array of ApplicationProductsSchema
attributes
object
Additional attributes of the product, such as custom properties or features.
brand
object (ProductBrand)
ProductBrand
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
logo
object (Media)
Media
meta
object
A metadata object containing additional information about the media, such as dimensions, format, or other relevant details.
type
string
The type of media.
Enum
url
string
The URL where the media can be accessed.
alt
string
The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed.
thumbnail
string
The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media.
name
string
uid
integer
color
string
description
string
A detailed description of the product.
discount
string
The discount applied to the product.
has_variant
boolean
Indicates whether the product has variants, such as different sizes or colors.
highlights
array of string
Key highlights of the product.
image_nature
string
The nature of the product image, indicating if it's the default or a standard image.
Enum
item_code
string
A unique code assigned to the product item at company and brand level.
item_type
string
The type of the product, defining its nature.
Enum
medias
array of object (Media)
A list of media items associated with the product, such as images or videos.
Array of Media
meta
object
A metadata object containing additional information about the media, such as dimensions, format, or other relevant details.
type
string
The type of media.
Enum
url
string
The URL where the media can be accessed.
alt
string
The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed.
thumbnail
string
The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media.
name
string
The name of the product.
price
object (ProductListingPrice)
ProductListingPrice
effective
object (Price1)
Price1
currency_code
object (CurrencyCodeEnum)
Enum
currency_symbol
string
max
number
min
number
marked
object (Price1)
Price1
currency_code
object (CurrencyCodeEnum)
Enum
currency_symbol
string
max
number
min
number
selling
object (Price1)
Price1
currency_code
object (CurrencyCodeEnum)
Enum
currency_symbol
string
max
number
min
number
product_online_date
string
| date-time
The date and time when the product becomes available online.
promo_meta
object
Metadata related to any promotions associated with the product.
rating
number
The average rating of the product, typically based on customer reviews.
rating_count
integer
The total number of ratings the product has received.
sellable
boolean
Indicates whether the product is available for sale.
short_description
string
A brief description of the product.
similars
array of string
A list of similar products.
slug
string
A URL-friendly string representing the product.
teaser_tag
object
A teaser tag object providing short promotional information about the product.
tryouts
array of string
A list of tryout options or samples available for the product.
type
string
The type or category of the product.
uid
integer
A unique identifier for the product.
popularity
integer
A numerical value indicating the popularity of the product.
brand_uid
integer
The unique identifier for the brand associated with the product.
category_uid
integer
The unique identifier for the category to which the product belongs.
verification_status
integer
The verification status of the product, typically represented as an integer.
channel_identifier
string
The identifier for the sales channel through which the product is sold.
category_slug
string
A URL-friendly string representing the product's category.
size_guide
string
A guide or chart providing size information for the product.
l3_categories
array of integer
A list of L3 category IDs of the product.
store_ids
array of integer
A list of store IDs where the product is available.
company_ids
array of integer
A list of company IDs associated with the product.
departments
array of integer
A list of department IDs where the product is categorized.
tags
array of string
A list of tags or keywords associated with the product.
l3_category_names
array of string
A list of names of L3 categories of the product.
sizes
array of string
A list of available sizes for the product.
product_group_tag
array of string
Tags that group the product with other similar products.
multi_size
boolean
Indicates whether the product is available in multiple sizes.
is_gift
boolean
Indicates whether the product can be considered as a gift.
is_cod
boolean
Indicates whether the product is eligible for cash on delivery (COD).
is_dependent
boolean
Indicates whether the product depends on another product.
is_available
boolean
Indicates whether the product is currently available for purchase.
moq
object (ApplicationItemMOQ)
ApplicationItemMOQ
increment_unit
integer
| value >= 1
The minimum quantity increment in which the item can be purchased.
Default Value : 1
maximum
integer
The maximum quantity allowed for purchase.
minimum
integer
| value >= 1
The minimum quantity required for purchase.
Default Value : 1
seo
object (ApplicationItemSEO)
ApplicationItemSEO
description
string
The SEO description of the item
title
string
The SEO title of the item
sitemap
object (ApplicationItemSeoSitemap)
ApplicationItemSeoSitemap
priority
number
The SEO priority of the item
frequency
string
The SEO frequency of the item
breadcrumbs
array of object (ApplicationItemSeoBreadcrumbs)
Array of ApplicationItemSeoBreadcrumbs
url
string
action
array of object (ApplicationItemSeoAction)
Array of ApplicationItemSeoAction
page
object
type
string
meta_tags
array of object (ApplicationItemSeoMetaTags)
Array of ApplicationItemSeoMetaTags
title
string
items
array of object (ApplicationItemSeoMetaTagItem)
Array of ApplicationItemSeoMetaTagItem
key
string
value
string
canonical_url
string
variants
object
An object containing details about the product variants.
variant_media
object
Media items specific to the product variants.
variant_group
object
A group identifier for products that are variants of one another.
multi_categories
array of object (MultiCategoriesSchema)
Array of MultiCategoriesSchema
l1
integer
The ID of the Level 1 (L1) category of the product.
l2
integer
The ID of the Level 2 (L2) category of the product.
l3
integer
The ID of the Level 3 (L3) category of the product.
is_active
boolean
Indicates whether the L3 category of the product is currently active.
department
integer
The department associated with the L3 category of the product.
template_tag
string
Tag used for categorizing or templating purposes.
net_quantity
object
Net quantity details for the product.
custom_order
object (CustomOrder)
CustomOrder
manufacturing_time_unit
string
Unit of time for manufacturing (e.g., days, weeks).
is_custom_order
boolean
Indicates if the product is available for custom orders.
manufacturing_time
integer
Time required for manufacturing in the specified unit.
country_of_origin
string
Country where the product is manufactured or sourced from.
_custom_json
object
Custom JSON data associated with the product.
identifiers
array of string
Identifiers associated with the product.
item_id
integer
Unique identifier for the item.
_custom_meta
array of object (CustomMeta)
Custom meta associated with the product.
Array of CustomMeta
key
string
The key of the metadata. Should be a non-empty string and length should not exceed 30 characters.
Minimum Length : 1
Maximum Length : 30
value
string
The value of the metadata. Should be a non-empty string and length should not exceed 100 characters.
Minimum Length : 1
Maximum Length : 100
discount_percentage
integer
The discount applied to the product in percentage.
sort_on
array of object (ProductSortOn)
Array of ProductSortOn
is_selected
boolean
Indicates whether this sorting option is currently selected.
name
string
The display name of the sorting option, used to show on the UI.
value
string
The value representing the sorting option.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
1
application_id:
"64c00b72c07acacc1357503b"
id:
"65620443a7d23306c5d75df2"
sort_on:
"latest"
page_size:
12
page_no:
1
is_pinned:
true
q:
"brown"
is_excluded:
true
Was this section helpful?
GET
Response
Get the items for a collection
getCollectionItems
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
id
string
Required
A `id` is a unique identifier of a collection.
Response
200
400
Status object. Tells whether the operation was successful.
CommonResponseSchemaCollection
message
string
A message providing details about the response.
Examples
Parameters
company_id:
1
application_id:
"64c00b72c07acacc1357503b"
id:
"65620443a7d23306c5d75df2"
Was this section helpful?
DEL
Response
Clear priorities set for collection items.
clearCollectionItemsPriority
Adds items to a collection specified by its `id`. See `CollectionItemRequest` for the list of attributes needed to add items to an collection.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
id
string
Required
A `id` is a unique identifier of a collection.
Request body
allow_facets
boolean
Indicates whether facets are allowed for filtering the collection items.
allow_sort
boolean
Indicates whether sorting is enabled for the collection items.
items
array of object (CollectionItemSchemaV2)
A list of items in the collection.
Array of CollectionItemSchemaV2
action
string
Required
Specifies whether the item should be added or removed from the collection.
Enum
item_id
integer
Required
The unique identifier of the item in the collection.
priority
integer
The priority level of the item in the collection, with higher values representing higher priority.
query
array of object (CollectionQuerySchemaV2)
A list of query conditions to filter the collection items.
Array of CollectionQuerySchemaV2
attribute
string
Required
The attribute of the collection query
op
string
Required
The operation to be performed on the attribute of the collection query
Enum
value
array of string
Required
type
string
Required
The type of the collection item, defining its classification.
visible_facets_keys
array of string
A list of keys representing visible facets for the collection, used for filtering.
Response
200
400
Status object. Tells whether the operation was successful.
CommonResponseSchemaCollection
message
string
A message providing details about the response.
Examples
Parameters
company_id:
1
application_id:
"64c00b72c07acacc1357503b"
id:
"65620443a7d23306c5d75df2"
body:
body
Was this section helpful?
POST
Response
Add items to a collection
addCollectionItems
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
slug
string
Required
A `slug` is a human readable, URL friendly unique identifier of an object. Pass the `slug` of the collection which you want to retrieve.
Response
200
The Collection object.
GetCollectionDetailResponseSchema
_custom_json
object
Custom JSON data associated with the collection.
_locale_language
object
Locale-specific language details.
_schedule
object (CollectionSchedule)
CollectionSchedule
cron
string
Nullable
duration
integer
Nullable
end
string
Nullable
next_schedule
array of object (NextSchedule)
Array of NextSchedule
end
string
Nullable
start
string
start
string
action
object
Action details, including navigation or page redirection information.
allow_facets
boolean
Indicates whether facets are allowed for filtering the collection.
allow_sort
boolean
Indicates whether sorting is enabled for the collection.
app_id
string
The unique identifier of the application to which the collection belongs.
badge
object (CollectionBadge)
CollectionBadge
color
string
The color of the badge displayed with the collection, typically represented as a string (e.g., a hex code or color name).
text
string
The text displayed on the badge, which may indicate a label or promotion related to the collection.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
banners
object (ImageUrls)
ImageUrls
landscape
object (BannerImage)
BannerImage
aspect_ratio
string
type
string
url
string
| url
portrait
object (BannerImage)
BannerImage
aspect_ratio
string
type
string
url
string
| url
cron
object
description
string
A textual description of the collection.
is_active
boolean
Indicates whether the collection is currently active.
is_visible
boolean
Indicates whether the collection is visible on the platform.
logo
object (Media)
Media
meta
object
A metadata object containing additional information about the media, such as dimensions, format, or other relevant details.
type
string
The type of media.
Enum
url
string
The URL where the media can be accessed.
alt
string
The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed.
thumbnail
string
The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media.
meta
object
Metadata associated with the collection.
name
string
The name of the collection.
priority
integer
The priority level assigned to the collection.
published
boolean
Indicates whether the collection is published and visible to customers.
query
array of object (CollectionQuery)
Query details that define how items in the collection are filtered.
Array of CollectionQuery
attribute
string
The attribute of the collection query
op
string
The operation to be performed on the attribute of the collection query
Enum
value
array of string
The value of the attribute of the collection query
seo
object (SeoDetail)
SeoDetail
description
string
title
string
sitemap
object (SitemapDetail)
SitemapDetail
priority
number
frequency
string
breadcrumbs
array of object (ApplicationItemSeoBreadcrumbs)
Array of ApplicationItemSeoBreadcrumbs
url
string
action
array of object (ApplicationItemSeoAction)
Array of ApplicationItemSeoAction
page
object
type
string
meta_tags
array of object (Metatags)
Array of Metatags
title
string
items
array of object (ApplicationItemSeoMetaTags)
Array of ApplicationItemSeoMetaTags
title
string
items
array of object (ApplicationItemSeoMetaTagItem)
Array of ApplicationItemSeoMetaTagItem
key
string
value
string
canonical_url
string
slug
string
The URL-friendly slug for the collection.
sort_on
string
The sorting criteria applied to the collection (e.g., by latest, discount).
tags
array of string
Tags associated with the collection.
type
string
The type of the collection (e.g., query-based).
uid
string
A unique identifier for the collection.
_id
string
A unique identifier for the collection, matching `uid`.
visible_facets_keys
array of string
Keys representing visible facets for filtering.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
application_id:
"64c00b72c07acacc1357503b"
slug:
"testslug2"
Was this section helpful?
GET
Response
Get collection details.
getCollectionDetail
Update a collection by it's id. On successful request, returns the updated collection
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
id
string
Required
A `id` is a unique identifier of a collection.
Request body
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Required
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Required
Enum
uid
string
app_id
string
_custom_json
object
Custom JSON object containing additional metadata specific to the collection.
_locale_language
object
Locale-based language settings for the collection.
_schedule
object (CollectionSchedule)
CollectionSchedule
cron
string
Nullable
duration
integer
Nullable
end
string
Nullable
next_schedule
array of object (NextSchedule)
Array of NextSchedule
end
string
Nullable
start
string
start
string
allow_facets
boolean
Indicates whether facets are allowed for filtering items in the collection.
allow_sort
boolean
Specifies whether sorting is allowed for items within the collection.
badge
object (CollectionBadge)
CollectionBadge
color
string
The color of the badge displayed with the collection, typically represented as a string (e.g., a hex code or color name).
text
string
The text displayed on the badge, which may indicate a label or promotion related to the collection.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
banners
object (CollectionBanner)
CollectionBanner
landscape
object (CollectionImage)
Required
CollectionImage
aspect_ratio
string
url
string
secure_url
string
type
string
portrait
object (CollectionImage)
Required
CollectionImage
aspect_ratio
string
url
string
secure_url
string
type
string
description
string
A brief description of the collection.
is_active
boolean
Indicates if the collection is active and visible to users.
is_visible
boolean
Specifies whether the collection is visible to users on the platform.
logo
object (CollectionImage)
CollectionImage
aspect_ratio
string
url
string
secure_url
string
type
string
meta
object
Additional metadata related to the collection.
modified_by
object (UserInfo)
UserInfo
email
string
| email
The email address of the user.
uid
string
The unique ID of the user.
user_id
string
The ID of the user.
username
string
The username of the user.
name
string
The name of the collection.
priority
integer
Priority level of the collection, determining its order in listings.
published
boolean
Indicates whether the collection is published and accessible to the public.
query
array of object (CollectionQuery)
List of query filters that define which items are included in the collection.
Array of CollectionQuery
attribute
string
Required
The attribute of the collection query
op
string
Required
The operation to be performed on the attribute of the collection query
Enum
value
array of string
Required
The value of the attribute of the collection query
seo
object (CollectionSeoDetail)
CollectionSeoDetail
description
string
SEO meta description for the item or collection. This is used to describe the content for search engines.
title
string
SEO meta title for the item or collection. It is used as the title that appears in search results.
sitemap
object (Sitemap)
Sitemap
priority
number
frequency
string
breadcrumbs
array of object (ApplicationCollectionItemSeoBreadcrumbs)
List of breadcrumbs for navigation, showing the hierarchy of pages leading to the current page.
Array of ApplicationCollectionItemSeoBreadcrumbs
url
string
The URL that this breadcrumb points to.
action
object (ApplicationCollectionItemSeoAction)
ApplicationCollectionItemSeoAction
type
string
The type of action, typically 'page'.
page
object (ApplicationCollectionItemSeoPage)
ApplicationCollectionItemSeoPage
params
object
Any parameters associated with the page.
query
object (PageQuery)
PageQuery
brand
array of string
List of brands being filtered by the query.
type
string
The type of page.
url
string
| uri
The URL for the page.
meta_tags
array of object (Metatags)
An array of meta tags, each containing key-value pairs for various SEO meta tags used to enhance search visibility.
Array of Metatags
title
string
items
array of object (ApplicationItemSeoMetaTags)
Array of ApplicationItemSeoMetaTags
title
string
Required
items
array of object (ApplicationItemSeoMetaTagItem)
Array of ApplicationItemSeoMetaTagItem
key
string
Required
value
string
Required
canonical_url
string
The canonical URL for the item or collection, which tells search engines the preferred version of the URL to avoid duplicate content issues.
slug
string
A unique identifier used to reference the collection in URLs.
sort_on
string
The field by which items in the collection are sorted (e.g., popular, latest).
tags
array of string
List of tags associated with the collection.
type
string
The type of collection, either 'items' or 'query'.
visible_facets_keys
array of string
Keys for facets that are visible to users for filtering items in the collection.
is_searchable
boolean
Response
200
400
The Collection object.
UpdateCollection
action
object (Action)
Action
type
string
Type of action to be taken e.g, page.
page
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
popup
object (ActionPage)
ActionPage
params
object
Parameters that should be considered in path.
query
object
Query parameter if any to be added to the action.
url
string
The URL for the action.
type
object (PageType)
Enum
uid
string
app_id
string
_custom_json
object
Custom JSON object containing additional metadata specific to the collection.
_locale_language
object
Locale-based language settings for the collection.
_schedule
object (CollectionSchedule)
CollectionSchedule
cron
string
Nullable
duration
integer
Nullable
end
string
Nullable
next_schedule
array of object (NextSchedule)
Array of NextSchedule
end
string
Nullable
start
string
start
string
allow_facets
boolean
Indicates whether facets are allowed for filtering items in the collection.
allow_sort
boolean
Specifies whether sorting is allowed for items within the collection.
badge
object (CollectionBadge)
CollectionBadge
color
string
The color of the badge displayed with the collection, typically represented as a string (e.g., a hex code or color name).
text
string
The text displayed on the badge, which may indicate a label or promotion related to the collection.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
banners
object (CollectionBanner)
CollectionBanner
landscape
object (CollectionImage)
CollectionImage
aspect_ratio
string
url
string
secure_url
string
type
string
portrait
object (CollectionImage)
CollectionImage
aspect_ratio
string
url
string
secure_url
string
type
string
description
string
A brief description of the collection.
is_active
boolean
Indicates if the collection is active and visible to users.
is_visible
boolean
Specifies whether the collection is visible to users on the platform.
logo
object (CollectionImage)
CollectionImage
aspect_ratio
string
url
string
secure_url
string
type
string
meta
object
Additional metadata related to the collection.
modified_by
object (UserInfo)
UserInfo
email
string
| email
The email address of the user.
uid
string
The unique ID of the user.
user_id
string
The ID of the user.
username
string
The username of the user.
name
string
The name of the collection.
priority
integer
Priority level of the collection, determining its order in listings.
published
boolean
Indicates whether the collection is published and accessible to the public.
query
array of object (CollectionQuery)
List of query filters that define which items are included in the collection.
Array of CollectionQuery
attribute
string
The attribute of the collection query
op
string
The operation to be performed on the attribute of the collection query
Enum
value
array of string
The value of the attribute of the collection query
seo
object (CollectionSeoDetail)
CollectionSeoDetail
description
string
SEO meta description for the item or collection. This is used to describe the content for search engines.
title
string
SEO meta title for the item or collection. It is used as the title that appears in search results.
sitemap
object (Sitemap)
Sitemap
priority
number
frequency
string
breadcrumbs
array of object (ApplicationCollectionItemSeoBreadcrumbs)
List of breadcrumbs for navigation, showing the hierarchy of pages leading to the current page.
Array of ApplicationCollectionItemSeoBreadcrumbs
url
string
The URL that this breadcrumb points to.
action
object (ApplicationCollectionItemSeoAction)
ApplicationCollectionItemSeoAction
type
string
The type of action, typically 'page'.
page
object (ApplicationCollectionItemSeoPage)
ApplicationCollectionItemSeoPage
params
object
Any parameters associated with the page.
query
object (PageQuery)
PageQuery
brand
array of string
List of brands being filtered by the query.
type
string
The type of page.
url
string
| uri
The URL for the page.
meta_tags
array of object (Metatags)
An array of meta tags, each containing key-value pairs for various SEO meta tags used to enhance search visibility.
Array of Metatags
title
string
items
array of object (ApplicationItemSeoMetaTags)
Array of ApplicationItemSeoMetaTags
title
string
items
array of object (ApplicationItemSeoMetaTagItem)
Array of ApplicationItemSeoMetaTagItem
key
string
value
string
canonical_url
string
The canonical URL for the item or collection, which tells search engines the preferred version of the URL to avoid duplicate content issues.
slug
string
A unique identifier used to reference the collection in URLs.
sort_on
string
The field by which items in the collection are sorted (e.g., popular, latest).
tags
array of string
List of tags associated with the collection.
type
string
The type of collection, either 'items' or 'query'.
visible_facets_keys
array of string
Keys for facets that are visible to users for filtering items in the collection.
is_searchable
boolean
Examples
Parameters
company_id:
1
application_id:
"64c00b72c07acacc1357503b"
id:
"65620443a7d23306c5d75df2"
body:
body
Was this section helpful?
PUT
Response
Update a collection
updateCollection
Delete a collection by it's id. Returns an object that tells whether the collection was deleted successfully
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
id
string
Required
A `id` is a unique identifier of a collection.
Response
200
400
Status object. Tells whether the operation was successful.
CommonResponseSchemaCollection
message
string
A message providing details about the response.
Examples
Parameters
company_id:
1
application_id:
"64c00b72c07acacc1357503b"
id:
"65620443a7d23306c5d75df2"
Was this section helpful?
DEL
Response
Delete a collection.
deleteCollection
Access catalog insights, seller performance data, and company metrics for informed decision-making and performance evaluation.
Operations
GET
# Get catalog insights.
Retrieve the count of catalog related data like products, brands, departments and categories that have been made live as per configuration of the application.
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
string
Brand slug
Response
200
Response Data
CatalogInsightResponseSchema
brand_distribution
object (CatalogInsightBrand)
CatalogInsightBrand
article_freshness
integer
available_articles
integer
available_sizes
integer
name
string
total_articles
integer
total_sizes
integer
item
object (CatalogInsightItem)
CatalogInsightItem
count
integer
out_of_stock_count
integer
sellable_count
integer
Examples
Parameters
company_id:
"1"
application_id:
"64aed475db2cfb5b8a9f623d"
brand:
"test"
Was this section helpful?
GET
Response
Get catalog insights.
getCatalogInsights
Simplify your product management. Create, retrieve, update, and delete products globally. Handle variants and attributes at the global level. Manage inventory and perform bulk operations at the company level. Additionally, oversee HSN codes at the company level and manage product assets globally for comprehensive product management.
Operations
GET
# Get discounted inventory by size identifier.
GET
# Get pricing of a product
Allows to retrieve Inventory data for particular company grouped by size and store.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
item_id
integer
Required
Item code of the product of which size is to be get.
size_identifier
integer
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
location_ids
array of integer
Search by store ids.
Response
200
returns a list of all inventory grouped by size and store
ApplicationInventorySellerIdentifierResponsePaginated
items
array of object (InventorySellerResponseSchema)
Array of InventorySellerResponseSchema
_custom_json
object
Custom JSON data for the article.
added_on_store
string
The date and time when the article was added to the store.
brand
object (BrandMeta)
BrandMeta
id
integer
Unique identifier for the brand.
name
string
Name of the brand.
company
object (CompanyMeta)
CompanyMeta
id
integer
Unique identifier for the company.
country_of_origin
string
The country of origin of the article.
created_by
object (UserSchema)
Nullable
The user who created the article.
UserSchema
_id
string
contact
string
The contact information of the user.
uid
string
user_id
string
The unique ID of the user.
username
string
The username of the user.
dimension
object (DimensionResponseSchema)
DimensionResponseSchema
height
number
The height dimension.
is_default
boolean
Indicates if it is the default dimension.
length
number
The length dimension.
unit
string
The unit of dimension.
width
number
The width dimension.
expiration_date
string
| date-time
The expiration date of the article.
fragile
boolean
Indicates if the article is fragile.
fynd_article_code
string
The Fynd article code.
fynd_item_code
string
The Fynd item code.
fynd_meta
object
The Fynd metadata of the article.
identifier
object
The identifier of the article.
is_active
boolean
Indicates if the article is active.
Default Value : true
is_set
boolean
item_id
integer
The ID of the item.
manufacturer
object (ManufacturerResponseSchema)
ManufacturerResponseSchema
address
string
The address of the manufacturer.
is_default
boolean
Indicates if it is the default manufacturer.
name
string
The name of the manufacturer.
meta
object
Nullable
Additional metadata for the article.
modified_by
object (UserSchema)
Nullable
The user who modified the article.
UserSchema
_id
string
contact
string
The contact information of the user.
uid
string
user_id
string
The unique ID of the user.
username
string
The username of the user.
price
object (PriceMeta)
PriceMeta
currency
string
The currency used for the prices.
effective
number
The effective price.
marked
number
The marked price.
tp_notes
object
Additional notes for the transfer price.
transfer
number
The transfer price.
updated_at
string
| date-time
The date and time of the last update.
quantities
object (Quantities)
Quantities
damaged
object (QuantityBase)
QuantityBase
count
integer
updated_at
string
| date-time
not_available
object (QuantityBase)
QuantityBase
count
integer
updated_at
string
| date-time
order_committed
object (QuantityBase)
QuantityBase
count
integer
updated_at
string
| date-time
sellable
object (QuantityBase)
QuantityBase
count
integer
updated_at
string
| date-time
raw_meta
object
The raw metadata of the article.
return_config
object (InventoryReturnConfig)
InventoryReturnConfig
returnable
boolean
Indicates if the item is returnable.
Default Value : false
time
integer
| value >= 0
The return time in days or hours.
unit
string
The unit of return time.
Enum
seller_identifier
string
The seller identifier of the article.
set
object (InventorySet)
InventorySet
name
string
The name of the inventory set.
quantity
integer
The quantity of items available in the inventory set.
size_distribution
object (SizeDistribution)
SizeDistribution
sizes
array of object (SetSize)
Array of SetSize
pieces
integer
| value >= 1
| value <= 100
Number of pieces in the set.
size
string
Size of the item in the set.
size
string
The size of the article.
stage
string
The stage of the article.
store
object (StoreMeta)
StoreMeta
id
integer
The unique identifier of the store.
tags
array of string
Nullable
The tags associated with the article.
tax_identifier
object (TaxIdentifier)
TaxIdentifier
hsn_code
string
hsn_code_id
string
reporting_hsn
string
total_quantity
integer
| value >= 0
The total quantity of the article.
trace_id
string
The trace ID of the article.
track_inventory
boolean
Indicates if the inventory is tracked for the article.
Default Value : true
trader
array of object (Trader1)
Nullable
The traders associated with the article.
Array of Trader1
address
array of string
name
string
type
string
Enum
uid
string
The unique identifier of the article.
weight
object (WeightResponseSchema)
WeightResponseSchema
is_default
boolean
Indicates if it is the default weight.
shipping
number
The shipping weight.
unit
string
The unit of weight.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
1
application_id:
"63b6aa5558bf3ed100740c10"
item_id:
75779472
size_identifier:
410163085004
page_no:
1
page_size:
1
location_ids:
1
Was this section helpful?
GET
Response
Get discounted inventory by size identifier.
getDiscountedInventoryBySizeIdentifier
Retrieve the discounted price of a specific product for a given application. This endpoint allows filtering by stores, factory types, and sellers
Parameters
application_id
string
Required
An `application_id` is a unique identifier for a particular sale channel.
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
item_id
integer
Required
Unique identifier of the product
store_ids
array of integer
An array of unique identifiers representing the store locations from which the product pricing should be fetched. If not provided, pricing for all applicable store locations will be returned.
factory_type_ids
array of string
An array of unique factory type identifiers that specify that pricing from which factory type should be retrieved. This parameter allows filtering the price based on factory types.
seller_id
integer
The company uid for which we want to fetch discounted pricing for a product
Response
200
Success. Returns discounted price grouped by factory_type_ids and the min-max marked, effective and selling price
AppPriceByIdResponseSchema
data
array of object (PriceGroupedByZone)
Array of PriceGroupedByZone
discount
string
store_id
array of integer
seller_id
integer
factory_type_id
string
discount_meta
object (DiscountMeta)
DiscountMeta
start
string
end
string
timer
boolean
price
object (ProductListingPrice)
ProductListingPrice
effective
object (Price1)
Price1
currency_code
object (CurrencyCodeEnum)
Enum
currency_symbol
string
max
number
min
number
marked
object (Price1)
Price1
currency_code
object (CurrencyCodeEnum)
Enum
currency_symbol
string
max
number
min
number
selling
object (Price1)
Price1
currency_code
object (CurrencyCodeEnum)
Enum
currency_symbol
string
max
number
min
number
Examples
Parameters
application_id:
"000000000000000000000001"
company_id:
1
item_id:
7513279
store_ids:
9691
factory_type_ids:
"65f14a0e33072af204b29263"
seller_id:
1
Was this section helpful?
GET
Response
Get pricing of a product
getAppPriceById
Access and modify platform-wide configurations. Retrieve the current platform configuration settings and update them as needed.
Operations
GET
# Retrieve query filters.
GET
# Retrieve configurations.
POST
# Create configuration for product listing.
GET
# Retrieve catalog configuration.
GET
# Retrieve configuration by type.
POST
# Create configuration by type.
POST
# Update 'Allow Single' setting.
POST
# Update default sorting.
POST
# Create listing configuration.
GET
# Retrieve listing configurations.
POST
# Create group configuration.
GET
# Retrieve group configurations.
PUT
# Update group configuration.
DEL
# Delete group configuration.
PUT
# Update listing configuration.
DEL
# Delete listing configuration.
GET
# Retrieve configuration metadata.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Response
200
The attached items of an collection.
GetQueryFiltersResponseSchema
filters
array of object (CollectionProductFilters)
An array of filters to be applied on products while querying.
Array of CollectionProductFilters
key
object (ProductFiltersKey)
ProductFiltersKey
display
string
kind
string
logo
string
| url
name
string
operators
array of string
values
array of object (CollectionProductFiltersValue)
A list of possible values corresponding to the filter key. These values can be selected for filtering products.
Array of CollectionProductFiltersValue
display
string
Display name of the filter value.
count
integer
The number of products that match this filter value.
is_selected
boolean
Indicates whether the filter value is currently selected by the user.
value
string
The actual value for the filter, used in filtering queries.
logo
object
operators
object
A map of operators available for product queries, where the key is the operator type and the value is a string.
sort_on
array of object (CollectionProductSortOn)
An array of sorting options to be applied to product queries.
Array of CollectionProductSortOn
is_selected
boolean
Indicates whether this sorting option is currently applied.
name
string
Display name of the sorting option.
value
string
Technical value of the sorting option used in queries.
logo
string
| url
URL to the logo image representing the sorting option.
Examples
Parameters
company_id:
1
application_id:
"64c00b72c07acacc1357503b"
Was this section helpful?
GET
Response
Retrieve query filters.
getQueryFilters
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Response
200
Get application level configured catalog details.
GetAppCatalogConfiguration
data
object (AppCatalogConfiguration)
AppCatalogConfiguration
app_id
string
config_id
string
config_type
string
created_by
object (UserSchema)
The user who created the configuration.
UserSchema
_id
string
contact
string
The contact information of the user.
uid
string
user_id
string
The unique ID of the user.
username
string
The username of the user.
created_on
string
| date-time
id
string
listing
object (ConfigurationListing)
ConfigurationListing
filter
object (ConfigurationListingFilter)
ConfigurationListingFilter
allow_single
boolean
attribute_config
array of object (ConfigurationListingFilterConfig)
Array of ConfigurationListingFilterConfig
display_name
string
is_active
boolean
key
string
logo
string
| url
name
string
priority
integer
| value >= 1
type
string
Enum
value_config
object (ConfigurationListingFilterValue)
ConfigurationListingFilterValue
bucket_points
array of object (ConfigurationBucketPoints)
Array of ConfigurationBucketPoints
display
string
end
number
start
number
condition
string
Default Value : OR
map
object
map_values
array of object
priority
array of string
sort
string
Default Value : count
value
string
sort
object (ConfigurationListingSort)
ConfigurationListingSort
config
array of object (ConfigurationListingSortConfig)
Array of ConfigurationListingSortConfig
is_active
boolean
key
string
logo
string
| url
name
string
priority
integer
| value >= 1
default_key
string
modified_by
object (UserSchema)
The user who modified the configuration.
UserSchema
_id
string
contact
string
The contact information of the user.
uid
string
user_id
string
The unique ID of the user.
username
string
The username of the user.
modified_on
string
| date-time
product
object (ConfigurationProduct)
ConfigurationProduct
similar
object (ConfigurationProductSimilar)
ConfigurationProductSimilar
config
array of object (ConfigurationProductConfig)
Array of ConfigurationProductConfig
is_active
boolean
key
string
logo
string
| url
priority
integer
| value >= 1
size
object (ProductSize)
ProductSize
max
integer
| value >= 1
min
integer
| value >= 1
subtitle
string
title
string
variant
object (ConfigurationProductVariant)
ConfigurationProductVariant
config
array of object (ConfigurationProductVariantConfig)
Array of ConfigurationProductVariantConfig
display_type
string
is_active
boolean
key
string
logo
string
| url
name
string
priority
integer
| value >= 1
size
object (ProductSize)
ProductSize
max
integer
| value >= 1
min
integer
| value >= 1
details_groups
object (ConfigurationProductDetailsGroups)
ConfigurationProductDetailsGroups
config
array of object (ConfigurationProductDetailsConfig)
Array of ConfigurationProductDetailsConfig
name
string
slug
string
priority
integer
template_slugs
array of string
attributes
array of object (ConfigurationProductDetailsAttribute)
Array of ConfigurationProductDetailsAttribute
name
string
slug
string
display_type
string
priority
integer
is_active
boolean
key
string
is_active
boolean
type
string
is_default
boolean
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
Was this section helpful?
GET
Response
Retrieve configurations.
getConfigurations
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Request body
app_id
string
Required
config_id
string
config_type
string
Required
created_by
object
created_on
string
| date-time
listing
object (ConfigurationListing)
ConfigurationListing
filter
object (ConfigurationListingFilter)
ConfigurationListingFilter
allow_single
boolean
Required
attribute_config
array of object (ConfigurationListingFilterConfig)
Array of ConfigurationListingFilterConfig
display_name
string
is_active
boolean
Required
key
string
Required
logo
string
| url
name
string
priority
integer
| value >= 1
Required
type
string
Required
Enum
value_config
object (ConfigurationListingFilterValue)
ConfigurationListingFilterValue
bucket_points
array of object (ConfigurationBucketPoints)
Array of ConfigurationBucketPoints
display
string
end
number
start
number
condition
string
Default Value : OR
map
object
map_values
array of object
priority
array of string
sort
string
Default Value : count
value
string
sort
object (ConfigurationListingSort)
ConfigurationListingSort
config
array of object (ConfigurationListingSortConfig)
Array of ConfigurationListingSortConfig
is_active
boolean
Required
key
string
Required
logo
string
| url
name
string
priority
integer
| value >= 1
Required
default_key
string
Required
modified_by
object
modified_on
string
| date-time
product
object (ConfigurationProduct)
ConfigurationProduct
similar
object (ConfigurationProductSimilar)
ConfigurationProductSimilar
config
array of object (ConfigurationProductConfig)
Array of ConfigurationProductConfig
is_active
boolean
Required
key
string
Required
logo
string
| url
priority
integer
| value >= 1
Required
size
object (ProductSize)
ProductSize
max
integer
| value >= 1
Required
min
integer
| value >= 1
Required
subtitle
string
title
string
variant
object (ConfigurationProductVariant)
ConfigurationProductVariant
config
array of object (ConfigurationProductVariantConfig)
Array of ConfigurationProductVariantConfig
display_type
string
Required
is_active
boolean
Required
key
string
Required
logo
string
| url
name
string
Required
priority
integer
| value >= 1
Required
size
object (ProductSize)
Required
ProductSize
max
integer
| value >= 1
Required
min
integer
| value >= 1
Required
details_groups
object (ConfigurationProductDetailsGroups)
ConfigurationProductDetailsGroups
config
array of object (ConfigurationProductDetailsConfig)
Array of ConfigurationProductDetailsConfig
name
string
slug
string
priority
integer
template_slugs
array of string
attributes
array of object (ConfigurationProductDetailsAttribute)
Array of ConfigurationProductDetailsAttribute
name
string
slug
string
display_type
string
priority
integer
is_active
boolean
key
string
is_active
boolean
type
string
Response
200
400
success flag will tell whether the operation was successful.
GetAppCatalogConfiguration
data
object (AppCatalogConfiguration)
AppCatalogConfiguration
app_id
string
config_id
string
config_type
string
created_by
object (UserSchema)
The user who created the configuration.
UserSchema
_id
string
contact
string
The contact information of the user.
uid
string
user_id
string
The unique ID of the user.
username
string
The username of the user.
created_on
string
| date-time
id
string
listing
object (ConfigurationListing)
ConfigurationListing
filter
object (ConfigurationListingFilter)
ConfigurationListingFilter
allow_single
boolean
attribute_config
array of object (ConfigurationListingFilterConfig)
Array of ConfigurationListingFilterConfig
display_name
string
is_active
boolean
key
string
logo
string
| url
name
string
priority
integer
| value >= 1
type
string
Enum
value_config
object (ConfigurationListingFilterValue)
ConfigurationListingFilterValue
bucket_points
array of object (ConfigurationBucketPoints)
Array of ConfigurationBucketPoints
display
string
end
number
start
number
condition
string
Default Value : OR
map
object
map_values
array of object
priority
array of string
sort
string
Default Value : count
value
string
sort
object (ConfigurationListingSort)
ConfigurationListingSort
config
array of object (ConfigurationListingSortConfig)
Array of ConfigurationListingSortConfig
is_active
boolean
key
string
logo
string
| url
name
string
priority
integer
| value >= 1
default_key
string
modified_by
object (UserSchema)
The user who modified the configuration.
UserSchema
_id
string
contact
string
The contact information of the user.
uid
string
user_id
string
The unique ID of the user.
username
string
The username of the user.
modified_on
string
| date-time
product
object (ConfigurationProduct)
ConfigurationProduct
similar
object (ConfigurationProductSimilar)
ConfigurationProductSimilar
config
array of object (ConfigurationProductConfig)
Array of ConfigurationProductConfig
is_active
boolean
key
string
logo
string
| url
priority
integer
| value >= 1
size
object (ProductSize)
ProductSize
max
integer
| value >= 1
min
integer
| value >= 1
subtitle
string
title
string
variant
object (ConfigurationProductVariant)
ConfigurationProductVariant
config
array of object (ConfigurationProductVariantConfig)
Array of ConfigurationProductVariantConfig
display_type
string
is_active
boolean
key
string
logo
string
| url
name
string
priority
integer
| value >= 1
size
object (ProductSize)
ProductSize
max
integer
| value >= 1
min
integer
| value >= 1
details_groups
object (ConfigurationProductDetailsGroups)
ConfigurationProductDetailsGroups
config
array of object (ConfigurationProductDetailsConfig)
Array of ConfigurationProductDetailsConfig
name
string
slug
string
priority
integer
template_slugs
array of string
attributes
array of object (ConfigurationProductDetailsAttribute)
Array of ConfigurationProductDetailsAttribute
name
string
slug
string
display_type
string
priority
integer
is_active
boolean
key
string
is_active
boolean
type
string
is_default
boolean
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
body:
body
Was this section helpful?
POST
Response
Create configuration for product listing.
createConfigurationProductListing
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Response
200
configuration details for catalog.
GetCatalogConfigurationMetaData
listing
object (MetaDataListingResponseSchema)
MetaDataListingResponseSchema
filter
object (MetaDataListingFilterResponseSchema)
MetaDataListingFilterResponseSchema
data
array of object (MetaDataListingFilterMetaResponseSchema)
Array of MetaDataListingFilterMetaResponseSchema
display
string
filter_types
array of string
key
string
units
array of object
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
sort
object (MetaDataListingSortResponseSchema)
MetaDataListingSortResponseSchema
data
array of object (MetaDataListingSortMetaResponseSchema)
Array of MetaDataListingSortMetaResponseSchema
display
string
key
string
product
object (GetCatalogConfigurationDetailsProduct)
GetCatalogConfigurationDetailsProduct
compare
object (CompareFilter)
CompareFilter
data
array of object (FilterItem)
Array of FilterItem
key
string
display
string
filter_types
array of string
units
array of string
similar
object (SimilarFilter)
SimilarFilter
data
array of object (SimilarItem)
Array of SimilarItem
key
string
display
string
variant
object (VariantFilter)
VariantFilter
data
array of object (VariantItem)
Array of VariantItem
key
string
display
string
detail
object (DetailFilter)
DetailFilter
data
array of object (FilterItem)
Array of FilterItem
key
string
display
string
filter_types
array of string
units
array of string
values
object (DetailFilterValues)
DetailFilterValues
display_type
array of object (DisplayType)
Array of DisplayType
key
string
display
string
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
Was this section helpful?
GET
Response
Retrieve catalog configuration.
getCatalogConfiguration
Retrieve configuration details based on a specific type in the catalog.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
type
string
Required
type can be brands, categories etc.
Response
200
Get application level configured catalog details. See example below or refer `GetAppCatalogEntityConfigurationSchema` for details
GetAppCatalogEntityConfiguration
data
object (EntityConfiguration)
EntityConfiguration
app_id
string
config_id
string
config_type
string
id
string
listing
object (GetCatalogConfigurationDetailsSchemaListing)
GetCatalogConfigurationDetailsSchemaListing
filter
object
sort
object
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
product
object (GetCatalogConfigurationDetailsProduct)
GetCatalogConfigurationDetailsProduct
compare
object (CompareFilter)
CompareFilter
data
array of object (FilterItem)
Array of FilterItem
key
string
display
string
filter_types
array of string
units
array of string
similar
object (SimilarFilter)
SimilarFilter
data
array of object (SimilarItem)
Array of SimilarItem
key
string
display
string
variant
object (VariantFilter)
VariantFilter
data
array of object (VariantItem)
Array of VariantItem
key
string
display
string
detail
object (DetailFilter)
DetailFilter
data
array of object (FilterItem)
Array of FilterItem
key
string
display
string
filter_types
array of string
units
array of string
values
object (DetailFilterValues)
DetailFilterValues
display_type
array of object (DisplayType)
Array of DisplayType
key
string
display
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
is_default
boolean
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
type:
"categories"
Was this section helpful?
GET
Response
Retrieve configuration by type.
getConfigurationByType
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
type
string
Required
type can be brands, categories etc.
Request body
app_id
string
Required
config_id
string
config_type
string
Required
created_by
object
created_on
string
| date-time
listing
object (ConfigurationListing)
ConfigurationListing
filter
object (ConfigurationListingFilter)
ConfigurationListingFilter
allow_single
boolean
Required
attribute_config
array of object (ConfigurationListingFilterConfig)
Array of ConfigurationListingFilterConfig
display_name
string
is_active
boolean
Required
key
string
Required
logo
string
| url
name
string
priority
integer
| value >= 1
Required
type
string
Required
Enum
value_config
object (ConfigurationListingFilterValue)
ConfigurationListingFilterValue
bucket_points
array of object (ConfigurationBucketPoints)
Array of ConfigurationBucketPoints
display
string
end
number
start
number
condition
string
Default Value : OR
map
object
map_values
array of object
priority
array of string
sort
string
Default Value : count
value
string
sort
object (ConfigurationListingSort)
ConfigurationListingSort
config
array of object (ConfigurationListingSortConfig)
Array of ConfigurationListingSortConfig
is_active
boolean
Required
key
string
Required
logo
string
| url
name
string
priority
integer
| value >= 1
Required
default_key
string
Required
modified_by
object
modified_on
string
| date-time
product
object (ConfigurationProduct)
ConfigurationProduct
similar
object (ConfigurationProductSimilar)
ConfigurationProductSimilar
config
array of object (ConfigurationProductConfig)
Array of ConfigurationProductConfig
is_active
boolean
Required
key
string
Required
logo
string
| url
priority
integer
| value >= 1
Required
size
object (ProductSize)
ProductSize
max
integer
| value >= 1
Required
min
integer
| value >= 1
Required
subtitle
string
title
string
variant
object (ConfigurationProductVariant)
ConfigurationProductVariant
config
array of object (ConfigurationProductVariantConfig)
Array of ConfigurationProductVariantConfig
display_type
string
Required
is_active
boolean
Required
key
string
Required
logo
string
| url
name
string
Required
priority
integer
| value >= 1
Required
size
object (ProductSize)
Required
ProductSize
max
integer
| value >= 1
Required
min
integer
| value >= 1
Required
details_groups
object (ConfigurationProductDetailsGroups)
ConfigurationProductDetailsGroups
config
array of object (ConfigurationProductDetailsConfig)
Array of ConfigurationProductDetailsConfig
name
string
slug
string
priority
integer
template_slugs
array of string
attributes
array of object (ConfigurationProductDetailsAttribute)
Array of ConfigurationProductDetailsAttribute
name
string
slug
string
display_type
string
priority
integer
is_active
boolean
key
string
is_active
boolean
type
string
Response
200
success flag will tell whether the operation was successful.
GetAppCatalogConfiguration
data
object (AppCatalogConfiguration)
AppCatalogConfiguration
app_id
string
config_id
string
config_type
string
created_by
object (UserSchema)
The user who created the configuration.
UserSchema
_id
string
contact
string
The contact information of the user.
uid
string
user_id
string
The unique ID of the user.
username
string
The username of the user.
created_on
string
| date-time
id
string
listing
object (ConfigurationListing)
ConfigurationListing
filter
object (ConfigurationListingFilter)
ConfigurationListingFilter
allow_single
boolean
attribute_config
array of object (ConfigurationListingFilterConfig)
Array of ConfigurationListingFilterConfig
display_name
string
is_active
boolean
key
string
logo
string
| url
name
string
priority
integer
| value >= 1
type
string
Enum
value_config
object (ConfigurationListingFilterValue)
ConfigurationListingFilterValue
bucket_points
array of object (ConfigurationBucketPoints)
Array of ConfigurationBucketPoints
display
string
end
number
start
number
condition
string
Default Value : OR
map
object
map_values
array of object
priority
array of string
sort
string
Default Value : count
value
string
sort
object (ConfigurationListingSort)
ConfigurationListingSort
config
array of object (ConfigurationListingSortConfig)
Array of ConfigurationListingSortConfig
is_active
boolean
key
string
logo
string
| url
name
string
priority
integer
| value >= 1
default_key
string
modified_by
object (UserSchema)
The user who modified the configuration.
UserSchema
_id
string
contact
string
The contact information of the user.
uid
string
user_id
string
The unique ID of the user.
username
string
The username of the user.
modified_on
string
| date-time
product
object (ConfigurationProduct)
ConfigurationProduct
similar
object (ConfigurationProductSimilar)
ConfigurationProductSimilar
config
array of object (ConfigurationProductConfig)
Array of ConfigurationProductConfig
is_active
boolean
key
string
logo
string
| url
priority
integer
| value >= 1
size
object (ProductSize)
ProductSize
max
integer
| value >= 1
min
integer
| value >= 1
subtitle
string
title
string
variant
object (ConfigurationProductVariant)
ConfigurationProductVariant
config
array of object (ConfigurationProductVariantConfig)
Array of ConfigurationProductVariantConfig
display_type
string
is_active
boolean
key
string
logo
string
| url
name
string
priority
integer
| value >= 1
size
object (ProductSize)
ProductSize
max
integer
| value >= 1
min
integer
| value >= 1
details_groups
object (ConfigurationProductDetailsGroups)
ConfigurationProductDetailsGroups
config
array of object (ConfigurationProductDetailsConfig)
Array of ConfigurationProductDetailsConfig
name
string
slug
string
priority
integer
template_slugs
array of string
attributes
array of object (ConfigurationProductDetailsAttribute)
Array of ConfigurationProductDetailsAttribute
name
string
slug
string
display_type
string
priority
integer
is_active
boolean
key
string
is_active
boolean
type
string
is_default
boolean
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
type:
"details_groups"
body:
body
Was this section helpful?
POST
Response
Create configuration by type.
createConfigurationByType
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Request body
allow_single
boolean
Required
Response
200
success message will tell whether the operation was successful.
ConfigSuccessResponseSchema
message
string
A message confirming the successful completion of the configuration operation.
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
body:
body
Was this section helpful?
POST
Response
Update 'Allow Single' setting.
updateAllowSingle
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
Request body
default_key
string
Required
The default key used for the requested operation.
Response
200
400
success message will tell whether the operation was successful.
ConfigSuccessResponseSchema
message
string
A message confirming the successful completion of the configuration operation.
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
body:
body
Was this section helpful?
POST
Response
Update default sorting.
updateDefaultSort
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
config_type
string
Required
A `config_type` is a unique identifier for a particular listing configuration type.
Enum
Request body
app_id
string
Required
allow_single
boolean
attribute_name
string
value_config
object (ValueConfigType)
ValueConfigType
bucket_points
array of object
map
object
sort
string
condition
string
value
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
type
string
is_active
boolean
Required
is_default
boolean
Required
key
string
Required
logo
string
| url
name
string
priority
integer
| value >= 1
Required
Response
200
400
success flag will tell whether the operation was successful.
AppConfigurationsFilterResponseSchema
id
string
app_id
string
allow_single
boolean
attribute_name
string
value_config
object (ValueConfigType)
ValueConfigType
bucket_points
array of object
map
object
sort
string
condition
string
value
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
type
string
is_active
boolean
is_default
boolean
key
string
logo
string
| url
name
string
priority
integer
| value >= 1
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
config_type:
"filter"
body:
body
Was this section helpful?
POST
Response
Create listing configuration.
createListingConfiguration
Retrieve the details of the application configured configurations of listing config types.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
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.
uids
array of integer
Only for categories config type, Get configuration list filtered by `uids`.
Response
200
configuration details for catalog.
GetListingConfigResponseSchema
data
array of object (ListingDataType)
Array of ListingDataType
app_id
string
allow_single
boolean
id
string
is_active
boolean
key
string
name
string
is_default
boolean
priority
integer
logo
string
value_config
object (ListingValueConfigType)
ListingValueConfigType
sort
string
bucket_points
array of object
map
object
condition
string
value
string
type
string
display_type
string
Display type of the variant attribute.
Enum
size
object (SizeLimitConfiguration)
SizeLimitConfiguration
min
number
Minimum number of variants to display.
max
number
Maximum number of variants to display.
page
object (PageResponseType)
PageResponseType
current
integer
has_next
boolean
next
integer
total_count
integer
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
config_type:
"filter"
page_no:
1
page_size:
1
search:
"cushion"
uids:
1
Was this section helpful?
GET
Response
Retrieve listing configurations.
getListingConfigurations
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
config_type
string
Required
A `config_type` is a unique identifier for a particular group configuration type.
Enum
Request body
app_id
string
attributes
array of object (AttributeDetailsGroup)
Array of AttributeDetailsGroup
display_type
string
Required
The type of display used for the attribute, such as text, dropdown, or image.
is_active
boolean
Required
Indicates if this attribute group is currently active.
key
string
A unique key or identifier for the attribute group.
logo
string
| url
URL of the logo image associated with this attribute group.
name
string
Required
The name of the attribute group.
priority
integer
| value >= 1
Required
The priority of the attribute group, determining the order in which it is displayed or processed.
slug
string
A URL-friendly identifier for the attribute group, often used in APIs for identification.
unit
string
The unit of measurement associated with the attribute, if applicable (e.g., cm, kg).
is_active
boolean
Required
is_default
boolean
Required
logo
string
| url
name
string
priority
integer
| value >= 1
Required
slug
string
Required
template_slugs
array of string
Response
200
400
success flag will tell whether the operation was successful.
AppConfigurationDetail
app_id
string
Unique identifier for the application to which this configuration belongs.
attributes
array of object (AttributeDetailsGroup)
A list of attribute groups associated with the app configuration. Each attribute group defines a set of attributes relevant to the app.
Minimum Items : 1
Array of AttributeDetailsGroup
display_type
string
The type of display used for the attribute, such as text, dropdown, or image.
is_active
boolean
Indicates if this attribute group is currently active.
key
string
A unique key or identifier for the attribute group.
logo
string
| url
URL of the logo image associated with this attribute group.
name
string
The name of the attribute group.
priority
integer
| value >= 1
The priority of the attribute group, determining the order in which it is displayed or processed.
slug
string
A URL-friendly identifier for the attribute group, often used in APIs for identification.
unit
string
The unit of measurement associated with the attribute, if applicable (e.g., cm, kg).
is_active
boolean
Indicates whether this configuration is currently active for the application.
is_default
boolean
Specifies if this configuration is the default setting for the application.
logo
string
| url
URL of the logo image associated with the application configuration.
name
string
The name of the application configuration.
priority
integer
| value >= 1
The priority of this configuration compared to others. Higher priority configurations are given precedence.
slug
string
template_slugs
array of string
A list of template slugs associated with this configuration, representing different templates that the configuration might use.
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
config_type:
"seller_groups"
body:
body
Was this section helpful?
POST
Response
Create group configuration.
createGroupConfiguration
Retrieve the details of the application configured configurations of group config types.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
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
configuration details for catalog.
GetConfigResponseSchema
data
array of object (ConfigItem)
Array of ConfigItem
app_id
string
Unique identifier for the application to which this configuration belongs.
attributes
array of object (AttributeConfig)
Array of AttributeConfig
display_type
string
The type of display used for the attribute (e.g., text, dropdown).
is_active
boolean
Indicates whether the attribute is currently active.
key
string
A unique key or identifier for the attribute.
name
string
The name of the attribute.
priority
integer
| value >= 1
The priority of the attribute.
slug
string
A URL-friendly identifier for the attribute.
id
string
Unique identifier for the configuration.
is_active
boolean
Indicates if this configuration is currently active for the application.
is_default
boolean
Specifies whether this is the default configuration for the application.
name
string
The name of the configuration group.
priority
integer
| value >= 1
The priority of this configuration group.
slug
string
A URL-friendly identifier for the configuration group.
template_slugs
array of string
A list of template slugs associated with this configuration.
seo
object (ApplicationItemSEO)
ApplicationItemSEO
description
string
The SEO description of the item
title
string
The SEO title of the item
sitemap
object (ApplicationItemSeoSitemap)
ApplicationItemSeoSitemap
priority
number
The SEO priority of the item
frequency
string
The SEO frequency of the item
breadcrumbs
array of object (ApplicationItemSeoBreadcrumbs)
Array of ApplicationItemSeoBreadcrumbs
url
string
action
array of object (ApplicationItemSeoAction)
Array of ApplicationItemSeoAction
page
object
type
string
meta_tags
array of object (ApplicationItemSeoMetaTags)
Array of ApplicationItemSeoMetaTags
title
string
items
array of object (ApplicationItemSeoMetaTagItem)
Array of ApplicationItemSeoMetaTagItem
key
string
value
string
canonical_url
string
page
object (PageResponseType)
PageResponseType
current
integer
has_next
boolean
next
integer
total_count
integer
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
config_type:
"seller_groups"
page_no:
1
page_size:
1
search:
"test"
Was this section helpful?
GET
Response
Retrieve group configurations.
getGroupConfigurations
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
config_type
string
Required
A `config_type` is a unique identifier for a particular group configuration type.
Enum
group_slug
string
Required
A `group_slug` is a unique identifier of a particular configuration.
Request body
app_id
string
Required
Unique identifier for the application to which this configuration belongs.
attributes
array of object (AttributeDetailsGroup)
A list of attribute groups associated with the app configuration. Each attribute group defines a set of attributes relevant to the app.
Minimum Items : 1
Array of AttributeDetailsGroup
display_type
string
Required
The type of display used for the attribute, such as text, dropdown, or image.
is_active
boolean
Required
Indicates if this attribute group is currently active.
key
string
A unique key or identifier for the attribute group.
logo
string
| url
URL of the logo image associated with this attribute group.
name
string
Required
The name of the attribute group.
priority
integer
| value >= 1
Required
The priority of the attribute group, determining the order in which it is displayed or processed.
slug
string
A URL-friendly identifier for the attribute group, often used in APIs for identification.
unit
string
The unit of measurement associated with the attribute, if applicable (e.g., cm, kg).
is_active
boolean
Required
Indicates whether this configuration is currently active for the application.
is_default
boolean
Required
Specifies if this configuration is the default setting for the application.
logo
string
| url
URL of the logo image associated with the application configuration.
name
string
The name of the application configuration.
priority
integer
| value >= 1
Required
The priority of this configuration compared to others. Higher priority configurations are given precedence.
slug
string
Required
template_slugs
array of string
A list of template slugs associated with this configuration, representing different templates that the configuration might use.
Response
200
400
success flag will tell whether the operation was successful.
AppConfigurationDetail
app_id
string
Unique identifier for the application to which this configuration belongs.
attributes
array of object (AttributeDetailsGroup)
A list of attribute groups associated with the app configuration. Each attribute group defines a set of attributes relevant to the app.
Minimum Items : 1
Array of AttributeDetailsGroup
display_type
string
The type of display used for the attribute, such as text, dropdown, or image.
is_active
boolean
Indicates if this attribute group is currently active.
key
string
A unique key or identifier for the attribute group.
logo
string
| url
URL of the logo image associated with this attribute group.
name
string
The name of the attribute group.
priority
integer
| value >= 1
The priority of the attribute group, determining the order in which it is displayed or processed.
slug
string
A URL-friendly identifier for the attribute group, often used in APIs for identification.
unit
string
The unit of measurement associated with the attribute, if applicable (e.g., cm, kg).
is_active
boolean
Indicates whether this configuration is currently active for the application.
is_default
boolean
Specifies if this configuration is the default setting for the application.
logo
string
| url
URL of the logo image associated with the application configuration.
name
string
The name of the application configuration.
priority
integer
| value >= 1
The priority of this configuration compared to others. Higher priority configurations are given precedence.
slug
string
template_slugs
array of string
A list of template slugs associated with this configuration, representing different templates that the configuration might use.
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
config_type:
"seller_groups"
group_slug:
"656c3941f62a832779362cf1"
body:
body
Was this section helpful?
PUT
Response
Update group configuration.
updateGroupConfiguration
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
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
400
Bad request. See the error object in the response body for specific reason
ConfigErrorResponseSchema
code
string
errors
object
message
string
A human-readable error message providing details about the configuration failure.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
config_type:
"seller_groups"
group_slug:
"656c3941f62a832779362cf1"
Was this section helpful?
DEL
Response
Delete group configuration.
deleteGroupConfiguration
Modify the details and settings of an existing listing configuration.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
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
id
string
app_id
string
allow_single
boolean
attribute_name
string
value_config
object (ValueConfigType)
ValueConfigType
bucket_points
array of object
map
object
sort
string
condition
string
value
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
type
string
is_active
boolean
is_default
boolean
key
string
logo
string
| url
name
string
priority
integer
| value >= 1
Response
200
400
success flag will tell whether the operation was successful.
AppConfigurationsFilterResponseSchema
id
string
app_id
string
allow_single
boolean
attribute_name
string
value_config
object (ValueConfigType)
ValueConfigType
bucket_points
array of object
map
object
sort
string
condition
string
value
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
type
string
is_active
boolean
is_default
boolean
key
string
logo
string
| url
name
string
priority
integer
| value >= 1
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
config_type:
"filter"
config_id:
"656cc670c404d0f059e622b4"
body:
body
Was this section helpful?
PUT
Response
Update listing configuration.
updateListingConfiguration
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
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
400
success message will tell whether the operation was successful.
ConfigSuccessResponseSchema
message
string
A message confirming the successful completion of the configuration operation.
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
config_type:
"filter"
config_id:
"656cc670c404d0f059e622b4"
Was this section helpful?
DEL
Response
Delete listing configuration.
deleteListingConfiguration
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
application_id
string
Required
A `application_id` is a unique identifier for a particular sale channel.
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.
Response
200
configuration details for catalog.
GetConfigMetadataResponseSchema
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
condition
array of object (ConditionItem)
Array of ConditionItem
key
string
display
string
data
array of object (DataItem)
Array of DataItem
key
string
display
string
filter_types
array of string
compatible_units
array of string
values
object (GetConfigMetadataValues)
GetConfigMetadataValues
type
array of object (ValueTypeItem)
Array of ValueTypeItem
key
string
display
string
sort
array of object (SortTypeItem)
Array of SortTypeItem
key
string
display
string
Examples
Parameters
company_id:
1
application_id:
"000000000000000000000001"
config_type:
"filter"
Was this section helpful?
GET
Response