Sitecore OrderCloud Documentation

docs

Portal Login

Partially update a product variant.

PATCH

/products/{productID}/variants/{variantID}

200

Roles

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

FullAccessProductAdmin

Parameters

NameTypeDescriptionPossible Values
productIDRequiredstringID of the product.---
variantIDRequiredstringID of the variant.---

Request Body

PropertyTypeFormatMax LengthPossible Values
IDstring---100 characters---
Namestring---100 characters---
Descriptionstring---2000 characters---
Activeboolean---------

ShipWeightnumberfloat------
ShipHeightnumberfloat------
ShipWidthnumberfloat------
ShipLengthnumberfloat------
Inventoryobject---------
xpobject---------

Response Body

PropertyTypeFormatMax LengthPossible Values
IDstring---100 characters---
Namestring---100 characters---
Descriptionstring---2000 characters---
Activeboolean---------

ShipWeightnumberfloat------
ShipHeightnumberfloat------
ShipWidthnumberfloat------
ShipLengthnumberfloat------
Inventoryobject---------
SpecsRead Onlyarray---------
xpobject---------

Partially update a product variant.

PATCH

/products/{productID}/variants/{variantID}

200

Roles

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

FullAccessProductAdmin

Parameters

NameTypeDescriptionPossible Values
productIDRequiredstringID of the product.---
variantIDRequiredstringID of the variant.---

Request Body

PropertyTypeFormatMax LengthPossible Values
IDstring---100 characters---
Namestring---100 characters---
Descriptionstring---2000 characters---
Activeboolean---------

ShipWeightnumberfloat------
ShipHeightnumberfloat------
ShipWidthnumberfloat------
ShipLengthnumberfloat------
Inventoryobject---------
xpobject---------

Response Body

PropertyTypeFormatMax LengthPossible Values
IDstring---100 characters---
Namestring---100 characters---
Descriptionstring---2000 characters---
Activeboolean---------

ShipWeightnumberfloat------
ShipHeightnumberfloat------
ShipWidthnumberfloat------
ShipLengthnumberfloat------
Inventoryobject---------
SpecsRead Onlyarray---------
xpobject---------
Sitecore Logo

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

Contact Us
Privacy Policy
Sitecore