Create a new product

POST
/products

Description

If ID is provided and an object with that ID already exists, a 409 (conflict) error is returned.

Roles

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

FullAccess
ProductAdmin

Request Body

PropertyTypeFormatMax LengthPossible Values
OwnerIDstring---------

DefaultPriceScheduleIDstring---------

AutoForwardboolean---------

IDstring---------
Name
Required
string---100 characters---
Descriptionstring---2000 characters---
QuantityMultiplierintegerint32------

ShipWeightnumberfloat------
ShipHeightnumberfloat------
ShipWidthnumberfloat------
ShipLengthnumberfloat------
Activeboolean---------

ShipFromAddressIDstring---------

Inventoryobject---------
PropertyTypeFormatMax LengthPossible Values
Enabledboolean---------

NotificationPointintegerint32------

VariantLevelTrackingboolean---------

OrderCanExceedboolean---------

QuantityAvailableintegerint32------

DefaultSupplierIDstring---------

AllSuppliersCanSellboolean---------

xpobject---------

Response Body

PropertyTypeFormatMax LengthPossible Values
OwnerIDstring---------

DefaultPriceScheduleIDstring---------

AutoForwardboolean---------

IDstring---------
Namestring---100 characters---
Descriptionstring---2000 characters---
QuantityMultiplierintegerint32------

ShipWeightnumberfloat------
ShipHeightnumberfloat------
ShipWidthnumberfloat------
ShipLengthnumberfloat------
Activeboolean---------

SpecCount
Read Only
integerint32------

VariantCount
Read Only
integerint32------

ShipFromAddressIDstring---------

Inventoryobject---------
PropertyTypeFormatMax LengthPossible Values
Enabledboolean---------

NotificationPointintegerint32------

VariantLevelTrackingboolean---------

OrderCanExceedboolean---------

QuantityAvailableintegerint32------

LastUpdated
Read Only
stringdate-time------
DefaultSupplierIDstring---------

AllSuppliersCanSellboolean---------

xpobject---------