Sitecore API catalog/OrderCloud/Bundles

Bundles

Bundles represent a collection of physical, digital, or abstract goods that are offered for sale, sometimes at a specially defined price, by a seller or supplier and are purchasable by buyer users via an order.

Operations

List bundles

Request

Security
OAuth2(Required scopes: FullAccessBundleAdminBundleReader)
Query
catalogIDstring

ID of the catalog.

categoryIDstring

ID of the category.

supplierIDstring

ID of the supplier.

searchstring

Word or phrase to search for.

searchOnArray of strings

Comma-delimited list of fields to search on.

Items Enum:"ID""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""!OwnerID""!Name""!ID"
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/bundles?catalogID=string&categoryID=string&supplierID=string&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(Bundle)
Example:
[
  {
    "ID": "",
    "OwnerID": "",
    "Name": "",
    "Description": "",
    "Active": false,
    "xp": {}
  }
]
Metaobject(MetaWithFacets)
Response
{
  "Items": [
    { … }
  ],
  "Meta": {
    "Facets": [ … ],
    "Page": 0,
    "PageSize": 0,
    "TotalCount": 0,
    "TotalPages": 0,
    "ItemRange": [ … ],
    "NextPageKey": "string"
  }
}