CustomerSortKeys

Version 2019-04

The set of valid sort keys for the customers query.

Show definition
"""
The set of valid sort keys for the customers query.
"""
enum CustomerSortKeys {
  """
  Sort by the `id` value.
  """
  ID
  """
  Sort by the `last_order_date` value.
  """
  LAST_ORDER_DATE
  """
  Sort by the `location` value.
  """
  LOCATION
  """
  Sort by the `name` value.
  """
  NAME
  """
  Sort by the `orders_count` value.
  """
  ORDERS_COUNT
  """
  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_spent` value.
  """
  TOTAL_SPENT
  """
  Sort by the `updated_at` value.
  """
  UPDATED_AT
}

Values

UPDATED_AT

Sort by the updated_at value.

LAST_ORDER_DATE

Sort by the last_order_date value.

LOCATION

Sort by the location value.

NAME

Sort by the name value.

ORDERS_COUNT

Sort by the orders_count 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_SPENT

Sort by the total_spent value.

ID

Sort by the id value.

Version 2019-07 (Latest)

The set of valid sort keys for the customers query.

Show definition
"""
The set of valid sort keys for the customers query.
"""
enum CustomerSortKeys {
  """
  Sort by the `id` value.
  """
  ID
  """
  Sort by the `last_order_date` value.
  """
  LAST_ORDER_DATE
  """
  Sort by the `location` value.
  """
  LOCATION
  """
  Sort by the `name` value.
  """
  NAME
  """
  Sort by the `orders_count` value.
  """
  ORDERS_COUNT
  """
  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_spent` value.
  """
  TOTAL_SPENT
  """
  Sort by the `updated_at` value.
  """
  UPDATED_AT
}

Values

UPDATED_AT

Sort by the updated_at value.

LAST_ORDER_DATE

Sort by the last_order_date value.

LOCATION

Sort by the location value.

NAME

Sort by the name value.

ORDERS_COUNT

Sort by the orders_count 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_SPENT

Sort by the total_spent value.

ID

Sort by the id value.

Version 2019-10 (Release candidate)

The set of valid sort keys for the customers query.

Show definition
"""
The set of valid sort keys for the customers query.
"""
enum CustomerSortKeys {
  """
  Sort by the `id` value.
  """
  ID
  """
  Sort by the `last_order_date` value.
  """
  LAST_ORDER_DATE
  """
  Sort by the `location` value.
  """
  LOCATION
  """
  Sort by the `name` value.
  """
  NAME
  """
  Sort by the `orders_count` value.
  """
  ORDERS_COUNT
  """
  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_spent` value.
  """
  TOTAL_SPENT
  """
  Sort by the `updated_at` value.
  """
  UPDATED_AT
}

Values

UPDATED_AT

Sort by the updated_at value.

LAST_ORDER_DATE

Sort by the last_order_date value.

LOCATION

Sort by the location value.

NAME

Sort by the name value.

ORDERS_COUNT

Sort by the orders_count 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_SPENT

Sort by the total_spent value.

ID

Sort by the id value.

Sign up for a Partner account to get started.

Sign up