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

OrderSortKeys enum

Version 2021-01 (Release candidate)

The set of valid sort keys for the Order query.

Values

UPDATED_AT

Sort by the updated_at value.

CUSTOMER_NAME

Sort by the customer_name value.

FINANCIAL_STATUS

Sort by the financial_status value.

FULFILLMENT_STATUS

Sort by the fulfillment_status value.

ID

Sort by the id value.

ORDER_NUMBER

Sort by the order_number value.

PROCESSED_AT

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

TOTAL_PRICE

Sort by the total_price value.

CREATED_AT

Sort by the created_at value.

Version 2020-10 (Latest)

The set of valid sort keys for the Order query.

Values

UPDATED_AT

Sort by the updated_at value.

CUSTOMER_NAME

Sort by the customer_name value.

FINANCIAL_STATUS

Sort by the financial_status value.

FULFILLMENT_STATUS

Sort by the fulfillment_status value.

ID

Sort by the id value.

ORDER_NUMBER

Sort by the order_number value.

PROCESSED_AT

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

TOTAL_PRICE

Sort by the total_price value.

CREATED_AT

Sort by the created_at value.

Version 2020-07

The set of valid sort keys for the Order query.

Values

UPDATED_AT

Sort by the updated_at value.

CUSTOMER_NAME

Sort by the customer_name value.

FINANCIAL_STATUS

Sort by the financial_status value.

FULFILLMENT_STATUS

Sort by the fulfillment_status value.

ID

Sort by the id value.

ORDER_NUMBER

Sort by the order_number value.

PROCESSED_AT

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

TOTAL_PRICE

Sort by the total_price value.

CREATED_AT

Sort by the created_at value.

Version 2020-04

The set of valid sort keys for the Order query.

Values

UPDATED_AT

Sort by the updated_at value.

CUSTOMER_NAME

Sort by the customer_name value.

FINANCIAL_STATUS

Sort by the financial_status value.

FULFILLMENT_STATUS

Sort by the fulfillment_status value.

ID

Sort by the id value.

ORDER_NUMBER

Sort by the order_number value.

PROCESSED_AT

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

TOTAL_PRICE

Sort by the total_price value.

CREATED_AT

Sort by the created_at value.

Version 2020-01

The set of valid sort keys for the Order query.

Values

UPDATED_AT

Sort by the updated_at value.

CUSTOMER_NAME

Sort by the customer_name value.

FINANCIAL_STATUS

Sort by the financial_status value.

FULFILLMENT_STATUS

Sort by the fulfillment_status value.

ID

Sort by the id value.

ORDER_NUMBER

Sort by the order_number value.

PROCESSED_AT

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

TOTAL_PRICE

Sort by the total_price value.

CREATED_AT

Sort by the created_at value.

Version 2019-10 (Unsupported)

The set of valid sort keys for the Order query.

Values

UPDATED_AT

Sort by the updated_at value.

CUSTOMER_NAME

Sort by the customer_name value.

FINANCIAL_STATUS

Sort by the financial_status value.

FULFILLMENT_STATUS

Sort by the fulfillment_status value.

ID

Sort by the id value.

ORDER_NUMBER

Sort by the order_number value.

PROCESSED_AT

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

TOTAL_PRICE

Sort by the total_price value.

CREATED_AT

Sort by the created_at value.

Version 2019-07 (Unsupported)

The set of valid sort keys for the Order query.

Values

UPDATED_AT

Sort by the updated_at value.

CUSTOMER_NAME

Sort by the customer_name value.

FINANCIAL_STATUS

Sort by the financial_status value.

FULFILLMENT_STATUS

Sort by the fulfillment_status value.

ID

Sort by the id value.

ORDER_NUMBER

Sort by the order_number value.

PROCESSED_AT

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

TOTAL_PRICE

Sort by the total_price value.

CREATED_AT

Sort by the created_at value.

Version 2019-04 (Unsupported)

The set of valid sort keys for the Order query.

Values

UPDATED_AT

Sort by the updated_at value.

CUSTOMER_NAME

Sort by the customer_name value.

FINANCIAL_STATUS

Sort by the financial_status value.

FULFILLMENT_STATUS

Sort by the fulfillment_status value.

ID

Sort by the id value.

ORDER_NUMBER

Sort by the order_number value.

PROCESSED_AT

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

TOTAL_PRICE

Sort by the total_price value.

CREATED_AT

Sort by the created_at value.