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

NameTypeDescriptionDefault (ordered by priority)
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.OwnerID, Name, ID, !OwnerID, !Name, !ID
pageintegerPage of results to return. Default: 1---
pageSizeintegerNumber of results to return per page. Default: 20, max: 100.---
filtersobjectAny additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'---

Response Body

PropertyTypeFormatMax Length
Itemsarray------
PropertyTypeFormatMax Length
IDstring------
Namestring------
Descriptionstring---2000 characters
Activeboolean------
ShipWeightnumberfloat---
ShipHeightnumberfloat---
ShipWidthnumberfloat---
ShipLengthnumberfloat---
Inventoryobject------
PropertyTypeFormatMax Length
QuantityAvailableintegerint32---
LastUpdated
Read Only
stringdate-time---
Specs
Read Only
array------
PropertyTypeFormatMax Length
SpecID
Read Only
string------
Name
Read Only
string------
OptionID
Read Only
string------
Value
Read Only
string---2000 characters
PriceMarkupType
Read Only
string------
PriceMarkup
Read Only
numberfloat---
xpobject------
Metaobject------
PropertyTypeFormatMax Length
Pageintegerint32---
PageSizeintegerint32---
TotalCountintegerint32---
TotalPagesintegerint32---
ItemRangearray------