Get a list of products visible to this user

GET
/me/products

Description

Only available to Buyer Users.

Roles

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

FullAccess
Shopper

Parameters

NameTypeDescriptionPossible Values
catalogIDstringID of the catalog.---
categoryIDstringID of the category.---
depthstringIndicates how deep down the category hierarchy to return results. Valid values are a number of 1 or greater, or 'all'. Relative to CategoryID if specified, otherwise top level of the Catalog. Default is 'all'.---
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.AnyTerm, 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 LengthPossible Values
Itemsarray---------
PropertyTypeFormatMax LengthPossible Values
PriceSchedule
Read Only
object---------
PropertyTypeFormatMax LengthPossible Values
ID
Read Only
string---------
Name
Read Only
string---100 characters---
ApplyTax
Read Only
boolean---------

ApplyShipping
Read Only
boolean---------

MinQuantity
Read Only
integerint32------

MaxQuantity
Read Only
integerint32------

UseCumulativeQuantity
Read Only
boolean---------

RestrictedQuantity
Read Only
boolean---------

PriceBreaks
Read Only
array---------
PropertyTypeFormatMax LengthPossible Values
Quantity
Read Only
integerint32------

Price
Read Only
numberfloat------

xp
Read Only
object---------
IDstring---------
Namestring---100 characters---
Descriptionstring---2000 characters---
QuantityMultiplierintegerint32------

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

SpecCount
Read Only
integerint32------

VariantCount
Read Only
integerint32------

ShipFromAddressIDstring---------

Inventoryobject---------
PropertyTypeFormatMax LengthPossible Values
Enabledboolean---------

NotificationPointintegerint32------

VariantLevelTrackingboolean---------

OrderCanExceedboolean---------

QuantityAvailableintegerint32------

LastUpdated
Read Only
stringdate-time------
DefaultSupplierIDstring---------

xpobject---------
Metaobject---------
PropertyTypeFormatMax LengthPossible Values
Facetsarray---------
PropertyTypeFormatMax LengthPossible Values
Namestring---------
XpPathstring---------
Valuesarray---------
PropertyTypeFormatMax LengthPossible Values
Valuestring---------
Countintegerint32------
xpobject---------
Pageintegerint32------
PageSizeintegerint32------
TotalCountintegerint32------
TotalPagesintegerint32------
ItemRangearray---------