API version: unstable
API version: 2021-07 Release candidate
API version: 2021-04 Latest
API version: 2021-01
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

ProductCollectionSortKeys enum

Version unstable

The set of valid sort keys for the ProductCollection query.

Values

  • BEST_SELLING

    Sort by the best-selling value.

  • COLLECTION_DEFAULT

    Sort by the collection-default value.

  • CREATED

    Sort by the created value.

  • ID

    Sort by the id value.

  • MANUAL

    Sort by the manual value.

  • PRICE

    Sort by the price value.

  • RELEVANCE

    During a search (i.e. when the query parameter has been specified on the connection) this sorts the results by relevance to the search term(s). When no search query is specified, this sort key is not deterministic and should not be used.

  • TITLE

    Sort by the title value.

Version 2021-07 (Release candidate)

The set of valid sort keys for the ProductCollection query.

Values

  • BEST_SELLING

    Sort by the best-selling value.

  • COLLECTION_DEFAULT

    Sort by the collection-default value.

  • CREATED

    Sort by the created value.

  • ID

    Sort by the id value.

  • MANUAL

    Sort by the manual value.

  • PRICE

    Sort by the price value.

  • RELEVANCE

    During a search (i.e. when the query parameter has been specified on the connection) this sorts the results by relevance to the search term(s). When no search query is specified, this sort key is not deterministic and should not be used.

  • TITLE

    Sort by the title value.

Version 2021-04 (Latest)

The set of valid sort keys for the ProductCollection query.

Values

  • BEST_SELLING

    Sort by the best-selling value.

  • COLLECTION_DEFAULT

    Sort by the collection-default value.

  • CREATED

    Sort by the created value.

  • ID

    Sort by the id value.

  • MANUAL

    Sort by the manual value.

  • PRICE

    Sort by the price value.

  • RELEVANCE

    During a search (i.e. when the query parameter has been specified on the connection) this sorts the results by relevance to the search term(s). When no search query is specified, this sort key is not deterministic and should not be used.

  • TITLE

    Sort by the title value.

Version 2021-01

The set of valid sort keys for the ProductCollection query.

Values

  • BEST_SELLING

    Sort by the best-selling value.

  • COLLECTION_DEFAULT

    Sort by the collection-default value.

  • CREATED

    Sort by the created value.

  • ID

    Sort by the id value.

  • MANUAL

    Sort by the manual value.

  • PRICE

    Sort by the price value.

  • RELEVANCE

    During a search (i.e. when the query parameter has been specified on the connection) this sorts the results by relevance to the search term(s). When no search query is specified, this sort key is not deterministic and should not be used.

  • TITLE

    Sort by the title value.

Version 2020-10

The set of valid sort keys for the ProductCollection query.

Values

  • BEST_SELLING

    Sort by the best-selling value.

  • COLLECTION_DEFAULT

    Sort by the collection-default value.

  • CREATED

    Sort by the created value.

  • ID

    Sort by the id value.

  • MANUAL

    Sort by the manual value.

  • PRICE

    Sort by the price value.

  • RELEVANCE

    During a search (i.e. when the query parameter has been specified on the connection) this sorts the results by relevance to the search term(s). When no search query is specified, this sort key is not deterministic and should not be used.

  • TITLE

    Sort by the title value.

Version 2020-07

The set of valid sort keys for the ProductCollection query.

Values

  • BEST_SELLING

    Sort by the best-selling value.

  • COLLECTION_DEFAULT

    Sort by the collection-default value.

  • CREATED

    Sort by the created value.

  • ID

    Sort by the id value.

  • MANUAL

    Sort by the manual value.

  • PRICE

    Sort by the price value.

  • RELEVANCE

    During a search (i.e. when the query parameter has been specified on the connection) this sorts the results by relevance to the search term(s). When no search query is specified, this sort key is not deterministic and should not be used.

  • TITLE

    Sort by the title value.

Version 2020-04

The set of valid sort keys for the ProductCollection query.

Values

  • BEST_SELLING

    Sort by the best-selling value.

  • COLLECTION_DEFAULT

    Sort by the collection-default value.

  • CREATED

    Sort by the created value.

  • ID

    Sort by the id value.

  • MANUAL

    Sort by the manual value.

  • PRICE

    Sort by the price value.

  • RELEVANCE

    During a search (i.e. when the query parameter has been specified on the connection) this sorts the results by relevance to the search term(s). When no search query is specified, this sort key is not deterministic and should not be used.

  • TITLE

    Sort by the title value.

Version 2020-01 (Unsupported)

The set of valid sort keys for the ProductCollection query.

Values

  • BEST_SELLING

    Sort by the best-selling value.

  • COLLECTION_DEFAULT

    Sort by the collection-default value.

  • CREATED

    Sort by the created value.

  • ID

    Sort by the id value.

  • MANUAL

    Sort by the manual value.

  • PRICE

    Sort by the price value.

  • RELEVANCE

    During a search (i.e. when the query parameter has been specified on the connection) this sorts the results by relevance to the search term(s). When no search query is specified, this sort key is not deterministic and should not be used.

  • TITLE

    Sort by the title value.

Version 2019-10 (Unsupported)

The set of valid sort keys for the ProductCollection query.

Values

  • BEST_SELLING

    Sort by the best-selling value.

  • COLLECTION_DEFAULT

    Sort by the collection-default value.

  • CREATED

    Sort by the created value.

  • ID

    Sort by the id value.

  • MANUAL

    Sort by the manual value.

  • PRICE

    Sort by the price value.

  • RELEVANCE

    During a search (i.e. when the query parameter has been specified on the connection) this sorts the results by relevance to the search term(s). When no search query is specified, this sort key is not deterministic and should not be used.

  • TITLE

    Sort by the title value.

Version 2019-07 (Unsupported)

The set of valid sort keys for the ProductCollection query.

Values

  • BEST_SELLING

    Sort by the best-selling value.

  • COLLECTION_DEFAULT

    Sort by the collection-default value.

  • CREATED

    Sort by the created value.

  • ID

    Sort by the id value.

  • MANUAL

    Sort by the manual value.

  • PRICE

    Sort by the price value.

  • RELEVANCE

    During a search (i.e. when the query parameter has been specified on the connection) this sorts the results by relevance to the search term(s). When no search query is specified, this sort key is not deterministic and should not be used.

  • TITLE

    Sort by the title value.

Version 2019-04 (Unsupported)

The set of valid sort keys for the ProductCollection query.

Values

  • BEST_SELLING

    Sort by the best-selling value.

  • COLLECTION_DEFAULT

    Sort by the collection-default value.

  • CREATED

    Sort by the created value.

  • ID

    Sort by the id value.

  • MANUAL

    Sort by the manual value.

  • PRICE

    Sort by the price value.

  • RELEVANCE

    During a search (i.e. when the query parameter has been specified on the connection) this sorts the results by relevance to the search term(s). When no search query is specified, this sort key is not deterministic and should not be used.

  • TITLE

    Sort by the title value.