OrderSortKeys

The set of valid sort keys for the orders query.

Show definition

# The set of valid sort keys for the orders query.
enum OrderSortKeys {
  # Sort by the created_at value.
  CREATED_AT

# Sort by the customer_name value. CUSTOMER_NAME

# Sort by the financial_status value. FINANCIAL_STATUS

# Sort by the fulfillment_status value. FULFILLMENT_STATUS

# Sort by the id value. ID

# Sort by the order_number value. ORDER_NUMBER

# Sort by the processed_at value. PROCESSED_AT

# 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. RELEVANCE

# Sort by the total_price value. TOTAL_PRICE

# Sort by the updated_at value. UPDATED_AT }

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.

Sign up for a Partner account to get started.

Sign up