CollectionRule

Version 2019-04

Represents at rule that's used to assign products to a collection.

Required access

read_products access scope

Show definition
"""
Represents at rule that's used to assign products to a collection.
"""
type CollectionRule {
  """
  The attribute that the rule focuses on (for example, `title` or `product_type`).
  """
  column: CollectionRuleColumn!
  """
  The value that the operator is applied to (for example, `Hats`).
  """
  condition: String!
  """
  The type of operator that the rule is based on (for example, `equals`, `contains`, or `not_equals`).
  """
  relation: CollectionRuleRelation!
}

Fields

column (CollectionRuleColumn!)

The attribute that the rule focuses on (for example, title or product_type).

condition (String!)

The value that the operator is applied to (for example, Hats).

relation (CollectionRuleRelation!)

The type of operator that the rule is based on (for example, equals, contains, or not_equals).

Version 2019-07 (Latest)

Represents at rule that's used to assign products to a collection.

Required access

read_products access scope

Show definition
"""
Represents at rule that's used to assign products to a collection.
"""
type CollectionRule {
  """
  The attribute that the rule focuses on (for example, `title` or `product_type`).
  """
  column: CollectionRuleColumn!
  """
  The value that the operator is applied to (for example, `Hats`).
  """
  condition: String!
  """
  The type of operator that the rule is based on (for example, `equals`, `contains`, or `not_equals`).
  """
  relation: CollectionRuleRelation!
}

Fields

column (CollectionRuleColumn!)

The attribute that the rule focuses on (for example, title or product_type).

condition (String!)

The value that the operator is applied to (for example, Hats).

relation (CollectionRuleRelation!)

The type of operator that the rule is based on (for example, equals, contains, or not_equals).

Version 2019-10 (Release candidate)

Represents at rule that's used to assign products to a collection.

Required access

read_products access scope

Show definition
"""
Represents at rule that's used to assign products to a collection.
"""
type CollectionRule {
  """
  The attribute that the rule focuses on (for example, `title` or `product_type`).
  """
  column: CollectionRuleColumn!
  """
  The value that the operator is applied to (for example, `Hats`).
  """
  condition: String!
  """
  The type of operator that the rule is based on (for example, `equals`, `contains`, or `not_equals`).
  """
  relation: CollectionRuleRelation!
}

Fields

column (CollectionRuleColumn!)

The attribute that the rule focuses on (for example, title or product_type).

condition (String!)

The value that the operator is applied to (for example, Hats).

relation (CollectionRuleRelation!)

The type of operator that the rule is based on (for example, equals, contains, or not_equals).

Sign up for a Partner account to get started.

Sign up