docs

Partially update a product.

PATCH

/products/{productID}

200

Roles

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

FullAccessProductAdmin

Parameters

Name		Type	Description	Possible Values
productID	Required	`string`	ID of the product.	---

Request Body

Property Type Format Max Length Possible Values

OwnerID

string

---

---

---

DefaultPriceScheduleID

string

---

---

---

AutoForward

boolean

---

---

---

ID string --- 100 characters ---

ParentID

string

---

---

---

IsParent

boolean

---

---

---

Name string --- 100 characters ---

Description string --- 2000 characters ---

QuantityMultiplier

integer

int32

---

---

ShipWeight number float --- ---

ShipHeight number float --- ---

ShipWidth number float --- ---

ShipLength number float --- ---

Active

boolean

---

---

---

ShipFromAddressID

string

---

---

---

Inventory object --- --- ---

DefaultSupplierID

string

---

---

---

AllSuppliersCanSell

boolean

---

---

---

Returnable boolean --- --- ---

xp object --- --- ---

Response Body

Property Type Format Max Length Possible Values

OwnerID

string

---

---

---

DefaultPriceScheduleID

string

---

---

---

AutoForward

boolean

---

---

---

ID string --- 100 characters ---

ParentID

string

---

---

---

IsParent

boolean

---

---

---

IsBundle

Read Only

boolean

---

---

---

Name string --- 100 characters ---

Description string --- 2000 characters ---

QuantityMultiplier

integer

int32

---

---

ShipWeight number float --- ---

ShipHeight number float --- ---

ShipWidth number float --- ---

ShipLength number float --- ---

Active

boolean

---

---

---

SpecCount

Read Only

integer

int32

---

---

VariantCount

Read Only

integer

int32

---

---

ShipFromAddressID

string

---

---

---

Inventory object --- --- ---

DefaultSupplierID

string

---

---

---

AllSuppliersCanSell

boolean

---

---

---

Returnable boolean --- --- ---

xp object --- --- ---

Partially update a product.

PATCH

/products/{productID}

200

Roles

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

FullAccessProductAdmin

Parameters

Name		Type	Description	Possible Values
productID	Required	`string`	ID of the product.	---

Request Body

Property Type Format Max Length Possible Values

OwnerID

string

---

---

---

DefaultPriceScheduleID

string

---

---

---

AutoForward

boolean

---

---

---

ID string --- 100 characters ---

ParentID

string

---

---

---

IsParent

boolean

---

---

---

Name string --- 100 characters ---

Description string --- 2000 characters ---

QuantityMultiplier

integer

int32

---

---

ShipWeight number float --- ---

ShipHeight number float --- ---

ShipWidth number float --- ---

ShipLength number float --- ---

Active

boolean

---

---

---

ShipFromAddressID

string

---

---

---

Inventory object --- --- ---

DefaultSupplierID

string

---

---

---

AllSuppliersCanSell

boolean

---

---

---

Returnable boolean --- --- ---

xp object --- --- ---

Response Body

Property Type Format Max Length Possible Values

OwnerID

string

---

---

---

DefaultPriceScheduleID

string

---

---

---

AutoForward

boolean

---

---

---

ID string --- 100 characters ---

ParentID

string

---

---

---

IsParent

boolean

---

---

---

IsBundle

Read Only

boolean

---

---

---

Name string --- 100 characters ---

Description string --- 2000 characters ---

QuantityMultiplier

integer

int32

---

---

ShipWeight number float --- ---

ShipHeight number float --- ---

ShipWidth number float --- ---

ShipLength number float --- ---

Active

boolean

---

---

---

SpecCount

Read Only

integer

int32

---

---

VariantCount

Read Only

integer

int32

---

---

ShipFromAddressID

string

---

---

---

Inventory object --- --- ---

DefaultSupplierID

string

---

---

---

AllSuppliersCanSell

boolean

---

---

---

Returnable boolean --- --- ---

xp object --- --- ---