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

ProductSortKeys enum

Version unstable

The set of valid sort keys for the Product query.

Values

  • CREATED_AT

    Sort by the created_at value.

  • ID

    Sort by the id value.

  • INVENTORY_TOTAL

    Sort by the inventory_total value.

  • PRODUCT_TYPE

    Sort by the product_type value.

  • PUBLISHED_AT

    Sort by the published_at 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.

  • UPDATED_AT

    Sort by the updated_at value.

  • VENDOR

    Sort by the vendor value.

Version 2021-07 (Release candidate)

The set of valid sort keys for the Product query.

Values

  • CREATED_AT

    Sort by the created_at value.

  • ID

    Sort by the id value.

  • INVENTORY_TOTAL

    Sort by the inventory_total value.

  • PRODUCT_TYPE

    Sort by the product_type value.

  • PUBLISHED_AT

    Sort by the published_at 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.

  • UPDATED_AT

    Sort by the updated_at value.

  • VENDOR

    Sort by the vendor value.

Version 2021-04 (Latest)

The set of valid sort keys for the Product query.

Values

  • CREATED_AT

    Sort by the created_at value.

  • ID

    Sort by the id value.

  • INVENTORY_TOTAL

    Sort by the inventory_total value.

  • PRODUCT_TYPE

    Sort by the product_type value.

  • PUBLISHED_AT

    Sort by the published_at 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.

  • UPDATED_AT

    Sort by the updated_at value.

  • VENDOR

    Sort by the vendor value.

Version 2021-01

The set of valid sort keys for the Product query.

Values

  • CREATED_AT

    Sort by the created_at value.

  • ID

    Sort by the id value.

  • INVENTORY_TOTAL

    Sort by the inventory_total value.

  • PRODUCT_TYPE

    Sort by the product_type value.

  • PUBLISHED_AT

    Sort by the published_at 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.

  • UPDATED_AT

    Sort by the updated_at value.

  • VENDOR

    Sort by the vendor value.

Version 2020-10

The set of valid sort keys for the Product query.

Values

  • CREATED_AT

    Sort by the created_at value.

  • ID

    Sort by the id value.

  • INVENTORY_TOTAL

    Sort by the inventory_total value.

  • PRODUCT_TYPE

    Sort by the product_type value.

  • PUBLISHED_AT

    Sort by the published_at 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.

  • UPDATED_AT

    Sort by the updated_at value.

  • VENDOR

    Sort by the vendor value.

Version 2020-07

The set of valid sort keys for the Product query.

Values

  • CREATED_AT

    Sort by the created_at value.

  • ID

    Sort by the id value.

  • INVENTORY_TOTAL

    Sort by the inventory_total value.

  • PRODUCT_TYPE

    Sort by the product_type value.

  • PUBLISHED_AT

    Sort by the published_at 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.

  • UPDATED_AT

    Sort by the updated_at value.

  • VENDOR

    Sort by the vendor value.

Version 2020-04

The set of valid sort keys for the Product query.

Values

  • CREATED_AT

    Sort by the created_at value.

  • ID

    Sort by the id value.

  • INVENTORY_TOTAL

    Sort by the inventory_total value.

  • PRODUCT_TYPE

    Sort by the product_type value.

  • PUBLISHED_AT

    Sort by the published_at 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.

  • UPDATED_AT

    Sort by the updated_at value.

  • VENDOR

    Sort by the vendor value.

Version 2020-01 (Unsupported)

The set of valid sort keys for the Product query.

Values

  • CREATED_AT

    Sort by the created_at value.

  • ID

    Sort by the id value.

  • INVENTORY_TOTAL

    Sort by the inventory_total value.

  • PRODUCT_TYPE

    Sort by the product_type value.

  • PUBLISHED_AT

    Sort by the published_at 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.

  • UPDATED_AT

    Sort by the updated_at value.

  • VENDOR

    Sort by the vendor value.

Version 2019-10 (Unsupported)

The set of valid sort keys for the Product query.

Values

  • CREATED_AT

    Sort by the created_at value.

  • ID

    Sort by the id value.

  • INVENTORY_TOTAL

    Sort by the inventory_total value.

  • PRODUCT_TYPE

    Sort by the product_type value.

  • PUBLISHED_AT

    Sort by the published_at 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.

  • UPDATED_AT

    Sort by the updated_at value.

  • VENDOR

    Sort by the vendor value.

Version 2019-07 (Unsupported)

The set of valid sort keys for the Product query.

Values

  • CREATED_AT

    Sort by the created_at value.

  • ID

    Sort by the id value.

  • INVENTORY_TOTAL

    Sort by the inventory_total value.

  • PRODUCT_TYPE

    Sort by the product_type value.

  • PUBLISHED_AT

    Sort by the published_at 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.

  • UPDATED_AT

    Sort by the updated_at value.

  • VENDOR

    Sort by the vendor value.

Version 2019-04 (Unsupported)

The set of valid sort keys for the Product query.

Values

  • CREATED_AT

    Sort by the created_at value.

  • ID

    Sort by the id value.

  • INVENTORY_TOTAL

    Sort by the inventory_total value.

  • PRODUCT_TYPE

    Sort by the product_type value.

  • PUBLISHED_AT

    Sort by the published_at 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.

  • UPDATED_AT

    Sort by the updated_at value.

  • VENDOR

    Sort by the vendor value.