Sitecore OrderCloud Documentation

docs

Portal login

Get a list of product collection entries.

GET

/buyers/{buyerID}/productcollections/{productCollectionID}/products

200

Roles

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

FullAccessProductCollectionReader

Parameters

NameTypeDescriptionPossible Values
buyerIDRequiredstringID of the buyer.---
productCollectionIDRequiredstringID of the product collection.---
searchstringWord or phrase to search for.---
searchOnarrayComma-delimited list of fields to search on.ID, ParentID, 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, ParentID, !OwnerID, !Name, !ID, !ParentID
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---------
Metaobject---------
Sitecore Logo

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

Contact Us
Privacy Policy
Sitecore