v1

latestOpenAPI 3.1.02026-07-241660500.9 KB

Update Variant

put/v3/variant

Query parameters

idstring required

Variant ID

Request body

productIdinteger required
namestring
pricenumber float
costnumber float
onHandinteger

Product Inventory

displayColorstring
primaryIdstring
secondaryIdstring
propertiesobject

Response

201

idinteger
namestring
clientNumberstring
descriptionstring
taxCodestring
activeboolean
modifiedstring
createdstring
deletedboolean
taxableboolean
tagsobject[]
minPricestring
maxPricestring
availableCountinteger
quantitySoldinteger
collectionNamestring
displayImageDefaultboolean

Example response

{
  "id": 477764,
  "name": "Test Product",
  "clientNumber": "0.690839114527218",
  "description": "Product for Testing",
  "active": true,
  "modified": "2021-09-15T17:14:51.33Z",
  "created": "2021-09-15T15:53:43.793Z",
  "taxable": true,
  "minPrice": "1",
  "maxPrice": "1",
  "availableCount": 150,
  "collectionName": "test collection",
  "displayImageDefault": true
}