ProductVariantSortKeys

Version 2019-04

The set of valid sort keys for the variants query.

Show definition
"""
The set of valid sort keys for the variants query.
"""
enum ProductVariantSortKeys {
  """
  Sort by the `full_title` value.
  """
  FULL_TITLE
  """
  Sort by the `id` value.
  """
  ID
  """
  Sort by the `inventory_levels.available` value.
  """
  INVENTORY_LEVELS_AVAILABLE
  """
  Sort by the `inventory_management` value.
  """
  INVENTORY_MANAGEMENT
  """
  Sort by the `inventory_policy` value.
  """
  INVENTORY_POLICY
  """
  Sort by the `inventory_quantity` value.
  """
  INVENTORY_QUANTITY
  """
  Sort by the `name` value.
  """
  NAME
  """
  Sort by the `popular` value.
  """
  POPULAR
  """
  Sort by the `position` value.
  """
  POSITION
  """
  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 `sku` value.
  """
  SKU
  """
  Sort by the `title` value.
  """
  TITLE
}

Values

TITLE

Sort by the title value.

ID

Sort by the id value.

INVENTORY_LEVELS_AVAILABLE

Sort by the inventory_levels.available value.

INVENTORY_MANAGEMENT

Sort by the inventory_management value.

INVENTORY_POLICY

Sort by the inventory_policy value.

INVENTORY_QUANTITY

Sort by the inventory_quantity value.

NAME

Sort by the name value.

POPULAR

Sort by the popular value.

POSITION

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

SKU

Sort by the sku value.

FULL_TITLE

Sort by the full_title value.

Version 2019-07 (Latest)

The set of valid sort keys for the variants query.

Show definition
"""
The set of valid sort keys for the variants query.
"""
enum ProductVariantSortKeys {
  """
  Sort by the `full_title` value.
  """
  FULL_TITLE
  """
  Sort by the `id` value.
  """
  ID
  """
  Sort by the `inventory_levels.available` value.
  """
  INVENTORY_LEVELS_AVAILABLE
  """
  Sort by the `inventory_management` value.
  """
  INVENTORY_MANAGEMENT
  """
  Sort by the `inventory_policy` value.
  """
  INVENTORY_POLICY
  """
  Sort by the `inventory_quantity` value.
  """
  INVENTORY_QUANTITY
  """
  Sort by the `name` value.
  """
  NAME
  """
  Sort by the `popular` value.
  """
  POPULAR
  """
  Sort by the `position` value.
  """
  POSITION
  """
  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 `sku` value.
  """
  SKU
  """
  Sort by the `title` value.
  """
  TITLE
}

Values

TITLE

Sort by the title value.

ID

Sort by the id value.

INVENTORY_LEVELS_AVAILABLE

Sort by the inventory_levels.available value.

INVENTORY_MANAGEMENT

Sort by the inventory_management value.

INVENTORY_POLICY

Sort by the inventory_policy value.

INVENTORY_QUANTITY

Sort by the inventory_quantity value.

NAME

Sort by the name value.

POPULAR

Sort by the popular value.

POSITION

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

SKU

Sort by the sku value.

FULL_TITLE

Sort by the full_title value.

Version 2019-10 (Release candidate)

The set of valid sort keys for the variants query.

Show definition
"""
The set of valid sort keys for the variants query.
"""
enum ProductVariantSortKeys {
  """
  Sort by the `full_title` value.
  """
  FULL_TITLE
  """
  Sort by the `id` value.
  """
  ID
  """
  Sort by the `inventory_levels.available` value.
  """
  INVENTORY_LEVELS_AVAILABLE
  """
  Sort by the `inventory_management` value.
  """
  INVENTORY_MANAGEMENT
  """
  Sort by the `inventory_policy` value.
  """
  INVENTORY_POLICY
  """
  Sort by the `inventory_quantity` value.
  """
  INVENTORY_QUANTITY
  """
  Sort by the `name` value.
  """
  NAME
  """
  Sort by the `popular` value.
  """
  POPULAR
  """
  Sort by the `position` value.
  """
  POSITION
  """
  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 `sku` value.
  """
  SKU
  """
  Sort by the `title` value.
  """
  TITLE
}

Values

TITLE

Sort by the title value.

ID

Sort by the id value.

INVENTORY_LEVELS_AVAILABLE

Sort by the inventory_levels.available value.

INVENTORY_MANAGEMENT

Sort by the inventory_management value.

INVENTORY_POLICY

Sort by the inventory_policy value.

INVENTORY_QUANTITY

Sort by the inventory_quantity value.

NAME

Sort by the name value.

POPULAR

Sort by the popular value.

POSITION

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

SKU

Sort by the sku value.

FULL_TITLE

Sort by the full_title value.

Sign up for a Partner account to get started.

Sign up