List product collection entries

Request

Security

OAuth2(Required scopes: FullAccessProductCollectionReader)

Path

buyerIDstringrequired

ID of the buyer.

productCollectionIDstringrequired

ID of the product collection.

Query

searchstring

Word or phrase to search for.

searchOnArray of strings

Comma-delimited list of fields to search on.

Items Enum:"ID""ParentID""Name""Description"

searchTypestring(SearchType)

Type of search to perform.

Default:"AnyTerm"

Enum:"AnyTerm""AllTermsAnyField""AllTermsSameField""ExactPhrase""ExactPhrasePrefix"

sortByArray of strings

Comma-delimited list of fields to sort by.

Items Enum:"OwnerID""Name""ID""ParentID""!OwnerID""!Name""!ID""!ParentID"

pageinteger

Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.

Default:1

pageSizeinteger, <= 100

Number of results to return per page.

Default:20

filtersobject

An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'

curl -i -X GET \
  'https://api.ordercloud.io/v1/buyers/{buyerID}/productcollections/{productCollectionID}/products?search=string&searchOn=ID&searchType=AnyTerm&sortBy=OwnerID&page=1&pageSize=20&filters=' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

ItemsArray of objects(ProductCollectionProduct)

Example:

[
  {
    "ListOrder": 0,
    "DateAdded": "2018-01-01T00:00:00-06:00",
    "OwnerID": "",
    "DefaultPriceScheduleID": "",
    "AutoForward": false,
    "ID": "",
    "ParentID": "",
    "IsParent": false,
    "IsBundle": false,
    "Name": "",
    "Description": "",
    "QuantityMultiplier": 0,
    "ShipWeight": 0,
    "ShipHeight": 0,
    "ShipWidth": 0,
    "ShipLength": 0,
    "Active": false,
    "SpecCount": 0,
    "VariantCount": 0,
    "ShipFromAddressID": "",
    "Inventory": { … },
    "DefaultSupplierID": "",
    "AllSuppliersCanSell": false,
    "Returnable": false,
    "DateCreated": "2018-01-01T00:00:00-06:00",
    "xp": {}
  }
]

Metaobject(MetaWithFacets)

Response

{
  "Items": [
    { … }
  ],
  "Meta": {
    "Facets": [ … ],
    "Page": 0,
    "PageSize": 0,
    "TotalCount": 0,
    "TotalPages": 0,
    "ItemRange": [ … ],
    "NextPageKey": "string"
  }
}