Sitecore API catalog/OrderCloud/Product facets

Product facets

Product facets are extended properties (values on product XP) designated to drive data to support faceted navigation. Buyer list endpoints for products will populate and return facets in the meta object, a collection of facet names, values, and counts. Counts represent the total results that would be returned if the current set were filtered on that facet value.

Operations

List product facets

Request

Security
OAuth2(Required scopes: FullAccessProductFacetAdminProductFacetReader)
Query
searchstring

Word or phrase to search for.

searchOnArray of strings

Comma-delimited list of fields to search on.

Items Enum:"ID""Name""XpPath"
sortByArray of strings

Comma-delimited list of fields to sort by.

Items Enum:"ListOrder""ID""Name""XpPath""!ListOrder""!ID""!Name""!XpPath"
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/productfacets?search=string&searchOn=ID&sortBy=ListOrder&page=1&pageSize=20&filters=' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
ItemsArray of objects(ProductFacet)
Example:
[
  {
    "ID": "",
    "Name": "",
    "XpPath": "",
    "ListOrder": 1,
    "MinCount": 0,
    "xp": {}
  }
]
Metaobject(Meta)
Response
{
  "Items": [
    { … }
  ],
  "Meta": {
    "Page": 0,
    "PageSize": 0,
    "TotalCount": 0,
    "TotalPages": 0,
    "ItemRange": [ … ],
    "NextPageKey": "string"
  }
}