Catalog
Manages product catalogs, including adding, updating, and deleting products, as well as categorizing them.
Category
Categories are hierarchical structure that enables a systematic organization of products for better discoverability of products on storefront. Categories are structured into three levels: L1, L2, and L3, with L1 representing the top-level category, followed by L2 and L3. For example - Clothing(L1) >> Shirts(L2) >> Formal Shirts(L3) A single L1 category can encompass multiple L2 categories underneath it, and similarly, an L2 category can contain multiple L3 categories within it. Category is a sales-channel specific configuration. While categories are common across all companies, sales channel can configure L3 category names tailored to their unique requirements.
Operations
GET
# List categories
POST
# Create categories
GET
# Get category by uid
PUT
# Update category
GET
List categories
Retrieve a list of categories data associated to a specific company and queries passed in the request.
Parameters
company_id
string
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
slug
string
Get category by slug
Response
200
4XX
Category Meta. See example below or refer `CategoryResponse` for details
CategoryResponse
items
array of object (Category)
Array of Category
page
object (Page)
Page
Examples
Parameters
companyId:
"value"
level:
"value"
department:
1
q:
"value"
pageNo:
1
pageSize:
1
uids:
0,1
slug:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List categories
listCategories
POST
Create categories
Allows to create product categories for specific company.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
Request body
departments
array of integer
Required
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
is_active
boolean
Required
It is the flag indicating if the category is active.
level
integer
Required
It is the level of category
marketplaces
object (CategoryMapping)
It is the mapping of the category in different marketplaces.
CategoryMapping
media
object (Media1)
It is the details of the media such as banner and logo..
Media1
name
string
Required
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.
Response
200
4XX
Category Meta. See example below or refer `CategoryCreateResponse` for details
CategoryCreateResponse
message
string
It is the message of the response from the category.
uid
integer
It is the unique identifier of the category.
Examples
Parameters
companyId:
"value"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create categories
createCategories
GET
Get category by uid
Retrieve detailed information about a specific category by its uid for a specific company.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
uid
string
Required
Category unique id
Response
200
4XX
Get Data for one category. See example below or refer `CategoryResponse` for details
SingleCategoryResponse
data
object (Category)
Category
Examples
Parameters
companyId:
"value"
uid:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get category by uid
getCategoryData
PUT
Update category
Modify data for an existing category by its uid for a specific company.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
uid
string
Required
Category unique id
Request body
departments
array of integer
Required
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
is_active
boolean
Required
It is the flag indicating if the category is active.
level
integer
Required
It is the level of category
marketplaces
object (CategoryMapping)
It is the mapping of the category in different marketplaces.
CategoryMapping
media
object (Media1)
It is the details of the media such as banner and logo..
Media1
name
string
Required
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.
Response
200
4XX
Category Meta. See example below or refer `CategoryUpdateResponse` for details
CategoryUpdateResponse
message
string
It is the message of the response from the category.
success
boolean
It is the flag indication the success response.
Examples
Parameters
companyId:
"value"
uid:
"value"
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Update category
updateCategory
Department
A department categorizes products into different sections or categories based on their type or purpose. Departments help organize products in a logical manner, making it easier for customers to navigate the product catalog. Each department typically has a unique identifier and a name. For example, a clothing ecommerce platform might have departments such as Men's Clothing, Women's Clothing, Accessories, Footwear, etc. You can retrieve a list of all departments associated with available products, facilitating easy navigation and organization of products based on departmental categorization. Additionally, the APIs allow you to list all products associated with a specific brand, collection, or category in a random order, enhancing user engagement and discovery within your application
Operations
GET
# List company department
POST
# Create departments
GET
# Get department by uid
PUT
# Update department
GET
List company department
Allows you to list all departments data for a specific company.
Parameters
company_id
string
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
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.
slug
string
Can filter by slug
Response
200
4XX
List of departments data. See example below or refer `DepartmentsResponse` for details
DepartmentsResponse
items
array of object (GetDepartment)
Array of GetDepartment
page
object (Page)
Page
Examples
Parameters
companyId:
"value"
pageNo:
1
itemType:
"value"
pageSize:
1
name:
"value"
search:
"value"
isActive:
false
slug:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List company department
listDepartmentsData
POST
Create departments
Create departments for a specific company.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
Request body
_cls
string
_custom_json
object
is_active
boolean
logo
string
Required
name
string
Required
platforms
object
priority_order
integer
Required
slug
string
synonyms
array of string
tags
array of string
uid
integer
Response
200
4XX
Success Response. See example below or refer `DepartmentCreateResponseSchema` for details
DepartmentCreateResponse
message
string
uid
integer
Examples
Parameters
companyId:
"value"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create departments
createDepartments
GET
Get department by uid
Retrieve detailed information about a specific department for a specific company by uid.
Parameters
company_id
string
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
4XX
Departments Data. See example below or refer `DepartmentsResponse` for details
DepartmentsResponse
items
array of object (GetDepartment)
Array of GetDepartment
page
object (Page)
Page
Examples
Parameters
companyId:
"value"
uid:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get department by uid
getDepartmentData
PUT
Update department
Modify the department data by their uid for a specifc company.
Parameters
company_id
string
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.
Request body
_cls
string
_custom_json
object
is_active
boolean
logo
string
Required
name
string
Required
platforms
object
priority_order
integer
Required
slug
string
synonyms
array of string
tags
array of string
uid
integer
Response
200
4XX
Success Response. See example below or refer `DepartmentCreateResponseSchema` for details
DepartmentModel
_cls
string
_custom_json
object
_id
string
created_by
object (UserDetail)
User details of the creator of the document
UserDetail
created_on
string
| date-time
Timestamp of the creation of the document
is_active
boolean
Whether the department is currently active
logo
string
The URL of the department's logo
modified_by
object (UserDetail)
User details of the last modifier of the document
UserDetail
modified_on
string
| date-time
Timestamp of the last modification of the document
name
string
The name of the department
priority_order
integer
The priority order of the department
slug
string
The unique slug identifier for the department
synonyms
array of string
A list of synonyms for the department name
uid
integer
The unique ID for the department
verified_by
object (UserDetail)
User details of the verifier of the document, if applicable
UserDetail
verified_on
string
| date-time
Timestamp of when the document was verified, if applicable
Examples
Parameters
companyId:
"value"
uid:
"value"
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Update department
updateDepartment
Product
The "Product" resource offers detailed insights into items available for sale on Sales Channels or Marketplaces. It provides comprehensive product listings, stock status insights, seller details, and facilitates efficient product catalog management
Operations
GET
# List Inventory
GET
# List product tags
GET
# List inventory by size
GET
# List product size
DEL
# Delete product size
GET
# List inventory by size
POST
# Create Inventory
GET
# Get variants
GET
# List product HSN codes
GET
# Get product HSN code
POST
# Update inventories
GET
# List inventory export jobs
POST
# Create inventory export
GET
# List products
POST
# Create product
POST
# Upload bulk products
DEL
# Delete product
GET
# Get a product
PUT
# Update a product
DEL
# Delete an inventory
POST
# Update an inventory
GET
List Inventory
Allows to get Inventories data for particular company.
Parameters
company_id
string
Required
Id of the company associated to product that is to be viewed.
item_id
string
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
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.
qty_gt
integer
This field allows you to filter for inventories that have quantity greater than to the specified value based on qty_type filter.
qty_lt
integer
This field allows you to filter for inventories that have a quantity less than to the specified value based on qty_type filter.
qty_type
string
This field provides flexibility in selecting filter for inventory quantity counts and date queries. For example, you might use this field to specify "total" or "sellable" quantity.
Enum
from_date
string
| date-time
Inventory updated on filter to get inventories greater then or equal to provided date based on qty_type value.
to_date
string
| date-time
Inventory updated on filter to get inventories less then or equal to provided date based on qty_type value.
size_identifier
string
Size Identifier (Seller Identifier or Primary Identifier) of which inventory is to get.
Response
200
4XX
returns a list of all inventory grouped by size and store
GetInventoriesResponse
items
array of object (GetInventories)
Array of GetInventories
page
object (Page)
Page
Examples
Parameters
companyId:
"value"
itemId:
"value"
size:
"value"
pageNo:
1
pageSize:
1
pageId:
"value"
pageType:
"value"
q:
"value"
sellable:
false
storeIds:
0,1
brandIds:
0,1
sellerIdentifiers:
"lorem","ipsum"
qtyGt:
1
qtyLt:
1
qtyType:
"value"
fromDate:
"value"
toDate:
"value"
sizeIdentifier:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List Inventory
getInventories
GET
List product tags
Retrieve tags data associated to a particular company.
Parameters
company_id
integer
Required
Company Id for which tags to be fetched.
Response
200
4XX
Tag List. See example below for details
ProductTagsViewResponse
items
array of string
Examples
Parameters
companyId:
1
Was this section helpful?
GET
Loading...
Response
Loading...
List product tags
getProductTags
GET
List inventory by size
Retrieve inventory data for a specific company, item ID, and seller identifier. The API supports search capabilities using store codes and location IDs.
Parameters
company_id
integer
Required
Id of the company associated to product that is to be viewed.
item_id
integer
Required
Item code of the product of which size is to be get.
size_identifier
string
Required
Size Identifier (Seller Identifier or Primary Identifier) of which inventory is to get.
page_no
integer
The page number to navigate through the given set of results
page_size
integer
Number of items to retrieve in each page. Default is 12.
Default Value : 12
q
string
Search with help of store code.
location_ids
array of integer
Search by store ids.
Response
200
4XX
returns a list of all inventory grouped by size and store
InventorySellerIdentifierResponsePaginated
items
array of object (InventorySellerResponse)
Array of InventorySellerResponse
page
object (Page)
Page
Examples
Parameters
companyId:
1
itemId:
1
sizeIdentifier:
"value"
pageNo:
1
pageSize:
1
q:
"value"
locationIds:
0,1
Was this section helpful?
GET
Loading...
Response
Loading...
List inventory by size
getInventoryBySizeIdentifier
GET
List product size
Retrieve data associated to a particular product size.
Parameters
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
4XX
Product object. See example below for details
ProductListingResponse
items
array of object (Product)
Array of Product
page
object (Page)
Page
Examples
Parameters
itemCode:
"value"
companyId:
1
itemId:
1
brandUid:
1
uid:
1
Was this section helpful?
GET
Loading...
Response
Loading...
List product size
getProductSize
DEL
Delete product size
Allows to delete size associated with product.
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
4XX
Returns a success response
ProductSizeDeleteResponse
data
object (ProductSizeDeleteDataResponse)
ProductSizeDeleteDataResponse
success
boolean
Examples
Parameters
companyId:
1
itemId:
1
size:
"value"
Was this section helpful?
DEL
Loading...
Response
Loading...
Delete product size
deleteSize
GET
List inventory by size
Retrieve inventory data for a specific company, item ID, and size. The API supports search capabilities based on selling location (store) code and product availability (in stock or not)."
Parameters
company_id
integer
Required
Id of the company associated to product that is to be viewed.
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
4XX
returns a list of all inventory grouped by size and store
InventoryResponsePaginated
items
array of object (InventoryResponse)
Array of InventoryResponse
page
object (Page)
Page
Examples
Parameters
companyId:
1
itemId:
1
size:
"value"
pageNo:
1
pageSize:
1
q:
"value"
sellable:
false
Was this section helpful?
GET
Loading...
Response
Loading...
List inventory by size
getInventoryBySize
POST
Create Inventory
Allows add Inventory for particular size and selling location.
Parameters
company_id
integer
Required
Id of the company associated to product that is to be viewed.
item_id
integer
Required
Item code of the product of which size is to be get.
size
string
Required
Size in which inventory is to be added.
Request body
company_id
integer
Required
item
object (ItemQuery)
Required
ItemQuery
sizes
array of object (InvSize)
Required
Array of InvSize
Response
200
4XX
Returns a success response
SuccessResponse
success
boolean
Examples
Parameters
companyId:
1
itemId:
1
size:
"value"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create Inventory
addInventory
GET
Get variants
Retrieve variants of a specific product.
Parameters
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
4XX
Product Meta. See example below for details
ProductVariantsResponse
page
object (Page)
Page
variants
array of object (ProductVariants)
Array of ProductVariants
Examples
Parameters
companyId:
1
itemId:
1
variantType:
"value"
pageNo:
1
pageSize:
1
Was this section helpful?
GET
Loading...
Response
Loading...
Get variants
getVariantsOfProducts
GET
List product HSN codes
Retrieve all HSN codes associated with company products and provide search capabilities based on HSN code, reporting HSN, etc
Parameters
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
4XX
List of all HSN Codes. See example below or refer `HsnCodesListingResponseSchema` for details
HsnCodesListingResponseSchemaV2
items
array of object (HSNDataInsertV2)
Array of HSNDataInsertV2
page
object (PageResponse)
PageResponse
Examples
Parameters
pageNo:
1
pageSize:
1
q:
"value"
type:
"value"
companyId:
1
Was this section helpful?
GET
Loading...
Response
Loading...
List product HSN codes
getAllProductHsnCodes
GET
Get product HSN code
Retrieve HSN details associated with company ID and reporting HSN
Parameters
reporting_hsn
string
Required
reporting_hsn
company_id
integer
Required
Company Id for which HSN codes needs to be fetched
Response
200
4XX
Get specific HSN details. See example below or refer `HsnCodesListingResponseSchema` for details
HSNDataInsertV2
country_code
string
Country code.
created_by
object
Details of the user who created the HSN data.
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.
Minimum Length : 4
Maximum Length : 11
hsn_code_id
string
Unique identifier of the HSN code.
modified_by
object
Details of the user who last modified the HSN data.
modified_on
string
| date-time
Date and time when the HSN data was last modified.
reporting_hsn
string
HSN code.
taxes
array of object (TaxSlab)
List of tax slabs.
Array of TaxSlab
type
string
Type of HSN data (goods or services).
Enum
Examples
Parameters
reportingHsn:
"value"
companyId:
1
Was this section helpful?
GET
Loading...
Response
Loading...
Get product HSN code
getSingleProductHSNCode
POST
Update inventories
Allows to add Inventory for particular size and selling location. for associated companies
Parameters
company_id
integer
Required
Id of the company associated to product that is to be viewed.
Request body
company_id
integer
Required
The ID of the company.
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
Response
200
400
Returns a success or partial success response
InventoryUpdateResponse
items
array of object (InventoryResponseItem)
Array of InventoryResponseItem
message
string
It is the success message of the inventory update.
Examples
Parameters
companyId:
1
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Update inventories
updateInventories
GET
List inventory export jobs
Retrieve the history of inventory export jobs associated with the company
Parameters
company_id
integer
Required
It is the unique identifier of the company.
status
string
Status of the export job.
from_date
string
Inventory export history filtered according to from_date.
to_date
string
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
4XX
Returns a list of inventory export jobs
InventoryExportJobListResponse
items
object (InventoryJobDetailResponse)
This is the list/history of all the jobs.
InventoryJobDetailResponse
page
object (Page)
Page
Examples
Parameters
companyId:
1
status:
"value"
fromDate:
"value"
toDate:
"value"
q:
"value"
pageNo:
1
pageSize:
1
Was this section helpful?
GET
Loading...
Response
Loading...
List inventory export jobs
listInventoryExport
POST
Create inventory export
creates export job for inventory data associated with a company
Parameters
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
This filters that are applied for the export of the inventory.
InventoryExportFilter
notification_emails
array of string
The list of the emails to be notified after the completion of the job.
type
string
Nullable
The type of file that needs to be exported.
Default Value : csv
Enum
Response
200
4XX
Returns a success response
InventoryExportResponse
created_by
string
| date-time
The user that created the job.
created_on
string
| date-time
Creation datetime of the job
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.
Examples
Parameters
companyId:
1
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create inventory export
createInventoryExport
GET
List products
Retrieve a list of available products
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
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
4XX
Product Meta. See example below for details
ProductListingResponseV2
items
array of object (ProductSchemaV2)
Array of ProductSchemaV2
page
object (Page)
Page
Examples
Parameters
companyId:
1
brandIds:
0,1
categoryIds:
0,1
itemIds:
0,1
departmentIds:
0,1
itemCode:
"lorem","ipsum"
name:
"value"
slug:
"value"
allIdentifiers:
"lorem","ipsum"
q:
"value"
tags:
"lorem","ipsum"
pageNo:
1
pageSize:
1
pageType:
"value"
sortOn:
"value"
pageId:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List products
getProducts
POST
Create product
Users can create a product using this API, associating it with the provided company ID
Parameters
company_id
string
Required
Id of the company associated to product that is to be viewed.
Request body
_custom_json
object
action
string
Enum
attributes
object
brand_uid
integer
Required
bulk_job_id
string
category_slug
string
Required
change_request_id
string
Nullable
company_id
integer
Required
country_of_origin
string
Required
currency
string
Required
custom_order
object (CustomOrder)
CustomOrder
departments
array of integer
Required
description
string
highlights
array of string
Nullable
is_active
boolean
Default Value : true
is_dependent
boolean
Default Value : false
is_image_less_product
boolean
Default Value : false
is_set
boolean
Default Value : false
item_code
string
Required
item_type
string
Required
Enum
media
array of object (Media)
Nullable
Array of Media
multi_size
boolean
Default Value : true
name
string
Required
net_quantity
object (NetQuantity)
NetQuantity
no_of_boxes
integer
| value >= 1
Default Value : 1
product_group_tag
array of string
product_publish
object (ProductPublish1)
ProductPublish1
requester
string
Default Value : user
Enum
return_config
object (ReturnConfig)
Required
ReturnConfig
short_description
string
size_guide
string
sizes
array of object
Required
slug
string
Required
tags
array of string
tax_identifier
object (TaxIdentifier)
Required
TaxIdentifier
teaser_tag
object (TeaserTag)
TeaserTag
template_tag
string
Required
trader
array of object (Trader)
Required
Array of Trader
uid
integer
Nullable
variant_group
object
variant_media
object
variants
object
Response
200
4XX
Returns a success response
SuccessResponse1
success
boolean
uid
integer
Examples
Parameters
companyId:
"value"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create product
createProduct
POST
Upload bulk products
Users can create multiple products by providing the required information needed for product creation in a CSV or Excel file format.
Parameters
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.
Request body
company_id
integer
template_tag
string
product_type
string
department
string
file_path
string
Response
200
4XX
Returns a success response
BulkResponse
batch_id
string
created_by
object (UserInfo1)
The user who created the item.
UserInfo1
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 (UserInfo1)
Nullable
The user who last modified the item.
UserInfo1
modified_on
string
| date-time
The date and time when the item was last modified.
Default Value : 2023-08-16T12:07:13.817Z
Examples
Parameters
companyId:
1
department:
"value"
productType:
"value"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Upload bulk products
uploadBulkProducts
DEL
Delete product
Users can delete a product using this by providing the itemid.
Parameters
company_id
string
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
4XX
Returns a success response
SuccessResponse
success
boolean
Examples
Parameters
companyId:
"value"
itemId:
1
Was this section helpful?
DEL
Loading...
Response
Loading...
Delete product
deleteProduct
GET
Get a product
Retrieve data associated to a particular product.
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
4XX
Product object. See example below or refer `product.utils.format_product_response` for details
SingleProductResponse
data
object (ProductSchemaV2)
ProductSchemaV2
Examples
Parameters
companyId:
1
itemId:
1
brandUid:
1
itemCode:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get a product
getProduct
PUT
Update a product
Modify the details and settings of an existing product in the catalog.
Parameters
company_id
string
Required
Id of the company associated to product that is to be viewed.
item_id
integer
Required
Id of the product to be updated.
Request body
_custom_json
object
action
string
Enum
attributes
object
brand_uid
integer
Required
bulk_job_id
string
category_slug
string
Required
change_request_id
string
Nullable
company_id
integer
Required
country_of_origin
string
Required
currency
string
Required
custom_order
object (CustomOrder)
CustomOrder
departments
array of integer
Required
description
string
highlights
array of string
Nullable
is_active
boolean
Default Value : true
is_dependent
boolean
Default Value : false
is_image_less_product
boolean
Default Value : false
is_set
boolean
Default Value : false
item_code
string
Required
item_type
string
Required
Enum
media
array of object (Media)
Nullable
Array of Media
multi_size
boolean
Default Value : true
name
string
Required
net_quantity
object (NetQuantity)
NetQuantity
no_of_boxes
integer
| value >= 1
Default Value : 1
product_group_tag
array of string
product_publish
object (ProductPublish1)
ProductPublish1
requester
string
Default Value : user
Enum
return_config
object (ReturnConfig)
Required
ReturnConfig
short_description
string
size_guide
string
sizes
array of object
Required
slug
string
Required
tags
array of string
tax_identifier
object (TaxIdentifier)
Required
TaxIdentifier
teaser_tag
object (TeaserTag)
TeaserTag
template_tag
string
Required
trader
array of object (Trader)
Required
Array of Trader
uid
integer
Nullable
variant_group
object
variant_media
object
variants
object
Response
200
4XX
Returns a success response
SuccessResponse
success
boolean
Examples
Parameters
companyId:
"value"
itemId:
1
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Update a product
editProduct
DEL
Delete an inventory
You can use this API to delete inventory linked to a particular product size. When you make the API call, the inventory associated with that size will be removed as part of api process.
Parameters
company_id
integer
Required
Id of the company associated to product that is to be viewed.
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
company_id
integer
Required
The ID of the company.
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
Response
200
400
Returns a success response
InventoryUpdateResponse
items
array of object (InventoryResponseItem)
Array of InventoryResponseItem
message
string
It is the success message of the inventory update.
Examples
Parameters
companyId:
1
itemId:
1
sellerIdentifier:
"value"
body:
body
Was this section helpful?
DEL
Loading...
Response
Loading...
Delete an inventory
deleteRealtimeInventory
POST
Update an inventory
enables you to add inventory for a specific size and selling location (store). The inventory updates will be reflected instantly after the API call.
Parameters
company_id
integer
Required
Id of the company associated to product that is to be viewed.
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
company_id
integer
Required
The ID of the company.
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
Response
200
400
Returns a success response
InventoryUpdateResponse
items
array of object (InventoryResponseItem)
Array of InventoryResponseItem
message
string
It is the success message of the inventory update.
Examples
Parameters
companyId:
1
itemId:
1
sellerIdentifier:
"value"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Update an inventory
updateRealtimeInventory
Product Attribute
Product Attribute are attributes associated with products, providing a structured way to define and categorize product characteristics. These attributes can include details such as size, color, material, and any other relevant product features. Using this resource, users can create, retrieve, update, and delete product attributes, enabling them to maintain accurate and detailed product information. Attributes can be assigned to products to provide a comprehensive description, aiding in product categorization, searchability, and customization.
Operations
GET
# List product attributes
GET
# Get gender attribute by slug
GET
List product attributes
Retrieve attributes attached to products based on their L3 category.
Parameters
company_id
integer
Required
company for which you want to view the genders
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
4XX
Size guide object. See example below or refer `ProductAttributesResponseSchema` for details
ProductAttributesResponse
items
array of object (AttributeMasterSerializer)
Array of AttributeMasterSerializer
Examples
Parameters
companyId:
1
category:
"value"
filter:
false
Was this section helpful?
GET
Loading...
Response
Loading...
List product attributes
getProductAttributes
GET
Get gender attribute by slug
Retrieve the gender attribute for catalog listings by attribute slug passed for a specific company.
Parameters
company_id
integer
Required
company for which you want to view the genders
attribute_slug
string
Required
slug of the attribute for which you want to view the genders
Response
200
4XX
Size guide object. See example below or refer `GenderDetailSchema` for details
GenderDetail
departments
array of string
description
string
details
object (AttributeMasterDetails)
AttributeMasterDetails
enabled_for_end_consumer
boolean
filters
object (AttributeMasterFilter)
AttributeMasterFilter
id
string
is_nested
boolean
logo
string
| url
meta
object (AttributeMasterMeta)
AttributeMasterMeta
name
string
schema
object (AttributeMaster)
AttributeMaster
slug
string
Examples
Parameters
companyId:
1
attributeSlug:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get gender attribute by slug
getGenderAttribute
Product Bundle
The Product Bundle is dedicated to facilitating the creation, updating, and retrieval of various product bundles for a specific company within the system. A product bundle is a collection of multiple products or services offered together as a package deal, often at a discounted or special price. These bundles are designed to enhance customer value by combining complementary items or services into a single offering. Product Bundle provide comprehensive functionalities to manage product bundles efficiently. Product Bundle can access and retrieve a list of all product bundles associated with a company, allowing for easy navigation and management of bundled offerings. Additionally, users can retrieve detailed information about a single product bundle, including its contents and pricing details.
Operations
GET
# List product bundles
POST
# Create product bundle
GET
# Get product bundle
PUT
# Update product bundle
GET
List product bundles
Retrieve a list of product bundles available in the catalog associated to a specific company.
Parameters
company_id
string
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.
Response
200
4XX
List of bundle configured for a company. See example below or refer `GetProductBundleListingResponse` for details
GetProductBundleListingResponse
items
array of object (GetProductBundleCreateResponse)
Array of GetProductBundleCreateResponse
page
object (Page)
Page
Examples
Parameters
companyId:
"value"
q:
"value"
slug:
"lorem","ipsum"
Was this section helpful?
GET
Loading...
Response
Loading...
List product bundles
getProductBundle
POST
Create product bundle
Create product bundle in the catalog associated to a specific company
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
Request body
choice
string
Required
company_id
integer
created_by
object
created_on
string
| date-time
is_active
boolean
Required
logo
string
Nullable
meta
object
modified_by
object
modified_on
string
| date-time
name
string
Required
page_visibility
array of string
Enum
products
array of object (ProductBundleItem)
Required
Array of ProductBundleItem
same_store_assignment
boolean
Default Value : true
slug
string
Required
Response
200
4XX
Get bundle with id that is added. See example below or refer `GetProductBundleCreateResponse` for details
GetProductBundleCreateResponse
choice
string
company_id
integer
created_by
object
created_on
string
| date-time
id
string
is_active
boolean
logo
string
Nullable
meta
object
modified_by
object
modified_on
string
| date-time
name
string
page_visibility
array of string
Enum
products
array of object (ProductBundleItem)
Array of ProductBundleItem
same_store_assignment
boolean
Default Value : true
slug
string
Examples
Parameters
companyId:
"value"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create product bundle
createProductBundle
GET
Get product bundle
Retrieve detailed information about a specific product bundle associated to a specific company.
Parameters
company_id
string
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
4XX
The Collection object. See example below or refer `GetProductBundleResponse` for details
GetProductBundleResponse
choice
string
company_id
integer
is_active
boolean
logo
string
meta
object
name
string
page_visibility
array of string
products
array of object (GetProducts)
Array of GetProducts
same_store_assignment
boolean
slug
string
Examples
Parameters
companyId:
"value"
id:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get product bundle
getProductBundleDetail
PUT
Update product bundle
Modify the details of an existing product bundle in the catalog associated to a specific company.
Parameters
company_id
string
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
company_id
integer
is_active
boolean
Required
logo
string
Nullable
meta
object
modified_by
object
modified_on
string
| date-time
name
string
Required
page_visibility
array of string
Enum
products
array of object (ProductBundleItem)
Required
Array of ProductBundleItem
same_store_assignment
boolean
Default Value : true
slug
string
Required
Response
200
4XX
The Collection object. See example below or refer `GetProductBundleCreateResponse` for details.
GetProductBundleCreateResponse
choice
string
company_id
integer
created_by
object
created_on
string
| date-time
id
string
is_active
boolean
logo
string
Nullable
meta
object
modified_by
object
modified_on
string
| date-time
name
string
page_visibility
array of string
Enum
products
array of object (ProductBundleItem)
Array of ProductBundleItem
same_store_assignment
boolean
Default Value : true
slug
string
Examples
Parameters
companyId:
"value"
id:
"value"
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...
Update product bundle
updateProductBundle
Product Template
The Product Template used for efficient product data organization through predefined templates . Product templates serve as structured blueprints, ensuring uniformity and accuracy in product listings.
Operations
GET
# List product templates
GET
# List product template categories
GET
List product templates
Allows you to list all product templates for a specific company. also can filter by department.
Parameters
company_id
string
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
4XX
List of product templates. See example below or refer `TemplatesResponse` for details
TemplatesResponse
items
object (ProductTemplate)
ProductTemplate
page
object (Page)
Page
Examples
Parameters
companyId:
"value"
department:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List product templates
listProductTemplate
GET
List product template categories
Allows you to list all product template categories values for the departments specified for a specific company.
Parameters
company_id
string
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.
Response
200
4XX
List of all categories attached to departments specified. See example below or refer `ProdcutTemplateCategoriesResponse` for details
ProdcutTemplateCategoriesResponse
items
array of object (CategoriesResponse)
Array of CategoriesResponse
page
object (Page)
Page
Examples
Parameters
companyId:
"value"
departments:
"value"
itemType:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List product template categories
listProductTemplateCategories
Size Guide
Size Guide facilitates the management of size-related information for products, aiding customers in making informed purchasing decisions. A size guide includes measurements, fit guides, and size conversion charts. Size Guide can create new size guides, retrieve a list of available size guides, update existing guides, and obtain specific details about a size guide. This functionality ensures that sizing information remains accurate and accessible.
Operations
GET
# List size guides
POST
# Create size guide
GET
# Get size guide
PUT
# Update size guide
GET
List size guides
Allows to view all the size guides associated to the seller. Each size guide contains meta deta like header values like for shoulder, head, etc. and measurement unit like cm and values contains sizes for the same.
Parameters
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.
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
brand_id
integer
Brand id that is to be searched.
Response
200
4XX
Size guide object. See example below or refer `ListSizeGuide` for details
ListSizeGuide
items
array of object
page
object
Examples
Parameters
companyId:
"value"
active:
false
q:
"value"
tag:
"value"
pageNo:
1
pageSize:
1
brandId:
1
Was this section helpful?
GET
Loading...
Response
Loading...
List size guides
getSizeGuides
POST
Create size guide
Allows to create a size guide associated to a seller
Parameters
company_id
string
Required
Id of the company inside which the size guide is to be created.
Request body
active
boolean
brand_id
integer
company_id
integer
created_by
object
created_on
string
| date-time
description
string
guide
object (Guide)
Guide
id
string
image
string
| url
modified_by
object
modified_on
string
| date-time
name
string
Required
subtitle
string
tag
string
title
string
Required
Response
200
4XX
Returns a success response
SuccessResponse
success
boolean
Examples
Parameters
companyId:
"value"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create size guide
createSizeGuide
GET
Get size guide
Retrieve data associated about a specific size guide. It contains meta deta like header values like for shoulder, head, etc. and measurement unit like cm and values contains sizes for the same.
Parameters
company_id
string
Required
Id of the company associated to size guide.
id
string
Required
Id of the size guide to be viewed.
Response
200
4XX
Brand object. See example below or refer `SizeGuideResponseSchema` for details
SizeGuideResponse
active
boolean
brand_id
integer
company_id
integer
created_by
object
created_on
string
guide
object
id
string
modified_by
object
modified_on
string
name
string
subtitle
string
tag
string
title
string
Examples
Parameters
companyId:
"value"
id:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get size guide
getSizeGuide
PUT
Update size guide
Allows to edit a specific size guide.
Parameters
company_id
string
Required
Id of the company.
id
string
Required
Mongo id of the size guide to be edited
Request body
active
boolean
brand_id
integer
company_id
integer
created_by
object
created_on
string
| date-time
description
string
guide
object (Guide)
Guide
id
string
image
string
| url
modified_by
object
modified_on
string
| date-time
name
string
Required
subtitle
string
tag
string
title
string
Required
Response
200
4XX
Returns a success response
SuccessResponse
success
boolean
Examples
Parameters
companyId:
"value"
id:
"value"
body:
body
Was this section helpful?
PUT
Loading...
Response
Loading...