catalog-query-sorted-attribute.md

Catalog Query Sorted Attribute

The query expression to specify the key to sort search results.

Structure

CatalogQuerySortedAttribute

Fields

Name	Type	Tags	Description
attributeName	string	Required	The attribute whose value is used as the sort key. Constraints: Minimum Length: 1
initialAttributeValue	string | undefined	Optional	The first attribute value to be returned by the query. Ascending sorts will return only objects with this value or greater, while descending sorts will return only objects with this value or less. If unset, start at the beginning (for ascending sorts) or end (for descending sorts).
sortOrder	string | undefined	Optional	The order (e.g., chronological or alphabetical) in which results from a request are returned.

Example (as JSON)

{
  "attribute_name": "attribute_name4",
  "initial_attribute_value": null,
  "sort_order": null
}