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
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
4XX
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"
Was this section helpful?
GET
Response
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.
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"
Was this section helpful?
GET
Response
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
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
4XX
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"
Was this section helpful?
GET
Response
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.
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"
Was this section helpful?
GET
Response
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
POST
# Update an Article Price
POST
# Update an Article Quantity
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
4XX
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"
Was this section helpful?
GET
Response
Parameters
company_id
integer
Required
Company Id for which tags to be fetched.
Response
200
4XX
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
Was this section helpful?
GET
Response
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 (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
Was this section helpful?
GET
Response
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.
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
Was this section helpful?
GET
Response
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
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"
Was this section helpful?
DEL
Response
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 (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
Was this section helpful?
GET
Response
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
4XX
Returns a success response
SuccessResponseSchema
success
boolean
Examples
Parameters
company_id:
1
item_id:
750002
size:
"M"
body:
body
Was this section helpful?
POST
Response
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.
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
Was this section helpful?
GET
Response
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
4XX
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.
Enum
threshold
number
Threshold value above which the tax slab applies.
type
string
Type of HSN data (goods or services).
Enum
page
object (PageResponseSchema)
PageResponseSchema
current
integer
It is the current page of the page response schema.
has_next
boolean
It is the bool indicates if there is a next page.
has_previous
boolean
It is the bool indicates if there is a previous page.
item_total
integer
It is the total number of item present for the filter.
size
integer
It is the size of each page.
Examples
Parameters
page_no:
1
page_size:
1
q:
"0920247825"
type:
"goods"
company_id:
1
Was this section helpful?
GET
Response
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 `HSNDataInsertV2` for details
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
object
HSN code.
id
string
Internal database identifier for the HSN data.
taxes
array of object (TaxSlab)
List of applicable tax slabs for the HSN data.
Array of TaxSlab
cess
number
Cess rate applicable for the tax slab.
effective_date
string
| date-time
The date from which the tax slab becomes effective.
rate
number
Applicable tax rate.
Enum
threshold
number
Threshold value above which the tax slab applies.
type
string
Type of HSN data (goods or services).
Enum
Examples
Parameters
reporting_hsn:
"0202310102H1"
company_id:
1
Was this section helpful?
GET
Response
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.
Response
200
400
Returns a success or partial success response
InventoryUpdateResponseSchema
items
array of object (InventoryResponseItem)
Array of InventoryResponseItem
data
object (InventoryPayload)
InventoryPayload
expiration_date
string
| date-time
The expiration date of the inventory item.
price_effective
number
The effective price of the inventory item.
price_marked
number
The marked price of the inventory item.
seller_identifier
string
The identifier of the seller.
Pattern : ^[A-Za-z0-9-_@,#\(\)\.\+\/ ]+$
store_id
integer
The ID of the store.
tags
array of string
Nullable
The tags associated with the inventory item.
total_quantity
integer
Nullable
The total quantity of the inventory item.
trace_id
string
The trace ID of the inventory payload.
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.
success
boolean
It is the success status of the inventory update.
Examples
Parameters
company_id:
1
body:
body
Was this section helpful?
POST
Response
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.(Pending, Running, Success)
from_date
string
| date
Inventory export history filtered according to from_date.
to_date
string
| date
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
InventoryExportJobListResponseSchema
items
object (InventoryJobDetailResponseSchema)
This is the list/history of all the jobs.
InventoryJobDetailResponseSchema
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
stats
object
Provides count of total/success/failed
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:
"Pending"
from_date:
"2023-01-11T00:00:00.000Z"
to_date:
"2023-01-11T00:00:00.000Z"
q:
"120304f4-7d3e-11ee-a705-d6fb21611540"
page_no:
1
page_size:
1
Was this section helpful?
GET
Response
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
InventoryExportResponseSchema
created_by
string
| date-time
The user that created the job.
created_on
string
| date-time
Creation datetime of the job
filters
object (Filters)
Filters
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 stores selected.
Default Value :
to_date
string
| date-time
The modified-on date till when the data needs to be exported.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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
Response
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
Enum
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.
ProductListingResponseV2
items
array of object (ProductSchemaV2)
Array of ProductSchemaV2
_custom_json
object
Custom JSON data specific to the product, used for storing additional information.
all_company_ids
array of integer
List of company IDs associated with the product.
all_identifiers
array of string
List of unique product identifiers such as SKU codes or GTINs.
all_sizes
array of object
Details of all available sizes for the product, including pricing and inventory information.
attributes
object
Additional attributes specific to the product.
brand
object (Brand)
Brand
logo
object (Logo)
Logo
aspect_ratio
string
Aspect ratio of the logo image, typically expressed as a string (e.g., '16:9').
aspect_ratio_f
integer
Numeric representation of the aspect ratio for scaling purposes.
secure_url
string
Secure URL to the logo image.
url
string
URL to the logo image.
name
string
The name of the brand.
uid
integer
Unique identifier for the brand.
brand_uid
integer
Unique identifier for the brand.
category
object
Object representing the category to which the product belongs.
category_slug
string
Slug representation of the product category for SEO purposes.
category_uid
integer
Unique identifier for the product category.
color
string
Primary color of the product.
company_id
integer
Identifier for the company managing the product.
country_of_origin
string
Country where the product was manufactured or sourced.
created_by
object
Object containing details about the user who created the product.
currency
string
The currency in which the product is priced (e.g., "INR").
custom_order
object
Information about custom order options for the product, including manufacturing time.
departments
array of integer
List of department IDs associated with the product.
description
string
Long description of the product.
highlights
array of string
Key features or highlights of the product.
hsn_code
string
Harmonized System Nomenclature (HSN) code for taxation purposes.
id
string
Unique identifier of the product in the database.
image_nature
string
Describes the nature of the product images (e.g., "standard").
images
array of object (Image)
List of image URLs associated with the product.
Array of Image
aspect_ratio
string
aspect_ratio_f
number
secure_url
string
url
string
is_active
boolean
Indicates whether the product is currently active or not.
is_dependent
boolean
Indicates if the product depends on other products (e.g., part of a set).
is_expirable
boolean
Indicates whether the product has an expiry date.
is_image_less_product
boolean
Indicates if the product does not have associated images.
is_physical
boolean
Indicates if the product is a physical item (as opposed to a digital product).
is_set
boolean
Indicates if the product is a set of items rather than a single item.
item_code
string
Unique code used to identify the product, often used internally or by sellers.
item_type
string
Describes the type of product (e.g., "standard" or "set").
Enum
l3_mapping
array of string
Hierarchical mapping of the product to categories (e.g., "electronics>qled_television").
media
array of object (Media)
Media assets associated with the product, such as images or videos.
Array of Media
meta
object
A metadata object containing additional information about the media, such as dimensions, format, or other relevant details.
type
string
The type of media.
Enum
url
string
The URL where the media can be accessed.
alt
string
The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed.
thumbnail
string
The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media.
modified_by
object
Object containing details about the user who last modified the product.
modified_on
string
| date-time
The timestamp when the product was last modified.
moq
object
Minimum order quantity details for the product.
multi_size
boolean
Indicates if the product is available in multiple sizes.
name
string
Name of the product.
net_quantity
object (NetQuantityResponseSchema)
NetQuantityResponseSchema
unit
string
The unit of measurement for the net quantity.
value
number
The actual quantity of the product in the specified unit.
no_of_boxes
integer
Number of boxes required to pack the product.
pending
string
Pending status related to product availability or verification.
primary_color
string
The primary color of the product.
product_group_tag
array of string
Tags associated with the product grouping.
product_publish
object (ProductPublish)
ProductPublish
is_set
boolean
Default Value : false
product_online_date
string
| date-time
return_config
object (ReturnConfigResponseSchema)
ReturnConfigResponseSchema
returnable
boolean
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
Short description of the product, typically used in product listings.
size_guide
string
Reference to the size guide for the product, if applicable.
sizes
array of object (SizeDetails)
List of size details for the product.
Array of SizeDetails
size
string
Size identifier for the product (e.g., "S", "M", "L").
store_count
integer
The number of stores that have this size available.
sellable_quantity
integer
Quantity of the product that is sellable in this size.
sellable
boolean
Indicates if this size is currently sellable.
size_priority
integer
The priority of the size for display purposes.
identifiers
array of object (Identifier)
List of identifiers (e.g., SKU codes, GTINs) associated with the size.
Array of Identifier
primary
boolean
Indicates if this is the primary identifier for the size.
gtin_value
string
The GTIN (Global Trade Item Number) value for the size.
gtin_type
string
The type of GTIN (e.g., SKU code, UPC, EAN).
price
Undefined Type
oneOf Schema from below
Properties
marked
object
Properties
min
number
Minimum marked price of the product for this size.
max
number
Maximum marked price of the product for this size.
effective
object
Properties
min
number
Minimum effective price of the product for this size.
max
number
Maximum effective price of the product for this size.
seller_identifier
string
Seller-specific identifier for this size.
price_transfer
number
Price transfer value for this size, typically used in business transactions.
track_inventory
boolean
Indicates if inventory is being tracked for this size.
slug
string
URL-friendly version of the product name for SEO purposes.
stage
string
Current stage of the product (e.g., "pending", "verified").
tags
array of string
Tags associated with the product for categorization and search purposes.
tax_identifier
object (TaxIdentifier)
TaxIdentifier
hsn_code
string
hsn_code_id
string
reporting_hsn
string
teaser_tag
object
Teaser tags used for marketing the product (e.g., "new arrival").
template_tag
string
Product template tag (e.g., "television").
trader
array of object (Trader)
List of traders or sellers associated with the product.
Array of Trader
address
array of string
List of addresses associated with the trader.
name
string
The name of the trader.
Minimum Length : 1
Maximum Length : 300
type
string
The role or type of the trader.
Enum
uid
integer
Unique identifier of the product.
variant_group
object
Grouping of product variants.
variant_media
object
Media information for product variants.
variants
object
List of product variants.
verified_by
object (VerifiedBy)
VerifiedBy
user_id
string
The unique identifier of the user who verified the product.
username
string
The username of the user who verified the product.
verified_on
string
| date-time
Timestamp when the product was verified.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
Examples
Parameters
brand_ids:
101,102,103
category_ids:
1,2,3
item_ids:
1001,1002
department_ids:
5,10
item_code:
"CODE123","CODE456"
name:
"Sample Product"
slug:
"sample-product-slug"
all_identifiers:
"IDENT123","IDENT456"
q:
"search query"
tags:
"tag1","tag2"
page_no:
2
page_size:
20
page_type:
"cursor"
sort_on:
"created"
page_id:
"2023-10-01T12:00:00Z"
Was this section helpful?
GET
Response
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
Custom JSON data that can be used for additional product properties.
action
string
The action to perform wrt to the product (e.g., upsert, update, delete).
Enum
attributes
object
Additional attributes related to the product.
brand_uid
integer
Required
Unique identifier for the product's brand.
bulk_job_id
string
Job ID associated with bulk operations.
category_slug
string
Required
The category to which the product belongs.
change_request_id
string
Nullable
Change request identifier for product updates.
company_id
integer
Required
Unique identifier for the company associated with the product.
country_of_origin
string
Required
The country where the product was manufactured or sourced.
currency
string
Required
The currency in which the product's price is listed.
custom_order
object (CustomOrder)
CustomOrder
manufacturing_time_unit
string
Unit of time for manufacturing (e.g., days, weeks).
is_custom_order
boolean
Required
Indicates if the product is available for custom orders.
manufacturing_time
integer
Time required for manufacturing in the specified unit.
departments
array of integer
Required
List of department IDs associated with the product.
Minimum Items : 1
Maximum Items : 1
description
string
A detailed description of the product.
highlights
array of string
Nullable
Product highlights or key features.
is_active
boolean
Flag to indicate if the product is active.
Default Value : true
is_dependent
boolean
Flag to indicate if the product is dependent on other products.
Default Value : false
is_image_less_product
boolean
Flag to indicate if the product does not have associated images.
Default Value : false
is_set
boolean
Flag to indicate if the product is part of a set.
Default Value : false
item_code
string
Required
Unique item code or SKU of the product.
Pattern : ^[A-Za-z0-9-_@,#\(\)\. ]+$
item_type
string
Required
Type of the product (e.g., standard, set, composite, digital).
Enum
media
array of object (Media)
Nullable
List of media URLs (images, videos) associated with the product.
Maximum Items : 30
Array of Media
meta
object
A metadata object containing additional information about the media, such as dimensions, format, or other relevant details.
type
string
The type of media.
Enum
url
string
Required
The URL where the media can be accessed.
alt
string
The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed.
thumbnail
string
The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media.
multi_size
boolean
Indicates if the product supports multiple sizes.
Default Value : true
name
string
Required
The name of the product.
Minimum Length : 1
Maximum Length : 300
net_quantity
object (NetQuantity)
NetQuantity
unit
string
The unit of measurement used for the net quantity of the product.
Enum
value
number
| value >= 0.001
The value of the net quantity of the product.
no_of_boxes
integer
| value >= 1
Number of boxes required to package the product.
Default Value : 1
product_group_tag
array of string
Tags to group products together for classification.
Maximum Items : 7
product_publish
object (ProductPublish)
ProductPublish
is_set
boolean
Default Value : false
product_online_date
string
| date-time
requester
string
The role requesting the product operation (admin or user).
Default Value : user
Enum
return_config
object (ReturnConfig)
Required
ReturnConfig
returnable
boolean
Required
time
integer
| value >= 0
Required
unit
string
Required
Enum
short_description
string
A short description of the product, up to 50 characters.
Maximum Length : 50
size_guide
string
Identifier for the product's size guide.
sizes
array of object
Required
List of sizes available for the product.
slug
string
Required
URL-friendly identifier for the product.
Pattern : ^[a-z0-9-_]*$
tags
array of string
List of tags associated with the product.
tax_identifier
object (TaxIdentifier)
Required
TaxIdentifier
hsn_code
string
hsn_code_id
string
reporting_hsn
string
teaser_tag
object (TeaserTag)
TeaserTag
tag
string
Nullable
url
string
| url
Nullable
template_tag
string
Required
Template tag for the product, used for classification.
trader
array of object (Trader)
Required
List of traders associated with the product.
Array of Trader
address
array of string
List of addresses associated with the trader.
name
string
Required
The name of the trader.
Minimum Length : 1
Maximum Length : 300
type
string
The role or type of the trader.
Enum
uid
integer
Nullable
Unique identifier for the product.
variant_group
object
Variant group information for the product.
variant_media
object
Media related to product variants.
variants
object
Variants information for the product.
Response
200
4XX
Returns a success response
SuccessResponseObject
success
boolean
Indicates whether the operation was successful or not.
uid
integer
A unique identifier associated with the successful operation.
Examples
Parameters
company_id:
"12345"
body:
body
Was this section helpful?
POST
Response
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.
Enum
Request body
company_id
string
The unique identifier of the company associated with the bulk product job.
template_tag
string
The template tag used to classify the products in the bulk job.
product_type
string
The type of products being processed in the bulk job (e.g., standard, digital, composite).
Enum
department
string
The department under which the products in the bulk job are categorized.
file_path
string
The file path of the uploaded file containing the bulk product data.
Response
200
4XX
Returns a success response
BulkResponseSchema
batch_id
string
created_by
object (UserInfo)
The user who created the item.
UserInfo
email
string
| email
The email address of the user.
uid
string
The unique ID of the user.
user_id
string
The ID of the user.
username
string
The username of the user.
created_on
string
| date-time
The date and time when the item was created.
is_active
boolean
Whether the item is active or not.
Default Value : true
modified_by
object (UserInfo)
Nullable
The user who last modified the item.
UserInfo
email
string
| email
The email address of the user.
uid
string
The unique ID of the user.
user_id
string
The ID of the user.
username
string
The username of the user.
modified_on
string
| date-time
The date and time when the item was last modified.
Default Value : 2023-08-16T12:07:13.817Z
Examples
Parameters
company_id:
12345
department:
"Electronics"
product_type:
"standard"
body:
body
Was this section helpful?
POST
Response
Parameters
company_id
string
Required
Company Id of the company associated with the product to be deleted.
item_id
integer
Required
Id of the product to be deleted.
Request body
brand_uid
integer
The brand identifier for the product.
item_code
string
The code of the item to be deleted.
company_id
string
The ID of the company. (Optional if already provided in the path)
item_id
integer
The ID of the product.
Response
200
404
Returns a success response
SuccessResponseSchema
success
boolean
Examples
Parameters
company_id:
"COMP123"
item_id:
750028
body:
body
Was this section helpful?
DEL
Response
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.
SingleProductResponseSchema
data
object (ProductSchemaV2)
ProductSchemaV2
_custom_json
object
Custom JSON data specific to the product, used for storing additional information.
all_company_ids
array of integer
List of company IDs associated with the product.
all_identifiers
array of string
List of unique product identifiers such as SKU codes or GTINs.
all_sizes
array of object
Details of all available sizes for the product, including pricing and inventory information.
attributes
object
Additional attributes specific to the product.
brand
object (Brand)
Brand
logo
object (Logo)
Logo
aspect_ratio
string
Aspect ratio of the logo image, typically expressed as a string (e.g., '16:9').
aspect_ratio_f
integer
Numeric representation of the aspect ratio for scaling purposes.
secure_url
string
Secure URL to the logo image.
url
string
URL to the logo image.
name
string
The name of the brand.
uid
integer
Unique identifier for the brand.
brand_uid
integer
Unique identifier for the brand.
category
object
Object representing the category to which the product belongs.
category_slug
string
Slug representation of the product category for SEO purposes.
category_uid
integer
Unique identifier for the product category.
color
string
Primary color of the product.
company_id
integer
Identifier for the company managing the product.
country_of_origin
string
Country where the product was manufactured or sourced.
created_by
object
Object containing details about the user who created the product.
currency
string
The currency in which the product is priced (e.g., "INR").
custom_order
object
Information about custom order options for the product, including manufacturing time.
departments
array of integer
List of department IDs associated with the product.
description
string
Long description of the product.
highlights
array of string
Key features or highlights of the product.
hsn_code
string
Harmonized System Nomenclature (HSN) code for taxation purposes.
id
string
Unique identifier of the product in the database.
image_nature
string
Describes the nature of the product images (e.g., "standard").
images
array of object (Image)
List of image URLs associated with the product.
Array of Image
aspect_ratio
string
aspect_ratio_f
number
secure_url
string
url
string
is_active
boolean
Indicates whether the product is currently active or not.
is_dependent
boolean
Indicates if the product depends on other products (e.g., part of a set).
is_expirable
boolean
Indicates whether the product has an expiry date.
is_image_less_product
boolean
Indicates if the product does not have associated images.
is_physical
boolean
Indicates if the product is a physical item (as opposed to a digital product).
is_set
boolean
Indicates if the product is a set of items rather than a single item.
item_code
string
Unique code used to identify the product, often used internally or by sellers.
item_type
string
Describes the type of product (e.g., "standard" or "set").
Enum
l3_mapping
array of string
Hierarchical mapping of the product to categories (e.g., "electronics>qled_television").
media
array of object (Media)
Media assets associated with the product, such as images or videos.
Array of Media
meta
object
A metadata object containing additional information about the media, such as dimensions, format, or other relevant details.
type
string
The type of media.
Enum
url
string
The URL where the media can be accessed.
alt
string
The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed.
thumbnail
string
The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media.
modified_by
object
Object containing details about the user who last modified the product.
modified_on
string
| date-time
The timestamp when the product was last modified.
moq
object
Minimum order quantity details for the product.
multi_size
boolean
Indicates if the product is available in multiple sizes.
name
string
Name of the product.
net_quantity
object (NetQuantityResponseSchema)
NetQuantityResponseSchema
unit
string
The unit of measurement for the net quantity.
value
number
The actual quantity of the product in the specified unit.
no_of_boxes
integer
Number of boxes required to pack the product.
pending
string
Pending status related to product availability or verification.
primary_color
string
The primary color of the product.
product_group_tag
array of string
Tags associated with the product grouping.
product_publish
object (ProductPublish)
ProductPublish
is_set
boolean
Default Value : false
product_online_date
string
| date-time
return_config
object (ReturnConfigResponseSchema)
ReturnConfigResponseSchema
returnable
boolean
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
Short description of the product, typically used in product listings.
size_guide
string
Reference to the size guide for the product, if applicable.
sizes
array of object (SizeDetails)
List of size details for the product.
Array of SizeDetails
size
string
Size identifier for the product (e.g., "S", "M", "L").
store_count
integer
The number of stores that have this size available.
sellable_quantity
integer
Quantity of the product that is sellable in this size.
sellable
boolean
Indicates if this size is currently sellable.
size_priority
integer
The priority of the size for display purposes.
identifiers
array of object (Identifier)
List of identifiers (e.g., SKU codes, GTINs) associated with the size.
Array of Identifier
primary
boolean
Indicates if this is the primary identifier for the size.
gtin_value
string
The GTIN (Global Trade Item Number) value for the size.
gtin_type
string
The type of GTIN (e.g., SKU code, UPC, EAN).
price
object
oneOf Schema from below
Properties
marked
object
Properties
min
number
Minimum marked price of the product for this size.
max
number
Maximum marked price of the product for this size.
effective
object
Properties
min
number
Minimum effective price of the product for this size.
max
number
Maximum effective price of the product for this size.
seller_identifier
string
Seller-specific identifier for this size.
price_transfer
number
Price transfer value for this size, typically used in business transactions.
track_inventory
boolean
Indicates if inventory is being tracked for this size.
slug
string
URL-friendly version of the product name for SEO purposes.
stage
string
Current stage of the product (e.g., "pending", "verified").
tags
array of string
Tags associated with the product for categorization and search purposes.
tax_identifier
object (TaxIdentifier)
TaxIdentifier
hsn_code
string
hsn_code_id
string
reporting_hsn
string
teaser_tag
object
Teaser tags used for marketing the product (e.g., "new arrival").
template_tag
string
Product template tag (e.g., "television").
trader
array of object (Trader)
List of traders or sellers associated with the product.
Array of Trader
address
array of string
List of addresses associated with the trader.
name
string
The name of the trader.
Minimum Length : 1
Maximum Length : 300
type
string
The role or type of the trader.
Enum
uid
integer
Unique identifier of the product.
variant_group
object
Grouping of product variants.
variant_media
object
Media information for product variants.
variants
object
List of product variants.
verified_by
object (VerifiedBy)
VerifiedBy
user_id
string
The unique identifier of the user who verified the product.
username
string
The username of the user who verified the product.
verified_on
string
| date-time
Timestamp when the product was verified.
Examples
Parameters
company_id:
98765
item_id:
54321
brand_uid:
11122
item_code:
"ITEM123"
Was this section helpful?
GET
Response
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
Custom JSON data that can be used for additional product properties.
action
string
The action to perform wrt to the product (e.g., upsert, update, delete).
Enum
attributes
object
Additional attributes related to the product.
brand_uid
integer
Required
Unique identifier for the product's brand.
bulk_job_id
string
Job ID associated with bulk operations.
category_slug
string
Required
The category to which the product belongs.
change_request_id
string
Nullable
Change request identifier for product updates.
company_id
integer
Required
Unique identifier for the company associated with the product.
country_of_origin
string
Required
The country where the product was manufactured or sourced.
currency
string
Required
The currency in which the product's price is listed.
custom_order
object (CustomOrder)
CustomOrder
manufacturing_time_unit
string
Unit of time for manufacturing (e.g., days, weeks).
is_custom_order
boolean
Required
Indicates if the product is available for custom orders.
manufacturing_time
integer
Time required for manufacturing in the specified unit.
departments
array of integer
Required
List of department IDs associated with the product.
Minimum Items : 1
Maximum Items : 1
description
string
A detailed description of the product.
highlights
array of string
Nullable
Product highlights or key features.
is_active
boolean
Flag to indicate if the product is active.
Default Value : true
is_dependent
boolean
Flag to indicate if the product is dependent on other products.
Default Value : false
is_image_less_product
boolean
Flag to indicate if the product does not have associated images.
Default Value : false
is_set
boolean
Flag to indicate if the product is part of a set.
Default Value : false
item_code
string
Required
Unique item code or SKU of the product.
Pattern : ^[A-Za-z0-9-_@,#\(\)\. ]+$
item_type
string
Required
Type of the product (e.g., standard, set, composite, digital).
Enum
media
array of object (Media)
Nullable
List of media URLs (images, videos) associated with the product.
Maximum Items : 30
Array of Media
meta
object
A metadata object containing additional information about the media, such as dimensions, format, or other relevant details.
type
string
The type of media.
Enum
url
string
Required
The URL where the media can be accessed.
alt
string
The alternative text for the media, used for accessibility and as a fallback when the media cannot be displayed.
thumbnail
string
The URL of the thumbnail image, typically a smaller or lower-resolution version of the main media.
multi_size
boolean
Indicates if the product supports multiple sizes.
Default Value : true
name
string
Required
The name of the product.
Minimum Length : 1
Maximum Length : 300
net_quantity
object (NetQuantity)
NetQuantity
unit
string
The unit of measurement used for the net quantity of the product.
Enum
value
number
| value >= 0.001
The value of the net quantity of the product.
no_of_boxes
integer
| value >= 1
Number of boxes required to package the product.
Default Value : 1
product_group_tag
array of string
Tags to group products together for classification.
Maximum Items : 7
product_publish
object (ProductPublish)
ProductPublish
is_set
boolean
Default Value : false
product_online_date
string
| date-time
requester
string
The role requesting the product operation (admin or user).
Default Value : user
Enum
return_config
object (ReturnConfig)
Required
ReturnConfig
returnable
boolean
Required
time
integer
| value >= 0
Required
unit
string
Required
Enum
short_description
string
A short description of the product, up to 50 characters.
Maximum Length : 50
size_guide
string
Identifier for the product's size guide.
sizes
array of object
Required
List of sizes available for the product.
slug
string
Required
URL-friendly identifier for the product.
Pattern : ^[a-z0-9-_]*$
tags
array of string
List of tags associated with the product.
tax_identifier
object (TaxIdentifier)
Required
TaxIdentifier
hsn_code
string
hsn_code_id
string
reporting_hsn
string
teaser_tag
object (TeaserTag)
TeaserTag
tag
string
Nullable
url
string
| url
Nullable
template_tag
string
Required
Template tag for the product, used for classification.
trader
array of object (Trader)
Required
List of traders associated with the product.
Array of Trader
address
array of string
List of addresses associated with the trader.
name
string
Required
The name of the trader.
Minimum Length : 1
Maximum Length : 300
type
string
The role or type of the trader.
Enum
uid
integer
Nullable
Unique identifier for the product.
variant_group
object
Variant group information for the product.
variant_media
object
Media related to product variants.
variants
object
Variants information for the product.
Response
200
4XX
Returns a success response
SuccessResponseSchema
success
boolean
Examples
Parameters
company_id:
"value"
item_id:
1
body:
body
Was this section helpful?
PUT
Response
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
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.
Response
200
400
Returns a success response
InventoryUpdateResponseSchema
items
array of object (InventoryResponseItem)
Array of InventoryResponseItem
data
object (InventoryPayload)
InventoryPayload
expiration_date
string
| date-time
The expiration date of the inventory item.
price_effective
number
The effective price of the inventory item.
price_marked
number
The marked price of the inventory item.
seller_identifier
string
The identifier of the seller.
Pattern : ^[A-Za-z0-9-_@,#\(\)\.\+\/ ]+$
store_id
integer
The ID of the store.
tags
array of string
Nullable
The tags associated with the inventory item.
total_quantity
integer
Nullable
The total quantity of the inventory item.
trace_id
string
The trace ID of the inventory payload.
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.
success
boolean
It is the success status of the inventory update.
Examples
Parameters
company_id:
1
item_id:
1234
seller_identifier:
"Test4M"
body:
body
Was this section helpful?
DEL
Response
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
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.
Response
200
400
Returns a success response
InventoryUpdateResponseSchema
items
array of object (InventoryResponseItem)
Array of InventoryResponseItem
data
object (InventoryPayload)
InventoryPayload
expiration_date
string
| date-time
The expiration date of the inventory item.
price_effective
number
The effective price of the inventory item.
price_marked
number
The marked price of the inventory item.
seller_identifier
string
The identifier of the seller.
Pattern : ^[A-Za-z0-9-_@,#\(\)\.\+\/ ]+$
store_id
integer
The ID of the store.
tags
array of string
Nullable
The tags associated with the inventory item.
total_quantity
integer
Nullable
The total quantity of the inventory item.
trace_id
string
The trace ID of the inventory payload.
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.
success
boolean
It is the success status of the inventory update.
Examples
Parameters
company_id:
1
item_id:
1234
seller_identifier:
"TEST4M"
body:
body
Was this section helpful?
POST
Response
enables you to update article price for a specific size and selling location (store). The price updates will be reflected instantly after the API call.
Parameters
company_id
integer
Required
Id of the company associated to product for that article price to be updated.
store_id
integer
Required
The Store Id to update price of size for specific store.
seller_identifier
string
Required
Size Identifier (Seller Identifier or Primary Identifier) of which article price is to update.
Request body
price_effective
number
Required
The effective price of the inventory item.
price_marked
number
Required
The marked price of the inventory item.
tags
array of string
Tags associated with inventory item.
Response
200
422
Returns a success response
LocationPriceQuantitySuccessResponseSchema
message
string
It is the success message of the price/quantity update.
Examples
Parameters
company_id:
1
store_id:
1
seller_identifier:
"value"
body:
body
Was this section helpful?
POST
Response
enables you to update article quantity for a specific size and selling location (store). The quantity updates will be reflected instantly after the API call.
Parameters
company_id
integer
Required
Id of the company associated to product for that article quantity to be updated.
store_id
integer
Required
The Store Id to update quantity of size for specific store.
seller_identifier
string
Required
Size Identifier (Seller Identifier or Primary Identifier) of which article quantity is to update.
Request body
expiration_date
string
| date-time
The expiration date of the inventory item.
total_quantity
integer
Required
The total quantity of the inventory item.
Response
200
422
Returns a success response
LocationPriceQuantitySuccessResponseSchema
message
string
It is the success message of the price/quantity update.
Examples
Parameters
company_id:
1
store_id:
1
seller_identifier:
"value"
body:
body
Was this section helpful?
POST
Response
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 attribute detail by slug
Parameters
company_id
integer
Required
The company id for which the detail needs to be retrieved.
category
string
Required
It is the name of the l3 cateogry
filter
boolean
If true, returns filtered values, else returns all the attributes
Response
200
4XX
Size guide object.
ProductAttributesResponseSchema
items
array of object (AttributeMasterSchema)
Array of AttributeMasterSchema
created_by
object
Information about the user who created the attribute.
created_on
string
| date-time
The timestamp when the attribute was created.
departments
array of string
Departments or categories to which the attribute applies.
Minimum Items : 1
description
string
A description of the attribute.
details
object (AttributeMasterDetails)
AttributeMasterDetails
display_type
string
Type of display used for the attribute (e.g., text, dropdown).
enabled_for_end_consumer
boolean
Indicates if the attribute is enabled for end consumers.
filters
object (AttributeMasterFilter)
AttributeMasterFilter
depends_on
array of string
indexing
boolean
Whether the attribute should be indexed for search.
priority
integer
Priority of the attribute in filtering (optional).
is_nested
boolean
Indicates if the attribute can be nested under other attributes.
logo
string
URL of the logo associated with the attribute.
modified_by
object
Information about the user who last modified the attribute.
modified_on
string
| date-time
The timestamp when the attribute was last modified.
name
string
Name of the attribute.
raw_key
string
Name of the attribute.
schema
object (AttributeMaster)
AttributeMaster
allowed_values
array of string
List of allowed values for the attribute, if applicable.
format
string
Format of the attribute, such as case formatting.
mandatory
boolean
Whether the attribute is mandatory.
multi
boolean
Indicates if the attribute allows multiple values.
range
object (AttributeSchemaRange)
AttributeSchemaRange
min
integer
Minimum allowed value for the attribute.
max
integer
Maximum allowed value for the attribute.
type
string
Data type of the attribute.
Enum
suggestion
string
Suggested or recommended value for the attribute, if applicable.
synonyms
object
Synonyms or alternative names for the attribute, used for search and indexing.
tags
array of string
Tags or keywords associated with the attribute, often used for categorization.
unit
string
The unit of measurement for the attribute, if applicable (e.g., cm, kg).
slug
string
Unique slug or identifier for the attribute.
variant
boolean
Indicates if the attribute is a variant of another attribute.
Default Value : false
Examples
Parameters
company_id:
1
category:
"activewear-t-shirts"
Was this section helpful?
GET
Response
Retrieve the attribute detail for catalog listings by attribute slug passed for a specific company.
Parameters
company_id
integer
Required
The company id for which the detail needs to be retrieved.
attribute_slug
string
Required
Slug of the attribute for which you want to view the details
Response
200
4XX
Get Attribute Detail by Slug.
AttributeDetail
_id
array of string
description
string
details
object (AttributeMasterDetails)
AttributeMasterDetails
display_type
string
Type of display used for the attribute (e.g., text, dropdown).
enabled_for_end_consumer
boolean
filters
object (AttributeMasterFilter)
AttributeMasterFilter
depends_on
array of string
indexing
boolean
Whether the attribute should be indexed for search.
priority
integer
Priority of the attribute in filtering (optional).
is_nested
boolean
logo
string
| url
meta
object (AttributeMasterMeta)
AttributeMasterMeta
enriched
boolean
Indicates if the attribute has been enriched with additional details or data beyond the basic schema.
mandatory_details
object (AttributeMasterMandatoryDetails)
AttributeMasterMandatoryDetails
l3_keys
array of string
A list of Level 3 (L3) keys associated with the attribute, typically used for advanced categorization or attribute grouping.
name
string
schema
object (AttributeMaster)
AttributeMaster
allowed_values
array of string
List of allowed values for the attribute, if applicable.
format
string
Format of the attribute, such as case formatting.
mandatory
boolean
Whether the attribute is mandatory.
multi
boolean
Indicates if the attribute allows multiple values.
range
object (AttributeSchemaRange)
AttributeSchemaRange
min
integer
Minimum allowed value for the attribute.
max
integer
Maximum allowed value for the attribute.
type
string
Data type of the attribute.
Enum
slug
string
Examples
Parameters
company_id:
1
attribute_slug:
"custom-attribute"
Was this section helpful?
GET
Response
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
Retrieve a list of product bundles available in the catalog associated to a specific company.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
q
string
A search string that is searched with product bundle name.
slug
array of string
slugs of bundles to be retrieved.
page_no
integer
The page number to navigate through the given set of results
page_size
integer
Number of items to retrieve in each page. Default is 12.
Default Value : 12
Response
200
4XX
List of bundle configured for a company.
GetProductBundleListingResponseSchema
items
array of object (GetProductBundleCreateResponseSchema)
List of product bundles that are returned in the response.
Array of GetProductBundleCreateResponseSchema
choice
string
Specifies the type of bundle, e.g., single or multi.
company_id
integer
Unique identifier for the company that owns the product bundle.
created_by
object (CreatedBy)
CreatedBy
user_id
string
Unique identifier for the user.
username
string
Username of the user who created the product.
created_on
string
| date-time
Timestamp when the product bundle was created.
id
string
Unique identifier for the product bundle.
is_active
boolean
Indicates if the product bundle is active or not.
logo
string
Nullable
URL of the product bundle's logo, or null if not available.
meta
object
Additional metadata about the product bundle.
modified_by
object (ModifiedBy)
ModifiedBy
user_id
string
Unique identifier for the user who modified the entity.
username
string
Username of the user who last modified the entity.
modified_on
string
| date-time
Timestamp when the product bundle was last modified.
name
string
Name of the product bundle.
page_visibility
array of string
Visibility settings for the product bundle across different pages.
Enum
products
array of object (ProductBundleItem)
List of products that are part of the product bundle.
Maximum Items : 10
Array of ProductBundleItem
allow_remove
boolean
Indicates whether the product can be removed from the bundle.
auto_add_to_cart
boolean
Specifies if the product is automatically added to the cart.
auto_select
boolean
Indicates if the product is automatically selected in the bundle.
max_quantity
integer
| value >= 1
| value <= 99
Maximum quantity of the product that can be added to the bundle.
min_quantity
integer
| value >= 1
| value <= 99
Minimum quantity of the product that must be added to the bundle.
product_uid
integer
Unique identifier for the product.
same_store_assignment
boolean
Indicates whether all products in the bundle belong to the same store.
Default Value : true
slug
string
Unique slug used to identify the product bundle in URLs.
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
q:
"bundlename"
slug:
"bundlename"
page_no:
1
page_size:
10
Was this section helpful?
GET
Response
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
Request body
choice
string
Required
Specifies the type of product bundle (e.g., 'single' or 'multi').
company_id
integer
The unique identifier of the company to which the product bundle belongs.
created_by
object
Information about the user who created the product bundle, including user ID and username.
created_on
string
| date-time
The timestamp when the product bundle was created.
is_active
boolean
Required
Indicates whether the product bundle is currently active.
logo
string
Nullable
URL of the logo associated with the product bundle, if available. Can be null.
meta
object
Additional metadata for the product bundle.
modified_by
object
Information about the user who last modified the product bundle, including user ID and username.
modified_on
string
| date-time
The timestamp when the product bundle was last modified.
name
string
Required
The name of the product bundle.
page_visibility
array of string
Pages where the product bundle is visible (e.g., 'pdp' for product display page).
Enum
products
array of object (ProductBundleItem)
Required
A list of products included in the bundle. A maximum of 10 products can be added.
Maximum Items : 10
Array of ProductBundleItem
allow_remove
boolean
Indicates whether the product can be removed from the bundle.
auto_add_to_cart
boolean
Specifies if the product is automatically added to the cart.
auto_select
boolean
Indicates if the product is automatically selected in the bundle.
max_quantity
integer
| value >= 1
| value <= 99
Required
Maximum quantity of the product that can be added to the bundle.
min_quantity
integer
| value >= 1
| value <= 99
Required
Minimum quantity of the product that must be added to the bundle.
product_uid
integer
Required
Unique identifier for the product.
same_store_assignment
boolean
Indicates whether all products in the bundle are assigned to the same store.
Default Value : true
slug
string
Required
A URL-friendly unique identifier for the product bundle.
Response
200
4XX
Get bundle with id that is added.
GetProductBundleCreateResponseSchema
choice
string
Specifies the type of bundle, e.g., single or multi.
company_id
integer
Unique identifier for the company that owns the product bundle.
created_by
object (CreatedBy)
CreatedBy
user_id
string
Unique identifier for the user.
username
string
Username of the user who created the product.
created_on
string
| date-time
Timestamp when the product bundle was created.
id
string
Unique identifier for the product bundle.
is_active
boolean
Indicates if the product bundle is active or not.
logo
string
Nullable
URL of the product bundle's logo, or null if not available.
meta
object
Additional metadata about the product bundle.
modified_by
object (ModifiedBy)
ModifiedBy
user_id
string
Unique identifier for the user who modified the entity.
username
string
Username of the user who last modified the entity.
modified_on
string
| date-time
Timestamp when the product bundle was last modified.
name
string
Name of the product bundle.
page_visibility
array of string
Visibility settings for the product bundle across different pages.
Enum
products
array of object (ProductBundleItem)
List of products that are part of the product bundle.
Maximum Items : 10
Array of ProductBundleItem
allow_remove
boolean
Indicates whether the product can be removed from the bundle.
auto_add_to_cart
boolean
Specifies if the product is automatically added to the cart.
auto_select
boolean
Indicates if the product is automatically selected in the bundle.
max_quantity
integer
| value >= 1
| value <= 99
Maximum quantity of the product that can be added to the bundle.
min_quantity
integer
| value >= 1
| value <= 99
Minimum quantity of the product that must be added to the bundle.
product_uid
integer
Unique identifier for the product.
same_store_assignment
boolean
Indicates whether all products in the bundle belong to the same store.
Default Value : true
slug
string
Unique slug used to identify the product bundle in URLs.
Examples
Parameters
company_id:
1
body:
body
Was this section helpful?
POST
Response
Retrieve detailed information about a specific product bundle associated to a specific company.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
id
string
Required
A `id` is a unique identifier for a particular detail. Pass the `id` of the keywords which you want to retrieve.
Response
200
4XX
The Collection object.
GetProductBundleResponseSchema
choice
string
Specifies the type of product bundle, e.g., 'single' or 'multi'.
company_id
integer
The unique identifier of the company that owns the product bundle.
is_active
boolean
Indicates whether the product bundle is active.
logo
string
URL of the logo associated with the product bundle.
meta
object
Additional metadata for the product bundle.
name
string
The name of the product bundle.
page_visibility
array of string
List of pages where the product bundle is visible, e.g., 'pdp'.
products
array of object (GetProducts)
A list of products included in the bundle.
Array of GetProducts
allow_remove
boolean
Indicates whether the product can be removed from the bundle.
auto_add_to_cart
boolean
Specifies if the product is automatically added to the cart.
auto_select
boolean
Indicates if the product is automatically selected in the bundle.
max_quantity
integer
The maximum quantity of the product that can be added to the bundle.
min_quantity
integer
The minimum quantity of the product that must be added to the bundle.
product_uid
integer
Unique identifier for the product.
product_details
object (ProductDetails)
ProductDetails
slug
string
Unique URL-friendly identifier for the product.
quantity
integer
The quantity of the product available.
attributes
object
A set of key-value pairs representing the attributes of the product, such as pattern, gender, etc.
price
object (Price)
Price
currency
string
max_effective
number
max_marked
number
min_effective
number
min_marked
number
images
array of string
List of URLs pointing to images of the product.
uid
integer
Unique identifier for the product.
item_code
string
Code assigned to the product for inventory purposes.
identifier
object
Identification details for the product, including EANs (European Article Numbers).
sizes
array of string
List of available sizes for the product.
country_of_origin
string
Country where the product was manufactured.
same_store_assignment
boolean
Indicates whether all products in the bundle are assigned to the same store.
slug
string
Unique URL-friendly identifier for the product bundle.
Examples
Parameters
company_id:
1
id:
"670cc311d47e8ce5c8f0756a"
Was this section helpful?
GET
Response
Modify the details of an existing product bundle in the catalog associated to a specific company.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
id
string
Required
A `id` is a unique identifier for a particular detail. Pass the `id` of the keywords which you want to delete.
Request body
choice
string
Required
Specifies the type of product bundle (e.g., 'single' or 'multi').
company_id
integer
The unique identifier of the company to which the product bundle belongs.
is_active
boolean
Required
Indicates whether the product bundle is currently active.
logo
string
Nullable
URL of the logo associated with the product bundle, if available. Can be null.
meta
object
Additional metadata for the product bundle.
name
string
Required
The name of the product bundle.
page_visibility
array of string
Pages where the product bundle is visible (e.g., 'pdp' for product display page).
Enum
products
array of object (ProductBundleItem)
Required
A list of products included in the bundle. A maximum of 10 products can be added.
Maximum Items : 10
Array of ProductBundleItem
allow_remove
boolean
Indicates whether the product can be removed from the bundle.
auto_add_to_cart
boolean
Specifies if the product is automatically added to the cart.
auto_select
boolean
Indicates if the product is automatically selected in the bundle.
max_quantity
integer
| value >= 1
| value <= 99
Required
Maximum quantity of the product that can be added to the bundle.
min_quantity
integer
| value >= 1
| value <= 99
Required
Minimum quantity of the product that must be added to the bundle.
product_uid
integer
Required
Unique identifier for the product.
same_store_assignment
boolean
Indicates whether all products in the bundle are assigned to the same store.
Default Value : true
slug
string
Required
A URL-friendly unique identifier for the product bundle.
Response
200
4XX
The Collection object.
GetProductBundleCreateResponseSchema
choice
string
Specifies the type of bundle, e.g., single or multi.
company_id
integer
Unique identifier for the company that owns the product bundle.
created_by
object (CreatedBy)
CreatedBy
user_id
string
Unique identifier for the user.
username
string
Username of the user who created the product.
created_on
string
| date-time
Timestamp when the product bundle was created.
id
string
Unique identifier for the product bundle.
is_active
boolean
Indicates if the product bundle is active or not.
logo
string
Nullable
URL of the product bundle's logo, or null if not available.
meta
object
Additional metadata about the product bundle.
modified_by
object (ModifiedBy)
ModifiedBy
user_id
string
Unique identifier for the user who modified the entity.
username
string
Username of the user who last modified the entity.
modified_on
string
| date-time
Timestamp when the product bundle was last modified.
name
string
Name of the product bundle.
page_visibility
array of string
Visibility settings for the product bundle across different pages.
Enum
products
array of object (ProductBundleItem)
List of products that are part of the product bundle.
Maximum Items : 10
Array of ProductBundleItem
allow_remove
boolean
Indicates whether the product can be removed from the bundle.
auto_add_to_cart
boolean
Specifies if the product is automatically added to the cart.
auto_select
boolean
Indicates if the product is automatically selected in the bundle.
max_quantity
integer
| value >= 1
| value <= 99
Maximum quantity of the product that can be added to the bundle.
min_quantity
integer
| value >= 1
| value <= 99
Minimum quantity of the product that must be added to the bundle.
product_uid
integer
Unique identifier for the product.
same_store_assignment
boolean
Indicates whether all products in the bundle belong to the same store.
Default Value : true
slug
string
Unique slug used to identify the product bundle in URLs.
Examples
Parameters
company_id:
1
id:
"670cc311d47e8ce5c8f0756a"
body:
body
Was this section helpful?
PUT
Response
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
# Validate product template
Allows you to list all product templates for a specific company. also can filter by department.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
department
string
Required
A `department` is the name of a particular department.
Response
200
4XX
List of product templates.
TemplatesResponseSchema
items
array of object (ProductTemplate)
List of product templates.
Array of ProductTemplate
attributes
array of string
List of attributes associated with the product template.
categories
array of string
List of categories the product template belongs to.
created_by
object (CreatedBy)
CreatedBy
user_id
string
Unique identifier for the user.
username
string
Username of the user who created the product.
created_on
string
| date-time
Timestamp of when the product template was created.
departments
array of string
List of departments the product template is associated with.
description
string
Detailed description of the product template.
is_active
boolean
Indicates if the product template is currently active.
Default Value : true
is_archived
boolean
Indicates if the product template is archived.
is_expirable
boolean
Indicates if the product template is expirable.
is_physical
boolean
Indicates if the product template represents a physical product.
logo
string
URL of the product template logo.
modified_by
object (ModifiedBy)
ModifiedBy
user_id
string
Unique identifier for the user who modified the entity.
username
string
Username of the user who last modified the entity.
modified_on
string
| date-time
Timestamp of when the product template was last modified.
name
string
The name of the product template.
slug
string
Unique URL-friendly identifier for the product template.
tag
string
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
Examples
Parameters
company_id:
1
department:
"loksabha"
Was this section helpful?
GET
Response
Allows you to list all product template categories values for the departments specified for a specific company.
Parameters
company_id
integer
Required
A `company_id` is a unique identifier for a particular seller account.
departments
string
Required
A `department` is name of a departments whose category needs to be listed. Can specify multiple departments.
item_type
string
Required
An `item_type` is the type of item, it can be `set`, `standard`, `digital`, etc.
Enum
Response
200
4XX
List of all categories attached to departments specified. See example below or refer `ProdcutTemplateCategoriesResponse` for details
ProdcutTemplateCategoriesResponseSchema
items
array of object (CategoriesResponseSchema)
Array of CategoriesResponseSchema
name
string
The name of the category.
slug
string
A URL-friendly unique identifier for the category.
slug_key
string
A key used for internal identification of the category slug.
template_slug
string
The slug of the template associated with the category.
uid
integer
A unique identifier for the category.
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
Examples
Parameters
company_id:
1
departments:
"loksabha"
Was this section helpful?
GET
Response
Allows you to list all product templates global validation values for all the fields present in the database for a specific company.
Parameters
company_id
string
Required
A `company_id` is a unique identifier for a particular seller account.
item_type
string
An `item_type` defines the type of item. The default value is standard.
Enum
bulk
boolean
This specification determines the schema type to be retrieved. When set to true, it will return the schema for bulk data; when set to false, it will provide the schema for a single product. The default value is false.
Response
200
422
List of fields and validation values fro each. See example below or refer `TemplatesValidationResponse` for details
TemplatesGlobalValidationResponseSchema
data
object (TemplateGlobalValidationData)
TemplateGlobalValidationData
global_validation
object (GlobalValidation)
GlobalValidation
definitions
object
description
string
properties
object (Properties)
Properties
brand_uid
object
category_slug
object
command
object
country_of_origin
object
currency
object
custom_order
object
description
object
highlights
object
hsn_code
object
is_active
object
is_dependent
object
item_code
object
item_type
object
media
object
multi_size
object
name
object
no_of_boxes
object
product_group_tag
object
product_publish
object
return_config
object
short_description
object
size_guide
object
sizes
object
slug
object
tags
object
teaser_tag
object
trader
object
trader_type
object
variants
object
required
array of string
title
string
type
string
Examples
Parameters
company_id:
"value"
item_type:
"value"
bulk:
false
Was this section helpful?
GET
Response
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
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 (SizeGuideItem)
A list of size guides, each containing detailed information about a product's dimensions, creation, and modification data.
Array of SizeGuideItem
active
boolean
Indicates if the size guide is active or not.
brand_id
integer
The identifier for the brand associated with the size guide.
company_id
integer
The identifier for the company that owns the size guide.
created_by
object (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.
created_on
string
| date-time
The timestamp when the size guide was created.
guide
object (Guide)
Guide
meta
object (Meta)
Meta
headers
object
unit
string
Enum
values
array of object
id
string
The unique identifier for the size guide.
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.
modified_on
string
| date-time
The timestamp when the size guide was last modified.
name
string
The name of the size guide.
subtitle
string
A short description or subtitle for the size guide.
tag
string
A tag or identifier used to classify the size guide.
title
string
The title of the size guide.
description
string
A detailed description or HTML content providing more information about the size guide.
image
string
A URL to an image associated with the size guide.
page
object (PageResponseSchema)
PageResponseSchema
current
integer
It is the current page of the page response schema.
has_next
boolean
It is the bool indicates if there is a next page.
has_previous
boolean
It is the bool indicates if there is a previous page.
item_total
integer
It is the total number of item present for the filter.
size
integer
It is the size of each page.
Examples
Parameters
company_id:
"1"
active:
true
q:
"Sample SG Test"
tag:
"adidas"
page_no:
1
page_size:
1
brand_id:
342343
Was this section helpful?
GET
Response
Parameters
company_id
string
Required
Id of the company inside which the size guide is to be created.
Request body
active
boolean
Indicates whether the size guide is currently active.
brand_id
integer
The unique identifier for the brand associated with the size guide.
company_id
string
The unique identifier for the company that owns the size guide.
created_by
object
Information about the user who created the size guide.
created_on
string
| date-time
The timestamp when the size guide was created, in ISO 8601 format.
description
string
A detailed HTML description of the size guide.
guide
object (Guide)
Guide
meta
object (Meta)
Meta
headers
object
unit
string
Enum
values
array of object
id
string
The public identifier of the size guide.
image
string
| url
A URL pointing to an image associated with the size guide.
modified_by
object
Information about the user who last modified the size guide.
modified_on
string
| date-time
The timestamp when the size guide was last modified, in ISO 8601 format.
name
string
Required
The name of the size guide.
subtitle
string
A short description or subtitle of the size guide.
tag
string
A tag or label associated with the size guide, used for categorization or reference.
title
string
Required
The main title of the size guide.
Response
200
4XX
Returns a success response
SuccessResponseSchema
success
boolean
Examples
Parameters
company_id:
"1"
body:
body
Was this section helpful?
POST
Response
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
Size Guide Object object. See example below or refer `SizeGuideResponseSchema` for details
SizeGuideResponseSchema
active
boolean
Indicates whether the size guide is currently active.
brand_id
integer
The unique identifier for the brand associated with the size guide.
company_id
integer
The unique identifier for the company that owns the size guide.
created_by
object (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.
created_on
string
| date-time
The timestamp when the size guide was created, in ISO 8601 format.
guide
object
The main content of the size guide, containing details such as the size measurements, headers, and units.
id
string
The public identifier of the size guide.
image
string
A URL pointing to an image associated with the size guide.
modified_by
object (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.
modified_on
string
| date-time
The timestamp when the size guide was last modified, in ISO 8601 format.
name
string
The name or title of the size guide.
subtitle
string
A short description or subtitle of the size guide.
tag
string
A tag or label associated with the size guide, used for categorization or reference.
title
string
The main title of the size guide.
Examples
Parameters
company_id:
"1"
id:
"asdafdgddfvfv1"
Was this section helpful?
GET
Response
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
Indicates whether the size guide is currently active.
brand_id
integer
The unique identifier for the brand associated with the size guide.
company_id
string
The unique identifier for the company that owns the size guide.
created_by
object
Information about the user who created the size guide.
created_on
string
| date-time
The timestamp when the size guide was created, in ISO 8601 format.
description
string
A detailed HTML description of the size guide.
guide
object (Guide)
Guide
meta
object (Meta)
Meta
headers
object
unit
string
Enum
values
array of object
id
string
The public identifier of the size guide.
image
string
| url
A URL pointing to an image associated with the size guide.
modified_by
object
Information about the user who last modified the size guide.
modified_on
string
| date-time
The timestamp when the size guide was last modified, in ISO 8601 format.
name
string
Required
The name of the size guide.
subtitle
string
A short description or subtitle of the size guide.
tag
string
A tag or label associated with the size guide, used for categorization or reference.
title
string
Required
The main title of the size guide.
Response
200
4XX
Returns a success response
SuccessResponseSchema
success
boolean
Examples
Parameters
company_id:
"1"
id:
"asdafdgddfvfv1"
body:
body
Was this section helpful?
PUT
Response