Catalog
Manages product catalogs, including adding, updating, and deleting products, as well as categorizing them.
Categories are hierarchical structure that enables a systematic organization of products for better discoverability of products on storefront. Categories are structured into three levels: L1, L2, and L3, with L1 representing the top-level category, followed by L2 and L3. For example - Clothing(L1) >> Shirts(L2) >> Formal Shirts(L3) A single L1 category can encompass multiple L2 categories underneath it, and similarly, an L2 category can contain multiple L3 categories within it. Category is a sales-channel specific configuration. While categories are common across all companies, sales channel can configure L3 category names tailored to their unique requirements.
Operations
GET
# List categories
GET
# Get category by uid
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
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)
It is the mapping of the category in different marketplaces.
CategoryMapping
ajio
object (CategoryMappingValues)
It is the category id mapping for ajio platform.
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)
It is the category id mapping for facebook platform.
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)
It is the category id mapping for google platform.
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)
It is the details of the media such as banner and logo..
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.
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.
Examples
Parameters
company_id:
"value"
level:
"value"
department:
1
q:
"value"
page_no:
1
page_size:
1
uids:
0,1
slug:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List categories
listCategories
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
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)
It is the mapping of the category in different marketplaces.
CategoryMapping
ajio
object (CategoryMappingValues)
It is the category id mapping for ajio platform.
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)
It is the category id mapping for facebook platform.
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)
It is the category id mapping for google platform.
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)
It is the details of the media such as banner and logo..
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.
Examples
Parameters
company_id:
"value"
uid:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get category by uid
getCategoryData
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
GET
# Get department by uid
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
created_by
object (RequestUserSerializer)
RequestUserSerializer
_id
string
contact
string
uid
string
user_id
string
username
string
created_on
string
| date-time
is_active
boolean
item_type
string
logo
string
| url
modified_by
object (RequestUserSerializer)
RequestUserSerializer
_id
string
contact
string
uid
string
user_id
string
username
string
modified_on
string
| date-time
name
string
page_no
integer
Default Value : 1
page_size
integer
Default Value : 20
priority_order
integer
search
string
slug
string
synonyms
array of string
uid
integer
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
Examples
Parameters
company_id:
"value"
page_no:
1
item_type:
"value"
page_size:
1
name:
"value"
search:
"value"
is_active:
false
slug:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List company department
listDepartmentsData
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
created_by
object (RequestUserSerializer)
RequestUserSerializer
_id
string
contact
string
uid
string
user_id
string
username
string
created_on
string
| date-time
is_active
boolean
item_type
string
logo
string
| url
modified_by
object (RequestUserSerializer)
RequestUserSerializer
_id
string
contact
string
uid
string
user_id
string
username
string
modified_on
string
| date-time
name
string
page_no
integer
Default Value : 1
page_size
integer
Default Value : 20
priority_order
integer
search
string
slug
string
synonyms
array of string
uid
integer
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
Examples
Parameters
company_id:
"value"
uid:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
Get department by uid
getDepartmentData
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
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
brand
object (InventoryBrandMeta)
InventoryBrandMeta
id
integer
name
string
company
object (InventoryCompanyMeta)
InventoryCompanyMeta
id
integer
country_of_origin
string
created_by
object (RequestUserSerializer)
RequestUserSerializer
_id
string
contact
string
uid
string
user_id
string
username
string
date_meta
object (DateMeta)
DateMeta
added_on_store
string
| date-time
created_on
string
| date-time
inventory_updated_on
string
| date-time
modified_on
string
| date-time
dimension
object (InventoryDimensionResponse)
InventoryDimensionResponse
height
number
length
number
unit
string
width
number
expiration_date
string
| date-time
id
string
identifier
object
inventory_updated_on
string
| date-time
is_set
boolean
item_id
integer
manufacturer
object (InventoryManufacturerResponse)
InventoryManufacturerResponse
address
string
is_default
boolean
name
string
modified_by
object (RequestUserSerializer)
RequestUserSerializer
_id
string
contact
string
uid
string
user_id
string
username
string
platforms
object
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
updated_at
string
| date-time
not_available
object (Quantity)
Quantity
count
integer
updated_at
string
| date-time
order_committed
object (Quantity)
Quantity
count
integer
updated_at
string
| date-time
sellable
object (Quantity)
Quantity
count
integer
updated_at
string
| date-time
return_config
object (ReturnConfig)
ReturnConfig
returnable
boolean
time
integer
| value >= 0
unit
string
Enum
seller_identifier
string
size
string
stage
string
store
object (ArticleStoreResponse)
ArticleStoreResponse
name
string
store_code
string
store_type
string
uid
integer
tags
array of string
tax_identifier
object
total_quantity
integer
| value >= 0
trace_id
string
track_inventory
boolean
trader
array of object (TraderResponse)
Array of TraderResponse
address
array of string
name
string
type
string
Enum
uid
string
weight
object (InventoryWeightResponse)
InventoryWeightResponse
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.
Examples
Parameters
company_id:
"value"
item_id:
"value"
size:
"value"
page_no:
1
page_size:
1
page_id:
"value"
page_type:
"value"
q:
"value"
sellable:
false
store_ids:
0,1
brand_ids:
0,1
seller_identifiers:
"lorem","ipsum"
qty_gt:
1
qty_lt:
1
qty_type:
"value"
from_date:
"value"
to_date:
"value"
size_identifier:
"value"
Was this section helpful?
GET
Loading...
Response
Loading...
List Inventory
getInventories
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
company_id:
1
Was this section helpful?
GET
Loading...
Response
Loading...
List product tags
getProductTags
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
_custom_json
object
Custom JSON data for the article.
added_on_store
string
| date-time
The date and time when the article was added to the store.
brand
object (BrandMeta)
The metadata of the brand.
BrandMeta
id
integer
name
string
company
object (CompanyMeta)
The metadata of the company.
CompanyMeta
id
integer
country_of_origin
string
The country of origin of the article.
created_by
object (RequestUserSerializer)
Nullable
The user who created the article.
RequestUserSerializer
_id
string
contact
string
uid
string
user_id
string
username
string
dimension
object (DimensionResponse)
The dimensions of the article.
DimensionResponse
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 (ManufacturerResponse)
The manufacturer of the article.
ManufacturerResponse
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 (RequestUserSerializer)
Nullable
The user who modified the article.
RequestUserSerializer
_id
string
contact
string
uid
string
user_id
string
username
string
price
object (PriceMeta)
The price metadata of the article.
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 (ReturnConfig1)
The return configuration of the article.
ReturnConfig1
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
quantity
integer
size_distribution
object (SizeDistribution)
SizeDistribution
sizes
array of object (SetSize)
Array of SetSize
pieces
integer
| value >= 1
| value <= 100
size
string
size
string
The size of the article.
stage
string
The stage of the article.
store
object (StoreMeta)
The metadata of the store.
StoreMeta
id
integer
tags
array of string
Nullable
The tags associated with the article.
tax_identifier
object
The tax identifier of the article.
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 (WeightResponse)
The weight of the article.
WeightResponse
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.
Examples
Parameters
company_id:
1
item_id:
1
size_identifier:
"value"
page_no:
1
page_size:
1
q:
"value"
location_ids:
0,1
Was this section helpful?
GET
Loading...
Response
Loading...
List inventory by size
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
4XX
Product object. See example below for details
ProductListingResponse
items
array of object (Product)
Array of Product
_custom_json
object
all_company_ids
array of integer
all_identifiers
array of string
all_sizes
array of object
attributes
object
brand
object (Brand)
Brand
logo
object (Logo)
Logo
aspect_ratio
string
aspect_ratio_f
integer
secure_url
string
url
string
name
string
uid
integer
brand_uid
integer
category
object
category_slug
string
category_uid
integer
color
string
company_id
integer
country_of_origin
string
created_by
object
created_on
string
| date-time
currency
string
custom_order
object
departments
array of integer
description
string
highlights
array of string
hsn_code
string
id
string
image_nature
string
images
array of object (Image)
Array of Image
aspect_ratio
string
aspect_ratio_f
number
secure_url
string
url
string
is_active
boolean
is_dependent
boolean
is_expirable
boolean
is_image_less_product
boolean
is_physical
boolean
is_set
boolean
item_code
string
item_type
string
l3_mapping
array of string
media
array of object (Media)
Array of Media
meta
object
type
string
url
string
modified_by
object
modified_on
string
| date-time
moq
object
multi_size
boolean
name
string
net_quantity
object (NetQuantityResponse)
NetQuantityResponse
unit
string
value
number
no_of_boxes
integer
pending
string
primary_color
string
product_group_tag
array of string
product_publish
object (ProductPublished)
ProductPublished
is_set
boolean
product_online_date
integer
return_config
object (ReturnConfigResponse)
ReturnConfigResponse
returnable
boolean
time
integer
unit
string
short_description
string
size_guide
string
sizes
array of object
slug
string
stage
string
tags
array of string
tax_identifier
object
teaser_tag
object
template_tag
string
trader
array of object (Trader)
Array of Trader
address
array of string
name
string
type
string
Enum
uid
integer
variant_group
object
variant_media
object
variants
object
verified_by
object (VerifiedBy)
VerifiedBy
user_id
string
username
string
verified_on
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.
Examples
Parameters
item_code:
"value"
company_id:
1
item_id:
1
brand_uid:
1
uid:
1
Was this section helpful?
GET
Loading...
Response
Loading...
List product size
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
4XX
Returns a success response
ProductSizeDeleteResponse
data
object (ProductSizeDeleteDataResponse)
ProductSizeDeleteDataResponse
company_id
integer
item_id
integer
size
string
success
boolean
Examples
Parameters
company_id:
1
item_id:
1
size:
"value"
Was this section helpful?
DEL
Loading...
Response
Loading...
Delete product size
deleteSize
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
currency
string
identifiers
object
inventory_updated_on
string
item_id
integer
price
number
price_effective
number
price_transfer
number
quantity
integer
sellable_quantity
integer
seller_identifier
string
size
string
store
object
uid
string
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
Examples
Parameters
company_id:
1
item_id:
1
size:
"value"
page_no:
1
page_size:
1
q:
"value"
sellable:
false
Was this section helpful?
GET
Loading...
Response
Loading...
List inventory by size
getInventoryBySize
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
brand_uid
integer
item_code
string
uid
integer
sizes
array of object (InvSize)
Required
Array of InvSize
currency
string
Required
The currency used for the item price.
expiration_date
string
| date-time
identifiers
array of object (GTIN)
Required
Array of GTIN
gtin_type
string
Required
Enum
gtin_value
string
Required
primary
boolean
Default Value : false
is_set
boolean
item_dimensions_unit_of_measure
string
Nullable
The unit of measure for the item dimensions.
item_height
number
| value >= 0.1
Nullable
The height of the item.
item_length
number
| value >= 0.1
Nullable
The length of the item.
item_weight
number
| value >= 0.1
Nullable
The weight of the item.
item_weight_unit_of_measure
string
Nullable
The unit of measure for the item weight.
item_width
number
| value >= 0.1
Nullable
The width of the item.
price
number
| value >= 0
price_effective
number
| value >= 0
Required
price_transfer
number
Nullable
quantity
integer
| value >= 0
Required
set
object (InventorySet)
InventorySet
name
string
quantity
integer
size_distribution
object (SizeDistribution)
Required
SizeDistribution
sizes
array of object (SetSize)
Required
Array of SetSize
pieces
integer
| value >= 1
| value <= 100
Required
size
string
Required
size
string
Required
store_code
string
Required
Response
200
4XX
Returns a success response
SuccessResponse
success
boolean
Examples
Parameters
company_id:
1
item_id:
1
size:
"value"
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Create Inventory
addInventory
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
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.
variants
array of object (ProductVariants)
Array of ProductVariants
brand_uid
integer
category_uid
integer
item_code
string
media
array of object (Media)
Array of Media
meta
object
type
string
url
string
name
string
uid
integer
Examples
Parameters
company_id:
1
item_id:
1
variant_type:
"value"
page_no:
1
page_size:
1
Was this section helpful?
GET
Loading...
Response
Loading...
Get variants
getVariantsOfProducts
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
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
cess
number
effective_date
string
| date-time
rate
number
Enum
threshold
number
type
string
Type of HSN data (goods or services).
Enum
page
object (PageResponse)
PageResponse
current
string
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:
"value"
type:
"value"
company_id:
1
Was this section helpful?
GET
Loading...
Response
Loading...
List 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
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
cess
number
effective_date
string
| date-time
rate
number
Enum
threshold
number
type
string
Type of HSN data (goods or services).
Enum
Examples
Parameters
reporting_hsn:
"value"
company_id:
1
Was this section helpful?
GET
Loading...
Response
Loading...
Get product HSN code
getSingleProductHSNCode
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
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.
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
InventoryUpdateResponse
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.
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.
message
string
It is the success message of the inventory update.
Examples
Parameters
company_id:
1
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
Update inventories
updateInventories
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
cancelled_by
object (UserDetail)
This is the user detail of the user who cancelled the job.
UserDetail
contact
string
The contact details of the user.
super_user
boolean
A flag indicating whether the user is a super user.
user_id
string
The user ID of the user.
username
string
The username of the user.
cancelled_on
string
| date-time
This is the timestamp of the cacellation for this job.
completed_on
string
| date-time
This is the timestamp of the completion for this job.
created_by
object (UserDetail)
This is the user detail of the user who cancelled the job.
UserDetail
contact
string
The contact details of the user.
super_user
boolean
A flag indicating whether the user is a super user.
user_id
string
The user ID of the user.
username
string
The username of the user.
created_on
string
| date-time
This is the timestamp of the creation for this job.
filters
object (InventoryJobFilters)
This is the filter criteria applied for the export job.
InventoryJobFilters
brands
array of string
The list of all the brands selected.
Default Value :
from_date
string
| date-time
The modified on date from which the data needs to be exported.
quantity
object (InventoryExportQuantityFilter)
The quantity range that needs to be exported.
InventoryExportQuantityFilter
max
integer
The maximum quantity that needs to be exported.
min
integer
The minimum quantity that needs to be exported.
operators
string
Condition for the quantity that needs to be exported.
Enum
stores
array of string
The list of all the store selected.
Default Value :
to_date
string
| date-time
The modified on date till when the data needs to be exported.
id
string
This is the ID of the job.
modified_on
string
| date-time
This is the timestamp of the modification for this job.
notification_emails
array of string
User email to get notification post completion of the job.
Default Value :
seller_id
integer
This ID of the company.
status
string
This tells you the current status of the export job.
Enum
task_id
string
This is the task id of the jobs that is used for search.
type
string
Nullable
This is the file type of the export.
Default Value : csv
Enum
url
string
| url
This is the url to download the export.
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.
Examples
Parameters
company_id:
1
status:
"value"
from_date:
"value"
to_date:
"value"
q:
"value"
page_no:
1
page_size:
1
Was this section helpful?
GET
Loading...
Response
Loading...
List inventory export jobs
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
This filters that are applied for the export of the inventory.
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)
The quantity range that needs to be exported.
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
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
company_id:
1
body:
body
Was this section helpful?
POST
Loading...
Response
Loading...
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
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
_custom_json
object
all_company_ids
array of integer
all_identifiers
array of string
all_sizes
array of object
attributes
object
brand
object (Brand)
Brand
logo
object (Logo)
Logo
aspect_ratio
string
aspect_ratio_f
integer
secure_url
string
url
string
name
string
uid
integer
brand_uid
integer
category
object
category_slug
string
category_uid
integer
color
string
company_id
integer
country_of_origin
string
created_by
object
created_on
string
| date-time
currency
string
custom_order
object
departments
array of integer
description
string
highlights
array of string
hsn_code
string
id
string
image_nature
string
images
array of object (Image)
Array of Image
aspect_ratio
string
aspect_ratio_f
number
secure_url
string
url
string
is_active
boolean
is_dependent
boolean
is_expirable
boolean
is_image_less_product
boolean
is_physical
boolean
is_set
boolean
item_code
string
item_type
string
l3_mapping
array of string
media
array of object (Media)
Array of Media
meta
object
type
string
url
string
modified_by
object
modified_on
string
| date-time
moq
object
multi_size
boolean
name
string
net_quantity
object (NetQuantityResponse)
NetQuantityResponse
unit
string
value
number