--- schema_version: "1" id: 81b8d54a6d839101a289de106354b3c98d57a49ed24f9939043bad8c30d13f58 title: ConnectApi.SortRule collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/apexref/apex_connectapi_output_sort_rule_output.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_connectapi_output_sort_rule_output.htm source_site: developer.salesforce.com content_type: documentation content_hash: cd0e6ae920f0e9888bf3515b57002fb5950f5acf7b3f9109b11d814bdbf2ed88 description: Sort rule. --- # 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—When no direction is defined, sorts by relevance.
  • Descending—Sorts in descending alphanumeric order (Z–A, 9–0).
52.0
label String Label of the sort rule. 52.0
labelSuffix ConnectApi.​CommerceSearch​SortRuleLabelSuffix Label suffix of the sort rule.Values are:
  • Ascen—Label suffix for 'Asc'
  • Ascending—Label suffix for 'Ascending'
  • Az—Label suffix for 'A-Z'
  • Descen—Label suffix for 'Desc'
  • Descending—Label suffix for 'Descending'
  • FewMany—Label suffix for 'Few-Many'
  • HeavyLight—Label suffix for 'Heavy-Light'
  • HighLow—Label suffix for 'High-Low'
  • HighestLowest—Label suffix for 'Highest-Lowest'
  • LightHeavy—Label suffix for 'Light-Heavy'
  • LowHigh—Label suffix for 'Low-High'
  • LowestHighest—Label suffix for 'Lowest-Highest'
  • ManyFew—Label suffix for 'Many-Few'
  • NewOld—Label suffix for 'New-Old'
  • Newest—Label suffix for 'Newest'
  • NewestOldest—Label suffix for 'Newest-Oldest'
  • NineZero—Label suffix for '9-0'
  • OldNew—Label suffix for 'Old-New'
  • Oldest—Label suffix for 'Oldest'
  • OldestNewest—Label suffix for 'Oldest-Newest'
  • PriceDecreasing—Label suffix for '$- #### See Also - [ConnectApi.SortRulesCollection](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_connectapi_output_sort_rules_collection_output.htm "Collection of sort rules.")
  • PriceIncreasing—Label suffix for '$-$'
  • ThickThin—Label suffix for 'Thick-Thin'
  • ThinThick—Label suffix for 'Thin-Thick'
  • Za—Label suffix for 'Z-A'
  • ZeroNine—Label suffix for '0-9'
54.0
nameOrId String Name of the sort rule field or, if the sort rule is based on a custom field, ID. 52.0
sortOrder Integer Sort order for the rule. A lower number has higher precedence. The first sort option is called when no other option is selected. 54.0
sortRuleId String ID of the sort rule. 52.0
type ConnectApi.​CommerceSearch​SortRuleType Type of sort rule. Values are:
  • ProductAttributeBased—Sorts by product attribute fields.
  • ProductBased—Sorts by product field data.
  • Relevancy—Sorts by product and catalog term frequency.
  • SortByPricebook—Sorts by product prices defined in the specified pricebook (version 55.0 and later).
52.0
#### See Also - [ConnectApi.SortRulesCollection](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_connectapi_output_sort_rules_collection_output.htm "Collection of sort rules.")