API version: unstable
API version: 2021-04 Release candidate
API version: 2021-01 Latest
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

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-04 (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-01 (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 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

Version 2020-07

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-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 2020-01 (Unsupported)

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 2019-10 (Unsupported)

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 2019-07 (Unsupported)

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 2019-04 (Unsupported)

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