Get a list of products

GET
/products

Roles

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

FullAccess
ProductAdmin
ProductReader

Parameters

NameTypeDescriptionDefault (ordered by priority)
catalogIDstringID of the catalog.---
categoryIDstringID of the category.---
supplierIDstringID of the supplier.---
searchstringWord or phrase to search for.---
searchOnarrayComma-delimited list of fields to search on.ID, Name, Description
searchTypestringType of search to perform. Possible values: AnyTerm (default), AllTermsAnyField, AllTermsSameField, ExactPhrase, ExactPhrasePrefix.---
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
OwnerID
Read Only
string------
ID of the Seller or Supplier org that created the Product.
DefaultPriceScheduleIDstring------
AutoForwardboolean------
If true, when this product is ordered by a Buyer, it will automatically be added to a new Order from the Seller to the Default Supplier and submitted. Requires a valid DefaultSupplierID.
IDstring------
Namestring---100 characters
Descriptionstring---2000 characters
QuantityMultiplierintegerint32---
ShipWeightnumberfloat---
ShipHeightnumberfloat---
ShipWidthnumberfloat---
ShipLengthnumberfloat---
Activeboolean------
SpecCount
Read Only
integerint32---
VariantCount
Read Only
integerint32---
ShipFromAddressIDstring------
Inventoryobject------
PropertyTypeFormatMax Length
Enabledboolean------
NotificationPointintegerint32---
VariantLevelTrackingboolean------
OrderCanExceedboolean------
QuantityAvailableintegerint32---
Automatically decrements on order submit.
LastUpdated
Read Only
stringdate-time---
DefaultSupplierIDstring------
xpobject------
Metaobject------
PropertyTypeFormatMax Length
Facetsarray------
PropertyTypeFormatMax Length
Namestring------
XpPathstring------
Valuesarray------
PropertyTypeFormatMax Length
Valuestring------
Countintegerint32---
xpobject------
Pageintegerint32---
PageSizeintegerint32---
TotalCountintegerint32---
TotalPagesintegerint32---
ItemRangearray------