Partially update a product variant

PATCH
/products/{productID}/variants/{variantID}

Roles

At least one of the roles below is required to access this endpoint

FullAccess
ProductAdmin

Parameters

NameTypeDescriptionDefault (ordered by priority)
productIDstringID of the product.---
variantIDstringID of the variant.---

Request Body

PropertyTypeFormatMax Length
IDstring------
Namestring------
Descriptionstring---2000 characters
Activeboolean------
ShipWeightnumberfloat---
ShipHeightnumberfloat---
ShipWidthnumberfloat---
ShipLengthnumberfloat---
Inventoryobject------
PropertyTypeFormatMax Length
QuantityAvailableintegerint32---
xpobject------

Response Body

PropertyTypeFormatMax Length
IDstring------
Namestring------
Descriptionstring---2000 characters
Activeboolean------
ShipWeightnumberfloat---
ShipHeightnumberfloat---
ShipWidthnumberfloat---
ShipLengthnumberfloat---
Inventoryobject------
PropertyTypeFormatMax Length
QuantityAvailableintegerint32---
LastUpdated
Read Only
stringdate-time---
Specs
Read Only
array------
PropertyTypeFormatMax Length
SpecID
Read Only
string------
Name
Read Only
string------
OptionID
Read Only
string------
Value
Read Only
string---2000 characters
PriceMarkupType
Read Only
string------
PriceMarkup
Read Only
numberfloat---
xpobject------