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_idpath
integer
Required
A `company_id` is a unique identifier for a particular seller account.
levelquery
array of integer
Get category for multiple levels
departmentquery
integer
Get category for multiple departments filtered
qquery
string
Get multiple categories filtered by search string
page_noquery
integer
The page number to navigate through the given set of results
page_sizequery
integer
Number of items to retrieve in each page. Default is 10.
Default Value : 12
uidsquery
array of integer
Get multiple categories filtered by category uids.
Maximum Items : 100
slugquery
string
Get category by slug
GET
Response
200
Category Meta.
Hide
items
array of object (Category)
The list of categories.
Show
page
object (Page)
Show
Examples
Parameters
company_id:
24
level:
1,2,3
department:
146
q:
"Emmanuelle1153977215920241148294"
page_no:
1
page_size:
10
uids:
1,2,3
slug:
"emmanuelle1153977215920241148294"
Response
List categories
listCategories
Retrieve detailed information about a specific category by its uid for a specific company.
Parameters
company_idpath
string
Required
A `company_id` is a unique identifier for a particular seller account.
uidpath
string
Required
Category unique id
GET
Response
200
Get Data for one category.
Hide
The category data containing details like created_by, media, hierarchy, etc.
data
object (Category)
Show
Examples
Parameters
company_id:
"1"
uid:
"430093"
Response
Get category by uid
getCategoryData
A department categorizes products into different sections or categories based on their type or purpose. Departments help organize products in a logical manner, making it easier for customers to navigate the product catalog. Each department typically has a unique identifier and a name. For example, a clothing ecommerce platform might have departments such as Men's Clothing, Women's Clothing, Accessories, Footwear, etc. You can retrieve a list of all departments associated with available products, facilitating easy navigation and organization of products based on departmental categorization. Additionally, the APIs allow you to list all products associated with a specific brand, collection, or category in a random order, enhancing user engagement and discovery within your application
Operations
GET
# List company department
GET
# Get department by uid
Parameters
company_idpath
string
Required
A `company_id` is a unique identifier for a particular seller account.
page_noquery
integer
The page number to navigate through the given set of results
item_typequery
string
A `item_type` is a type of product eg. set, standard, digital
Enum
page_sizequery
integer
Number of items to retrieve in each page. Default is 10.
namequery
string
Can search departments by passing name.
searchquery
string
Can search departments by passing name of the department in search parameter.
is_activequery
boolean
Can query for departments based on whether they are active or inactive.
slugquery
string
Can filter by slug
GET
Response
200
List of departments data.
Hide
items
array of object (GetDepartment)
List of department objects.
Show
page
object (Page)
Show
Examples
Parameters
company_id:
"1"
page_no:
1
item_type:
"standard"
page_size:
1
name:
"Fashion"
search:
"Fashion"
is_active:
false
slug:
"Fashion"
Response
List company department
listDepartmentsData
Retrieve detailed information about a specific department for a specific company by uid.
Parameters
company_idpath
string
Required
A `company_id` is a unique identifier for a particular seller account.
uidpath
string
Required
A `uid` is a unique identifier of a department.
GET
Response
200
Departments Data.
Hide
items
array of object (GetDepartment)
List of department objects.
Show
page
object (Page)
Show
Examples
Parameters
company_id:
"1"
uid:
"4"
Response
Get department by uid
getDepartmentData
The "Product" resource offers detailed insights into items available for sale on Sales Channels or Marketplaces. It provides comprehensive product listings, stock status insights, seller details, and facilitates efficient product catalog management
Operations
GET
# List Inventory
GET
# List product tags
GET
# List inventory by size
GET
# List product size
DEL
# Delete product size
POST
# Create Inventory
GET
# List inventory by size
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
PUT
# Update a product
PATCH
# Patch a product
DEL
# Delete product
GET
# Get a product
DEL
# Delete an inventory
POST
# Update an inventory
POST
# Update an Article Price
POST
# Update an Article Quantity
Parameters
company_idpath
string
Required
Id of the company associated to product that is to be viewed.
item_idquery
string
Item code of the product of which size is to be get.
sizequery
string
Size of which inventory is to get.
page_noquery
integer
The page number to navigate through the given set of results
page_sizequery
integer
Number of items to retrieve in each page. Default is 12.
Default Value : 12
page_idquery
string
Alphanumeric Page ID to retrieve next set of results.
page_typequery
string
Available pagination types are cursor or number.
Default Value : number
Enum
qquery
string
Search with help of store code.
sellablequery
boolean
Filter on whether product is in stock or not.
Default Value : false
store_idsquery
array of integer
The Store Id of products to fetch inventory.
brand_idsquery
array of integer
The Brand Id of products to fetch inventory.
seller_identifiersquery
array of string
The Seller Identifier or Primary Identifier of the inventory.
qty_gtquery
integer
This field allows you to filter for inventories that have quantity greater than to the specified value based on qty_type filter.
qty_ltquery
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_typequery
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_datequery
string
| date-time
Inventory updated on filter to get inventories greater then or equal to provided date based on qty_type value.
to_datequery
string
| date-time
Inventory updated on filter to get inventories less then or equal to provided date based on qty_type value.
size_identifierquery
string
Size Identifier (Seller Identifier or Primary Identifier) of which inventory is to get.
GET
Response
200
returns a list of all inventory grouped by size and store
Hide
Response for getting inventories.
items
array of object (GetInventories)
List of product inventories.
Show
page
object (Page)
Show
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"
Response
List Inventory
getInventories
Parameters
company_idpath
integer
Required
Company Id for which tags to be fetched.
GET
Response
200
Tag List.
Hide
Represents the response for viewing a list of product tags.
items
array of string
An array of product tag strings representing various tags associated with the products.
Examples
Parameters
company_id:
1
Response
List product tags
getProductTags
Retrieve inventory data for a specific company, item ID, and seller identifier. The API supports search capabilities using store codes and location IDs.
Parameters
company_idpath
integer
Required
Id of the company associated to product that is to be viewed.
item_idpath
integer
Required
Item code of the product of which size is to be get.
size_identifierpath
string
Required
Size Identifier (Seller Identifier or Primary Identifier) of which inventory is to get.
page_noquery
integer
The page number to navigate through the given set of results
page_sizequery
integer
Number of items to retrieve in each page. Default is 12.
Default Value : 12
qquery
string
Search with help of store code.
location_idsquery
array of integer
Search by store ids.
GET
Response
200
returns a list of all inventory grouped by size and store
Hide
Response schema for getting inventory by seller identifier.
items
array of object (InventorySellerResponseSchema)
Show
page
object (Page)
Show
Examples
Parameters
item_id:
10989
size_identifier:
"5645463"
page_no:
1
page_size:
1
q:
"SJBTS"
location_ids:
1,2,3
Response
List inventory by size
getInventoryBySizeIdentifier
Parameters
item_codequery
string
Item code of the product size.
company_idpath
integer
Required
Company Id of the product size.
item_idpath
integer
Required
Item Id of the product size.
brand_uidquery
integer
Brand Id of the product size.
uidquery
integer
Id of the product size.
GET
Response
200
Product object.
Hide
items
array of object (Product)
Show
page
object (Page)
Show
Response
List product size
getProductSize
Parameters
company_idpath
integer
Required
Company Id of the company associated to size that is to be deleted.
item_idpath
integer
Required
Item Id of the product associated with size to be deleted.
sizepath
string
Required
size to be deleted.
DEL
Response
200
Returns a success response
Hide
data
object (ProductSizeDeleteDataResponseSchema)
Show
success
boolean
Indicates whether the size deletion operation was successful.
Response
Delete product size
deleteSize
Parameters
company_idpath
integer
Required
Id of the company associated to product that is to be viewed.
item_idpath
integer
Required
Item id of the product of which size is to be get.
sizepath
string
Required
Size in which inventory is to be added.
Request body
company_id
integer
Required
item
object (ItemQuery)
Required
Show
sizes
array of object (InvSize)
Required
Show
transaction_type
string
Nullable
Reason for the inventory update. Recorded in the audit-trail event for the resulting article mutation. Optional; defaults to "other" when omitted.
Enum
transaction
object (InventoryTransaction)
Nullable
Audit transaction context; supersedes the flat `transaction_type` (its `type` carries the same value). All fields optional; recorded in the audit-trail event.
Show
POST
Response
200
Returns a success response
Hide
Indicates whether the operation was successful or not.
success
boolean
Response
Create Inventory
addInventory
Available till 1/23/2027
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_idpath
integer
Required
Id of the company associated to product that is to be viewed.
item_idpath
integer
Required
Item code of the product of which size is to be get.
sizepath
string
Required
Size of which inventory is to get.
page_noquery
integer
The page number to navigate through the given set of results
page_sizequery
integer
Number of items to retrieve in each page. Default is 12.
Default Value : 12
qquery
string
Search with help of store code.
sellablequery
boolean
Filter on whether product is in stock or not.
Default Value : false
GET
Response
200
returns a list of all inventory grouped by size and store
Hide
items
array of object (InventoryResponseSchema)
Show
page
object (Page)
Show
Response
List inventory by size
getInventoryBySize
Parameters
company_idpath
integer
Required
Get list of products filtered by company Id
item_idpath
integer
Required
Get list of variants of item Id
variant_typepath
string
Required
Get multiple products filtered by variant type
page_noquery
integer
The page number to navigate through the given set of results
page_sizequery
integer
Number of items to retrieve in each page. Default is 10.
Default Value : 10
GET
Response
200
Product Meta.
Hide
page
object (Page)
Show
variants
array of object (ProductVariants)
A list of product variants returned in the response.
Show
Examples
Parameters
company_id:
1
item_id:
12345
variant_type:
"color"
page_no:
1
page_size:
2
Response
Get variants
getVariantsOfProducts
Retrieve all HSN codes associated with company products and provide search capabilities based on HSN code, reporting HSN, etc
Parameters
page_noquery
integer
indicates current page number
Default Value : 1
page_sizequery
integer
indicates page size
Default Value : 12
qquery
string
search using hsn code, description, reporting_hsn
typequery
string
search using type
company_idpath
integer
Required
Company Id for which HSN codes needs to be fetched
GET
Response
200
List of all HSN Codes.
Hide
items
array of object (HSNDataInsertV2)
Show
page
object (PageResponseSchema)
Show
Response
List product HSN codes
getAllProductHsnCodes
Parameters
reporting_hsnpath
string
Required
reporting_hsn
company_idpath
integer
Required
Company Id for which HSN codes needs to be fetched
GET
Response
200
Get specific HSN details. See example below or refer `HSNDataInsertV2` for details
Hide
Represents the data structure for HSN codes, including relevant tax details, descriptions, and metadata such as country code and user details of creation and modification.
country_code
string
Country code.
created_by
object (CreatedBySchema)
Show
modified_by
object (ModifiedBySchema)
Show
created_on
string
| date-time
Date and time when the HSN data was created.
description
string
Description of the HSN data.
hsn_code
string
tax_rule_id
string
Unique identifier of the tax rule.
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.
Show
type
string
Type of HSN data (goods or services).
Enum
Response
Get product HSN code
getSingleProductHSNCode
Allows to add Inventory for particular size and selling location. for associated companies
Parameters
company_idpath
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
Show
transaction_type
string
Nullable
Reason for the inventory update. Recorded in the audit-trail event for the resulting article mutation; per-row values on `payload[].transaction_type` override this top-level value. Optional; defaults to "other" when omitted.
Enum
transaction
object (InventoryTransaction)
Nullable
Audit transaction context; supersedes the flat `transaction_type` (its `type` carries the same value). All fields optional; recorded in the audit-trail event.
Show
POST
Response
200
400
Returns a success or partial success response
Hide
It is the response of the inventory update.
items
array of object (InventoryResponseItem)
Show
message
string
It is the success message of the inventory update.
success
boolean
It is the success status of the inventory update.
Response
Update inventories
updateInventories
Retrieve the history of inventory export jobs associated with the company
Parameters
company_idpath
integer
Required
It is the unique identifier of the company.
statusquery
string
Status of the export job.(Pending, Running, Success)
from_datequery
string
| date
Inventory export history filtered according to from_date.
to_datequery
string
| date
Inventory export history filtered according to from_date.
qquery
string
Inventory export history filtered according to task ID.
page_noquery
integer
The page number to navigate through the given set of results
page_sizequery
integer
Number of items to retrieve in each page. Default is 12.
Default Value : 12
GET
Response
200
Returns a list of inventory export jobs
Hide
items
array of object (InventoryJobDetailResponseSchema)
Nullable
This is the list/history of all the jobs.
Show
page
object (Page)
Show
Response
List inventory export jobs
listInventoryExport
Parameters
company_idpath
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.
Show
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
POST
Response
200
Returns a success response
Hide
created_by
string
| date-time
The user that created the job.
created_on
string
| date-time
Creation datetime of the job
filters
object (Filters)
Show
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
Response
Create inventory export
createInventoryExport
Parameters
company_idpath
integer
Required
Get list of products filtered by company Id
brand_idsquery
array of integer
Get multiple products filtered by Brand Ids
category_idsquery
array of integer
Get multiple products filtered by Category Ids
item_idsquery
array of integer
Get multiple products filtered by Item Ids
department_idsquery
array of integer
Get multiple products filtered by Department Ids
item_codequery
array of string
Get multiple products filtered by Item Code
namequery
string
Get multiple products filtered by Name (Pattern Match)
slugquery
string
Get multiple products filtered by Slug
all_identifiersquery
array of string
Get multiple products filtered by All Identifiers
qquery
string
Get multiple products filtered by q string
tagsquery
array of string
Get multiple products filtered by tags
page_noquery
integer
The page number to navigate through the given set of results
page_sizequery
integer
Number of items to retrieve in each page. Default is 10.
Default Value : 10
page_typequery
string
For pagination type value can be cursor or number. Default is number.
Default Value : number
Enum
sort_onquery
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_idquery
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.
GET
Response
200
Product Meta.
Hide
items
array of object (ProductSchemaV2)
Show
page
object (Page)
Show
Response
List products
getProducts
Users can create a product using this API, associating it with the provided company ID
Parameters
company_idpath
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)
Show
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
Specifies the type of product, such as standard, set, composite, digital, virtual_bundle, or physical_bundle. For bundle types (virtual_bundle or physical_bundle), use the category, department, and brand of the base child SKU. In this case, attributes are optional. The bundle_details attribute must be included for bundle types.
Enum
media
array of object (Media)
Nullable
List of media URLs (images, videos) associated with the product.
Maximum Items : 30
Show
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)
Show
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)
Show
requester
string
The role requesting the product operation (admin or user).
Default Value : user
Enum
return_config
object (ReturnConfig)
Required
Show
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 (TaxIdentifierV3)
Required
Show
teaser_tag
object (TeaserTag)
Show
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.
Show
variant_group
object
Variant group information for the product.
variant_media
object
Media related to product variants.
variants
object
Variants information for the product.
hs_code
string
Nullable
HS Code for the product. This is required for indian companies.
bundle_details
array of object (BundleDetails)
Nullable
List of bundle details for products that are part of a bundle.
Show
POST
Response
200
Returns a success response
Hide
success
boolean
Indicates whether the operation was successful or not.
uid
integer
A unique identifier associated with the successful operation.
Response
Create product
createProduct
Parameters
company_idpath
string
Required
Id of the company associated to product that is to be viewed.
item_idpath
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)
Show
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
Specifies the type of product, such as standard, set, composite, digital, virtual_bundle, or physical_bundle. For bundle types (virtual_bundle or physical_bundle), use the category, department, and brand of the base child SKU. In this case, attributes are optional. The bundle_details attribute must be included for bundle types.
Enum
media
array of object (Media)
Nullable
List of media URLs (images, videos) associated with the product.
Maximum Items : 30
Show
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)
Show
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)
Show
requester
string
The role requesting the product operation (admin or user).
Default Value : user
Enum
return_config
object (ReturnConfig)
Required
Show
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 (TaxIdentifierV3)
Required
Show
hs_code
string
Nullable
HS Code for the product. This is required for indian companies.
teaser_tag
object (TeaserTag)
Show
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.
Show
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.
bundle_details
array of object (BundleDetails)
List of bundle details for products that are part of a bundle. This will have child skus along with net quantity used in bundle formation.
Show
PUT
Response
200
Returns a success response
Hide
Indicates whether the operation was successful or not.
success
boolean
Response
Update a product
editProduct
Partially update an existing product in the catalog using PATCH method. This operation allows you to modify specific fields of a product without affecting other attributes. Only the fields provided in the request body will be updated, while all other existing product data remains unchanged.
For objects (e.g. attributes), merge keys shallowly: any key in the patch overrides the existing value.
For arrays of primitives (e.g. tags): replaced wholesale when present.
For arrays of objects (e.g. sizes): match on a unique identifier (seller_identifier) and apply the merge-patch per element; unmentioned elements remain unchanged.
Parameters
company_idpath
string
Required
Id of the company associated.
item_idpath
integer
Required
Item ID of the product to be patched.
Request body
_custom_json
object
Custom JSON data that can be used for additional product properties.
attributes
object
Additional attributes related to the product.
country_of_origin
string
The country where the product was manufactured or sourced.
custom_order
object (CustomOrder)
Show
description
string
A detailed description of the product. Provide base64 encoded value in input.
highlights
array of string
Product highlights or key features.
is_active
boolean
Flag to indicate if the product is active.
is_dependent
boolean
Flag to indicate if the product is dependent on other products.
media
array of object (Media)
List of media URLs (images, videos) associated with the product.
Maximum Items : 30
Show
multi_size
boolean
Indicates if the product supports multiple sizes.
name
string
The name of the product.
Maximum Length : 300
net_quantity
object (NetQuantity)
Show
no_of_boxes
integer
Number of boxes required to package the product.
product_group_tag
array of string
Tags to group products together for classification.
Maximum Items : 7
product_publish
object (ProductPublish)
Show
return_config
object (ReturnConfig)
Show
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 (ProductSizePatch)
List of sizes available for the product.
Show
tags
array of string
List of tags associated with the product.
tax_identifier
object (TaxIdentifierV3)
Show
hs_code
string
Nullable
HS Code for the product. This is required for indian companies.
teaser_tag
object (TeaserTag)
Show
template_tag
string
Template tag for the product, used for classification.
trader
array of object (Trader)
List of traders associated with the product.
Show
variant_group
object
Variant group information for the product.
variant_media
object
Media related to product variants.
variants
object
Variants information for the product.
PATCH
Response
200
Returns a success response
Hide
Indicates whether the operation was successful or not.
success
boolean
Response
Patch a product
partialUpdateProduct
Parameters
company_idpath
string
Required
Company Id of the company associated with the product to be deleted.
item_idpath
integer
Required
Id of the product to be deleted.
DEL
Response
200
404
Returns a success response
Hide
Indicates whether the operation was successful or not.
success
boolean
Response
Delete product
deleteProduct
Parameters
company_idpath
integer
Required
Company Id of the product.
item_idpath
integer
Required
Item Id of the product.
brand_uidquery
integer
Brand Id of the product.
item_codequery
string
Item code of the product.
GET
Response
200
Product object.
Hide
Schema for the GetProduct API response
data
object (ProductSchemaV2)
Show
Response
Get a product
getProduct
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_idpath
integer
Required
Id of the company associated to product that is to be viewed.
item_idpath
integer
Required
Item code of the product of which size is to be get.
seller_identifierpath
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
Show
transaction_type
string
Nullable
Reason for the inventory update. Recorded in the audit-trail event for the resulting article mutation; per-row values on `payload[].transaction_type` override this top-level value. Optional; defaults to "other" when omitted.
Enum
transaction
object (InventoryTransaction)
Nullable
Audit transaction context; supersedes the flat `transaction_type` (its `type` carries the same value). All fields optional; recorded in the audit-trail event.
Show
DEL
Response
200
400
Returns a success response
Hide
It is the response of the inventory update.
items
array of object (InventoryResponseItem)
Show
message
string
It is the success message of the inventory update.
success
boolean
It is the success status of the inventory update.
Response
Delete an inventory
deleteRealtimeInventory
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_idpath
integer
Required
Id of the company associated to product that is to be viewed.
item_idpath
integer
Required
Item code of the product of which size is to be get.
seller_identifierpath
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
Show
transaction_type
string
Nullable
Reason for the inventory update. Recorded in the audit-trail event for the resulting article mutation; per-row values on `payload[].transaction_type` override this top-level value. Optional; defaults to "other" when omitted.
Enum
transaction
object (InventoryTransaction)
Nullable
Audit transaction context; supersedes the flat `transaction_type` (its `type` carries the same value). All fields optional; recorded in the audit-trail event.
Show
POST
Response
200
400
Returns a success response
Hide
It is the response of the inventory update.
items
array of object (InventoryResponseItem)
Show
message
string
It is the success message of the inventory update.
success
boolean
It is the success status of the inventory update.
Response
Update an inventory
updateRealtimeInventory
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_idpath
integer
Required
Id of the company associated to product for that article price to be updated.
store_idpath
integer
Required
The Store Id to update price of size for specific store.
seller_identifierpath
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.
price_cost
number
The cost price of the article.
tags
array of string
Tags associated with inventory item.
transaction_type
string
Nullable
Reason for the price update. Recorded in the audit-trail event for the resulting article mutation. Optional; defaults to "other" when omitted.
Enum
transaction
object (InventoryTransaction)
Nullable
Audit transaction context; supersedes the flat `transaction_type` (its `type` carries the same value). All fields optional; recorded in the audit-trail event.
Show
POST
Response
200
422
Returns a success response
Hide
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
Response
Update an Article Price
updateLocationPrice
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_idpath
integer
Required
Id of the company associated to product for that article quantity to be updated.
store_idpath
integer
Required
The Store Id to update quantity of size for specific store.
seller_identifierpath
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
The total quantity of the inventory item. Any one of total_quantity, damaged_quantity, not_available_quantity should be provided.
damaged_quantity
integer
The damaged quantity of the inventory item. Any one of total_quantity, damaged_quantity, not_available_quantity should be provided.
not_available_quantity
integer
The not available quantity of the inventory item. Any one of total_quantity, damaged_quantity, not_available_quantity should be provided.
mode
string
Indicates whether delta or replace operation for inventory
Enum
transaction_type
string
Nullable
Reason for the quantity update. Recorded in the audit-trail event for the resulting article mutation. Optional; defaults to "other" when omitted.
Enum
transaction
object (InventoryTransaction)
Nullable
Audit transaction context; supersedes the flat `transaction_type` (its `type` carries the same value). All fields optional; recorded in the audit-trail event.
Show
POST
Response
200
422
Returns a success response
Hide
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
Response
Update an Article Quantity
updateLocationQuantity
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_idpath
integer
Required
The company id for which the detail needs to be retrieved.
categoryquery
string
Required
It is the name of the l3 cateogry
filterquery
boolean
If true, returns filtered values, else returns all the attributes
GET
Response
200
Size guide object.
Hide
Response object containing product attributes.
items
array of object (AttributeMasterSchema)
Show
Examples
Parameters
company_id:
1
category:
"activewear-t-shirts"
filter:
false
Response
List product attributes
getProductAttributes
Retrieve the attribute detail for catalog listings by attribute slug passed for a specific company.
Parameters
company_idpath
integer
Required
The company id for which the detail needs to be retrieved.
attribute_slugpath
string
Required
Slug of the attribute for which you want to view the details
GET
Response
200
Get Attribute Detail by Slug.
Hide
Detailed schema for a product attribute.
_id
array of string
description
string
details
object (AttributeMasterDetails)
Show
enabled_for_end_consumer
boolean
filters
object (AttributeMasterFilter)
Show
is_nested
boolean
logo
string
| url
meta
object (AttributeMasterMeta)
Show
name
string
schema
object (AttributeMaster)
Show
slug
string
Examples
Parameters
company_id:
1
attribute_slug:
"custom-attribute"
Response
Get attribute detail by slug
getAttribute
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_idpath
integer
Required
A `company_id` is a unique identifier for a particular seller account.
departmentquery
string
Required
A `department` is the name of a particular department.
page_noquery
integer
The page number to navigate through the given set of results
Default Value : 1
page_sizequery
integer
Number of items to retrieve in each page. Default is 12.
Default Value : 12
GET
Response
200
List of product templates.
Hide
items
array of object (ProductTemplate)
List of product templates.
Show
page
object (Page)
Show
Examples
Parameters
company_id:
1
department:
"loksabha"
page_no:
1
page_size:
12
Response
List product templates
listProductTemplate
Allows you to list all product template categories values for the departments specified for a specific company.
Parameters
company_idpath
integer
Required
A `company_id` is a unique identifier for a particular seller account.
departmentsquery
string
Required
A `department` is name of a departments whose category needs to be listed. Can specify multiple departments.
item_typequery
string
Required
An `item_type` is the type of item, it can be `set`, `standard`, `digital`, etc.
Enum
GET
Response
200
List of all categories attached to departments specified. See example below or refer `ProdcutTemplateCategoriesResponse` for details
Hide
items
array of object (CategoriesResponseSchema)
Show
page
object (Page)
Show
Examples
Parameters
company_id:
1
departments:
"loksabha"
Response
List product template categories
listProductTemplateCategories
Allows you to list all product templates global validation values for all the fields present in the database for a specific company.
Parameters
company_idpath
string
Required
A `company_id` is a unique identifier for a particular seller account.
item_typequery
string
An `item_type` defines the type of item. The default value is standard.
Enum
bulkquery
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.
GET
Response
200
422
List of fields and validation values fro each. See example below or refer `TemplatesValidationResponse` for details
Hide
data
object (TemplateGlobalValidationData)
Show
Examples
Parameters
company_id:
"value"
item_type:
"value"
bulk:
false
Response
Validate product template
validateProductGlobalTemplate
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_idpath
string
Required
Id of the company for which the size guides are to be fetched.
activequery
boolean
filter size guide on basis of active, in-active
qquery
string
Query that is to be searched.
tagquery
string
to filter size guide on basis of tag.
page_noquery
integer
The page number to navigate through the given set of results
page_sizequery
integer
Number of items to retrieve in each page. Default is 10.
Default Value : 10
brand_idquery
integer
Brand id that is to be searched.
GET
Response
200
Size guide object. See example below or refer `ListSizeGuide` for details
Hide
Represents the structure for a size guide, including metadata about size measurements, creation and modification details, and pagination information. Each size guide contains various attributes like dimensions, headers, and units for displaying size-related information.
items
array of object (SizeGuideItem)
A list of size guides, each containing detailed information about a product's dimensions, creation, and modification data.
Show
page
object (PageResponseSchema)
Show
Response
List size guides
getSizeGuides
Parameters
company_idpath
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)
Show
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.
POST
Response
200
Returns a success response
Hide
Indicates whether the operation was successful or not.
success
boolean
Response
Create size guide
createSizeGuide
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_idpath
string
Required
Id of the company associated to size guide.
idpath
string
Required
Id of the size guide to be viewed.
GET
Response
200
Size Guide Object object. See example below or refer `SizeGuideResponseSchema` for details
Hide
Represents the response structure for a size guide, including details about the guide's metadata, creation, modification, and associated information such as brand and company IDs.
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)
Show
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)
Show
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.
Response
Get size guide
getSizeGuide
Parameters
company_idpath
string
Required
Id of the company.
idpath
string
Required
Identifier 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)
Show
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.
PUT
Response
200
Returns a success response
Hide
Indicates whether the operation was successful or not.
success
boolean
Response
Update size guide
updateSizeGuide
A group of API that are used to create tax. Taxation consists of two parts: Rule and Version. The rule contains static information, such as name, description, etc. The version contains dynamic information about the tax rule, such as applicable date, tax rate, threshold price, and tracks changes to the tax rule over time.
Operations
POST
# Create Tax Rule
GET
# Get all tax rules of a company
PUT
# Update Tax Rule
DEL
# Delete a tax rule
GET
# Get tax versions for a tax rule
POST
# Create a tax version
DEL
# Delete a tax version
PUT
# Update a tax version
GET
# Get HS/SAC codes
POST
# Create HS/SAC code
POST
# Create tax component name
GET
# Get component names
Create a tax rule in a company, including its initial (live) version. The API supports both default (country-level) and region-specific versions by using optional parameters such as 'region_type' and 'areas'. This enables granular taxation rules scoped to different geographic regions.
Parameters
company_idpath
string
Required
Unique identifier of the company for which the tax rule will be created.
Request body
rule
object (TaxReqBodyRule)
Required
Show
versions
array of object (TaxReqBodyVersion)
Required
One or more tax versions to create with the rule (at least one required).
Show
POST
Response
200
Successfully created the tax rule and version.
Hide
rule
object (TaxRule)
Show
versions
object (TaxVersion)
Show
Response
Create Tax Rule
createTax
Retrieves a list of all tax rules defined for a company, along with their details.
Parameters
company_idpath
string
Required
Unique identifier of the company whose tax rules are being retrieved
qquery
string
Search query to filter tax rules
statusesquery
string
Filter tax rules based on their lifecycle status.
Enum
pagequery
integer
The page number to retrieve
limitquery
integer
Maximum number of tax rule items per page
version_statusquery
string
Filter tax rules to include only those with versions in the specified status.
Enum
GET
Response
200
A list of tax rules
Hide
items
array of object (TaxRuleItem)
List of tax rules with their versions
Show
page
object (Page)
Show
Examples
Parameters
company_id:
"1"
q:
"test 3"
statuses:
"ACTIVE"
page:
1
limit:
10
version_status:
"LIVE"
Response
Get all tax rules of a company
getAllTaxRules
Parameters
company_idpath
integer
Required
Unique identifier of the company for which the tax rule is being updated
rule_idpath
string
Required
Unique identifier of the tax rule to update
Request body
status
object (TaxStatusEnum)
Required
Enum
is_default
boolean
Required
Flag to set tax rule as the default. If a tax rule is inactive or not available for a product, the default tax rule will be applied.
name
string
Required
New name of the tax rule
PUT
Response
200
Successfully updated the tax rule
Hide
_id
string
Unique identifier of the tax rule
name
string
Name of the tax rule
description
string
Description of the tax rule
is_default
boolean
Flag to set any tax rule as default. If any tax rule is inactive on a product then default tax rule gets applied.
company_id
integer
Unique identifier of the company which the tax rule created
status
object (TaxStatusEnum)
Enum
created_on
string
| date-time
modified_on
string
| date-time
Examples
Parameters
company_id:
"1"
rule_id:
"6736e63e810235677a97a6b0"
body:
body
Response
Update Tax Rule
updateTaxRule
Deletes a tax rule and all its associated versions. Note: A rule cannot be deleted if it is set as the default or is currently assigned to any product.
To proceed with deletion, ensure you first assign another rule as the default and unlink this rule from all products.
Parameters
rule_idpath
string
Required
Unique identifier of the tax rule to be deleted
company_idpath
integer
Required
Unique identifier of the company associated with the tax rule to be deleted
DEL
Response
200
Successful deletion of the tax rule.
Hide
message
string
Message indicating the result of the deletion operation
Examples
Parameters
rule_id:
"value"
company_id:
1
Response
Delete a tax rule
deleteTaxRule
Retrieve the versions of a tax rule. You can filter results by version status.
Parameters
company_idpath
integer
Required
Unique identifier of the company for which the tax rule versoin is being retrieved
rule_idpath
string
Required
Unique identifier of the tax rule
version_statusquery
string
Filter by tax version status
Default Value : ALL
Enum
qquery
string
Case-insensitive search by region name (e.g., "john", "New York") to find matching tax versions
limitquery
string
The number of items to return per page for paginated past versions
Default Value : 10
pagequery
string
The page number for paginated past versions.
Default Value : 1
GET
Response
200
Successfully retrieved tax rule versions
Hide
items
array of object (TaxVersionDetail)
List of tax versions
Show
rule
object (TaxRule)
Show
page
object (Page)
Show
Examples
Parameters
company_id:
"1"
rule_id:
"6736e63e810235677a97a6b0"
version_status:
"ALL"
q:
"Rajasthan"
limit:
"10"
page:
"1"
Response
Get tax versions for a tax rule
getTaxVersionDetails
Creates a tax version using the provided rule_id with support for scheduled applicability and optional region-level overrides.
Parameters
company_idpath
integer
Required
Unique identifier of the company for which the tax rule is being created
rule_idpath
string
Required
Unique identifier of the tax rule
Request body
scope
string
Scope of the tax version
Enum
components
array of object (TaxComponent)
Required
List of tax components
Show
applicable_date
string
| date-time
Optional scheduled date from when this rule will come in effect. It should be at least one minute in the future from the current time.
region_type
string
Required when areas are present to denote the level (city/state/pincode) at which the version applies. Supported values follow Servicability's country hierarchy (e.g., India: state, city; UAE: sector, city); consult Servicability country-hierarchy APIs to retrieve valid levels.
areas
object (TaxGeoArea)
Show
store_ids
array of integer
Store identifiers for store-level taxation.
POST
Response
200
Successfully created tax rule.
Hide
_id
string
Unique identifier of the tax version
rule_id
string
Unique identifier of the tax rule to which this version belongs. This identifier links the tax version to its parent rule.
applicable_date
string
| date-time
The date and time when this version becomes effective and is used for taxation purposes.
This field must be at least one minute in the future relative to the current system time to ensure future scheduling of tax versions.
created_on
string
| date-time
ISO 8601 timestamp indicating when this tax version was created in the system.
Used for audit trails and version history.
modified_on
string
| date-time
ISO 8601 timestamp of the latest update to this tax version. Every modification or update to the version record updates this field, ensuring accurate audit and traceability.
company_id
integer
Unique identifier of the company for which this tax version is defined.
status
object (TaxStatusEnum)
Enum
region_type
string
Specifies the geographical region at which the tax rule version applies. Required and present when the version targets a specific region rather than the default country-level rule.
areas
object (TaxGeoArea)
Show
store_ids
array of integer
Array of store identifiers to which this tax version is scoped.
Enables store-level tax configuration, allowing companies to specify tax applicability at individual store granularity.
scope
object (TaxVersionScopeEnum)
Enum
components
array of object (TaxComponentResponseSchema)
Show
Response
Create a tax version
createTaxVersion
Deletes a tax rule using the provided rule_id. Only future/scheduled version can be deleted.
Parameters
rule_idpath
string
Required
Unique identifier of the tax rule to be deleted
version_idpath
string
Required
Unique identifier of the tax version to be deleted
company_idpath
integer
Required
Unique identifier of the company for which the tax rule is being deleted
DEL
Response
200
Successful deletion of the tax version
Hide
message
string
Message indicating the result of the deletion operation
tax_version_id
string
Unique identifier of the deleted tax version
rule_id
string
Unique identifier of the tax rule associated with the deleted version
deleted_on
string
| YYYY-MM-DDThh:mm:ss
Timestamp in ISO format specifying when the tax version was deleted
Examples
Parameters
rule_id:
"6736e63e810235677a97a6b0"
version_id:
"6736e63e810235677a97a6b9"
company_id:
"1"
Response
Delete a tax version
deleteTaxVersion
When updating a tax version, the rules differ depending on whether it is a live version (that is, its applicable_date is now or in the past) or a scheduled version (with an applicable_date in the future).
For live versions, only the component names may be modified and only when the corresponding _id also matches, while changes to fields such as applicable_date, scope, store_ids, areas, region_type, and any other properties are not allowed.
In contrast, for scheduled (future) versions, you may change the applicable_date using an ISO datetime representing the date and time the version takes effect (at the start of the local day); to avoid changing it, simply pass the current applicable_date value.
Components can be added, updated, or removed: new components may omit _id, and omitting a known _id from the request will remove that component. The scope (COUNTRY by default, or STORE or REGION) can be set; for STORE scope, store_ids are required—if not specified, the existing store_ids are used.
For REGION scope, areas are required and region_type can be provided or will default to the current setting. In all cases, component names are validated, and only one version per rule may exist for each local day.
Parameters
rule_idpath
string
Required
Unique identifier of the tax rule to be updated
version_idpath
string
Required
Unique identifier of the tax version to be updated
company_idpath
integer
Required
Unique identifier of the company for which the tax rule is being updated
Request body
components
array of object (TaxComponentResponseSchema)
Required
Show
applicable_date
string
| date-time
Required
It is the date from when this rule will come in effect. It should be at least one minute in the future from the current time.
region_type
string
Required when areas are present to denote the level (city/state/pincode) at which the version applies. Supported region types are derived from Servicability's country hierarchy (e.g., India: state, city; UAE: sector, city). Use the Servicability country-hierarchy API to read the allowed levels.
areas
object (TaxGeoArea)
Show
store_ids
array of integer
Store identifiers for store-level taxation.
PUT
Response
200
Successful update of the tax version
Hide
_id
string
Unique identifier of the tax version
rule_id
string
Unique identifier of the tax rule to which this version belongs. This identifier links the tax version to its parent rule.
applicable_date
string
| date-time
The date and time when this version becomes effective and is used for taxation purposes.
This field must be at least one minute in the future relative to the current system time to ensure future scheduling of tax versions.
created_on
string
| date-time
ISO 8601 timestamp indicating when this tax version was created in the system.
Used for audit trails and version history.
modified_on
string
| date-time
ISO 8601 timestamp of the latest update to this tax version. Every modification or update to the version record updates this field, ensuring accurate audit and traceability.
company_id
integer
Unique identifier of the company for which this tax version is defined.
status
object (TaxStatusEnum)
Enum
region_type
string
Specifies the geographical region at which the tax rule version applies. Required and present when the version targets a specific region rather than the default country-level rule.
areas
object (TaxGeoArea)
Show
store_ids
array of integer
Array of store identifiers to which this tax version is scoped.
Enables store-level tax configuration, allowing companies to specify tax applicability at individual store granularity.
scope
object (TaxVersionScopeEnum)
Enum
components
array of object (TaxComponentResponseSchema)
Show
Examples
Parameters
rule_id:
"6736e63e810235677a97a6b0"
version_id:
"6736e63e810235677a97a6b9"
company_id:
"1"
Response
Update a tax version
updateTaxVersion
Retrieve a list of Harmonized System (HS)) or Service Accounting Code (SAC)) codes for a company.
HS codes are used to classify goods in international trade, while SAC codes classify services for taxation purposes.
Supports optional filtering and pagination.
Parameters
company_idpath
integer
Required
Unique identifier of the company for which to retrieve HS/SAC codes.
pagequery
integer
The page number for pagination.
Default Value : 1
limitquery
integer
The number of items to return per page.
Default Value : 50
typequery
string
Filter by HS/SAC code type.
Enum
qquery
string
Search query to filter HS/SAC codes by code or description.
GET
Response
200
Successfully retrieved HS/SAC codes.
Hide
items
array of object (HSCodeItem)
Array of HS code responses
Show
page
object (Page)
Show
Response
Get HS/SAC codes
getHsCodes
Create a new Harmonized System (HS) or Service Accounting Code (SAC). These codes are used for product and service identification in taxation and compliance processes.
Parameters
company_idpath
integer
Required
Unique identifier of the company for which the HS/SAC code is being created
Request body
created_on
string
| date-time
Timestamp when the HS/SAC code entry was created.
modified_on
string
| date-time
Timestamp of the most recent modification to this HS/SAC code entry.
type
string
Required
Type of the code for services
Enum
company_id
integer
Unique identifier of the company to which this HS/SAC code is associated.
description
string
Description providing details about the HS or SAC code
hs_code
string
Required
The HS or SAC value being registered for the company.
_id
string
Unique identifier for the HS/SAC code entry
country_iso
string
ISO 3166-1 alpha-2 country code representing the country for which this code is registered.
POST
Response
200
Successfully created HS/SAC code
Hide
created_on
string
| date-time
Timestamp when the HS/SAC code entry was created.
modified_on
string
| date-time
Timestamp of the most recent modification to this HS/SAC code entry.
type
string
Type of the code for services
Enum
company_id
integer
Unique identifier of the company to which this HS/SAC code is associated.
description
string
Description providing details about the HS or SAC code
hs_code
string
The HS or SAC value being registered for the company.
_id
string
Unique identifier for the HS/SAC code entry
country_iso
string
ISO 3166-1 alpha-2 country code representing the country for which this code is registered.
Examples
Parameters
company_id:
1
body:
body
Response
Create HS/SAC code
createHsCode
Tax components represent different types of taxes that may be applied to products or transactions,
such as sales tax, value-added tax (VAT), goods and services tax, consumption tax,
or other region-specific taxation systems. This endpoint allows companies to define and
customize the names of tax components according to their local tax regulations and business requirements.
Parameters
company_idpath
integer
Required
Unique identifier of the company for which tax component names are being defined.
Request body
name
string
Required
Name of the tax component
POST
Response
200
Successfully created component names
Hide
Tax components are resources that represent different types of taxes that may be
applied to products or transactions, such as sales tax, value-added tax (VAT),
goods and services tax, consumption tax, or other region-specific taxation systems.
_id
string
Unique identifier for the tax component name
company_id
integer
Unique identifier of the company to which this tax component name is associated.
name
string
Name of the tax component
description
string
Description of the tax component name
created_on
string
| date-time
Timestamp when the component name was created
modified_on
string
| date-time
Timestamp when the component name was last modified
Examples
Parameters
Parameters are not required.
Response
Create tax component name
createTaxComponentName
Parameters
company_idpath
integer
Required
Unique identifier of the company whose tax component names are to be fetched.
GET
Response
200
Successfully retrieved component names
Hide
items
array of object (TaxComponentResponseSchema)
Show
page
object (Page)
Show
Examples
Parameters
Parameters are not required.
Response