Collection
Requires 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,
or ).
Fields such as relation are defined on each concrete type and return a type-specific enum (for example,
versus
). 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, and
) or use inline fragments.
Anchor to FieldsFields
- id (ID!)
- •ID!non-null
The unique identifier for this condition.
Anchor to Types implemented inTypes implemented in
- CollectionSourceInclusionConditionMetafieldBoolean (CollectionSourceInclusionConditionMetafieldBoolean)
- CollectionSourceInclusionConditionMetafieldDecimal (CollectionSourceInclusionConditionMetafieldDecimal)
- CollectionSourceInclusionConditionMetafieldInteger (CollectionSourceInclusionConditionMetafieldInteger)
- CollectionSourceInclusionConditionMetafieldMetaobject (CollectionSourceInclusionConditionMetafieldMetaobject)
- CollectionSourceInclusionConditionMetafieldMetaobjectList (CollectionSourceInclusionConditionMetafieldMetaobjectList)
- CollectionSourceInclusionConditionMetafieldString (CollectionSourceInclusionConditionMetafieldString)
- CollectionSourceInclusionConditionMetafieldStringList (CollectionSourceInclusionConditionMetafieldStringList)
- CollectionSourceInclusionConditionProductCategory (CollectionSourceInclusionConditionProductCategory)
- CollectionSourceInclusionConditionProductStatus (CollectionSourceInclusionConditionProductStatus)
- CollectionSourceInclusionConditionProductTag (CollectionSourceInclusionConditionProductTag)
- CollectionSourceInclusionConditionProductTitle (CollectionSourceInclusionConditionProductTitle)
- CollectionSourceInclusionConditionProductType (CollectionSourceInclusionConditionProductType)
- CollectionSourceInclusionConditionProductVendor (CollectionSourceInclusionConditionProductVendor)
- CollectionSourceInclusionConditionUnknown (CollectionSourceInclusionConditionUnknown)
- CollectionSourceInclusionConditionVariantCompareAtPrice (CollectionSourceInclusionConditionVariantCompareAtPrice)
- CollectionSourceInclusionConditionVariantInventory (CollectionSourceInclusionConditionVariantInventory)
- CollectionSourceInclusionConditionVariantPrice (CollectionSourceInclusionConditionVariantPrice)
- CollectionSourceInclusionConditionVariantTitle (CollectionSourceInclusionConditionVariantTitle)
- CollectionSourceInclusionConditionVariantWeight (CollectionSourceInclusionConditionVariantWeight)
- Anchor to CollectionSourceInclusionConditionMetafieldBooleanCollection•OBJECT
Source Inclusion Condition Metafield Boolean A condition based on boolean metafield values for including products in a collection.
- Anchor to CollectionSourceInclusionConditionMetafieldDecimalCollection•OBJECT
Source Inclusion Condition Metafield Decimal A condition based on decimal metafield values for including products in a collection.
- Anchor to CollectionSourceInclusionConditionMetafieldIntegerCollection•OBJECT
Source Inclusion Condition Metafield Integer 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
, 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. As of API version 2027-01, this legacy type is removed entirely.- Anchor to CollectionSourceInclusionConditionMetafieldMetaobjectCollection•OBJECT
Source Inclusion Condition Metafield Metaobject A condition based on single metaobject reference metafield values for including products in a collection.
- Anchor to CollectionSourceInclusionConditionMetafieldMetaobjectListCollection•OBJECT
Source Inclusion Condition Metafield Metaobject List A condition based on list of metaobject reference metafield values for including products in a collection.
- Anchor to CollectionSourceInclusionConditionMetafieldStringCollection•OBJECT
Source Inclusion Condition Metafield String A condition based on string metafield values for including products in a collection.
- Anchor to CollectionSourceInclusionConditionMetafieldStringListCollection•OBJECT
Source Inclusion Condition Metafield String List A condition based on list of string metafield values for including products in a collection.
- Anchor to CollectionSourceInclusionConditionProductCategoryCollection•OBJECT
Source Inclusion Condition Product Category A condition based on product category IDs for including products in a collection.
- Anchor to CollectionSourceInclusionConditionProductStatusCollection•OBJECT
Source Inclusion Condition Product Status A condition based on product status for including products in a collection.
- •OBJECT
A condition based on product tags for including products in a collection.
- Anchor to CollectionSourceInclusionConditionProductTitleCollection•OBJECT
Source Inclusion Condition Product Title A condition based on product titles for including products in a collection.
- Anchor to CollectionSourceInclusionConditionProductTypeCollection•OBJECT
Source Inclusion Condition Product Type A condition based on product types for including products in a collection.
- Anchor to CollectionSourceInclusionConditionProductVendorCollection•OBJECT
Source Inclusion Condition Product Vendor A condition based on product vendors for including products in a collection.
- •OBJECT
An inclusion condition introduced in a newer API version that is not modeled by this version of the API. Clients should treat the relation and values as opaque strings.
- Anchor to CollectionSourceInclusionConditionVariantCompareAtPriceCollection•OBJECT
Source Inclusion Condition Variant Compare At Price A condition based on variant compare at prices for including products in a collection.
- Anchor to CollectionSourceInclusionConditionVariantInventoryCollection•OBJECT
Source Inclusion Condition Variant Inventory A condition based on variant inventory quantities for including products in a collection.
- Anchor to CollectionSourceInclusionConditionVariantPriceCollection•OBJECT
Source Inclusion Condition Variant Price A condition based on variant prices for including products in a collection.
- Anchor to CollectionSourceInclusionConditionVariantTitleCollection•OBJECT
Source Inclusion Condition Variant Title A condition based on variant titles for including products in a collection.
- Anchor to CollectionSourceInclusionConditionVariantWeightCollection•OBJECT
Source Inclusion Condition Variant Weight A condition based on variant weights for including products in a collection.