CollectionRule object

Version unstable

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

Required access

read_products access scope.

Fields

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

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

Types that return CollectionRule

Version 2021-10 (Release candidate)

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

Required access

read_products access scope.

Fields

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

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

Types that return CollectionRule

Version 2021-07 (Latest)

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

Required access

read_products access scope.

Fields

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

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

Types that return CollectionRule

Version 2021-04

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

Required access

read_products access scope.

Fields

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

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

Types that return CollectionRule

Version 2021-01

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

Required access

read_products access scope.

Fields

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

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

Types that return CollectionRule

Version 2020-10

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

Required access

read_products access scope.

Fields

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

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

Types that return CollectionRule