Create or update a product

PUT
/products/{productID}

Description

If an object with the same ID already exists, it will be overwritten.

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.---

Request Body

PropertyTypeFormatMax Length
DefaultPriceScheduleIDstring------
AutoForwardboolean------
If true, when this product is ordered by a Buyer, it will automatically be added to a new Order from the Seller to the Default Supplier and submitted. Requires a valid DefaultSupplierID.
IDstring------
Name
Required
string---100 characters
Descriptionstring---2000 characters
QuantityMultiplier
Required
integerint32---
ShipWeightnumberfloat---
ShipHeightnumberfloat---
ShipWidthnumberfloat---
ShipLengthnumberfloat---
Activeboolean------
ShipFromAddressIDstring------
Inventoryobject------
PropertyTypeFormatMax Length
Enabledboolean------
NotificationPointintegerint32---
VariantLevelTrackingboolean------
OrderCanExceedboolean------
QuantityAvailableintegerint32---
Automatically decrements on order submit.
DefaultSupplierIDstring------
xpobject------

Response Body

PropertyTypeFormatMax Length
OwnerID
Read Only
string------
ID of the Seller or Supplier org that created the Product.
DefaultPriceScheduleIDstring------
AutoForwardboolean------
If true, when this product is ordered by a Buyer, it will automatically be added to a new Order from the Seller to the Default Supplier and submitted. Requires a valid DefaultSupplierID.
IDstring------
Namestring---100 characters
Descriptionstring---2000 characters
QuantityMultiplierintegerint32---
ShipWeightnumberfloat---
ShipHeightnumberfloat---
ShipWidthnumberfloat---
ShipLengthnumberfloat---
Activeboolean------
SpecCount
Read Only
integerint32---
VariantCount
Read Only
integerint32---
ShipFromAddressIDstring------
Inventoryobject------
PropertyTypeFormatMax Length
Enabledboolean------
NotificationPointintegerint32---
VariantLevelTrackingboolean------
OrderCanExceedboolean------
QuantityAvailableintegerint32---
Automatically decrements on order submit.
LastUpdated
Read Only
stringdate-time---
DefaultSupplierIDstring------
xpobject------