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
/service/platform/catalog/v1.0/company/{company_id}/category/
# List categories
GET
/service/platform/catalog/v1.0/company/{company_id}/category/{uid}/
# Get category by uid
GET

List categories

Retrieve a list of categories data associated to a specific company and queries passed in the request.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
level
string
Get category for multiple levels
department
integer
Get category for multiple departments filtered
q
string
Get multiple categories filtered by search string
page_no
integer
The page number to navigate through the given set of results
page_size
integer
Number of items to retrieve in each page. Default is 10.
Default Value : 12
uids
array of integer
Get multiple categories filtered by category uids.
Maximum Items : 100
slug
string
Get category by slug
Response
200
Category Meta.
CategoryResponseSchema
items
array of object (Category)
The list of categories.
Array of Category
created_by
object
It is the details of the user who created the category.
created_on
string
| date-time
It is Date and time when the category was created.
departments
array of integer
It is the list of unique department the category belongs to.
hierarchy
array of object (Hierarchy)
It is the list of category hierarchies for each department of an L3 category.
Array of Hierarchy
department
integer
It is the unique identifier of the department the category is mapped to.
l1
integer
It is the unique id of the L1 category mapped to the L3 category.
l2
integer
It is the unique id of the L2 category mapped to the L3 category.
id
string
It is the unique identifier of the category.
is_active
boolean
It is the flag indicating if the category is active.
level
integer
It is the level of category
marketplaces
object (CategoryMapping)
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:
24
level:
"24"
department:
146
q:
"Emmanuelle1153977215920241148294"
page_no:
1
page_size:
10
uids:
1,2,3
slug:
"emmanuelle1153977215920241148294"
GET
/service/platform/catalog/v1.0/company/{company_id}/category/
Loading...
Response
Loading...
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
Get Data for one category.
SingleCategoryResponseSchema
data
object (Category)
Category
created_by
object
It is the details of the user who created the category.
created_on
string
| date-time
It is Date and time when the category was created.
departments
array of integer
It is the list of unique department the category belongs to.
hierarchy
array of object (Hierarchy)
It is the list of category hierarchies for each department of an L3 category.
Array of Hierarchy
department
integer
It is the unique identifier of the department the category is mapped to.
l1
integer
It is the unique id of the L1 category mapped to the L3 category.
l2
integer
It is the unique id of the L2 category mapped to the L3 category.
id
string
It is the unique identifier of the category.
is_active
boolean
It is the flag indicating if the category is active.
level
integer
It is the level of category
marketplaces
object (CategoryMapping)
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:
"1"
uid:
"430093"
GET
/service/platform/catalog/v1.0/company/{company_id}/category/{uid}/
Loading...
Response
Loading...

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
/service/platform/catalog/v1.0/company/{company_id}/departments/
# List company department
GET
/service/platform/catalog/v1.0/company/{company_id}/departments/{uid}/
# Get department by uid
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
Enum
page_size
integer
Number of items to retrieve in each page. Default is 10.
name
string
Can search departments by passing name.
search
string
Can search departments by passing name of the department in search parameter.
is_active
boolean
Can query for departments based on whether they are active or inactive.
slug
string
Can filter by slug
Response
200
List of departments data.
DepartmentsResponseSchema
items
array of object (GetDepartment)
List of department objects.
Array of GetDepartment
created_by
object (RequestUserSchema)
RequestUserSchema
_id
string
contact
string
uid
string
user_id
string
username
string
created_on
string
| date-time
Timestamp of when the department was created.
is_active
boolean
Indicates whether the department is currently active.
item_type
string
Enum
logo
string
| url
URL of the department's logo.
modified_by
object (RequestUserSchema)
RequestUserSchema
_id
string
contact
string
uid
string
user_id
string
username
string
modified_on
string
| date-time
Timestamp of when the department was last modified.
id
string
Alternate unique identifier for the department.
name
string
Name of the department.
slug
string
URL-friendly slug for the department.
synonyms
array of string
List of alternative names for the department.
priority_order
integer
The priority order of the department for display purposes.
uid
integer
Unique identifier for the department within the system.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
Examples
Parameters
company_id:
"1"
page_no:
1
item_type:
"standard"
page_size:
1
name:
"Fashion"
search:
"Fashion"
slug:
"Fashion"
GET
/service/platform/catalog/v1.0/company/{company_id}/departments/
Loading...
Response
Loading...
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
Departments Data.
DepartmentsResponseSchema
items
array of object (GetDepartment)
List of department objects.
Array of GetDepartment
created_by
object (RequestUserSchema)
RequestUserSchema
_id
string
contact
string
uid
string
user_id
string
username
string
created_on
string
| date-time
Timestamp of when the department was created.
is_active
boolean
Indicates whether the department is currently active.
item_type
string
Enum
logo
string
| url
URL of the department's logo.
modified_by
object (RequestUserSchema)
RequestUserSchema
_id
string
contact
string
uid
string
user_id
string
username
string
modified_on
string
| date-time
Timestamp of when the department was last modified.
id
string
Alternate unique identifier for the department.
name
string
Name of the department.
slug
string
URL-friendly slug for the department.
synonyms
array of string
List of alternative names for the department.
priority_order
integer
The priority order of the department for display purposes.
uid
integer
Unique identifier for the department within the system.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
Examples
Parameters
company_id:
"1"
uid:
"4"
GET
/service/platform/catalog/v1.0/company/{company_id}/departments/{uid}/
Loading...
Response
Loading...

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
/service/platform/catalog/v1.0/company/{company_id}/inventories
# List Inventory
GET
/service/platform/catalog/v1.0/company/{company_id}/products/tags
# List product tags
GET
/service/platform/catalog/v1.0/company/{company_id}/products/{item_id}/inventory/{size_identifier}
# List inventory by size
GET
/service/platform/catalog/v1.0/company/{company_id}/products/{item_id}/sizes/
# List product size
DEL
/service/platform/catalog/v1.0/company/{company_id}/products/{item_id}/sizes/{size}
# Delete product size
GET
/service/platform/catalog/v1.0/company/{company_id}/products/{item_id}/sizes/{size}
# List inventory by size
POST
/service/platform/catalog/v1.0/company/{company_id}/products/{item_id}/sizes/{size}
# Create Inventory
GET
/service/platform/catalog/v1.0/company/{company_id}/products/{item_id}/variants/{variant_type}
# Get variants
GET
/service/platform/catalog/v2.0/company/{company_id}/hsn/
# List product HSN codes
GET
/service/platform/catalog/v2.0/company/{company_id}/hsn/{reporting_hsn}
# Get product HSN code
POST
/service/platform/catalog/v2.0/company/{company_id}/inventory/
# Update inventories
GET
/service/platform/catalog/v2.0/company/{company_id}/inventory/download/
# List inventory export jobs
POST
/service/platform/catalog/v2.0/company/{company_id}/inventory/download/
# Create inventory export
GET
/service/platform/catalog/v2.0/company/{company_id}/products/
# List products
POST
/service/platform/catalog/v2.0/company/{company_id}/products/
# Create product
POST
/service/platform/catalog/v2.0/company/{company_id}/products/bulk
# Upload bulk products
DEL
/service/platform/catalog/v2.0/company/{company_id}/products/{item_id}/
# Delete product
GET
/service/platform/catalog/v2.0/company/{company_id}/products/{item_id}/
# Get a product
PUT
/service/platform/catalog/v2.0/company/{company_id}/products/{item_id}/
# Update a product
DEL
/service/platform/catalog/v2.0/company/{company_id}/products/{item_id}/inventory/{seller_identifier}
# Delete an inventory
POST
/service/platform/catalog/v2.0/company/{company_id}/products/{item_id}/inventory/{seller_identifier}
# Update an inventory
POST
/service/platform/catalog/v1.0/company/{company_id}/store/{store_id}/identifier/{seller_identifier}/price
# Update an Article Price
POST
/service/platform/catalog/v1.0/company/{company_id}/store/{store_id}/identifier/{seller_identifier}/quantity
# Update an Article Quantity
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
Enum
q
string
Search with help of store code.
sellable
boolean
Filter on whether product is in stock or not.
Default Value : false
store_ids
array of integer
The Store Id of products to fetch inventory.
brand_ids
array of integer
The Brand Id of products to fetch inventory.
seller_identifiers
array of string
The Seller Identifier or Primary Identifier of the inventory.
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
returns a list of all inventory grouped by size and store
GetInventoriesResponseSchema
items
array of object (GetInventories)
List of product inventories.
Array of GetInventories
brand
object (InventoryBrandMeta)
InventoryBrandMeta
id
integer
Unique identifier for the brand in the inventory.
name
string
Name of the brand in the inventory.
company
object (InventoryCompanyMeta)
InventoryCompanyMeta
id
integer
country_of_origin
string
Country where the product was manufactured.
created_by
object (RequestUserSchema)
RequestUserSchema
_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 (InventoryDimensionResponseSchema)
InventoryDimensionResponseSchema
height
number
length
number
unit
string
width
number
expiration_date
string
| date-time
Expiration date of the product.
id
string
Unique identifier of the product.
identifier
object (Identifier)
Identifier
primary
boolean
Indicates if this is the primary identifier for the size.
gtin_value
string
The GTIN (Global Trade Item Number) value for the size.
gtin_type
string
The type of GTIN (e.g., SKU code, UPC, EAN).
inventory_updated_on
string
| date-time
The last date when inventory information was updated.
is_set
boolean
Indicates if the product is sold as a set.
item_id
integer
Unique item ID for the product.
manufacturer
object (InventoryManufacturerResponseSchema)
InventoryManufacturerResponseSchema
address
string
is_default
boolean
name
string
modified_by
object (RequestUserSchema)
RequestUserSchema
_id
string
contact
string
uid
string
user_id
string
username
string
platforms
object
Indicates platform availability status for the product.
price
object (PriceArticle)
PriceArticle
currency
string
effective
number
marked
number
tp_notes
object
transfer
number
quantities
object (QuantitiesArticle)
QuantitiesArticle
damaged
object (Quantity)
Quantity
count
integer
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
Seller’s identifier for the product.
size
string
Size of the product.
stage
string
Current stage of the product, such as verified or pending.
store
object (ArticleStoreResponseSchema)
ArticleStoreResponseSchema
name
string
store_code
string
store_type
string
Enum
uid
integer
tags
array of string
Tags associated with the product.
tax_identifier
object (TaxIdentifier)
TaxIdentifier
hsn_code
string
hsn_code_id
string
reporting_hsn
string
total_quantity
integer
| value >= 0
Total available quantity of the product.
trace_id
string
Trace ID for inventory management.
track_inventory
boolean
Indicates if the inventory is being tracked.
trader
array of object (TraderResponseSchema)
Information about traders, such as manufacturers or importers.
Array of TraderResponseSchema
address
array of string
name
string
type
string
Enum
uid
string
Unique identifier for the product.
weight
object (InventoryWeightResponseSchema)
InventoryWeightResponseSchema
shipping
number
unit
string
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
Examples
Parameters
company_id:
"1"
item_id:
"10768717"
size:
"OS"
page_no:
1
page_size:
2
page_id:
"2"
page_type:
"cursor"
q:
"spykar_l1"
sellable:
true
store_ids:
3243452
brand_ids:
3243452
seller_identifiers:
"3243452"
qty_gt:
100
qty_lt:
100
qty_type:
"total"
from_date:
"2024-10-16T01:45:30.764000"
to_date:
"2024-10-16T01:45:30.764000"
size_identifier:
"asdadasa"
GET
/service/platform/catalog/v1.0/company/{company_id}/inventories
Loading...
Response
Loading...
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
Tag List.
ProductTagsViewResponseSchema
items
array of string
An array of product tag strings representing various tags associated with the products.
Examples
Parameters
company_id:
1
GET
/service/platform/catalog/v1.0/company/{company_id}/products/tags
Loading...
Response
Loading...
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
returns a list of all inventory grouped by size and store
InventorySellerIdentifierResponsePaginated
items
array of object (InventorySellerResponseSchema)
Array of InventorySellerResponseSchema
_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
Unique identifier for the brand.
name
string
Name of the brand.
company
object (CompanyMeta)
The metadata of the company.
CompanyMeta
id
integer
Unique identifier for the company.
country_of_origin
string
The country of origin of the article.
created_by
object (RequestUserSchema)
Nullable
The user who created the article.
RequestUserSchema
_id
string
contact
string
uid
string
user_id
string
username
string
dimension
object (DimensionResponseSchema)
The dimensions of the article.
DimensionResponseSchema
height
number
The height dimension.
is_default
boolean
Indicates if it is the default dimension.
length
number
The length dimension.
unit
string
The unit of dimension.
width
number
The width dimension.
expiration_date
string
| date-time
The expiration date of the article.
fragile
boolean
Indicates if the article is fragile.
fynd_article_code
string
The Fynd article code.
fynd_item_code
string
The Fynd item code.
fynd_meta
object
The Fynd metadata of the article.
identifier
object
The identifier of the article.
is_active
boolean
Indicates if the article is active.
Default Value : true
is_set
boolean
item_id
integer
The ID of the item.
manufacturer
object (ManufacturerResponseSchema)
The manufacturer of the article.
ManufacturerResponseSchema
address
string
The address of the manufacturer.
is_default
boolean
Indicates if it is the default manufacturer.
name
string
The name of the manufacturer.
meta
object
Nullable
Additional metadata for the article.
modified_by
object (RequestUserSchema)
Nullable
The user who modified the article.
RequestUserSchema
_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 (InventoryReturnConfig)
InventoryReturnConfig
returnable
boolean
Indicates if the item is returnable.
Default Value : false
time
integer
| value >= 0
The return time in days or hours.
unit
string
The unit of return time.
Enum
seller_identifier
string
The seller identifier of the article.
set
object (InventorySet)
InventorySet
name
string
The name of the inventory set.
quantity
integer
The quantity of items available in the inventory set.
size_distribution
object (SizeDistribution)
SizeDistribution
sizes
array of object (SetSize)
Array of SetSize
pieces
integer
| value >= 1
| value <= 100
Number of pieces in the set.
size
string
Size of the item in the set.
size
string
The size of the article.
stage
string
The stage of the article.
store
object (StoreMeta)
The metadata of the store.
StoreMeta
id
integer
The unique identifier of the store.
tags
array of string
Nullable
The tags associated with the article.
tax_identifier
object (TaxIdentifier)
TaxIdentifier
hsn_code
string
hsn_code_id
string
reporting_hsn
string
total_quantity
integer
| value >= 0
The total quantity of the article.
trace_id
string
The trace ID of the article.
track_inventory
boolean
Indicates if the inventory is tracked for the article.
Default Value : true
trader
array of object (Trader)
Nullable
The traders associated with the article.
Array of Trader
address
array of string
List of addresses associated with the trader.
name
string
The name of the trader.
Minimum Length : 1
Maximum Length : 300
type
string
The role or type of the trader.
Enum
uid
string
The unique identifier of the article.
weight
object (WeightResponseSchema)
The weight of the article.
WeightResponseSchema
is_default
boolean
Indicates if it is the default weight.
shipping
number
The shipping weight.
unit
string
The unit of weight.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
Examples
Parameters
item_id:
10989
size_identifier:
"5645463"
page_no:
1
page_size:
1
q:
"SJBTS"
location_ids:
1,2,3
GET
/service/platform/catalog/v1.0/company/{company_id}/products/{item_id}/inventory/{size_identifier}
Loading...
Response
Loading...
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
Product object.
ProductListingResponseSchema
items
array of object (Product)
Array of Product
_custom_json
object
A custom JSON object that can hold any additional key-value pairs specific to the product.
all_company_ids
array of integer
List of company IDs associated with the product.
all_identifiers
array of string
List of identifiers such as SKU, barcode, etc.
all_sizes
array of object
List of available sizes for the product.
attributes
object
Additional attributes of the product such as material, color, pattern, etc.
brand
object (Brand)
Brand
logo
object (Logo)
Logo
aspect_ratio
string
Aspect ratio of the logo image, typically expressed as a string (e.g., '16:9').
aspect_ratio_f
integer
Numeric representation of the aspect ratio for scaling purposes.
secure_url
string
Secure URL to the logo image.
url
string
URL to the logo image.
name
string
The name of the brand.
uid
integer
Unique identifier for the brand.
brand_uid
integer
Unique ID of the brand associated with the product.
category
object
Details about the category the product belongs to.
category_slug
string
unique slug representing the category.
category_uid
integer
Unique ID of the product category.
color
string
Primary color of the product.
company_id
integer
ID of the company managing the product.
country_of_origin
string
The country where the product was manufactured.
created_by
object
Details of the user or entity that created the product.
created_on
string
| date-time
Timestamp indicating when the product was created.
currency
string
The currency used for pricing the product.
custom_order
object
Information related to custom orders, including lead time and production details.
departments
array of integer
List of department IDs related to the product.
description
string
Full description of the product.
highlights
array of string
List of key highlights of the product.
hsn_code
string
HSN (Harmonized System Nomenclature) code for tax classification.
id
string
Unique identifier for the product in the system.
image_nature
string
Nature of the product image, for example, 'standard' or 'custom'.
images
array of object (Image)
List of images associated with the product.
Array of Image
aspect_ratio
string
aspect_ratio_f
number
secure_url
string
url
string
is_active
boolean
Indicates whether the product is currently active or not.
is_dependent
boolean
Indicates whether the product depends on other products for its availability or configuration.
is_expirable
boolean
Indicates if the product has an expiration date.
is_image_less_product
boolean
Indicates if the product does not have an image associated.
is_physical
boolean
Specifies if the product is a physical item.
is_set
boolean
Indicates if the product is part of a set.
item_code
string
item_type
string
Enum
l3_mapping
array of string
List of category mappings for the product (level 3 categories).
media
array of object (Media)
Media objects associated with the product, such as videos or additional images.
Array of Media
meta
object
A metadata object containing additional information about the media, such as dimensions, format, or other relevant details.
type
string
The type of media.
Enum
url
string
The URL where the media can be accessed.
alt
string
The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed.
thumbnail
string
The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media.
modified_by
object
Details of the user or entity that last modified the product.
modified_on
string
| date-time
Timestamp indicating the last time the product was modified.
moq
object
Minimum Order Quantity (MOQ) details for the product.
name
string
Name of the product.
net_quantity
object (NetQuantityResponseSchema)
NetQuantityResponseSchema
unit
string
The unit of measurement for the net quantity.
value
number
The actual quantity of the product in the specified unit.
no_of_boxes
integer
Number of boxes required to pack the product.
pending
string
Status indicating if there are pending actions or updates required for the product.
primary_color
string
Primary color of the product.
product_group_tag
array of string
Tags for grouping the product in categories.
product_publish
object (ProductPublished)
ProductPublished
is_set
boolean
Indicates whether the product is part of a set.
product_online_date
integer
Timestamp when the product is scheduled to go live online.
return_config
object (ReturnConfigResponseSchema)
ReturnConfigResponseSchema
returnable
boolean
Indicates if the product is eligible for return.
time
integer
The duration within which the product can be returned.
unit
string
The time unit for the return duration, e.g., 'days' or 'hours'.
short_description
string
A brief description of the product.
size_guide
string
Link or identifier for the product's size guide.
sizes
array of object
List of available sizes for the product along with pricing and identifier information.
slug
string
URL slug for the product page.
stage
string
The current stage of the product in the system workflow (e.g., pending, verified).
tags
array of string
Tags or keywords associated with the product for search and categorization.
tax_identifier
object (TaxIdentifier)
TaxIdentifier
hsn_code
string
hsn_code_id
string
reporting_hsn
string
teaser_tag
object
A short promotional tag or label for the product.
template_tag
string
Tag representing the template used for the product listing.
trader
array of object (Trader)
List of traders or sellers associated with the product.
Array of Trader
address
array of string
List of addresses associated with the trader.
name
string
The name of the trader.
Minimum Length : 1
Maximum Length : 300
type
string
The role or type of the trader.
Enum
uid
integer
Unique identifier for the product.
variant_group
object
Details about the product's variant grouping (e.g., color or size variants).
variant_media
object
Media associated with specific variants of the product.
variants
object
Details about the product's available variants.
verified_by
object (VerifiedBy)
VerifiedBy
user_id
string
The unique identifier of the user who verified the product.
username
string
The username of the user who verified the product.
verified_on
string
| date-time
Timestamp indicating when the product was verified.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
Examples
Parameters
item_code:
"12345"
company_id:
1
item_id:
7400023
brand_uid:
12345
uid:
12345
GET
/service/platform/catalog/v1.0/company/{company_id}/products/{item_id}/sizes/
Loading...
Response
Loading...
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
Returns a success response
ProductSizeDeleteResponseSchema
data
object (ProductSizeDeleteDataResponseSchema)
ProductSizeDeleteDataResponseSchema
company_id
integer
The unique identifier for the company that manages the product.
item_id
integer
The unique identifier for the specific item from which the size is being deleted.
size
string
The size being deleted from the product.
success
boolean
Indicates whether the size deletion operation was successful.
Examples
Parameters
company_id:
1
item_id:
12345
size:
"S"
DEL
/service/platform/catalog/v1.0/company/{company_id}/products/{item_id}/sizes/{size}
Loading...
Response
Loading...
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
returns a list of all inventory grouped by size and store
InventoryResponsePaginated
items
array of object (InventoryResponseSchema)
Array of InventoryResponseSchema
currency
string
The currency in which the item is priced, e.g., 'INR'.
identifiers
object
Object containing identifier details such as GTIN or SKU codes.
inventory_updated_on
string
| date-time
The date and time when the inventory was last updated, in ISO 8601 format.
item_id
integer
The unique identifier for the item in the inventory system.
price
number
The original price of the item.
price_effective
number
The effective price of the item after any discounts.
price_transfer
number
The transfer price for the item (if applicable).
quantity
integer
The total quantity of the item available in the inventory.
sellable_quantity
integer
The quantity of the item that is available for sale.
seller_identifier
string
An identifier for the seller, typically an SKU or unique code.
size
string
The size of the item, if applicable.
store
object
Object containing details about the store where the item is stocked.
uid
string
A unique identifier combining store ID and seller identifier.
created_by
object
Details of the user or entity that created the item record, including 'username' and 'user_id'.
modified_by
object
Details of the user or entity that last modified the item record, including 'username' and 'user_id'.
expiration_date
string
| date-time
The expiration date of the item, if applicable, in ISO 8601 format.
tags
array of string
An array of tags or labels associated with the item for categorization or search purposes.
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:
75000
size:
"S"
page_no:
1
page_size:
1
q:
"AC000T"
sellable:
true
GET
/service/platform/catalog/v1.0/company/{company_id}/products/{item_id}/sizes/{size}
Loading...
Response
Loading...
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 id 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
The name of the inventory set.
quantity
integer
The quantity of items available in the inventory set.
size_distribution
object (SizeDistribution)
Required
SizeDistribution
sizes
array of object (SetSize)
Required
Array of SetSize
pieces
integer
| value >= 1
| value <= 100
Required
Number of pieces in the set.
size
string
Required
Size of the item in the set.
size
string
Required
store_code
string
Required
Response
200
Returns a success response
SuccessResponseSchema
success
boolean
Examples
Parameters
company_id:
1
item_id:
750002
size:
"M"
body:
body
POST
/service/platform/catalog/v1.0/company/{company_id}/products/{item_id}/sizes/{size}
Loading...
Response
Loading...
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
Product Meta.
ProductVariantsResponseSchema
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
variants
array of object (ProductVariants)
A list of product variants returned in the response.
Array of ProductVariants
brand_uid
integer
Unique identifier for the brand associated with the product variant.
category_uid
integer
Unique identifier for the category to which the product variant belongs.
item_code
string
Code that uniquely identifies the specific product variant.
media
array of object (Media)
Array of media objects representing images, videos, or other media associated with the product variant.
Array of Media
meta
object
A metadata object containing additional information about the media, such as dimensions, format, or other relevant details.
type
string
The type of media.
Enum
url
string
The URL where the media can be accessed.
alt
string
The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed.
thumbnail
string
The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media.
name
string
Name of the product variant.
uid
integer
Unique identifier for the product variant.
Examples
Parameters
company_id:
1
item_id:
12345
variant_type:
"color"
page_no:
1
page_size:
2
GET
/service/platform/catalog/v1.0/company/{company_id}/products/{item_id}/variants/{variant_type}
Loading...
Response
Loading...
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
indicates current page number
Default Value : 1
page_size
integer
indicates 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
List of all HSN Codes.
HsnCodesListingResponseSchemaV2
items
array of object (HSNDataInsertV2)
Array of HSNDataInsertV2
country_code
string
Country code.
created_by
object (CreatedBySchema)
CreatedBySchema
user_id
string
The unique identifier for the user who created the resource.
username
string
The username of the user who created the resource.
modified_by
object (ModifiedBySchema)
ModifiedBySchema
user_id
string
The unique identifier for the user who last modified the resource.
username
string
The username of the user who last modified the resource.
created_on
string
| date-time
Date and time when the HSN data was created.
description
string
Description of the HSN data.
hsn_code
string
hsn_code_id
string
Unique identifier of the HSN code.
modified_on
string
| date-time
Date and time when the HSN data was last modified.
reporting_hsn
Undefined Type
HSN code.
id
string
Internal database identifier for the HSN data.
taxes
array of object (TaxSlab)
List of applicable tax slabs for the HSN data.
Array of TaxSlab
cess
number
Cess rate applicable for the tax slab.
effective_date
string
| date-time
The date from which the tax slab becomes effective.
rate
number
Applicable tax rate.