Newer Version Available

This content describes an older version of this product. View Latest

ConnectApi.SortRule

Sort rule.
Property Name Type Description Available Version
direction ConnectApi.​CommerceSearch​SortRuleDirection Direction of the sort rule. Values are:
  • Ascending—Sorts in ascending alphanumeric order (A–Z, 0–9).
  • Default—If there isn’t an ascending or descending direction, sorts in default order. For example, sorting by relevancy.
  • Descending—Sorts in descending alphanumeric order (Z–A, 9–0).
52.0
label String Label of the sort rule. 52.0
nameOrId String Name of the sort rule field or, if the sort rule is based on a custom field, ID. 52.0
sortRuleId String ID of the sort rule. 52.0
type ConnectApi.​CommerceSearch​SortRuleType Type of sort rule. Values are:
  • Custom—Custom field or non-product object sort rule.
  • ProductAttributeBased
  • ProductBased—Product sort rule.
  • Relevancy—Relevancy sort rule.
52.0