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.
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
# List categories.
GET
# Get category data.
GET
# Get tags associated with locations for a company.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
level
string
Get category for multiple levels
department
integer
Get category for multiple departments filtered
q
string
Get multiple categories filtered by search string
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 : 12
uids
array of integer
Get multiple categories filtered by category uids.
Maximum Items : 100
Response
200
400
Category Meta.
CategoryResponseSchema
items
array of object (Category)
The list of categories.
Array of Category
created_by
object
It is the details of the user who created the category.
created_on
string
| date-time
It is Date and time when the category was created.
departments
array of integer
It is the list of unique department the category belongs to.
hierarchy
array of object (Hierarchy)
It is the list of category hierarchies for each department of an L3 category.
Array of Hierarchy
department
integer
It is the unique identifier of the department the category is mapped to.
l1
integer
It is the unique id of the L1 category mapped to the L3 category.
l2
integer
It is the unique id of the L2 category mapped to the L3 category.
id
string
It is the unique identifier of the category.
is_active
boolean
It is the flag indicating if the category is active.
level
integer
It is the level of category
marketplaces
object (CategoryMapping)
CategoryMapping
ajio
object (CategoryMappingValues)
CategoryMappingValues
catalog_id
integer
It is the category id mapping of the respective platform with Fynd Platform.
name
string
It is the name of the Category in the respective platform.
facebook
object (CategoryMappingValues)
CategoryMappingValues
catalog_id
integer
It is the category id mapping of the respective platform with Fynd Platform.
name
string
It is the name of the Category in the respective platform.
google
object (CategoryMappingValues)
CategoryMappingValues
catalog_id
integer
It is the category id mapping of the respective platform with Fynd Platform.
name
string
It is the name of the Category in the respective platform.
media
object (Media1)
Media1
landscape
string
It is the landscape cdn url for the category.
logo
string
It is the logo cdn url for the category.
portrait
string
It is the portrait cdn url for the category.
modified_by
object
It is the details of the user who last modified the category.
modified_on
string
| date-time
It is the date and time when the category was last modified.
name
string
It is the name of the category
priority
integer
It is the priority of the category.
slug
string
It is the slug of the category.
synonyms
array of string
It is the list of synonyms.
tryouts
array of string
It is the list of tryouts.
uid
integer
It is the unique identifier of the category.
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
level:
"3"
department:
1
q:
"test"
page_no:
1
page_size:
10
uids:
1
Was this section helpful?
GET
Response
List categories.
listCategories
Retrieve detailed information about a specific category with the associated meta.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
uid
string
Required
Category unique id
Response
200
422
Get Data for one category.
SingleCategoryResponseSchema
data
object (Category)
Category
created_by
object
It is the details of the user who created the category.
created_on
string
| date-time
It is Date and time when the category was created.
departments
array of integer
It is the list of unique department the category belongs to.
hierarchy
array of object (Hierarchy)
It is the list of category hierarchies for each department of an L3 category.
Array of Hierarchy
department
integer
It is the unique identifier of the department the category is mapped to.
l1
integer
It is the unique id of the L1 category mapped to the L3 category.
l2
integer
It is the unique id of the L2 category mapped to the L3 category.
id
string
It is the unique identifier of the category.
is_active
boolean
It is the flag indicating if the category is active.
level
integer
It is the level of category
marketplaces
object (CategoryMapping)
CategoryMapping
ajio
object (CategoryMappingValues)
CategoryMappingValues
catalog_id
integer
It is the category id mapping of the respective platform with Fynd Platform.
name
string
It is the name of the Category in the respective platform.
facebook
object (CategoryMappingValues)
CategoryMappingValues
catalog_id
integer
It is the category id mapping of the respective platform with Fynd Platform.
name
string
It is the name of the Category in the respective platform.
google
object (CategoryMappingValues)
CategoryMappingValues
catalog_id
integer
It is the category id mapping of the respective platform with Fynd Platform.
name
string
It is the name of the Category in the respective platform.
media
object (Media1)
Media1
landscape
string
It is the landscape cdn url for the category.
logo
string
It is the logo cdn url for the category.
portrait
string
It is the portrait cdn url for the category.
modified_by
object
It is the details of the user who last modified the category.
modified_on
string
| date-time
It is the date and time when the category was last modified.
name
string
It is the name of the category
priority
integer
It is the priority of the category.
slug
string
It is the slug of the category.
synonyms
array of string
It is the list of synonyms.
tryouts
array of string
It is the list of tryouts.
uid
integer
It is the unique identifier of the category.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
uid:
"5"
Was this section helpful?
GET
Response
Get category data.
getCategoryData
This API fetches all the tags associated to a company.
Parameters
company_id
integer
Required
Id of the company inside which the location is to be created.
Response
200
StoreTagsResponseSchema
tags
array of string
success
boolean
Examples
Parameters
company_id:
10
Was this section helpful?
GET
Response
Get tags associated with locations for a company.
getLocationTags
Access and manage company onboarding information, update company details, and retrieve company metrics for insights and analysis.
Operations
GET
# Get company metrics.
GET
# Get support representative's associated to a company
Allows to view the company metrics, i.e. the status of its brand and stores. Also its allows to view the number of products, company documents & store documents which are verified and unverified.
Parameters
company_id
integer
Required
The company id for which the detail needs to be retrieved.
Response
200
OptinCompanyMetrics
brand
integer
company
string
store
integer
Examples
Parameters
company_id:
1
Was this section helpful?
GET
Response
Get company metrics.
getCompanyMetrics
This API helps to view support representative's associated to a particular company.
Parameters
company_id
integer
Required
Id of the company.
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 : 20
Response
200
Company Support representative object.
CompanyDRIListResponseSchema
items
array of object (CompanyDRIResponseSchema)
List of Company DRIs.
Array of CompanyDRIResponseSchema
tags
array of string
List of tags associated with the Company DRI.
responsibilities
array of string
List of responsibilities of the Company DRI.
responsibilities_display_name
array of string
List of display names for responsibilities.
uid
integer
Unique identifier for the Company DRI.
company_id
integer
ID of the associated company.
status
boolean
Status of the Company DRI (active or inactive).
contact
object
Contact information for the Company DRI.
contact_details
object
Detailed contact information for the Company DRI.
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:
385
page_no:
1
page_size:
1
Was this section helpful?
GET
Response
Get support representative's associated to a company
getCompanyBrandsDRI
Access catalog insights, seller performance data, and company metrics for informed decision-making and performance evaluation.
Operations
GET
# Get seller insights.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
seller_app_id
string
Required
Id of the seller application which is serving the invetory/catalog of the company
Response
200
Response Data
CrossSellingResponseSchema
articles
integer
products
integer
Examples
Parameters
company_id:
1
seller_app_id:
"000000000000000000000001"
Was this section helpful?
GET
Response
Get seller insights.
getSellerInsights
Facilitates the creation and management of product bundles. You can use it to create new product bundles with createProductBundle, retrieve information about existing bundles with getProductBundle, and update bundle details using updateProductBundle.
Operations
POST
# Create a product bundle.
GET
# Retrieve product bundles.
GET
# Get product bundle details.
PUT
# Update a product bundle.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
Request body
choice
string
Required
Specifies the type of product bundle (e.g., 'single' or 'multi').
company_id
integer
The unique identifier of the company to which the product bundle belongs.
created_by
object
Information about the user who created the product bundle, including user ID and username.
created_on
string
| date-time
The timestamp when the product bundle was created.
is_active
boolean
Required
Indicates whether the product bundle is currently active.
logo
string
Nullable
URL of the logo associated with the product bundle, if available. Can be null.
meta
object
Additional metadata for the product bundle.
modified_by
object
Information about the user who last modified the product bundle, including user ID and username.
modified_on
string
| date-time
The timestamp when the product bundle was last modified.
name
string
Required
The name of the product bundle.
page_visibility
array of string
Pages where the product bundle is visible (e.g., 'pdp' for product display page).
Enum
products
array of object (ProductBundleItem)
Required
A list of products included in the bundle. A maximum of 10 products can be added.
Maximum Items : 10
Array of ProductBundleItem
max_quantity
integer
| value >= 1
| value <= 99
Required
Maximum quantity of the product that can be added to the bundle.
min_quantity
integer
| value >= 1
| value <= 99
Required
Minimum quantity of the product that must be added to the bundle.
product_uid
integer
Required
Unique identifier for the product.
same_store_assignment
boolean
Indicates whether all products in the bundle are assigned to the same store.
Default Value : true
slug
string
Required
A URL-friendly unique identifier for the product bundle.
auto_add_to_cart
boolean
Required
Specifies if the product is automatically added to the cart.
auto_select
boolean
Required
Indicates if the product is automatically selected in the bundle.
allow_remove
boolean
Required
Indicates whether the product can be removed from the bundle.
prefer_single_shipment
boolean
Required
allow_individual_return
boolean
Required
allow_individual_cancel
boolean
Required
Response
200
Get bundle with id that is added.
GetProductBundleCreateResponseSchema
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.
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.
choice
string
Specifies the type of bundle, e.g., single or multi.
company_id
integer
Unique identifier for the company that owns the product bundle.
created_on
string
| date-time
Timestamp when the product bundle was created.
id
string
Unique identifier for the product bundle.
is_active
boolean
Indicates if the product bundle is active or not.
logo
string
Nullable
URL of the product bundle's logo, or null if not available.
meta
object
Additional metadata about the product bundle.
modified_on
string
| date-time
Timestamp when the product bundle was last modified.
name
string
Name of the product bundle.
page_visibility
array of string
Visibility settings for the product bundle across different pages.
Enum
products
array of object (ProductBundleItem)
List of products that are part of the product bundle.
Maximum Items : 10
Array of ProductBundleItem
max_quantity
integer
| value >= 1
| value <= 99
Maximum quantity of the product that can be added to the bundle.
min_quantity
integer
| value >= 1
| value <= 99
Minimum quantity of the product that must be added to the bundle.
product_uid
integer
Unique identifier for the product.
same_store_assignment
boolean
Indicates whether all products in the bundle belong to the same store.
Default Value : true
slug
string
Unique slug used to identify the product bundle in URLs.
allow_remove
boolean
auto_add_to_cart
boolean
auto_select
boolean
prefer_single_shipment
boolean
allow_individual_cancel
boolean
allow_individual_return
boolean
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
body:
body
Was this section helpful?
POST
Response
Create a product bundle.
createProductBundle
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
q
string
A search string that is searched with product bundle name.
slug
array of string
slugs of bundles to be retrieved.
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
Response
200
List of bundle configured for a company.
GetProductBundleListingResponseSchema
items
array of object (GetProductBundleCreateResponseSchema)
List of product bundles that are returned in the response.
Array of GetProductBundleCreateResponseSchema
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.
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.
choice
string
Specifies the type of bundle, e.g., single or multi.
company_id
integer
Unique identifier for the company that owns the product bundle.
created_on
string
| date-time
Timestamp when the product bundle was created.
id
string
Unique identifier for the product bundle.
is_active
boolean
Indicates if the product bundle is active or not.
logo
string
Nullable
URL of the product bundle's logo, or null if not available.
meta
object
Additional metadata about the product bundle.
modified_on
string
| date-time
Timestamp when the product bundle was last modified.
name
string
Name of the product bundle.
page_visibility
array of string
Visibility settings for the product bundle across different pages.
Enum
products
array of object (ProductBundleItem)
List of products that are part of the product bundle.
Maximum Items : 10
Array of ProductBundleItem
max_quantity
integer
| value >= 1
| value <= 99
Maximum quantity of the product that can be added to the bundle.
min_quantity
integer
| value >= 1
| value <= 99
Minimum quantity of the product that must be added to the bundle.
product_uid
integer
Unique identifier for the product.
same_store_assignment
boolean
Indicates whether all products in the bundle belong to the same store.
Default Value : true
slug
string
Unique slug used to identify the product bundle in URLs.
allow_remove
boolean
auto_add_to_cart
boolean
auto_select
boolean
prefer_single_shipment
boolean
allow_individual_cancel
boolean
allow_individual_return
boolean
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
q:
"bundlename"
slug:
"bundlename"
page_no:
1
page_size:
10
Was this section helpful?
GET
Response
Retrieve product bundles.
getProductBundle
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
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
400
The Collection object.
GetProductBundleResponseSchema
choice
string
Specifies the type of product bundle, e.g., 'single' or 'multi'.
company_id
integer
The unique identifier of the company that owns the product bundle.
is_active
boolean
Indicates whether the product bundle is active.
logo
string
URL of the logo associated with the product bundle.
meta
object
Additional metadata for the product bundle.
name
string
The name of the product bundle.
page_visibility
array of string
List of pages where the product bundle is visible, e.g., 'pdp'.
products
array of object (GetProducts)
A list of products included in the bundle.
Array of GetProducts
max_quantity
integer
The maximum quantity of the product that can be added to the bundle.
min_quantity
integer
The minimum quantity of the product that must be added to the bundle.
price
object (Price)
Price
currency
string
max_effective
number
max_marked
number
min_effective
number
min_marked
number
product_details
object (LimitedProductData)
LimitedProductData
attributes
object
A set of key-value pairs representing the attributes of the product, such as pattern, gender, etc.
country_of_origin
string
Country where the product was manufactured.
identifier
object
Identification details for the product, including EANs (European Article Numbers).
images
array of string
List of URLs pointing to images of the product.
item_code
string
Code assigned to the product for inventory purposes.
name
string
price
object (ProductPriceRangeSchema)
ProductPriceRangeSchema
effective
object (PriceRange)
PriceRange
min
number
max
number
marked
object (PriceRange)
PriceRange
min
number
max
number
currency
string
quantity
integer
The quantity of the product available.
short_description
string
sizes
array of string
List of available sizes for the product.
slug
string
Unique URL-friendly identifier for the product.
uid
integer
Unique identifier for the product.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
product_uid
integer
Unique identifier for the product.
sizes
array of object (Size)
Array of Size
display
string
is_available
boolean
quantity
integer
value
string
same_store_assignment
boolean
Indicates whether all products in the bundle are assigned to the same store.
slug
string
Unique URL-friendly identifier for the product bundle.
allow_remove
boolean
auto_add_to_cart
boolean
auto_select
boolean
prefer_single_shipment
boolean
allow_individual_cancel
boolean
allow_individual_return
boolean
Examples
Parameters
company_id:
1
id:
"656830f5059489725d2fa072"
Was this section helpful?
GET
Response
Get product bundle details.
getProductBundleDetail
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
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
choice
string
Required
Specifies the type of product bundle (e.g., 'single' or 'multi').
company_id
integer
The unique identifier of the company to which the product bundle belongs.
is_active
boolean
Required
Indicates whether the product bundle is currently active.
logo
string
Nullable
URL of the logo associated with the product bundle, if available. Can be null.
meta
object
Additional metadata for the product bundle.
name
string
Required
The name of the product bundle.
page_visibility
array of string
Pages where the product bundle is visible (e.g., 'pdp' for product display page).
Enum
products
array of object (ProductBundleItem)
Required
A list of products included in the bundle. A maximum of 10 products can be added.
Maximum Items : 10
Array of ProductBundleItem
max_quantity
integer
| value >= 1
| value <= 99
Required
Maximum quantity of the product that can be added to the bundle.
min_quantity
integer
| value >= 1
| value <= 99
Required
Minimum quantity of the product that must be added to the bundle.
product_uid
integer
Required
Unique identifier for the product.
same_store_assignment
boolean
Indicates whether all products in the bundle are assigned to the same store.
Default Value : true
slug
string
Required
A URL-friendly unique identifier for the product bundle.
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
allow_individual_cancel
boolean
allow_individual_return
boolean
allow_remove
boolean
auto_add_to_cart
boolean
auto_select
boolean
prefer_single_shipment
boolean
Response
200
400
The Collection object.
GetProductBundleCreateResponseSchema
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.
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.
choice
string
Specifies the type of bundle, e.g., single or multi.
company_id
integer
Unique identifier for the company that owns the product bundle.
created_on
string
| date-time
Timestamp when the product bundle was created.
id
string
Unique identifier for the product bundle.
is_active
boolean
Indicates if the product bundle is active or not.
logo
string
Nullable
URL of the product bundle's logo, or null if not available.
meta
object
Additional metadata about the product bundle.
modified_on
string
| date-time
Timestamp when the product bundle was last modified.
name
string
Name of the product bundle.
page_visibility
array of string
Visibility settings for the product bundle across different pages.
Enum
products
array of object (ProductBundleItem)
List of products that are part of the product bundle.
Maximum Items : 10
Array of ProductBundleItem
max_quantity
integer
| value >= 1
| value <= 99
Maximum quantity of the product that can be added to the bundle.
min_quantity
integer
| value >= 1
| value <= 99
Minimum quantity of the product that must be added to the bundle.
product_uid
integer
Unique identifier for the product.
same_store_assignment
boolean
Indicates whether all products in the bundle belong to the same store.
Default Value : true
slug
string
Unique slug used to identify the product bundle in URLs.
allow_remove
boolean
auto_add_to_cart
boolean
auto_select
boolean
prefer_single_shipment
boolean
allow_individual_cancel
boolean
allow_individual_return
boolean
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
id:
"656830f5059489725d2fa072"
body:
body
Was this section helpful?
PUT
Response
Update a product bundle.
updateProductBundle
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
# Retrieve inventories.
GET
# Retrieve inventory bulk upload history.
POST
# Create bulk inventory upload job.
DEL
# Delete inventory bulk upload job.
POST
# Create bulk inventory.
POST
# Create inventory export job.
GET
# Retrieve inventory export data.
PATCH
# Edit notification_emails and status of export job.
GET
# Get Detail Product export detail.
PUT
# Edit notification_emails and status of export job.
GET
# Get Detail Product export detail.
GET
# Export inventory configuration.
GET
# Get product attributes.
GET
# Retrieve product assets in bulk.
POST
# Create product assets in bulk.
GET
# Retrieve product bulk upload history.
POST
# Create a Bulk product to upload job.
DEL
# Delete product bulk upload job.
POST
# Create products in bulk.
GET
# List HSN codes.
GET
# Get product tags.
GET
# Get product validation.
GET
# Get inventory by size identifier.
GET
# Get product size details.
DEL
# Delete product size.
GET
# Get inventory by size.
GET
# Get variants of products.
GET
# Get company verification status
GET
# Get the verification detail of a product
GET
# Get variant type list
GET
# Get all product HSN codes.
GET
# Get single product HSN code.
POST
# Update inventories.
GET
# List inventory exports.
POST
# Create inventory export.
GET
# Retrieve products.
POST
# Create a product.
POST
# Upload bulk products.
GET
# Retrieve product export jobs.
POST
# Create product export job.
GET
# Get product details.
PUT
# Edit a product.
DEL
# Delete a product.
GET
# Get all product sizes.
DEL
# Delete realtime inventory.
POST
# Update realtime inventory.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
item_id
integer
Item code of the product of which size is to be get.
size
string
Size 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
page_id
string
Alphanumeric Page ID to retrieve next set of results.
page_type
string
Available pagination types are cursor or number.
Default Value : number
Enum
q
string
Search with help of store code.
sellable
boolean
Filter on whether product is in stock or not.
Default Value : false
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
The Seller Identifier or Primary Identifier of the inventory.
min_sellable
integer
Min sellable quantity.
max_sellable
integer
Max sellable quantity.
from_date
string
| date-time
Inventory updated on filter to get inventories greater then provided date.
to_date
string
| date-time
Inventory updated on filter to get inventories less then provided date.
size_identifier
string
Size Identifier (Seller Identifier or Primary Identifier) of which inventory is to get.
Response
200
400
returns a list of all inventory grouped by size and store
GetInventoriesResponseSchema
items
array of object (GetInventories)
List of product inventories.
Array of GetInventories
brand
object (BrandMeta1)
BrandMeta1
id
integer
name
string
company
object (CompanyMeta1)
CompanyMeta1
id
integer
country_of_origin
string
Country where the product was manufactured.
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.
date_meta
object (DateMeta)
DateMeta
added_on_store
string
created_on
string
| date-time
inventory_updated_on
string
| date-time
modified_on
string
| date-time
dimension
object (InventoryDimensionResponseSchema)
InventoryDimensionResponseSchema
height
number
length
number
unit
string
width
number
expiration_date
string
| date-time
Expiration date of the product.
id
string
Unique identifier of the product.
identifier
object (Identifier)
Identifier
primary
boolean
Indicates if this is the primary identifier for the size.
gtin_value
string
The GTIN (Global Trade Item Number) value for the size.
gtin_type
string
The type of GTIN (e.g., SKU code, UPC, EAN).
inventory_updated_on
string
| date-time
The last date when inventory information was updated.
is_set
boolean
Indicates if the product is sold as a set.
item_id
integer
Unique item ID for the product.
manufacturer
object (InventoryManufacturerResponseSchema)
InventoryManufacturerResponseSchema
address
string
is_default
boolean
name
string
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.
platforms
object
Indicates platform availability status for the product.
price
object (PriceArticle)
PriceArticle
currency
string
effective
number
marked
number
tp_notes
object
transfer
number
quantities
object (QuantitiesArticle)
QuantitiesArticle
damaged
object (Quantity)
Quantity
count
integer
not_available
object (Quantity)
Quantity
count
integer
order_committed
object (Quantity)
Quantity
count
integer
sellable
object (Quantity)
Quantity
count
integer
return_config
object (ReturnConfig2)
ReturnConfig2
returnable
boolean
time
integer
| value >= 0
unit
string
Enum
seller_identifier
string
Seller's identifier for the product.
size
string
Size of the product.
stage
string
Current stage of the product, such as verified or pending.
store
object (ArticleStoreResponseSchema)
ArticleStoreResponseSchema
name
string
store_code
string
store_type
string
uid
integer
tags
array of string
Tags associated with the product.
tax_identifier
object (TaxIdentifier)
TaxIdentifier
hsn_code
string
hsn_code_id
string
reporting_hsn
string
total_quantity
integer
| value >= 0
Total available quantity of the product.
trace_id
string
Trace ID for inventory management.
track_inventory
boolean
Indicates if the inventory is being tracked.
trader
array of object (TraderResponseSchema)
Information about traders, such as manufacturers or importers.
Array of TraderResponseSchema
address
array of string
name
string
type
string
Enum
uid
string
Unique identifier for the product.
weight
object (InventoryWeightResponseSchema)
InventoryWeightResponseSchema
shipping
number
unit
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
item_id:
75779472
page_no:
1
page_size:
1
page_id:
"63ca421a6fb0ce930685f46e"
page_type:
"cursor"
q:
"Reliance 2"
sellable:
true
store_ids:
1
brand_ids:
355
seller_identifiers:
410163085004
max_sellable:
1000
from_date:
"2022-01-23T06:12:03Z"
to_date:
"2024-05-01T06:12:03Z"
size_identifier:
"Size123"
Was this section helpful?
GET
Response
Retrieve inventories.
getInventories
Parameters
company_id
integer
Required
Company Id of of which Inventory Bulk Upload History to be obtained.
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
Response
200
List of bulk Inventory upload jobs.
BulkInventoryGet
items
array of object (BulkInventoryGetItems)
Array of BulkInventoryGetItems
cancelled
integer
cancelled_records
array of string
company_id
integer
created_by
object
created_on
string
| date-time
failed
integer
failed_records
array of string
file_path
string
id
string
is_active
boolean
modified_by
object
modified_on
string
| date-time
stage
string
succeed
integer
total
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
page_no:
1
page_size:
1
Was this section helpful?
GET
Response
Retrieve inventory bulk upload history.
getInventoryBulkUploadHistory
Parameters
company_id
integer
Required
Company Id in which Inventory to be uploaded.
Request body
company_id
integer
The ID of the company.
file_path
string
The file path of the company.
Response
200
Returns a success response
InventoryBulkResponseSchema
batch_id
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.
created_on
string
| date-time
The date and time when the item was created.
is_active
boolean
Whether the item is active or not.
Default Value : true
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 item was last modified.
Examples
Parameters
company_id:
1
body:
body
Was this section helpful?
POST
Response
Create bulk inventory upload job.
createBulkInventoryJob
Parameters
company_id
integer
Required
Company Id of the company of which bulk Inventory job is to be deleted.
batch_id
string
Required
Batch Id of the bulk delete job.
Response
200
Returns a success response
SuccessResponseSchema
success
boolean
Examples
Parameters
company_id:
1
batch_id:
"657eb1023d7dac10444af49a"
Was this section helpful?
DEL
Response
Delete inventory bulk upload job.
deleteBulkInventoryJob
Parameters
company_id
integer
Required
Company Id in which Inventory is to be uploaded.
batch_id
string
Required
Batch Id of the bulk create job.
Request body
batch_id
string
Required
company_id
integer
Required
sizes
array of object (InventoryJobPayload)
Required
Array of InventoryJobPayload
currency
string
The currency used for the item price.
expiration_date
string
| date-time
The expiration date of the item.
item_dimensions_unit_of_measure
string
The unit of measure for the item dimensions.
item_weight_unit_of_measure
string
The unit of measure for the item weight.
price
number
The price of the item.
price_effective
number
The effective price of the item.
price_marked
number
The marked price of the item.
quantity
integer
The quantity of the item.
seller_identifier
string
Required
The identifier of the seller.
store_code
string
Required
The code of the store.
tags
array of string
Nullable
The tags associated with the item.
total_quantity
integer
The total quantity of the item.
trace_id
string
Nullable
The trace ID of the inventory job payload.
user
object
Response
200
Returns a success response
SuccessResponseSchema
success
boolean
Examples
Parameters
company_id:
10
batch_id:
"6399b83a5d02708ffeb17651"
body:
body
Was this section helpful?
POST
Response
Create bulk inventory.
createBulkInventory
Parameters
company_id
integer
Required
Company Id in which assets to be uploaded.
Request body
brand
array of integer
store
array of integer
type
string
Default Value : csv
Enum
Response
200
Returns a success response
InventoryExportResponseSchema
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
Creation datetime of the job
filters
object (InventoryExportFiltersResponseSchema)
InventoryExportFiltersResponseSchema
brand_ids
array of integer
store_ids
array of integer
modified_on
string
| date-time
Modification date of the job
notification_emails
array of string
The notification emails for the job.
seller_id
integer
The seller id that needs to be exported.
status
string
The status of the job.
Enum
task_id
string
The task id of the job.
type
string
The type of file that needs to be exported.
stats
object (Stats)
Stats
total
integer
_id
string
trigger_on
string
brand
array of integer
store
array of integer
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
10
body:
body
Was this section helpful?
POST
Response
Create inventory export job.
createInventoryExportJob
Parameters
company_id
integer
Required
Company Id in which assets to be uploaded.
Response
200
Returns a list of inventory export jobs
InventoryExportJobResponseSchema
items
array of object (InventoryExportItem)
Array of InventoryExportItem
status
string
type
string
stats
object
completed_on
string
| date-time
created_on
string
| date-time
modified_on
string
| date-time
seller_id
integer
task_id
string
notification_emails
array of 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.
_id
string
url
string
trigger_on
string
brand
array of integer
store
array of integer
Examples
Parameters
company_id:
10
Was this section helpful?
GET
Response
Retrieve inventory export data.
getInventoryExport
This API helps to edit notification_emails and status of export job.
Parameters
company_id
integer
Required
Company Id in which assets to be uploaded.
job_id
string
Required
Company Id in which assets to be uploaded.
Request body
notification_emails
array of string
status
string
Response
200
400
Returns a success response
PatchProductDownloadsResponseSchema
data
object (PatchProductDownloadsDataResponseSchema)
PatchProductDownloadsDataResponseSchema
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.
task_id
string
| uuid
modified_on
string
| date-time
seller_id
integer
url
string
status
string
notification_emails
array of string
completed_on
string
Examples
Parameters
company_id:
10
job_id:
"63a556e1aede4d743b333fad"
body:
body
Was this section helpful?
PATCH
Response
Edit notification_emails and status of export job.
patchProductExportDetail
Parameters
company_id
integer
Required
Company Id in which assets to be uploaded.
job_id
string
Required
Company Id in which assets to be uploaded.
Response
200
400
Returns a detail of product export jobs
GetProductDownloadsResponseSchema
modified_on
string
| date-time
url
string
| uri
status
string
completed_on
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.
created_on
string
| date-time
seller_id
integer
task_id
string
id
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
10
job_id:
"63a556e1aede4d743b333fad"
Was this section helpful?
GET
Response
Get Detail Product export detail.
getProductExportDetail
This API helps to edit notification_emails and status of export job.
Parameters
company_id
integer
Required
Company Id in which assets to be uploaded.
job_id
string
Required
Company Id in which assets to be uploaded.
Request body
notification_emails
array of string
status
string
Response
200
400
Returns a success response
EditInventoryDownloadsResponseSchema
data
object (EditInventoryDataDownloadsResponseSchema)
EditInventoryDataDownloadsResponseSchema
url
string
completed_on
string
seller_id
integer
task_id
string
| uuid
created_on
string
| date-time
modified_on
string
| date-time
notification_emails
array of string
status
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
10
job_id:
"63a56c14863953d1af0856a8"
body:
body
Was this section helpful?
PUT
Response
Edit notification_emails and status of export job.
patchInventoryExportDetail
Parameters
company_id
integer
Required
Company Id in which assets to be uploaded.
job_id
string
Required
Company Id in which assets to be uploaded.
Response
200
400
Returns a detail of product export jobs
EditInventoryDownloadsResponseSchema
data
object (EditInventoryDataDownloadsResponseSchema)
EditInventoryDataDownloadsResponseSchema
url
string
completed_on
string
seller_id
integer
task_id
string
| uuid
created_on
string
| date-time
modified_on
string
| date-time
notification_emails
array of string
status
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
10
job_id:
"63a56c14863953d1af0856a8"
Was this section helpful?
GET
Response
Get Detail Product export detail.
getInventoryExportDetail
Retrieve List of different filters like brand, store, and type for inventory export.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
filter
string
Required
filter type from any one of ['brand', 'store', 'type']
Response
200
400
returns filters configuration for inventory export
InventoryConfig
data
array of object (FilerList)
Array of FilerList
display
string
value
string
multivalue
boolean
Examples
Parameters
company_id:
10
filter:
"type"
Was this section helpful?
GET
Response
Export inventory configuration.
exportInventoryConfig
Parameters
company_id
integer
Required
The company id for which the detail needs to be retrieved.
category
string
Required
It is the name of the l3 cateogry
filter
boolean
If true, returns filtered values, else returns all the attributes
Response
200
Size guide object.
ProductAttributesResponseSchema
items
array of object (AttributeMasterSchema)
Array of AttributeMasterSchema
created_by
object
Information about the user who created the attribute.
created_on
string
| date-time
The timestamp when the attribute was created.
departments
array of string
Departments or categories to which the attribute applies.
Minimum Items : 1
description
string
A description of the attribute.
details
object (AttributeMasterDetails)
AttributeMasterDetails
display_type
string
Type of display used for the attribute (e.g., text, dropdown).
enabled_for_end_consumer
boolean
Indicates if the attribute is enabled for end consumers.
filters
object (AttributeMasterFilter)
AttributeMasterFilter
ddepends_on
array of string
indexing
boolean
Whether the attribute should be indexed for search.
priority
integer
Priority of the attribute in filtering (optional).
is_nested
boolean
Indicates if the attribute can be nested under other attributes.
logo
string
URL of the logo associated with the attribute.
modified_by
object
Information about the user who last modified the attribute.
modified_on
string
| date-time
The timestamp when the attribute was last modified.
name
string
Name of the attribute.
raw_key
string
Name of the attribute.
schema
object (AttributeMaster)
AttributeMaster
allowed_values
array of string
List of allowed values for the attribute, if applicable.
format
string
Format of the attribute, such as case formatting.
mandatory
boolean
Whether the attribute is mandatory.
multi
boolean
Indicates if the attribute allows multiple values.
range
object (AttributeSchemaRange)
AttributeSchemaRange
min
integer
Minimum allowed value for the attribute.
max
integer
Maximum allowed value for the attribute.
type
string
Data type of the attribute.
Enum
suggestion
string
Suggested or recommended value for the attribute, if applicable.
synonyms
object
Synonyms or alternative names for the attribute, used for search and indexing.
tags
array of string
Tags or keywords associated with the attribute, often used for categorization.
unit
string
The unit of measurement for the attribute, if applicable (e.g., cm, kg).
slug
string
Unique slug or identifier for the attribute.
variant
boolean
Indicates if the attribute is a variant of another attribute.
Default Value : false
Examples
Parameters
company_id:
1
category:
"hello3"
filter:
true
Was this section helpful?
GET
Response
Get product attributes.
getProductAttributes
Helps to retrieve bulk asset jobs data associated to a particular company.
Parameters
company_id
integer
Required
Company Id of the product size.
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
Response
200
List of bulk asset jobs List. See `BulkUtil.modify_batch_response` for details
BulkAssetResponseSchema
items
array of object (Items)
Array of Items
cancelled
integer
cancelled_records
array of string
company_id
integer
created_by
object (UserCommon)
UserCommon
company_id
integer
user_id
string
username
string
created_on
string
| date-time
failed
integer
failed_records
array of string
file_path
string
id
string
is_active
boolean
modified_by
object (UserCommon)
UserCommon
company_id
integer
user_id
string
username
string
modified_on
string
| date-time
retry
integer
stage
string
succeed
integer
total
integer
tracking_url
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
page_no:
1
page_size:
1
Was this section helpful?
GET
Response
Retrieve product assets in bulk.
getProductAssetsInBulk
Parameters
company_id
integer
Required
Company Id in which assets to be uploaded.
Request body
batch_id
string
company_id
integer
url
string
| url
Required
user
object
Required
Response
200
Returns a success response
SuccessResponseSchema
success
boolean
Examples
Parameters
company_id:
1
body:
body
Was this section helpful?
POST
Response
Create product assets in bulk.
createProductAssetsInBulk
Parameters
company_id
integer
Required
Company Id of of which Product Bulk Upload History to be obtained.
search
string
Search string to filter the results by batch id
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
Response
200
List of bulk product upload jobs. See `BulkRequestGetSchema` for details
ProductBulkRequestSchemaList
items
array of object (ProductBulkRequestSchema)
Array of ProductBulkRequestSchema
cancelled
integer
cancelled_records
array of object
company_id
integer
created_by
object (UserDetail1)
UserDetail1
full_name
string
user_id
string
username
string
created_on
string
| date-time
failed
integer
failed_records
array of object
file_path
string
| url
is_active
boolean
modified_by
object (UserDetail1)
UserDetail1
full_name
string
user_id
string
username
string
modified_on
string
| date-time
stage
string
succeed
integer
template
object (ProductTemplate)
ProductTemplate
attributes
array of string
List of attributes associated with the product template.
categories
array of string
List of categories the product template belongs to.
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 of when the product template was created.
departments
array of string
List of departments the product template is associated with.
description
string
Detailed description of the product template.
is_active
boolean
Indicates if the product template is currently active.
Default Value : true
is_archived
boolean
Indicates if the product template is archived.
is_expirable
boolean
Indicates if the product template is expirable.
is_physical
boolean
Indicates if the product template represents a physical product.
logo
string
URL of the product template logo.
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 of when the product template was last modified.
name
string
The name of the product template.
slug
string
Unique URL-friendly identifier for the product template.
tag
string
template_tag
string
total
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:
10
search:
"test"
page_no:
1
page_size:
1
Was this section helpful?
GET
Response
Retrieve product bulk upload history.
getProductBulkUploadHistory
Parameters
company_id
integer
Required
Company Id in which assets to be uploaded.
Request body
company_id
integer
The ID of the company
total
integer
Total records to be imported
succeed
integer
Successfully imported records
stage
string
The import stage
file_path
string
template_tag
string
Template tag for the import
tracking_url
string
Response
200
Returns a success response
ProductBulkResponseSchema
batch_id
string
Examples
Parameters
company_id:
1
body:
body
Was this section helpful?
POST
Response
Create a Bulk product to upload job.
createBulkProductUploadJob
Parameters
company_id
integer
Required
Company Id of the company associated to size that is to be deleted.
batch_id
string
Required
Batch Id of the bulk product job to be deleted.
Response
200
Returns a success response
SuccessResponseSchema
success
boolean
Examples
Parameters
company_id:
1
batch_id:
"63a42e9c9d271779f21f6402"
Was this section helpful?
DEL
Response
Delete product bulk upload job.
deleteProductBulkJob
Parameters
company_id
integer
Required
Company Id in which assets to be uploaded.
batch_id
string
Required
Batch Id in which assets to be uploaded.
Request body
batch_id
string
Required
company_id
integer
Required
data
array of object
Required
template_tag
string
Required
Response
200
400
Returns a success response
SuccessResponseSchema
success
boolean
Examples
Parameters
company_id:
1
batch_id:
"65a3e6dadb68f89d0f832870"
body:
body
Was this section helpful?
POST
Response
Create products in bulk.
createProductsInBulk
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
Response
200
List of all HSN Codes.
HSNCodesResponseSchema
data
object (HSNData)
HSNData
country_of_origin
array of string
hsn_code
array of string
message
string
Examples
Parameters
company_id:
1
Was this section helpful?
GET
Response
List HSN codes.
listHSNCodes
Parameters
company_id
integer
Required
Company Id for which tags to be fetched.
Response
200
Tag List. See example below for details
ProductTagsViewResponseSchema
items
array of string
An array of product tag strings representing various tags associated with the products.
Examples
Parameters
company_id:
1
Was this section helpful?
GET
Response
Get product tags.
getProductTags
Parameters
company_id
integer
Required
Validates data against given company
type
string
Required
Type of identifier to validate the product against.
slug
string
Required
Type of identifier to validate the product against.
Response
200
400
Validate Meta. See example below for details
ValidateProduct
valid
boolean
message
string
Examples
Parameters
company_id:
1
type:
"slug"
slug:
"test"
Was this section helpful?
GET
Response
Get product validation.
getProductValidation
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.
item_id
integer
Required
Item code of the product of which size is to be get.
size_identifier
string
Required
Size Identifier (Seller Identifier or Primary Identifier) of which inventory is to get.
page_no
integer
The page number to navigate through the given set of results
page_size
integer
Number of items to retrieve in each page. Default is 12.
Default Value : 12
q
string
Search with help of store code.
location_ids
array of integer
Search by store ids.
Response
200
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:
10
item_id:
2
size_identifier:
"MARCH_15_BULK001"
page_no:
1
page_size:
1
q:
"test"
location_ids:
1
Was this section helpful?
GET
Response
Get inventory by size identifier.
getInventoryBySizeIdentifier
Parameters
item_code
string
Item code of the product size.
company_id
integer
Required
Company Id of the product size.
item_id
integer
Required
Item Id of the product size.
brand_uid
integer
Brand Id of the product size.
uid
integer
Id of the product size.
Response
200
400
Product object. See example below for details
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.
Examples
Parameters
item_code:
"12345"
company_id:
1
item_id:
2
brand_uid:
12345
uid:
12345
Was this section helpful?
GET
Response
Get product size details.
getProductSize
Parameters
company_id
integer
Required
Company Id of the company associated to size that is to be deleted.
item_id
integer
Required
Item Id of the product associated with size to be deleted.
size
string
Required
size to be deleted.
Response
200
400
Returns a success response
ProductSizeDeleteResponseSchema
data
object (ProductSizeDeleteDataResponseSchema)
ProductSizeDeleteDataResponseSchema
company_id
integer
The unique identifier for the company that manages the product.
item_id
integer
The unique identifier for the specific item from which the size is being deleted.
size
string
The size being deleted from the product.
success
boolean
Indicates whether the size deletion operation was successful.
Examples
Parameters
company_id:
1
item_id:
2
size:
"XL"
Was this section helpful?
DEL
Response
Delete product size.
deleteSize
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.
item_id
integer
Required
Item code of the product of which size is to be get.
size
string
Required
Size of which inventory is to get.
page_no
integer
The page number to navigate through the given set of results
page_size
integer
Number of items to retrieve in each page. Default is 12.
Default Value : 12
q
string
Search with help of store code.
sellable
boolean
Filter on whether product is in stock or not.
Default Value : false
Response
200
400
returns a list of all inventory grouped by size and store
InventoryResponsePaginated
items
array of object (InventoryResponseSchema)
Array of InventoryResponseSchema
currency
string
The currency in which the item is priced, e.g., 'INR'.
inventory_updated_on
string
| date-time
The date and time when the inventory was last updated, in ISO 8601 format.
item_id
integer
The unique identifier for the item in the inventory system.
price
number
The original price of the item.
price_effective
number
The effective price of the item after any discounts.
price_transfer
number
The transfer price for the item (if applicable).
quantity
integer
The total quantity of the item available in the inventory.
sellable_quantity
integer
The quantity of the item that is available for sale.
seller_identifier
string
An identifier for the seller, typically an SKU or unique code.
size
string
The size of the item, if applicable.
uid
string
A unique identifier combining store ID and seller identifier.
expiration_date
string
| date-time
The expiration date of the item, if applicable, in ISO 8601 format.
tags
array of string
An array of tags or labels associated with the item for categorization or search purposes.
store
object (InventoryStore)
InventoryStore
name
string
store_code
string
uid
integer
address
object (InventoryAddress)
InventoryAddress
address1
string
pincode
string
city
string
country
string
state
string
lat_long
object (InventoryGeoLocation)
InventoryGeoLocation
type
string
coordinates
array of number
country_code
string
manager
object (InventoryManager)
InventoryManager
name
string
email
string
mobile_no
object (InventoryMobileNumber)
InventoryMobileNumber
number
string
country_code
integer
_custom_json
object
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.
identifiers
array of object (InventoryIdentifier)
Array of InventoryIdentifier
gtin_type
string
gtin_value
string
primary
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
item_id:
2
size:
"XL"
page_no:
1
page_size:
1
q:
"XL"
sellable:
true
Was this section helpful?
GET
Response
Get inventory by size.
getInventoryBySize
Parameters
company_id
integer
Required
Get list of products filtered by company Id
item_id
integer
Required
Get list of variants of item Id
variant_type
string
Required
Get multiple products filtered by variant type
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
Response
200
404
Product Meta. See example below for details
ProductVariantsResponseSchema
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.
variants
array of object (ProductVariants)
A list of product variants returned in the response.
Array of ProductVariants
brand_uid
integer
Unique identifier for the brand associated with the product variant.
category_uid
integer
Unique identifier for the category to which the product variant belongs.
item_code
string
Code that uniquely identifies the specific product variant.
media
array of object (Media)
Array of media objects representing images, videos, or other media associated with the product variant.
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 variant.
uid
integer
Unique identifier for the product variant.
Examples
Parameters
company_id:
1
item_id:
2
variant_type:
"color"
page_no:
1
page_size:
1
Was this section helpful?
GET
Response
Get variants of products.
getVariantsOfProducts
Parameters
company_id
integer
Required
Get company verification details filtered by company Id
q
string
A `q` parameter is used to search the company by its name.
page_no
integer
A `page_no` parameter is a number of the page requested.
page_size
integer
A `page_size` is the no of items per page.
Response
200
400
Product Meta. See example below for details
CompanyVerificationResponseSchema
uid
integer
name
string
stats
object (CompanyVerificationStats)
CompanyVerificationStats
verified
integer
total
integer
Examples
Parameters
company_id:
10
q:
"SHOPSENSE RETAIL TECHNOLOGIES LIMITED"
page_no:
1
page_size:
1
Was this section helpful?
GET
Response
Get company verification status
getCompanyVerification
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a seller account.
item_id
integer
Required
A `item_id` is a unique identifier for a specific product.
Response
200
400
Product verification data.
ProductVerificationModel
rejected_fields
object
status
string
brand_uid
integer
created_on
string
| date-time
company_ids
array of integer
item_code
string
remark
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_on
string
| date-time
slug
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.
item_id
integer
id
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
item_id:
2
Was this section helpful?
GET
Response
Get the verification detail of a product
getProductVerificationDetails
Parameters
company_id
integer
Required
Get list of products filtered by company Id
template_tag
string
Required
The page number to navigate through the given set of results
Response
200
Product Meta. See example below for details
VariantTypesResponseSchema
items
array of object (VariantTypeItem)
Array of VariantTypeItem
name
string
Name of the item
key
string
Key of the item
type
array of string
Array of item types
image_config
object
Nullable
Configuration for the image
Examples
Parameters
company_id:
10
template_tag:
"test"
Was this section helpful?
GET
Response
Get variant type list
getVariantTypes
Parameters
page_no
integer
page no
Default Value : 1
page_size
integer
page size
Default Value : 12
q
string
search using hsn code, description, reporting_hsn
type
string
search using type
company_id
integer
Required
Company Id for which HSN codes needs to be fetched
Response
200
400
List of all HSN Codes.
HsnCodesListingResponseSchemaV2
items
array of object (HSNDataInsertV2)
Array of HSNDataInsertV2
country_code
string
Country code.
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
Date and time when the HSN data was created.
description
string
Description of the HSN data.
hsn_code
string
hsn_code_id
string
Unique identifier of the HSN code.
modified_on
string
| date-time
Date and time when the HSN data was last modified.
reporting_hsn
Undefined Type
HSN code.
id
string
Internal database identifier for the HSN data.
taxes
array of object (TaxSlab)
List of applicable tax slabs for the HSN data.
Array of TaxSlab
cess
number
Cess rate applicable for the tax slab.
effective_date
string
| date-time
The date from which the tax slab becomes effective.
rate
number
Applicable tax rate.
Enum
threshold
number
Threshold value above which the tax slab applies.
type
string
Type of HSN data (goods or services).
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
page_no:
1
page_size:
1
q:
"615717171"
type:
"goods"
company_id:
1
Was this section helpful?
GET
Response
Get all product HSN codes.
getAllProductHsnCodes
Parameters
reporting_hsn
string
Required
reporting_hsn
company_id
integer
Required
Company Id for which HSN codes needs to be fetched
Response
200
400
Get specific HSN details.
HSNDataInsertV2
country_code
string
Country code.
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
Date and time when the HSN data was created.
description
string
Description of the HSN data.
hsn_code
string
hsn_code_id
string
Unique identifier of the HSN code.
modified_on
string
| date-time
Date and time when the HSN data was last modified.
reporting_hsn
object
HSN code.
id
string
Internal database identifier for the HSN data.
taxes
array of object (TaxSlab)
List of applicable tax slabs for the HSN data.
Array of TaxSlab
cess
number
Cess rate applicable for the tax slab.
effective_date
string
| date-time
The date from which the tax slab becomes effective.
rate
number
Applicable tax rate.
Enum
threshold
number
Threshold value above which the tax slab applies.
type
string
Type of HSN data (goods or services).
Enum
Examples
Parameters
reporting_hsn:
"615717171H1"
company_id:
1
Was this section helpful?
GET
Response
Get single product HSN code.
getSingleProductHSNCode
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
Request body
meta
object
Additional metadata for the inventory request.
Default Value : [object Object]
payload
array of object (InventoryPayload)
The list of inventory payloads.
Maximum Items : 50
Array of InventoryPayload
expiration_date
string
| date-time
The expiration date of the inventory item.
price_effective
number
The effective price of the inventory item.
price_marked
number
The marked price of the inventory item.
seller_identifier
string
Required
The identifier of the seller.
Pattern : ^[A-Za-z0-9-_@,#\(\)\.\+\/ ]+$
store_id
integer
Required
The ID of the store.
tags
array of string
Nullable
The tags associated with the inventory item.
total_quantity
integer
Nullable
The total quantity of the inventory item. Any one quantity is allowed `sellable_quantity` or `total_quantity`, the other one would be derived.
sellable_quantity
integer
The sellable quantity of the inventory item. Any one quantity is allowed `sellable_quantity` or `total_quantity`, the other one would be derived.
trace_id
string
The trace ID of the inventory payload.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
400
Returns a success or partial success response
InventoryUpdateResponseSchema
items
array of object (InventoryResponseItem)
Array of InventoryResponseItem
data
object (InventoryPayload)
InventoryPayload
expiration_date
string
| date-time
The expiration date of the inventory item.
price_effective
number
The effective price of the inventory item.
price_marked
number
The marked price of the inventory item.
seller_identifier
string
The identifier of the seller.
Pattern : ^[A-Za-z0-9-_@,#\(\)\.\+\/ ]+$
store_id
integer
The ID of the store.
tags
array of string
Nullable
The tags associated with the inventory item.
total_quantity
integer
Nullable
The total quantity of the inventory item. Any one quantity is allowed `sellable_quantity` or `total_quantity`, the other one would be derived.
sellable_quantity
integer
The sellable quantity of the inventory item. Any one quantity is allowed `sellable_quantity` or `total_quantity`, the other one would be derived.
trace_id
string
The trace ID of the inventory payload.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
reason
object (InventoryFailedReason)
InventoryFailedReason
errors
string
It is the error message of the inventory error response.
message
string
It is the message of the activity performed.
reason_code
integer
It is the reason code of the inventory error response.
message
string
It is the success message of the inventory update.
success
boolean
It is the success message of the inventory update.
Examples
Parameters
company_id:
10
body:
body
Was this section helpful?
POST
Response
Update inventories.
updateInventories
Helps you the retrieve the history of inventory jobs depending on the filtered criteria.
Parameters
company_id
integer
Required
It is the unique identifier of the company.
status
string
Status of the export job.
from_date
string
| date-time
Inventory export history filtered according to from_date.
to_date
string
| date-time
Inventory export history filtered according to from_date.
q
string
Inventory export history filtered according to task ID.
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
Response
200
400
Returns a list of inventory export jobs
InventoryExportJobListResponseSchema
items
array of object (InventoryExportJobList)
Array of InventoryExportJobList
status
string
completed_on
string
notification_emails
array of string
filters
object (InventoryExportJobListFilters)
InventoryExportJobListFilters
brand_ids
array of integer
store_ids
array of integer
brands
array of string
stores
array of string
stats
object (InventoryExportJobListStats)
InventoryExportJobListStats
success
integer
total
integer
type
string
modified_on
string
| date-time
created_on
string
| date-time
seller_id
integer
url
string
task_id
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.
id
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:
10
status:
"pending"
from_date:
"2023-12-10T06:12:03Z"
to_date:
"2023-12-10T06:12:03Z"
q:
"588bd932-9cc9-11ee-8cc4-d6fb2161153f"
page_no:
1
page_size:
12
Was this section helpful?
GET
Response
List inventory exports.
listInventoryExport
Parameters
company_id
integer
Required
Company Id in which assets to be uploaded.
Request body
data
array of string
The list of attributes that you want to extract in the export job.
Default Value :
filters
object (InventoryExportFilter)
Required
InventoryExportFilter
brand_ids
array of integer
The list of the brand ids that needs to be exported.
from_date
string
| date-time
The modified on date from which the data needs to be exported.
quantity
object (InventoryExportQuantityFilter)
InventoryExportQuantityFilter
max
integer
The maximum quantity that needs to be exported.
min
integer
The minimum quantity that needs to be exported.
operators
string
Required
Condition for the quantity that needs to be exported.
Enum
store_ids
array of integer
Required
The list of the store ids that needs to be exported.
to_date
string
| date-time
The modified on date till when the data needs to be exported.
notification_emails
array of string
The list of the emails to be notified after the completion of the job.
type
string
The type of file that needs to be exported.
Default Value : csv
Enum
Response
200
Returns a success response
InventoryExportResponseSchema
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
Creation datetime of the job
filters
object (InventoryExportFiltersResponseSchema)
InventoryExportFiltersResponseSchema
brand_ids
array of integer
store_ids
array of integer
modified_on
string
| date-time
Modification date of the job
notification_emails
array of string
The notification emails for the job.
seller_id
integer
The seller id that needs to be exported.
status
string
The status of the job.
Enum
task_id
string
The task id of the job.
type
string
The type of file that needs to be exported.
stats
object (Stats)
Stats
total
integer
_id
string
trigger_on
string
brand
array of integer
store
array of integer
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
10
body:
body
Was this section helpful?
POST
Response
Create inventory export.
createInventoryExport
Parameters
company_id
integer
Required
Get list of products filtered by company Id
brand_ids
array of integer
Get multiple products filtered by Brand Ids
multi_size
boolean
Get multiple products filtered by weather have multiple sizes or not
category_ids
array of integer
Get multiple products filtered by Category Ids
item_ids
array of integer
Get multiple products filtered by Item Ids
department_ids
array of integer
Get multiple products filtered by Department Ids
item_code
array of string
Get multiple products filtered by Item Code
name
string
Get multiple products filtered by Name (Pattern Match)
slug
string
Get multiple products filtered by Slug
all_identifiers
array of string
Get multiple products filtered by All Identifiers
q
string
Get multiple products filtered by q string
tags
array of string
Get multiple products filtered by tags
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
page_type
string
For pagination type value can be cursor or number. Default is number.
Default Value : number
sort_on
string
Field which is to be used for sorting, default is latest. Value can be latest (modified_on) or created (record id)
Default Value : latest
page_id
string
If page_type is cursor, each response will contain **next_id** param (datetime or id depending upon sort_on), which should be sent back as page_id to make cursor pagination work.
Response
200
Product Meta. See example below for details
ProductListingResponseV2Schema
items
array of object (ProductSchemaV2)
Array of ProductSchemaV2
_custom_json
object
Custom JSON data specific to the product, used for storing additional information.
all_company_ids
array of integer
List of company IDs associated with the product.
all_identifiers
array of string
List of unique product identifiers such as SKU codes or GTINs.
all_sizes
array of object
Details of all available sizes for the product, including pricing and inventory information.
attributes
object
Additional attributes specific to 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 for the brand.
category
object
Object representing the category to which the product belongs.
category_slug
string
Slug representation of the product category for SEO purposes.
category_uid
integer
Unique identifier for the product category.
color
string
Primary color of the product.
company_id
integer
Identifier for the company managing the product.
country_of_origin
string
Country where the product was manufactured or sourced.
created_by
object
Object containing details about the user who created the product.
currency
string
The currency in which the product is priced (e.g., "INR").
custom_order
object
Information about custom order options for the product, including manufacturing time.
departments
array of integer
List of department IDs associated with the product.
description
string
Long description of the product.
highlights
array of string
Key features or highlights of the product.
hsn_code
string
Harmonized System Nomenclature (HSN) code for taxation purposes.
id
string
Unique identifier of the product in the database.
image_nature
string
Describes the nature of the product images (e.g., "standard").
images
array of object (Image)
List of image URLs 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 if the product depends on other products (e.g., part of a set).
is_expirable
boolean
Indicates whether the product has an expiry 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 (as opposed to a digital product).
is_set
boolean
Indicates if the product is a set of items rather than a single item.
item_code
string
Unique code used to identify the product, often used internally or by sellers.
item_type
string
Describes the type of product (e.g., "standard" or "set").
Enum
l3_mapping
array of string
Hierarchical mapping of the product to categories (e.g., "electronics>qled_television").
media
array of object (Media)
Media assets 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
Object containing details about the user who last modified the product.
modified_on
string
| date-time
The timestamp when the product was last modified.
moq
object
Minimum order quantity details for the product.
multi_size
boolean
Indicates if the product is available in 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 to pack the product.
pending
string
Pending status related to product availability or verification.
primary_color
string
The primary color of the product.
product_group_tag
array of string
Tags associated with the product grouping.
product_publish
object (ProductPublish)
ProductPublish
is_set
boolean
Default Value : false
product_online_date
string
| date-time
return_config
object (ReturnConfigResponseSchema)
ReturnConfigResponseSchema
returnable
boolean
time
integer
unit
string
short_description
string
Short description of the product, typically used in product listings.
size_guide
string
Reference to the size guide for the product, if applicable.
sizes
array of object (SizeDetails)
List of size details for the product.
Array of SizeDetails
size
string
Size identifier for the product (e.g., "S", "M", "L").
store_count
integer
The number of stores that have this size available.
sellable_quantity
integer
Quantity of the product that is sellable in this size.
sellable
boolean
Indicates if this size is currently sellable.
size_priority
integer
The priority of the size for display purposes.
identifiers
array of object (Identifier)
List of identifiers (e.g., SKU codes, GTINs) associated with the size.
Array of Identifier
primary
boolean
Indicates if this is the primary identifier for the size.
gtin_value
string
The GTIN (Global Trade Item Number) value for the size.
gtin_type
string
The type of GTIN (e.g., SKU code, UPC, EAN).
price
number
oneOf Schema from below
Properties
marked
object
Properties
min
number
Minimum marked price of the product for this size.
max
number
Maximum marked price of the product for this size.
effective
object
Properties
min
number
Minimum effective price of the product for this size.
max
number
Maximum effective price of the product for this size.
seller_identifier
string
Seller-specific identifier for this size.
price_transfer
number
Price transfer value for this size, typically used in business transactions.
track_inventory
boolean
Indicates if inventory is being tracked for this size.
slug
string
URL-friendly version of the product name for SEO purposes.
stage
string
Current stage of the product (e.g., "pending", "verified").
tags
array of string
Tags associated with the product for categorization and search purposes.
tax_identifier
object (TaxIdentifier)
TaxIdentifier
hsn_code
string
hsn_code_id
string
reporting_hsn
string
teaser_tag
object
Teaser tags used for marketing the product (e.g., "new arrival").
template_tag
string
Product template tag (e.g., "television").
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 of the product.
variant_group
object
Grouping of product variants.
variant_media
object
Media information for product variants.
variants
object
List of product 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 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
brand_ids:
1
multi_size:
true
category_ids:
1
item_ids:
1
department_ids:
1
item_code:
"MT-104-GREY"
name:
"Brown Plain"
slug:
"play-clan-play-clan-green-tee-26166-96f62c"
all_identifiers:
"MT-104-GREY_XL"
q:
"brown"
tags:
"test"
page_no:
1
page_size:
1
page_type:
"cursor"
sort_on:
"latest"
page_id:
"1"
Was this section helpful?
GET
Response
Retrieve products.
getProducts
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
Request body
_custom_json
object
Custom JSON data that can be used for additional product properties.
action
string
The action to perform wrt to the product (e.g., upsert, update, delete).
Enum
attributes
object
Additional attributes related to the product.
brand_uid
integer
Required
Unique identifier for the product's brand.
bulk_job_id
string
Job ID associated with bulk operations.
category_slug
string
Required
The category to which the product belongs.
change_request_id
string
Nullable
Change request identifier for product updates.
company_id
integer
Required
Unique identifier for the company associated with the product.
country_of_origin
string
Required
The country where the product was manufactured or sourced.
currency
string
Required
The currency in which the product's price is listed.
custom_order
object (CustomOrder)
CustomOrder
manufacturing_time_unit
string
Unit of time for manufacturing (e.g., days, weeks).
is_custom_order
boolean
Required
Indicates if the product is available for custom orders.
manufacturing_time
integer
Time required for manufacturing in the specified unit.
departments
array of integer
Required
List of department IDs associated with the product.
Minimum Items : 1
Maximum Items : 1
description
string
A detailed description of the product.
highlights
array of string
Nullable
Product highlights or key features.
is_active
boolean
Flag to indicate if the product is active.
Default Value : true
is_dependent
boolean
Flag to indicate if the product is dependent on other products.
Default Value : false
is_image_less_product
boolean
Flag to indicate if the product does not have associated images.
Default Value : false
is_set
boolean
Flag to indicate if the product is part of a set.
Default Value : false
item_code
string
Required
Unique item code or SKU of the product.
Pattern : ^[A-Za-z0-9-_@,#\(\)\. ]+$
item_type
string
Required
Type of the product (e.g., standard, set, composite, digital).
Enum
media
array of object (Media)
Nullable
List of media URLs (images, videos) associated with the product.
Maximum Items : 30
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
Required
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.
multi_size
boolean
Indicates if the product supports multiple sizes.
Default Value : true
name
string
Required
The name of the product.
Minimum Length : 1
Maximum Length : 300
net_quantity
object (NetQuantity)
NetQuantity
unit
string
The unit of measurement used for the net quantity of the product.
Enum
value
number
| value >= 0.001
The value of the net quantity of the product.
no_of_boxes
integer
| value >= 1
Number of boxes required to package the product.
Default Value : 1
product_group_tag
array of string
Tags to group products together for classification.
Maximum Items : 7
product_publish
object (ProductPublish)
ProductPublish
is_set
boolean
Default Value : false
product_online_date
string
| date-time
requester
string
The role requesting the product operation (admin or user).
Default Value : user
Enum
return_config
object (ReturnConfig)
Required
ReturnConfig
returnable
boolean
Required
time
integer
| value >= 0
unit
string
Enum
short_description
string
A short description of the product, up to 50 characters.
Maximum Length : 50
size_guide
string
Identifier for the product's size guide.
sizes
array of object
Required
List of sizes available for the product.
slug
string
Required
URL-friendly identifier for the product.
Pattern : ^[a-z0-9-_]*$
tags
array of string
List of tags associated with the product.
tax_identifier
object (TaxIdentifier)
Required
TaxIdentifier
hsn_code
string
hsn_code_id
string
reporting_hsn
string
teaser_tag
object (TeaserTag)
TeaserTag
tag
string
Nullable
url
string
| url
Nullable
template_tag
string
Required
Template tag for the product, used for classification.
trader
array of object (Trader)
Required
List of traders associated with the product.
Array of Trader
address
array of string
List of addresses associated with the trader.
name
string
Required
The name of the trader.
Minimum Length : 1
Maximum Length : 300
type
string
The role or type of the trader.
Enum
uid
integer
Nullable
Unique identifier for the product.
variant_group
object
Variant group information for the product.
variant_media
object
Media related to product variants.
variants
object
Variants information for the product.
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:
10
body:
body
Was this section helpful?
POST
Response
Create a product.
createProduct
Parameters
company_id
integer
Required
Company Id in which assets to be uploaded.
department
string
Required
Department of the product to be uploaded.
product_type
string
Required
Product type of the product to be uploaded i.e. set, standard , digital.
Enum
Request body
company_id
integer
The unique identifier of the company associated with the bulk product job.
template_tag
string
The template tag used to classify the products in the bulk job.
product_type
string
The type of products being processed in the bulk job (e.g., standard, digital, composite).
Enum
department
string
The department under which the products in the bulk job are categorized.
file_path
string
The file path of the uploaded file containing the bulk product data.
Response
200
Returns a success response
ProductBulkResponseSchema
batch_id
string
Examples
Parameters
company_id:
1
department:
"aaa-department"
product_type:
"standard"
body:
body
Was this section helpful?
POST
Response
Upload bulk products.
uploadBulkProducts
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
status
string
This is a parameter used to find all the jobs with the specified status.
from_date
string
| date
This is a parameter used to find the job from the date specified to the current date.
to_date
string
| date
This is a parameter used to find the job from the from_date specified to the to_date.
q
string
It is a query parameter to search the export job with the task ID.
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
Response
200
400
List of Product Downloads Data.
ProductDownloadsResponseSchema
items
array of object (ProductTemplateExportResponseSchema)
The items of the job.
Array of ProductTemplateExportResponseSchema
trigger_on
string
id
string
template_tags
Undefined Type
completed_on
string
Completion datetime of the job
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.
filters
object
The filters that needs to be exported.
modified_on
string
| date-time
Modification date of the job
notification_emails
array of string
The notification emails for the job.
seller_id
integer
The seller id that needs to be exported.
status
string
The status of the job.
Enum
task_id
string
The task id of the job.
type
string
The type of file that needs to be exported.
url
string
| url
The filters that needs to be exported.
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:
10
status:
"pending"
from_date:
"2023-12-10"
to_date:
"2023-12-10"
q:
"588bd932-9cc9-11ee-8cc4-d6fb2161153f"
page_no:
1
page_size:
12
Was this section helpful?
GET
Response
Retrieve product export jobs.
getProductExportJobs
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
Request body
filters
object (ProductTemplateExportFilterRequestSchema)
ProductTemplateExportFilterRequestSchema
brands
array of string
The list of the brands that needs to be exported.
catalogue_types
array of string
Required
The list of the type of the catalog such as set, standard and composite.
Minimum Items : 1
from_date
string
| date-time
The modified on date from which the data needs to be exported.
templates
array of string
Required
The list of the templates that needs to be exported.
Minimum Items : 1
to_date
string
| date-time
The modified on date till when the data needs to be exported.
notification_emails
array of string
The list of the emails to be notified after the completion of the job.
type
string
Nullable
This is the type of the file for the export.
Response
200
Returns a success response
CreateProductDownloadsResponseSchema
data
object (CreateProductDownloadsDataResponseSchema)
CreateProductDownloadsDataResponseSchema
created_on
string
| date-time
type
string
task_id
string
filters
object (ProductDownloadFilters)
ProductDownloadFilters
brands
array of string
catalogue_types
array of string
templates
array of 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.
_id
string
notification_emails
array of object
modified_on
string
| date-time
status
string
seller_id
integer
stats
object (Stats)
Stats
total
integer
Examples
Parameters
company_id:
10
body:
body
Was this section helpful?
POST
Response
Create product export job.
createProductExportJob
Parameters
company_id
integer
Required
Company Id of the product.
item_id
integer
Required
Item Id of the product.
brand_uid
integer
Brand Id of the product.
item_code
string
Item code of the product.
Response
200
400
Product object.
SingleProductResponseSchema
data
object (ProductSchemaV2)
ProductSchemaV2
_custom_json
object
Custom JSON data specific to the product, used for storing additional information.
all_company_ids
array of integer
List of company IDs associated with the product.
all_identifiers
array of string
List of unique product identifiers such as SKU codes or GTINs.
all_sizes
array of object
Details of all available sizes for the product, including pricing and inventory information.
attributes
object
Additional attributes specific to 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 for the brand.
category
object
Object representing the category to which the product belongs.
category_slug
string
Slug representation of the product category for SEO purposes.
category_uid
integer
Unique identifier for the product category.
color
string
Primary color of the product.
company_id
integer
Identifier for the company managing the product.
country_of_origin
string
Country where the product was manufactured or sourced.
created_by
object
Object containing details about the user who created the product.
currency
string
The currency in which the product is priced (e.g., "INR").
custom_order
object
Information about custom order options for the product, including manufacturing time.
departments
array of integer
List of department IDs associated with the product.
description
string
Long description of the product.
highlights
array of string
Key features or highlights of the product.
hsn_code
string
Harmonized System Nomenclature (HSN) code for taxation purposes.
id
string
Unique identifier of the product in the database.
image_nature
string
Describes the nature of the product images (e.g., "standard").
images
array of object (Image)
List of image URLs 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 if the product depends on other products (e.g., part of a set).
is_expirable
boolean
Indicates whether the product has an expiry 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 (as opposed to a digital product).
is_set
boolean
Indicates if the product is a set of items rather than a single item.
item_code
string
Unique code used to identify the product, often used internally or by sellers.
item_type
string
Describes the type of product (e.g., "standard" or "set").
Enum
l3_mapping
array of string
Hierarchical mapping of the product to categories (e.g., "electronics>qled_television").
media
array of object (Media)
Media assets 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
Object containing details about the user who last modified the product.
modified_on
string
| date-time
The timestamp when the product was last modified.
moq
object
Minimum order quantity details for the product.
multi_size
boolean
Indicates if the product is available in 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 to pack the product.
pending
string
Pending status related to product availability or verification.
primary_color
string
The primary color of the product.
product_group_tag
array of string
Tags associated with the product grouping.
product_publish
object (ProductPublish)
ProductPublish
is_set
boolean
Default Value : false
product_online_date
string
| date-time
return_config
object (ReturnConfigResponseSchema)
ReturnConfigResponseSchema
returnable
boolean
time
integer
unit
string
short_description
string
Short description of the product, typically used in product listings.
size_guide
string
Reference to the size guide for the product, if applicable.
sizes
array of object (SizeDetails)
List of size details for the product.
Array of SizeDetails
size
string
Size identifier for the product (e.g., "S", "M", "L").
store_count
integer
The number of stores that have this size available.
sellable_quantity
integer
Quantity of the product that is sellable in this size.
sellable
boolean
Indicates if this size is currently sellable.
size_priority
integer
The priority of the size for display purposes.
identifiers
array of object (Identifier)
List of identifiers (e.g., SKU codes, GTINs) associated with the size.
Array of Identifier
primary
boolean
Indicates if this is the primary identifier for the size.
gtin_value
string
The GTIN (Global Trade Item Number) value for the size.
gtin_type
string
The type of GTIN (e.g., SKU code, UPC, EAN).
price
number
oneOf Schema from below
Properties
marked
object
Properties
min
number
Minimum marked price of the product for this size.
max
number
Maximum marked price of the product for this size.
effective
object
Properties
min
number
Minimum effective price of the product for this size.
max
number
Maximum effective price of the product for this size.
seller_identifier
string
Seller-specific identifier for this size.
price_transfer
number
Price transfer value for this size, typically used in business transactions.
track_inventory
boolean
Indicates if inventory is being tracked for this size.
slug
string
URL-friendly version of the product name for SEO purposes.
stage
string
Current stage of the product (e.g., "pending", "verified").
tags
array of string
Tags associated with the product for categorization and search purposes.
tax_identifier
object (TaxIdentifier)
TaxIdentifier
hsn_code
string
hsn_code_id
string
reporting_hsn
string
teaser_tag
object
Teaser tags used for marketing the product (e.g., "new arrival").
template_tag
string
Product template tag (e.g., "television").
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 of the product.
variant_group
object
Grouping of product variants.
variant_media
object
Media information for product variants.
variants
object
List of product 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 when the product was verified.
Examples
Parameters
company_id:
1
item_id:
2
brand_uid:
1
item_code:
"MT-104-GREY"
Was this section helpful?
GET
Response
Get product details.
getProduct
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
item_id
integer
Required
Id of the product to be updated.
Request body
_custom_json
object
Custom JSON data that can be used for additional product properties.
action
string
The action to perform wrt to the product (e.g., upsert, update, delete).
Enum
attributes
object
Additional attributes related to the product.
brand_uid
integer
Required
Unique identifier for the product's brand.
bulk_job_id
string
Job ID associated with bulk operations.
category_slug
string
Required
The category to which the product belongs.
change_request_id
string
Nullable
Change request identifier for product updates.
company_id
integer
Required
Unique identifier for the company associated with the product.
country_of_origin
string
Required
The country where the product was manufactured or sourced.
currency
string
Required
The currency in which the product's price is listed.
custom_order
object (CustomOrder)
CustomOrder
manufacturing_time_unit
string
Unit of time for manufacturing (e.g., days, weeks).
is_custom_order
boolean
Required
Indicates if the product is available for custom orders.
manufacturing_time
integer
Time required for manufacturing in the specified unit.
departments
array of integer
Required
List of department IDs associated with the product.
Minimum Items : 1
Maximum Items : 1
description
string
A detailed description of the product.
highlights
array of string
Nullable
Product highlights or key features.
is_active
boolean
Flag to indicate if the product is active.
Default Value : true
is_dependent
boolean
Flag to indicate if the product is dependent on other products.
Default Value : false
is_image_less_product
boolean
Flag to indicate if the product does not have associated images.
Default Value : false
is_set
boolean
Flag to indicate if the product is part of a set.
Default Value : false
item_code
string
Required
Unique item code or SKU of the product.
Pattern : ^[A-Za-z0-9-_@,#\(\)\. ]+$
item_type
string
Required
Type of the product (e.g., standard, set, composite, digital).
Enum
media
array of object (Media)
Nullable
List of media URLs (images, videos) associated with the product.
Maximum Items : 30
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
Required
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.
multi_size
boolean
Indicates if the product supports multiple sizes.
Default Value : true
name
string
Required
The name of the product.
Minimum Length : 1
Maximum Length : 300
net_quantity
object (NetQuantity)
NetQuantity
unit
string
The unit of measurement used for the net quantity of the product.
Enum
value
number
| value >= 0.001
The value of the net quantity of the product.
no_of_boxes
integer
| value >= 1
Number of boxes required to package the product.
Default Value : 1
product_group_tag
array of string
Tags to group products together for classification.
Maximum Items : 7
product_publish
object (ProductPublish)
ProductPublish
is_set
boolean
Default Value : false
product_online_date
string
| date-time
requester
string
The role requesting the product operation (admin or user).
Default Value : user
Enum
return_config
object (ReturnConfig)
Required
ReturnConfig
returnable
boolean
Required
time
integer
| value >= 0
unit
string
Enum
short_description
string
A short description of the product, up to 50 characters.
Maximum Length : 50
size_guide
string
Identifier for the product's size guide.
sizes
array of object
Required
List of sizes available for the product.
slug
string
Required
URL-friendly identifier for the product.
Pattern : ^[a-z0-9-_]*$
tags
array of string
List of tags associated with the product.
tax_identifier
object (TaxIdentifier)
Required
TaxIdentifier
hsn_code
string
hsn_code_id
string
reporting_hsn
string
teaser_tag
object (TeaserTag)
TeaserTag
tag
string
Nullable
url
string
| url
Nullable
template_tag
string
Required
Template tag for the product, used for classification.
trader
array of object (Trader)
Required
List of traders associated with the product.
Array of Trader
address
array of string
List of addresses associated with the trader.
name
string
Required
The name of the trader.
Minimum Length : 1
Maximum Length : 300
type
string
The role or type of the trader.
Enum
uid
integer
Nullable
Unique identifier for the product.
variant_group
object
Variant group information for the product.
variant_media
object
Media related to product variants.
variants
object
Variants information for the product.
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
SuccessResponseSchema
success
boolean
Examples
Parameters
company_id:
10
item_id:
10
body:
body
Was this section helpful?
PUT
Response
Edit a product.
editProduct
Parameters
company_id
integer
Required
Company Id of the company associated to product that is to be deleted.
item_id
integer
Required
Id of the product to be updated.
Response
200
400
Returns a success response
SuccessResponseSchema
success
boolean
Examples
Parameters
company_id:
10
item_id:
10
Was this section helpful?
DEL
Response
Delete a product.
deleteProduct
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
item_id
integer
Required
Id of the product to be updated.
Response
200
400
List Product Sizes.
GetAllSizes
all_sizes
array of object (AllSizes)
Array of AllSizes
identifiers
array of object (ValidateIdentifier)
A collection of identifiers (e.g., GTIN, UPC) associated with the size. Each identifier follows the structure defined in the ValidateIdentifier schema.
Array of ValidateIdentifier
gtin_type
string
The type of the identifier (e.g., GTIN-12, GTIN-13, UPC) used to categorize the format of the identifier.
gtin_value
string
The actual value of the identifier (e.g., the numeric or alphanumeric code representing the product).
primary
boolean
A flag indicating whether this identifier is the primary one for the product.
item_dimensions_unit_of_measure
string
The unit of measurement used for the item's dimensions (e.g., centimeters, inches).
item_height
number
The height of the item in the specified unit of measure.
item_length
number
The length of the item in the specified unit of measure.
item_weight
number
The weight of the item in the specified unit of measure.
item_weight_unit_of_measure
string
The unit of measurement for the item's weight (e.g., kilograms, pounds).
item_width
number
The width of the item in the specified unit of measure.
size
string
The label or designation for the item's size (e.g., S, M, L, or numerical values).
Examples
Parameters
company_id:
1
item_id:
2
Was this section helpful?
GET
Response
Get all product sizes.
allSizes
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
item_id
integer
Required
Item code of the product of which size is to be get.
seller_identifier
string
Required
Size Identifier (Seller Identifier or Primary Identifier) of which inventory is to get.
Request body
meta
object
Additional metadata for the inventory request.
Default Value : [object Object]
payload
array of object (InventoryPayload)
The list of inventory payloads.
Maximum Items : 50
Array of InventoryPayload
expiration_date
string
| date-time
The expiration date of the inventory item.
price_effective
number
The effective price of the inventory item.
price_marked
number
The marked price of the inventory item.
seller_identifier
string
Required
The identifier of the seller.
Pattern : ^[A-Za-z0-9-_@,#\(\)\.\+\/ ]+$
store_id
integer
Required
The ID of the store.
tags
array of string
Nullable
The tags associated with the inventory item.
total_quantity
integer
Nullable
The total quantity of the inventory item. Any one quantity is allowed `sellable_quantity` or `total_quantity`, the other one would be derived.
sellable_quantity
integer
The sellable quantity of the inventory item. Any one quantity is allowed `sellable_quantity` or `total_quantity`, the other one would be derived.
trace_id
string
The trace ID of the inventory payload.
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
InventoryUpdateResponseSchema
items
array of object (InventoryResponseItem)
Array of InventoryResponseItem
data
object (InventoryPayload)
InventoryPayload
expiration_date
string
| date-time
The expiration date of the inventory item.
price_effective
number
The effective price of the inventory item.
price_marked
number
The marked price of the inventory item.
seller_identifier
string
The identifier of the seller.
Pattern : ^[A-Za-z0-9-_@,#\(\)\.\+\/ ]+$
store_id
integer
The ID of the store.
tags
array of string
Nullable
The tags associated with the inventory item.
total_quantity
integer
Nullable
The total quantity of the inventory item. Any one quantity is allowed `sellable_quantity` or `total_quantity`, the other one would be derived.
sellable_quantity
integer
The sellable quantity of the inventory item. Any one quantity is allowed `sellable_quantity` or `total_quantity`, the other one would be derived.
trace_id
string
The trace ID of the inventory payload.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
reason
object (InventoryFailedReason)
InventoryFailedReason
errors
string
It is the error message of the inventory error response.
message
string
It is the message of the activity performed.
reason_code
integer
It is the reason code of the inventory error response.
message
string
It is the success message of the inventory update.
success
boolean
It is the success message of the inventory update.
Examples
Parameters
company_id:
10
item_id:
2
seller_identifier:
"MARCH_15_BULK001"
body:
body
Was this section helpful?
DEL
Response
Delete realtime inventory.
deleteRealtimeInventory
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
item_id
integer
Required
Item code of the product of which size is to be get.
seller_identifier
string
Required
Size Identifier (Seller Identifier or Primary Identifier) of which inventory is to get.
Request body
meta
object
Additional metadata for the inventory request.
Default Value : [object Object]
payload
array of object (InventoryPayload)
The list of inventory payloads.
Maximum Items : 50
Array of InventoryPayload
expiration_date
string
| date-time
The expiration date of the inventory item.
price_effective
number
The effective price of the inventory item.
price_marked
number
The marked price of the inventory item.
seller_identifier
string
Required
The identifier of the seller.
Pattern : ^[A-Za-z0-9-_@,#\(\)\.\+\/ ]+$
store_id
integer
Required
The ID of the store.
tags
array of string
Nullable
The tags associated with the inventory item.
total_quantity
integer
Nullable
The total quantity of the inventory item. Any one quantity is allowed `sellable_quantity` or `total_quantity`, the other one would be derived.
sellable_quantity
integer
The sellable quantity of the inventory item. Any one quantity is allowed `sellable_quantity` or `total_quantity`, the other one would be derived.
trace_id
string
The trace ID of the inventory payload.
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
InventoryUpdateResponseSchema
items
array of object (InventoryResponseItem)
Array of InventoryResponseItem
data
object (InventoryPayload)
InventoryPayload
expiration_date
string
| date-time
The expiration date of the inventory item.
price_effective
number
The effective price of the inventory item.
price_marked
number
The marked price of the inventory item.
seller_identifier
string
The identifier of the seller.
Pattern : ^[A-Za-z0-9-_@,#\(\)\.\+\/ ]+$
store_id
integer
The ID of the store.
tags
array of string
Nullable
The tags associated with the inventory item.
total_quantity
integer
Nullable
The total quantity of the inventory item. Any one quantity is allowed `sellable_quantity` or `total_quantity`, the other one would be derived.
sellable_quantity
integer
The sellable quantity of the inventory item. Any one quantity is allowed `sellable_quantity` or `total_quantity`, the other one would be derived.
trace_id
string
The trace ID of the inventory payload.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
reason
object (InventoryFailedReason)
InventoryFailedReason
errors
string
It is the error message of the inventory error response.
message
string
It is the message of the activity performed.
reason_code
integer
It is the reason code of the inventory error response.
message
string
It is the success message of the inventory update.
success
boolean
It is the success message of the inventory update.
Examples
Parameters
company_id:
10
item_id:
2
seller_identifier:
"MARCH_15_BULK001"
body:
body
Was this section helpful?
POST
Response
Update realtime inventory.
updateRealtimeInventory
Manage product templates. It creates new product templates, lists existing ones, updates template details, disables templates, retrieves specific templates, downloads template views, and validates product templates.
Operations
GET
# Validate product template
GET
# Validate product template
Allows you to list all product templates validation values for all the fields present in the database.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
slug
string
Required
A `slug` is a unique identifier for a particular template.
item_type
string
An `item_type` defines the type of item. The default value is standard.
Enum
bulk
boolean
This specification determines the schema type to be retrieved. When set to true, it will return the schema for bulk data; when set to false, it will provide the schema for a single product. The default value is false.
Response
200
400
List of fields and validation values fro each. See example below or refer `TemplatesValidationResponseSchema` for details
TemplatesValidationResponseSchema
data
object (TemplateValidationData)
TemplateValidationData
global_validation
object (GlobalValidation)
GlobalValidation
definitions
object
description
string
properties
object (Properties)
Properties
brand_uid
object
category_slug
object
command
object
country_of_origin
object
currency
object
custom_order
object
description
object
highlights
object
hsn_code
object
is_active
object
is_dependent
object
item_code
object
item_type
object
media
object
multi_size
object
name
object
no_of_boxes
object
product_group_tag
object
product_publish
object
return_config
object
short_description
object
size_guide
object
sizes
object
slug
object
tags
object
teaser_tag
object
trader
object
trader_type
object
variants
object
required
array of string
title
string
type
string
template_validation
object
template_details
object (TemplateDetails)
TemplateDetails
attributes
array of string
Nullable
Default Value :
categories
array of string
Nullable
Default Value :
departments
array of string
Nullable
Default Value :
description
string
id
string
is_active
boolean
Default Value : true
is_archived
boolean
is_expirable
boolean
is_physical
boolean
logo
string
name
string
slug
string
tag
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
slug:
"platform_template"
item_type:
"standard"
bulk:
true
Was this section helpful?
GET
Response
Validate product template
validateProductTemplate
Allows you to list all product templates global validation values for all the fields present in the database for a specific company.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
item_type
string
An `item_type` defines the type of item. The default value is standard.
Enum
bulk
boolean
This specification determines the schema type to be retrieved. When set to true, it will return the schema for bulk data; when set to false, it will provide the schema for a single product. The default value is false.
Response
200
422
List of fields and validation values fro each. See example below or refer `TemplatesValidationResponseSchema` for details
TemplatesGlobalValidationResponseSchema
data
object (TemplateGlobalValidationData)
TemplateGlobalValidationData
global_validation
object (GlobalValidation)
GlobalValidation
definitions
object
description
string
properties
object (Properties)
Properties
brand_uid
object
category_slug
object
command
object
country_of_origin
object
currency
object
custom_order
object
description
object
highlights
object
hsn_code
object
is_active
object
is_dependent
object
item_code
object
item_type
object
media
object
multi_size
object
name
object
no_of_boxes
object
product_group_tag
object
product_publish
object
return_config
object
short_description
object
size_guide
object
sizes
object
slug
object
tags
object
teaser_tag
object
trader
object
trader_type
object
variants
object
required
array of string
title
string
type
string
Examples
Parameters
company_id:
1
item_type:
"standard"
Was this section helpful?
GET
Response
Validate product template
validateProductGlobalTemplate
Retrieve product templates and departments, including listing categories, creating departments, validating templates, and more for organized product data.
Operations
GET
# List department data.
GET
# Get department data.
GET
# List template brand type values.
GET
# Download inventory template view.
GET
# Validate product template schema.
GET
# List product templates.
GET
# List product template categories.
GET
# Download product template views.
GET
# Update marketplace optin
Allows you to list all departments, also can search using name and filter active and incative departments, and item type.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
page_no
integer
The page number to navigate through the given set of results
item_type
string
A `item_type` is a type of product eg. set, standard, digital
Enum
page_size
integer
Number of items to retrieve in each page. Default is 10.
name
string
Can search departments by passing name.
search
string
Can search departments by passing name of the department in search parameter.
is_active
boolean
Can query for departments based on whether they are active or inactive.
uids
array of integer
Filter department by uids.
Response
200
List of departments data.
DepartmentsResponseSchema
items
array of object (GetDepartment)
List of department objects.
Array of GetDepartment
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 of when the department was created.
is_active
boolean
Indicates whether the department is currently active.
item_type
string
Enum
logo
string
| url
URL of the department's logo.
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 of when the department was last modified.
id
string
Alternate unique identifier for the department.
name
string
Name of the department.
slug
string
URL-friendly slug for the department.
synonyms
array of string
List of alternative names for the department.
priority_order
integer
The priority order of the department for display purposes.
uid
integer
Unique identifier for the department within the system.
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
page_no:
1
item_type:
"standard"
page_size:
1
name:
"Fashion"
search:
"Fashion"
is_active:
true
uids:
1
Was this section helpful?
GET
Response
List department data.
listDepartmentsData
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
uid
string
Required
A `uid` is a unique identifier of a department.
Response
200
422
Departments Data.
DepartmentsResponseSchema
items
array of object (GetDepartment)
List of department objects.
Array of GetDepartment
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 of when the department was created.
is_active
boolean
Indicates whether the department is currently active.
item_type
string
Enum
logo
string
| url
URL of the department's logo.
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 of when the department was last modified.
id
string
Alternate unique identifier for the department.
name
string
Name of the department.
slug
string
URL-friendly slug for the department.
synonyms
array of string
List of alternative names for the department.
priority_order
integer
The priority order of the department for display purposes.
uid
integer
Unique identifier for the department within the system.
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
uid:
"2"
Was this section helpful?
GET
Response
Get department data.
getDepartmentData
Retrieve values related to template brand types. The filter type query parameter defines what type of data to return. The type of query returns the valid values for the same
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
filter
string
Required
A `filter` is the unique identifier of the type of value required.
template_tag
string
A `template_tag` is the identifier of the type of template required.
item_type
string
A `item_type` is the identifier of the type of template required.
Enum
Response
200
400
ProductConfigurationDownloads
data
array of object
multivalue
boolean
Examples
Parameters
company_id:
10
filter:
"brand"
template_tag:
"test"
item_type:
"standard"
Was this section helpful?
GET
Response
List template brand type values.
listTemplateBrandTypeValues
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
type
string
Required
Type of file
Response
200
CSV File of product template data.
Examples
Parameters
company_id:
1
type:
"csv"
Was this section helpful?
GET
Response
Download inventory template view.
downloadInventoryTemplateView
Allows you to list all product templates validation values for all the fields present in the database.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
item_type
string
Required
An `item_type` defines the type of item. The default value is standard.
Enum
bulk
boolean
Required
Type of file template i.e if bulk
Response
200
400
List of fields and validation values fro each.
InventoryValidationResponseSchema
data
object
message
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
1
item_type:
"standard"
Was this section helpful?
GET
Response
Validate product template schema.
validateProductTemplateSchema
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
department
string
Required
A `department` is the name of a particular department.
Response
200
List of product templates.
TemplatesResponseSchema
items
array of object (ProductTemplate)
Array of ProductTemplate
attributes
array of string
List of attributes associated with the product template.
categories
array of string
List of categories the product template belongs to.
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 of when the product template was created.
departments
array of string
List of departments the product template is associated with.
description
string
Detailed description of the product template.
is_active
boolean
Indicates if the product template is currently active.
Default Value : true
is_archived
boolean
Indicates if the product template is archived.
is_expirable
boolean
Indicates if the product template is expirable.
is_physical
boolean
Indicates if the product template represents a physical product.
logo
string
URL of the product template logo.
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 of when the product template was last modified.
name
string
The name of the product template.
slug
string
Unique URL-friendly identifier for the product template.
tag
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
department:
"producttemplatedepartment"
Was this section helpful?
GET
Response
List product templates.
listProductTemplate
Allows you to list all product categories values for the departments specified.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
departments
string
Required
A `department` is name of a departments whose category needs to be listed. Can specify multiple departments.
item_type
string
Required
An `item_type` is the type of item, it can be `set`, `standard`, `digital`, etc.
Enum
page_size
number
Number of categories needed in one page
page_no
number
Page number to fetch, for example if pagesize is 10 and page number 1,
q
number
Search string to search categories from
Response
200
400
List of all categories attached to departments specified.
ProdcutTemplateCategoriesResponseSchema
items
array of object (CategoriesResponseSchema)
Array of CategoriesResponseSchema
name
string
The name of the category.
slug
string
A URL-friendly unique identifier for the category.
slug_key
string
A key used for internal identification of the category slug.
template_slug
string
The slug of the template associated with the category.
uid
integer
A unique identifier for 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
departments:
"producttemplatedepartment"
item_type:
"standard"
page_size:
10
page_no:
1
q:
1
Was this section helpful?
GET
Response
List product template categories.
listProductTemplateCategories
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
slug
string
Required
A `slug` is a unique identifier for a particular template.
item_type
string
An `item_type` defines the type of item. The default value is standard.
Enum
type
string
Format type of the sample file. The default value is excel.
Response
200
400
CSV File of product template data.
Examples
Parameters
company_id:
1
slug:
"platform_template"
item_type:
"standard"
type:
"csv"
Was this section helpful?
GET
Response
Download product template views.
downloadProductTemplateViews
Parameters
company_id
integer
Required
Id of the company associated to the template.
slug
string
Required
Slug of the template.
Response
200
Update marketplace optin config.
GetProductTemplateSlugResponseSchema
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.
items
array of object (GetProductTemplateSlugItemsSchema)
Array of GetProductTemplateSlugItemsSchema
attributes
array of string
departments
array of string
is_active
boolean
tag
string
is_physical
boolean
description
string
logo
string
| uri
is_archived
boolean
slug
string
categories
array of string
is_expirable
boolean
name
string
id
string
Examples
Parameters
company_id:
1
slug:
"test"
Was this section helpful?
GET
Response
Update marketplace optin
getProductTemplateBySlug
Manage size guides for your products. You can create new size guides using createSizeGuide, retrieve a list of available size guides with getSizeGuides, update existing size guides with updateSizeGuide, and obtain specific size guide details with getSizeGuide.
Operations
POST
# Create a size guide.
GET
# Retrieve size guides.
GET
# Get size guide details.
PUT
# Update a size guide.
Parameters
company_id
integer
Required
Id of the company inside which the size guide is to be created.
Request body
active
boolean
Indicates whether the size guide is currently active.
brand_id
integer
The unique identifier for the brand associated with the size guide.
company_id
string
The unique identifier for the company that owns the size guide.
created_by
object
Information about the user who created the size guide.
created_on
string
| date-time
The timestamp when the size guide was created, in ISO 8601 format.
description
string
A detailed HTML description of the size guide.
guide
object (Guide)
Guide
meta
object (Meta)
Meta
headers
object (GuideHeaders)
GuideHeaders
col_1
object (Header)
Header
value
string
convertable
boolean
col_2
object (Header)
Header
value
string
convertable
boolean
col_3
object (Header)
Header
value
string
convertable
boolean
col_4
object (Header)
Header
value
string
convertable
boolean
col_5
object (Header)
Header
value
string
convertable
boolean
col_6
object (Header)
Header
value
string
convertable
boolean
col_7
object (Header)
Header
value
string
convertable
boolean
col_8
object (Header)
Header
value
string
convertable
boolean
col_9
object (Header)
Header
value
string
convertable
boolean
col_10
object (Header)
Header
value
string
convertable
boolean
values
array of object (GuideValues)
Array of GuideValues
col_1
string
col_2
string
col_3
string
col_4
string
col_5
string
col_6
string
col_7
string
col_8
string
col_9
string
col_10
string
unit
string
Enum
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
id
string
The public identifier of the size guide.
image
string
| url
A URL pointing to an image associated with the size guide.
modified_by
object
Information about the user who last modified the size guide.
modified_on
string
| date-time
The timestamp when the size guide was last modified, in ISO 8601 format.
name
string
Required
The name of the size guide.
subtitle
string
A short description or subtitle of the size guide.
tag
string
A tag or label associated with the size guide, used for categorization or reference.
title
string
Required
The main title of the size guide.
Response
200
400
Returns a success response
SuccessResponseSchema
success
boolean
Examples
Parameters
company_id:
1
body:
body
Was this section helpful?
POST
Response
Create a size guide.
createSizeGuide
Parameters
company_id
string
Required
Id of the company for which the size guides are to be fetched.
active
boolean
filter size guide on basis of active, in-active
q
string
Query that is to be searched.
brand_id
integer
Brand id that is to be searched.
tag
string
to filter size guide on basis of tag.
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
Response
200
Size guide object.
ListSizeGuide
items
array of object (SizeGuideItem)
A list of size guides, each containing detailed information about a product's dimensions, creation, and modification data.
Array of SizeGuideItem
active
boolean
Indicates if the size guide is active or not.
brand_id
integer
The identifier for the brand associated with the size guide.
company_id
integer
The identifier for the company that owns the size guide.
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 timestamp when the size guide was created.
guide
object (Guide)
Guide
meta
object (Meta)
Meta
headers
object (GuideHeaders)
GuideHeaders
col_1
object (Header)
Header
value
string
convertable
boolean
col_2
object (Header)
Header
value
string
convertable
boolean
col_3
object (Header)
Header
value
string
convertable
boolean
col_4
object (Header)
Header
value
string
convertable
boolean
col_5
object (Header)
Header
value
string
convertable
boolean
col_6
object (Header)
Header
value
string
convertable
boolean
col_7
object (Header)
Header
value
string
convertable
boolean
col_8
object (Header)
Header
value
string
convertable
boolean
col_9
object (Header)
Header
value
string
convertable
boolean
col_10
object (Header)
Header
value
string
convertable
boolean
values
array of object (GuideValues)
Array of GuideValues
col_1
string
col_2
string
col_3
string
col_4
string
col_5
string
col_6
string
col_7
string
col_8
string
col_9
string
col_10
string
unit
string
Enum
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
id
string
The unique identifier for the size guide.
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 timestamp when the size guide was last modified.
name
string
The name of the size guide.
subtitle
string
A short description or subtitle for the size guide.
tag
string
A tag or identifier used to classify the size guide.
title
string
The title of the size guide.
description
string
A detailed description or HTML content providing more information about the size guide.
image
string
A URL to an image associated with the size guide
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"
active:
true
q:
"test"
brand_id:
1
page_no:
1
page_size:
1
Was this section helpful?
GET
Response
Retrieve size guides.
getSizeGuides
Parameters
id
string
Required
Id of the size guide to be viewed.
company_id
integer
Required
Id of the company associated to size guide.
Response
200
400
Size Guide Object.
SizeGuideResponseSchema
active
boolean
Indicates whether the size guide is currently active.
brand_id
integer
The unique identifier for the brand associated with the size guide.
company_id
integer
The unique identifier for the company that owns the size guide.
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 timestamp when the size guide was created, in ISO 8601 format.
guide
object
The main content of the size guide, containing details such as the size measurements, headers, and units.
id
string
The public identifier of the size guide.
image
string
A URL pointing to an image associated with the size guide.
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 timestamp when the size guide was last modified, in ISO 8601 format.
name
string
The name or title of the size guide.
subtitle
string
A short description or subtitle of the size guide.
tag
string
A tag or label associated with the size guide, used for categorization or reference.
title
string
The main title of the size guide.
Examples
Parameters
id:
"6567199070c59f542529866d"
company_id:
1
Was this section helpful?
GET
Response
Get size guide details.
getSizeGuide
Parameters
company_id
integer
Required
Id of the company.
id
string
Required
Mongo id of the size guide to be edited
Request body
active
boolean
Indicates whether the size guide is currently active.
brand_id
integer
The unique identifier for the brand associated with the size guide.
company_id
string
The unique identifier for the company that owns the size guide.
created_by
object
Information about the user who created the size guide.
created_on
string
| date-time
The timestamp when the size guide was created, in ISO 8601 format.
description
string
A detailed HTML description of the size guide.
guide
object (Guide)
Guide
meta
object (Meta)
Meta
headers
object (GuideHeaders)
GuideHeaders
col_1
object (Header)
Header
value
string
convertable
boolean
col_2
object (Header)
Header
value
string
convertable
boolean
col_3
object (Header)
Header
value
string
convertable
boolean
col_4
object (Header)
Header
value
string
convertable
boolean
col_5
object (Header)
Header
value
string
convertable
boolean
col_6
object (Header)
Header
value
string
convertable
boolean
col_7
object (Header)
Header
value
string
convertable
boolean
col_8
object (Header)
Header
value
string
convertable
boolean
col_9
object (Header)
Header
value
string
convertable
boolean
col_10
object (Header)
Header
value
string
convertable
boolean
values
array of object (GuideValues)
Array of GuideValues
col_1
string
col_2
string
col_3
string
col_4
string
col_5
string
col_6
string
col_7
string
col_8
string
col_9
string
col_10
string
unit
string
Enum
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
id
string
The public identifier of the size guide.
image
string
| url
A URL pointing to an image associated with the size guide.
modified_by
object
Information about the user who last modified the size guide.
modified_on
string
| date-time
The timestamp when the size guide was last modified, in ISO 8601 format.
name
string
Required
The name of the size guide.
subtitle
string
A short description or subtitle of the size guide.
tag
string
A tag or label associated with the size guide, used for categorization or reference.
title
string
Required
The main title of the size guide.
Response
200
400
Returns a success response
SuccessResponseSchema
success
boolean
Examples
Parameters
company_id:
1
id:
"6567199070c59f542529866d"
body:
body
Was this section helpful?
PUT
Response
Update a size guide.
updateSizeGuide
Obtain store details and access all attributes for comprehensive product information and categorization.
Operations
GET
# Get attribute detail by slug
Retrieve the attribute detail for catalog listings by attribute slug passed for a specific company.
Parameters
company_id
integer
Required
The company id for which the detail needs to be retrieved.
attribute_slug
string
Required
Slug of the attribute for which you want to view the details
Response
200
Get Attribute Detail by Slug.
AttributeDetail
created_on
string
| date-time
It is Date and time when the attribute was created.
modified_on
string
| date-time
It is Date and time when the attribute was modified.
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.
departments
array of string
description
string
details
object (AttributeMasterDetails)
AttributeMasterDetails
display_type
string
Type of display used for the attribute (e.g., text, dropdown).
enabled_for_end_consumer
boolean
filters
object (AttributeMasterFilter)
AttributeMasterFilter
ddepends_on
array of string
indexing
boolean
Whether the attribute should be indexed for search.
priority
integer
Priority of the attribute in filtering (optional).
_id
string
is_nested
boolean
logo
string
| url
meta
object (AttributeMasterMeta)
AttributeMasterMeta
enriched
boolean
Indicates if the attribute has been enriched with additional details or data beyond the basic schema.
mandatory_details
object (AttributeMasterMandatoryDetails)
AttributeMasterMandatoryDetails
l3_keys
array of string
A list of Level 3 (L3) keys associated with the attribute, typically used for advanced categorization or attribute grouping.
name
string
schema
object (AttributeMaster)
AttributeMaster
allowed_values
array of string
List of allowed values for the attribute, if applicable.
format
string
Format of the attribute, such as case formatting.
mandatory
boolean
Whether the attribute is mandatory.
multi
boolean
Indicates if the attribute allows multiple values.
range
object (AttributeSchemaRange)
AttributeSchemaRange
min
integer
Minimum allowed value for the attribute.
max
integer
Maximum allowed value for the attribute.
type
string
Data type of the attribute.
Enum
slug
string
variant
boolean
Examples
Parameters
company_id:
1
attribute_slug:
"test"
Was this section helpful?
GET
Response
Get attribute detail by slug
getAttribute
Access and modify platform-wide configurations. Retrieve the current platform configuration settings and update them as needed.
Operations
GET
# Get the Company Brand details of Optin.
GET
# Get the Company details.
GET
# Get the Store details.
GET
# List all marketplaces
PUT
# Update marketplace optin
POST
# Update marketplace optin
Get the details of the Brands associated with the given company_id passed.
Parameters
company_id
integer
Required
The company id for which the detail needs to be retrieved.
is_active
boolean
The is_active status for the optin id.
q
string
The search value to filter the list.
page_no
integer
The number of page for the company id.
page_size
integer
Number of records that can be seen on the page for the company id.
marketplace
string
The marketplace platform associated with the company id.
Response
200
OptinCompanyBrandDetailsView
items
array of object (CompanyBrandDetail)
Array of CompanyBrandDetail
brand_id
integer
brand_name
string
company_id
integer
total_article
integer
logo
object
name
string
id
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
is_active:
true
q:
"company"
page_no:
1
page_size:
1
marketplace:
"company"
Was this section helpful?
GET
Response
Get the Company Brand details of Optin.
getCompanyBrandDetail
Get the details of the company associated with the given company_id passed.
Parameters
company_id
integer
Required
The company id for which the detail needs to be retrieved.
Response
200
OptinCompanyDetail
name
string
uid
integer
business_info
string
business_type
string
company_type
string
Enum
business_country_info
object (OptinBusinessCountryInfo)
OptinBusinessCountryInfo
country
string
country_code
string
currency
object
timezone
string
address
object (OptinAddress)
OptinAddress
address1
string
state
string
pincode
string
city
string
country
string
latitude
number
longitude
number
country_code
string
documents
array of object (OptinDocument)
Array of OptinDocument
type
string
value
string
legal_name
string
verified
boolean
url
string
brands
array of integer
notification_emails
array of string
warnings
object
stage
string
Examples
Parameters
company_id:
1
Was this section helpful?
GET
Response
Get the Company details.
getCompanyDetail
Parameters
company_id
integer
Required
The company id for which the detail needs to be retrieved.
q
string
The search related the store for the company id.
page_no
integer
The number of page for the company id.
page_size
integer
Number of records that can be seen on the page for the company id.
Response
200
OptinStoreDetails
items
array of object (StoreDetail)
Array of StoreDetail
additional_contacts
array of object
company_id
integer
created_on
string
| date-time
display_name
string
modified_on
string
| date-time
name
string
store_code
string
store_type
string
Enum
timing
array of object (Timing)
Array of Timing
closing
object (Time)
Time
hour
integer
minute
integer
weekday
string
opening
object (Time)
Time
hour
integer
minute
integer
open
boolean
uid
integer
stage
string
modified_by
object (UserSchemaCustom)
UserSchemaCustom
user_id
string
username
string
manager
object (Manager)
Manager
name
string
email
string
mobile_no
object (MobileNo)
MobileNo
country_code
integer
number
string
notification_emails
array of string
verified_on
string
verified_by
object (UserSchemaCustom)
UserSchemaCustom
user_id
string
username
string
integration_type
object (IntegrationType)
IntegrationType
order
string
inventory
string
documents
array of object (Document)
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.
address
object (Address)
Address
country_code
string
address1
string
city
string
address2
string
country
string
pincode
string
landmark
string
state
string
created_by
object (UserSchemaCustom)
UserSchemaCustom
user_id
string
username
string
_custom_json
object
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
47
q:
"test"
page_no:
1
page_size:
1
Was this section helpful?
GET
Response
Get the Store details.
getStoreDetail
Parameters
company_id
integer
Required
Id of the company associated to the marketplace.
Response
200
List all Marketplace details.
GetAllMarketplaces
items
array of object (Marketplaces)
Array of Marketplaces
brand_ids
array of integer
app_id
string
enabled
boolean
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
opt_level
string
company_id
integer
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.
store_ids
array of integer
modified_on
string
| date-time
platforms
string
_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
Was this section helpful?
GET
Response
List all marketplaces
getMarketplaces
Parameters
company_id
integer
Required
Id of the company associated to the marketplace.
marketplace
string
Required
Slug of the marketplace .
Request body
brand_ids
array of integer
company_id
integer
enabled
boolean
opt_level
string
platform
string
store_ids
array of integer
Response
200
Update marketplace optin config.
UpdateMarketplaceOptinResponseSchema
brand_ids
array of integer
company_id
integer
app_id
string
enabled
boolean
opt_level
string
platform
string
store_ids
array of integer
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:
10
marketplace:
"fynd"
body:
body
Was this section helpful?
PUT
Response
Update marketplace optin
updateMarketplaceOptin
Parameters
company_id
integer
Required
Id of the company associated to the marketplace.
marketplace
string
Required
Slug of the marketplace .
Request body
brand_ids
array of integer
company_id
integer
enabled
boolean
opt_level
string
platform
string
store_ids
array of integer
Response
201
Update marketplace optin config.
CreateMarketplaceOptinResponseSchema
store_ids
array of integer
brand_ids
array of integer
company_id
integer
opt_level
string
platform
string
enabled
boolean
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
Examples
Parameters
company_id:
10
marketplace:
"test"
body:
body
Was this section helpful?
POST
Response