Product Variants

Master Variants

Variant list

get

Get list of varient

Query parameters

limitintegerOptional

offsetintegerOptional

countintegerOptional

Header parameters

AuthorizationstringRequired

Responses

200

success response

*/*

statusintegerOptionalDefault: 1

messagestringOptionalDefault: Successfully got count " or " Successfully got the complete list of varients.

get/variants

GET /variants HTTP/1.1
Authorization: text
Accept: */*

200

success response

{
  "status": 1,
  "message": "Successfully got count \" or \" Successfully got the complete list of varients."
}

Create varient

post

Add a varient

Header parameters

AuthorizationstringRequired

Body

namestringOptional

typestringOptional

sortOrderinteger · int32Optional

Responses

200

success response

application/json

namestringOptional

sortOrderinteger · int32Optional

typestringOptional

createdDatestring · date-timeOptional

idinteger · int32Optional

400

error response

application/json

post/variants

POST /variants HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 96

"name='text'&type='text'&sortOrder=1&varientsValue=[{'valueName':'text','sortOrder':1}]"

{
  "name": "text",
  "sortOrder": 1,
  "type": "text",
  "createdDate": "2026-01-01T00:00:00.000Z",
  "id": 1
}

update variant

put

Update a variant

Path parameters

idintegerRequired

Header parameters

AuthorizationstringRequired

Body

namestringOptional

typestringOptional

sortOrderinteger · int32Optional

Responses

200

success response

application/json

createdByinteger · int32Optional

createdDatestring · date-timeOptional

modifiedByintegerOptional

modifiedDatestring · date-timeOptional

idinteger · int32Optional

typestringOptional

namestringOptional

sortOrderinteger · int32Optional

400

error response

application/json

put/variants/{id}

PUT /variants/{id} HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 103

"name='text'&type='text'&sortOrder=1&varientsValue=[{'id':1,'valueName':'text','sortOrder':1}]"

{
  "createdBy": 1,
  "createdDate": "2026-01-01T00:00:00.000Z",
  "modifiedBy": 1,
  "modifiedDate": "2026-01-01T00:00:00.000Z",
  "id": 1,
  "type": "text",
  "name": "text",
  "sortOrder": 1
}

Delete varient

delete

Delete a varient

Path parameters

idintegerRequired

Header parameters

AuthorizationstringRequired

Responses

200

success response

*/*

statusintegerOptionalDefault: 1

messagestringOptionalDefault: Successfully deleted the varient.

400

error response

*/*

delete/variants/{id}

DELETE /variants/{id} HTTP/1.1
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully deleted the varient."
}

Variant detail

get

Get a detail of variant

Query parameters

idintegerOptional

Header parameters

AuthorizationstringRequired

Responses

200

success response

*/*

statusintegerOptionalDefault: 1

messagestringOptionalDefault: Successfully got varients detail

400

error response

*/*

get/variants/varients-detail

GET /variants/varients-detail HTTP/1.1
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully got varients detail"
}

Admin Product Variants

Product varient List

get

Get list of product varient

Query parameters

limitintegerOptional

offsetintegerOptional

keywordstringOptional

skustringOptional

statusstringOptional

priceintegerOptional

countintegerOptional

Header parameters

AuthorizationstringRequired

Responses

200

success response

*/*

statusintegerOptionalDefault: 1

messagestringOptionalDefault: Successfully got product lists count. " or " Successfully got the complete product list.

get/product-variants

GET /product-variants HTTP/1.1
Authorization: text
Accept: */*

200

success response

{
  "status": 1,
  "message": "Successfully got product lists count. \" or \" Successfully got the complete product list."
}

Product variants update

post

Update a product varient

Path parameters

idintegerRequired

Header parameters

AuthorizationstringRequired

Body

productIdinteger · int32Optional

productVarientinteger[]Optional

Responses

200

success response

application/json

statusintegerOptionalDefault: 1

messagestringOptionalDefault: Successfully updated the Product.

400

error response

application/json

post/product-variants/{id}

POST /product-variants/{id} HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 236

"productId=1&productVarient=[1]&productVarientOption=[{'id':1,'varientName':'text','price':'text','sku':'text','isActive':1,'quantity':1,'optionValue':[1],'optionImage':[{'image':'text','containerName':'text','defaultImage':1}]}]"

{
  "status": 1,
  "message": "Successfully updated the Product."
}

Delete product variant

delete

Delete a product variant

Path parameters

idintegerRequired

Header parameters

AuthorizationstringRequired

Responses

200

success response

*/*

statusintegerOptionalDefault: 1

messagestringOptionalDefault: Successfully deleted.

400

error response

*/*

delete/product-variants/{id}

DELETE /product-variants/{id} HTTP/1.1
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully deleted."
}

Product varient detail

get

Get detail of product varient

Path parameters

idintegerRequired

Header parameters

AuthorizationstringRequired

Responses

200

success response

*/*

statusintegerOptionalDefault: 1

messagestringOptionalDefault: Successfully get productDetail

get/api/product-variants/product-detail/{id}

GET /api/product-variants/product-detail/{id} HTTP/1.1
Authorization: text
Accept: */*

200

success response

{
  "status": 1,
  "message": "Successfully get productDetail"
}

Product variant inventory list

get

Get list of product variant inventory list

Query parameters

limitintegerOptional

offsetintegerOptional

keywordstringOptional

skustringOptional

statusstringOptional

priceintegerOptional

countintegerOptional

Header parameters

AuthorizationstringRequired

Responses

200

success response

*/*

statusintegerOptionalDefault: 1

messagestringOptionalDefault: Successfully got count " or " Successfully got the complete product list.

400

error response

*/*

get/product-variants/product-varient-inventory-list

GET /product-variants/product-varient-inventory-list HTTP/1.1
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully got count  \" or \" Successfully got the complete product list."
}

Product variant update stock

post

Update product variant stock

Header parameters

AuthorizationstringRequired

Body

productIdinteger · int32Optional

hasStockinteger · int32Optional

Responses

200

success response

application/json

createdByinteger · int32Optional

createdDatestring · date-timeOptional

modifiedByinteger · int32Optional

modifiedDatestring · date-timeOptional

productIdinteger · int32Optional

skustringOptional

upcstringOptional

hsnstringOptional

locationstringOptional

quantityinteger · int32Optional

minimumQuantityinteger · int32Optional

subtractStockinteger · int32Optional

stockStatusIdinteger · int32Optional

quotationAvailableinteger · int32Optional

imagestringOptional

imagePathstringOptional

manufacturerIdinteger · int32Optional

shippinginteger · int32Optional

serviceChargesstringOptional

taxTypeinteger · int32Optional

taxValueinteger · int32Optional

pricestringOptional

priceUpdateFileLogIdinteger · int32Optional

dateAvailablestringOptional

sortOrderinteger · int32Optional

namestringOptional

descriptionstringOptional

amountstringOptional

keywordsstringOptional

discountinteger · int32Optional

deleteFlaginteger · int32Optional

isFeaturedinteger · int32Optional

todayDealsinteger · int32Optional

conditioninteger · int32Optional

ratinginteger · int32Optional

wishListStatusinteger · int32Optional

productSlugstringOptional

isActiveinteger · int32Optional

widthstringOptional

heightstringOptional

lengthstringOptional

weightstringOptional

hasStockinteger · int32Optional

isSimplifiedinteger · int32Optional

ownerinteger · int32Optional

isCommoninteger · int32Optional

skuIdinteger · int32Optional

hasTirePriceinteger · int32Optional

outOfStockThresholdinteger · int32Optional

notifyMinQuantityinteger · int32Optional

minQuantityAllowedCartinteger · int32Optional

maxQuantityAllowedCartinteger · int32Optional

enableBackOrdersinteger · int32Optional

pincodeBasedDeliveryinteger · int32Optional

attributeKeywordstringOptional

settedAsCommonOninteger · int32Optional

400

error response

application/json

post/product-variants/product-varient-update-stock

POST /product-variants/product-varient-update-stock HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 178

"productId=1&hasStock=1&productStock=[{'skuId':1,'outOfStockThreshold':1,'notifyMinQuantity':1,'minQuantityAllowedCart':1,'maxQuantityAllowedCart':1,'enableBackOrders':1}]"

{
  "createdBy": 1,
  "createdDate": "2026-01-01T00:00:00.000Z",
  "modifiedBy": 1,
  "modifiedDate": "2026-01-01T00:00:00.000Z",
  "productId": 1,
  "sku": "text",
  "upc": "text",
  "hsn": "text",
  "location": "text",
  "quantity": 1,
  "minimumQuantity": 1,
  "subtractStock": 1,
  "stockStatusId": 1,
  "quotationAvailable": 1,
  "image": "text",
  "imagePath": "text",
  "manufacturerId": 1,
  "shipping": 1,
  "serviceCharges": "text",
  "taxType": 1,
  "taxValue": 1,
  "price": "text",
  "priceUpdateFileLogId": 1,
  "dateAvailable": "text",
  "sortOrder": 1,
  "name": "text",
  "description": "text",
  "amount": "text",
  "keywords": "text",
  "discount": 1,
  "deleteFlag": 1,
  "isFeatured": 1,
  "todayDeals": 1,
  "condition": 1,
  "rating": 1,
  "wishListStatus": 1,
  "productSlug": "text",
  "isActive": 1,
  "width": "text",
  "height": "text",
  "length": "text",
  "weight": "text",
  "hasStock": 1,
  "isSimplified": 1,
  "owner": 1,
  "isCommon": 1,
  "skuId": 1,
  "hasTirePrice": 1,
  "outOfStockThreshold": 1,
  "notifyMinQuantity": 1,
  "minQuantityAllowedCart": 1,
  "maxQuantityAllowedCart": 1,
  "enableBackOrders": 1,
  "pincodeBasedDelivery": 1,
  "attributeKeyword": "text",
  "settedAsCommonOn": 1
}

Product list

get

Get list of complete product list

Query parameters

limitintegerOptional

offsetintegerOptional

countintegerOptional

Header parameters

AuthorizationstringRequired

Responses

200

success response

*/*

statusintegerOptionalDefault: 1

messagestringOptionalDefault: Successfully got count " or " Successfully got the complete product list.

get/api/product-variants/update-product-id-sku

GET /api/product-variants/update-product-id-sku HTTP/1.1
Authorization: text
Accept: */*

200

success response

{
  "status": 1,
  "message": "Successfully got count \" or \" Successfully got the complete product list."
}

Store Product Variants

Product varient detail

get

Get a product variant detail

Path parameters

idintegerRequired

Header parameters

AuthorizationstringRequired

Responses

200

success response

*/*

statusintegerOptionalDefault: 1

messagestringOptionalDefault: Successfully get productDetail

400

error response

*/*

get/store-product-variants/product-detail/{id}

GET /store-product-variants/product-detail/{id} HTTP/1.1
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully get productDetail"
}