Skip to main content
Anchor to CollectionSourceInclusionConditionMetafield

CollectionSourceInclusionConditionMetafield

interface

Requires read_products access scope.

A condition that determines which products should be included in a collection.

This is an interface implemented by a concrete type per condition kind (for example, CollectionSourceInclusionConditionProductTag or CollectionSourceInclusionConditionVariantTitle). Fields such as relation are defined on each concrete type and return a type-specific enum (for example, CollectionSourceInclusionConditionProductTagRelation versus CollectionSourceInclusionConditionVariantTitleRelation). Conditions are mutually exclusive concrete types, but may contain overlapping field names such as relation. If your GraphQL tooling flags these as ambiguous, give each field a distinct alias (for example, tagRelation: relation and variantTitleRelation: relation) or use inline fragments.

•MetafieldDefinition!
non-null

The metafield definition to use for the condition.

•ID!
non-null

The unique identifier for this condition.


Was this section helpful?

Anchor to Types implemented inTypes implemented in

•OBJECT

A condition based on boolean metafield values for including products in a collection.

•OBJECT

A condition based on decimal metafield values for including products in a collection.

•OBJECT

A condition based on integer metafield values for including products in a collection. This object is deprecated as of API version 2026-10 in favor of CollectionSourceInclusionConditionMetafieldInt, which supports the full integer metafield value range. On those versions this legacy type is only returned to queries that reference it without also referencing CollectionSourceInclusionConditionMetafieldInt.

•OBJECT

A condition based on single metaobject reference metafield values for including products in a collection.

•OBJECT

A condition based on list of metaobject reference metafield values for including products in a collection.

•OBJECT

A condition based on string metafield values for including products in a collection.

•OBJECT

A condition based on list of string metafield values for including products in a collection.


Was this section helpful?