Sitecore Ordercloud

Get a list of product variants

GET
/products/{productID}/variants

Roles

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

FullAccess
ProductAdmin
ProductReader

Parameters

NameTypeDescriptionPossible Values
productIDstringID of the product.---
searchstringWord or phrase to search for.---
searchOnarrayComma-delimited list of fields to search on.ID, Name, Description
sortByarrayComma-delimited list of fields to sort by.ID, Name, !ID, !Name
pageintegerPage of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.---
pageSizeintegerNumber of results to return per page. Default: 20, max: 100.---
filtersobjectAn object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'---

Response Body

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

ShipWeightnumberfloat------
ShipHeightnumberfloat------
ShipWidthnumberfloat------
ShipLengthnumberfloat------
Inventoryobject---------
PropertyTypeFormatMax LengthPossible Values
QuantityAvailableintegerint32------
LastUpdated
Read Only
stringdate-time------
Specs
Read Only
array---------
PropertyTypeFormatMax LengthPossible Values
SpecID
Read Only
string---------
Name
Read Only
string---------
OptionID
Read Only
string---------
Value
Read Only
string---2000 characters---
PriceMarkupType
Read Only
string------NoMarkup, AmountPerQuantity, AmountTotal, Percentage
PriceMarkup
Read Only
numberfloat------
xpobject---------
Metaobject---------
PropertyTypeFormatMax LengthPossible Values
Pageintegerint32------
PageSizeintegerint32------
TotalCountintegerint32------
TotalPagesintegerint32------
ItemRangearray---------
NextPageKeystring---------