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

CollectionSortOrder enum

Version unstable

Specifies the sort order for the products in the collection.

Values

  • PRICE_DESC

    By price, in descending order (highest - lowest).

  • ALPHA_DESC

    Alphabetically, in descending order (Z - A).

  • BEST_SELLING

    By best-selling products.

  • CREATED

    By date created, in ascending order (oldest - newest).

  • CREATED_DESC

    By date created, in descending order (newest - oldest).

  • MANUAL

    In the order set manually by the merchant.

  • PRICE_ASC

    By price, in ascending order (lowest - highest).

  • ALPHA_ASC

    Alphabetically, in ascending order (A - Z).

Types that return CollectionSortOrder

Version 2021-04 (Release candidate)

Specifies the sort order for the products in the collection.

Values

  • PRICE_DESC

    By price, in descending order (highest - lowest).

  • ALPHA_DESC

    Alphabetically, in descending order (Z - A).

  • BEST_SELLING

    By best-selling products.

  • CREATED

    By date created, in ascending order (oldest - newest).

  • CREATED_DESC

    By date created, in descending order (newest - oldest).

  • MANUAL

    In the order set manually by the merchant.

  • PRICE_ASC

    By price, in ascending order (lowest - highest).

  • ALPHA_ASC

    Alphabetically, in ascending order (A - Z).

Types that return CollectionSortOrder

Version 2021-01 (Latest)

Specifies the sort order for the products in the collection.

Values

  • PRICE_DESC

    By price, in descending order (highest - lowest).

  • ALPHA_DESC

    Alphabetically, in descending order (Z - A).

  • BEST_SELLING

    By best-selling products.

  • CREATED

    By date created, in ascending order (oldest - newest).

  • CREATED_DESC

    By date created, in descending order (newest - oldest).

  • MANUAL

    In the order set manually by the merchant.

  • PRICE_ASC

    By price, in ascending order (lowest - highest).

  • ALPHA_ASC

    Alphabetically, in ascending order (A - Z).

Types that return CollectionSortOrder

Version 2020-10

Specifies the sort order for the products in the collection.

Values

  • PRICE_DESC

    By price, in descending order (highest - lowest).

  • ALPHA_DESC

    Alphabetically, in descending order (Z - A).

  • BEST_SELLING

    By best-selling products.

  • CREATED

    By date created, in ascending order (oldest - newest).

  • CREATED_DESC

    By date created, in descending order (newest - oldest).

  • MANUAL

    In the order set manually by the merchant.

  • PRICE_ASC

    By price, in ascending order (lowest - highest).

  • ALPHA_ASC

    Alphabetically, in ascending order (A - Z).

Types that return CollectionSortOrder

Version 2020-07

Specifies the sort order for the products in the collection.

Values

  • PRICE_DESC

    By price, in descending order (highest - lowest).

  • ALPHA_DESC

    Alphabetically, in descending order (Z - A).

  • BEST_SELLING

    By best-selling products.

  • CREATED

    By date created, in ascending order (oldest - newest).

  • CREATED_DESC

    By date created, in descending order (newest - oldest).

  • MANUAL

    In the order set manually by the merchant.

  • PRICE_ASC

    By price, in ascending order (lowest - highest).

  • ALPHA_ASC

    Alphabetically, in ascending order (A - Z).

Types that return CollectionSortOrder

Version 2020-04

Specifies the sort order for the products in the collection.

Values

  • PRICE_DESC

    By price, in descending order (highest - lowest).

  • ALPHA_DESC

    Alphabetically, in descending order (Z - A).

  • BEST_SELLING

    By best-selling products.

  • CREATED

    By date created, in ascending order (oldest - newest).

  • CREATED_DESC

    By date created, in descending order (newest - oldest).

  • MANUAL

    In the order set manually by the merchant.

  • PRICE_ASC

    By price, in ascending order (lowest - highest).

  • ALPHA_ASC

    Alphabetically, in ascending order (A - Z).

Types that return CollectionSortOrder

Version 2020-01 (Unsupported)

Specifies the sort order for the products in the collection.

Values

  • PRICE_DESC

    By price, in descending order (highest - lowest).

  • ALPHA_DESC

    Alphabetically, in descending order (Z - A).

  • BEST_SELLING

    By best-selling products.

  • CREATED

    By date created, in ascending order (oldest - newest).

  • CREATED_DESC

    By date created, in descending order (newest - oldest).

  • MANUAL

    In the order set manually by the merchant.

  • PRICE_ASC

    By price, in ascending order (lowest - highest).

  • ALPHA_ASC

    Alphabetically, in ascending order (A - Z).

Types that return CollectionSortOrder

Version 2019-10 (Unsupported)

Specifies the sort order for the products in the collection.

Values

  • PRICE_DESC

    By price, in descending order (highest - lowest).

  • ALPHA_DESC

    Alphabetically, in descending order (Z - A).

  • BEST_SELLING

    By best-selling products.

  • CREATED

    By date created, in ascending order (oldest - newest).

  • CREATED_DESC

    By date created, in descending order (newest - oldest).

  • MANUAL

    In the order set manually by the merchant.

  • PRICE_ASC

    By price, in ascending order (lowest - highest).

  • ALPHA_ASC

    Alphabetically, in ascending order (A - Z).

Types that return CollectionSortOrder

Version 2019-07 (Unsupported)

Specifies the sort order for the products in the collection.

Values

  • PRICE_DESC

    By price, in descending order (highest - lowest).

  • ALPHA_DESC

    Alphabetically, in descending order (Z - A).

  • BEST_SELLING

    By best-selling products.

  • CREATED

    By date created, in ascending order (oldest - newest).

  • CREATED_DESC

    By date created, in descending order (newest - oldest).

  • MANUAL

    In the order set manually by the merchant.

  • PRICE_ASC

    By price, in ascending order (lowest - highest).

  • ALPHA_ASC

    Alphabetically, in ascending order (A - Z).

Types that return CollectionSortOrder

Version 2019-04 (Unsupported)

Specifies the sort order for the products in the collection.

Values

  • PRICE_DESC

    By price, in descending order (highest - lowest).

  • ALPHA_DESC

    Alphabetically, in descending order (Z - A).

  • BEST_SELLING

    By best-selling products.

  • CREATED

    By date created, in ascending order (oldest - newest).

  • CREATED_DESC

    By date created, in descending order (newest - oldest).

  • MANUAL

    In the order set manually by the merchant.

  • PRICE_ASC

    By price, in ascending order (lowest - highest).

  • ALPHA_ASC

    Alphabetically, in ascending order (A - Z).

Types that return CollectionSortOrder