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

CollectionRule object

Version 2021-01 (Release candidate)

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

Required access

read_products access scope.

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).

Types that return CollectionRule

Version 2020-10 (Latest)

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

Required access

read_products access scope.

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).

Types that return CollectionRule

Version 2020-07

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

Required access

read_products access scope.

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).

Types that return CollectionRule

Version 2020-04

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

Required access

read_products access scope.

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).

Types that return CollectionRule

Version 2020-01

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

Required access

read_products access scope.

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).

Types that return CollectionRule

Version 2019-10 (Unsupported)

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

Required access

read_products access scope.

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).

Types that return CollectionRule

Version 2019-07 (Unsupported)

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

Required access

read_products access scope.

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).

Types that return CollectionRule

Version 2019-04 (Unsupported)

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

Required access

read_products access scope.

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).

Types that return CollectionRule