Sitecore OrderCloud Documentation

docs

Portal login

Create a new product.

POST

/products

201

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.

FullAccessProductAdmin

Request Body

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

DefaultPriceScheduleIDstring---------

AutoForwardboolean---------

IDstring---100 characters---
ParentIDstring---------

IsParentboolean---------

NameRequiredstring---100 characters---
Descriptionstring---2000 characters---
QuantityMultiplierintegerint32------

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

ShipFromAddressIDstring---------

Inventoryobject---------
DefaultSupplierIDstring---------

AllSuppliersCanSellboolean---------

Returnableboolean---------
xpobject---------

Response Body

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

DefaultPriceScheduleIDstring---------

AutoForwardboolean---------

IDstring---100 characters---
ParentIDstring---------

IsParentboolean---------

IsBundleRead Onlyboolean---------

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

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

SpecCountRead Onlyintegerint32------

VariantCountRead Onlyintegerint32------

ShipFromAddressIDstring---------

Inventoryobject---------
DefaultSupplierIDstring---------

AllSuppliersCanSellboolean---------

Returnableboolean---------
xpobject---------

Create a new product.

POST

/products

201

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.

FullAccessProductAdmin

Request Body

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

DefaultPriceScheduleIDstring---------

AutoForwardboolean---------

IDstring---100 characters---
ParentIDstring---------

IsParentboolean---------

NameRequiredstring---100 characters---
Descriptionstring---2000 characters---
QuantityMultiplierintegerint32------

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

ShipFromAddressIDstring---------

Inventoryobject---------
DefaultSupplierIDstring---------

AllSuppliersCanSellboolean---------

Returnableboolean---------
xpobject---------

Response Body

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

DefaultPriceScheduleIDstring---------

AutoForwardboolean---------

IDstring---100 characters---
ParentIDstring---------

IsParentboolean---------

IsBundleRead Onlyboolean---------

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

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

SpecCountRead Onlyintegerint32------

VariantCountRead Onlyintegerint32------

ShipFromAddressIDstring---------

Inventoryobject---------
DefaultSupplierIDstring---------

AllSuppliersCanSellboolean---------

Returnableboolean---------
xpobject---------
Sitecore Logo

© Copyright 2024, Sitecore OrderCloud®. All rights reserved.

Contact Us
Privacy Policy
Sitecore