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 definitiondefinition•Metafield
Definition! non-null The metafield definition to use for the condition.
- •ID!non-null
The unique identifier for this condition.
- Anchor to relationrelation•Collection
Source Inclusion Condition Metafield Boolean Relation! non-null The relationship between the metafield value and the condition.
- Anchor to valuevalue•Boolean!non-null
The boolean value to match against.
- Anchor to CollectionSourceInclusionConditionMetafieldDecimalCollection•OBJECT
Source Inclusion Condition Metafield Decimal A condition based on decimal metafield values for including products in a collection.
- Anchor to definitiondefinition•Metafield
Definition! non-null The metafield definition to use for the condition.
- •ID!non-null
The unique identifier for this condition.
- Anchor to relationrelation•Collection
Source Inclusion Condition Metafield Decimal Relation! non-null The relationship between the metafield value and the condition value.
- Anchor to valuevalue•Decimal!non-null
The decimal value to match against.
- Anchor to CollectionSourceInclusionConditionMetafieldIntegerCollection•OBJECT
Source Inclusion Condition Metafield Integer A condition based on integer metafield values for including products in a collection.
- Anchor to definitiondefinition•Metafield
Definition! non-null The metafield definition to use for the condition.
- •ID!non-null
The unique identifier for this condition.
- Anchor to relationrelation•Collection
Source Inclusion Condition Metafield Integer Relation! non-null The relationship between the metafield value and the condition value.
- Anchor to valuevalue•Int!non-null
The integer value to match against.
- 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 definitiondefinition•Metafield
Definition! non-null The metafield definition to use for the condition.
- •ID!non-null
The unique identifier for this condition.
- Anchor to relationrelation•Collection
Source Inclusion Condition Metafield Metaobject Relation! non-null The relationship between the metafield value and the condition value.
- Anchor to valuevalue•Metaobject!non-null
The metaobject to match against.
- 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 definitiondefinition•Metafield
Definition! non-null The metafield definition to use for the condition.
- •ID!non-null
The unique identifier for this condition.
- Anchor to matchTypematch•Collection
Type Condition Match Type! non-null Determines how many values a metafield must match against in order to satisfy this condition. Will be either at least one given value, or all of the given values.
- Anchor to relationrelation•Collection
Source Inclusion Condition Metafield Metaobject List Relation! non-null The relationship between the metafield value and the condition values.
- Anchor to valuesvalues•[Metaobject!]!non-null
The metaobjects to match against.
- Anchor to CollectionSourceInclusionConditionMetafieldStringCollection•OBJECT
Source Inclusion Condition Metafield String A condition based on string metafield values for including products in a collection.
- Anchor to definitiondefinition•Metafield
Definition! non-null The metafield definition to use for the condition.
- •ID!non-null
The unique identifier for this condition.
- Anchor to matchTypematch•Collection
Type Condition Match Type! non-null Determines how many values a metafield must match against in order to satisfy this condition. Will be either at least one given value, or all of the given values.
- Anchor to relationrelation•Collection
Source Inclusion Condition Metafield String Relation! non-null The relationship between the metafield value and the condition values.
- Anchor to valuesvalues•[String!]!non-null
The string values to match against.
- 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 definitiondefinition•Metafield
Definition! non-null The metafield definition to use for the condition.
- •ID!non-null
The unique identifier for this condition.
- Anchor to matchTypematch•Collection
Type Condition Match Type! non-null Determines how many values a metafield must match against in order to satisfy this condition. Will be either at least one given value, or all of the given values.
- Anchor to relationrelation•Collection
Source Inclusion Condition Metafield String List Relation! non-null The relationship between the metafield value and the condition values.
- Anchor to valuesvalues•[String!]!non-null
The string values to match against.
- Anchor to CollectionSourceInclusionConditionProductCategoryCollection•OBJECT
Source Inclusion Condition Product Category A condition based on product category IDs for including products in a collection.
- •ID!non-null
The unique identifier for this condition.
- Anchor to matchTypematch•Collection
Type Condition Match Type! non-null Specifies whether products must match any or all values.
- Anchor to relationrelation•Collection
Source Inclusion Condition Product Category Relation! non-null The relationship between the product category ID and the condition values.
- Anchor to valuesvalues•[Collection
Source Inclusion Condition Product Category Value!]! non-null The product category values to match against.
- •ID!
- Anchor to CollectionSourceInclusionConditionProductStatusCollection•OBJECT
Source Inclusion Condition Product Status A condition based on product status for including products in a collection.
- •ID!non-null
The unique identifier for this condition.
- Anchor to matchTypematch•Collection
Type Condition Match Type! non-null Specifies whether products must match any or all values.
- Anchor to relationrelation•Collection
Source Inclusion Condition Product Status Relation! non-null The relationship between the product status and the condition values.
- Anchor to valuesvalues•[Product
Status!]! non-null The product status values to match against.
- •ID!
- •OBJECT
A condition based on product tags for including products in a collection.
- •ID!non-null
The unique identifier for this condition.
- Anchor to matchTypematch•Collection
Type Condition Match Type! non-null Determines how many values a metafield must match against in order to satisfy this condition. Will be either at least one given value, or all of the given values.
- Anchor to relationrelation•Collection
Source Inclusion Condition Product Tag Relation! non-null The relationship between the product tag and the condition values.
- Anchor to valuesvalues•[String!]!non-null
The tag values to match against.
- •ID!
- Anchor to CollectionSourceInclusionConditionProductTitleCollection•OBJECT
Source Inclusion Condition Product Title A condition based on product titles for including products in a collection.
- •ID!non-null
The unique identifier for this condition.
- Anchor to matchTypematch•Collection
Type Condition Match Type! non-null Determines how many values a metafield must match against in order to satisfy this condition. Will be either at least one given value, or all of the given values.
- Anchor to relationrelation•Collection
Source Inclusion Condition Product Title Relation! non-null The relationship between the product title and the condition values.
- Anchor to valuesvalues•[String!]!non-null
The title values to match against.
- •ID!
- Anchor to CollectionSourceInclusionConditionProductTypeCollection•OBJECT
Source Inclusion Condition Product Type A condition based on product types for including products in a collection.
- •ID!non-null
The unique identifier for this condition.
- Anchor to matchTypematch•Collection
Type Condition Match Type! non-null Specifies whether products must match any or all values.
- Anchor to relationrelation•Collection
Source Inclusion Condition Product Type Relation! non-null The relationship between the product type and the condition values.
- Anchor to valuesvalues•[String!]!non-null
The product type values to match against.
- •ID!
- Anchor to CollectionSourceInclusionConditionProductVendorCollection•OBJECT
Source Inclusion Condition Product Vendor A condition based on product vendors for including products in a collection.
- •ID!non-null
The unique identifier for this condition.
- Anchor to matchTypematch•Collection
Type Condition Match Type! non-null Specifies whether products must match any or all values.
- Anchor to relationrelation•Collection
Source Inclusion Condition Product Vendor Relation! non-null The relationship between the product vendor and the condition values.
- Anchor to valuesvalues•[String!]!non-null
The product vendor values to match against.
- •ID!
- •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.
- •ID!non-null
The unique identifier for this condition.
- Anchor to matchTypematch•Collection
Type Condition Match Type Whether products must match any or all values. Null when the condition has no concept of a match type.
- Anchor to relationrelation•String
The relation, as a raw string. Nullable and not coerced into an enum because the set of possible relations is open-ended for unknown condition types, and some future conditions may not have a relation at all.
- Anchor to valuesvalues•[String!]
The condition values, as raw strings. Nullable because some future condition types may have no values at all.
- •ID!
- 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.
- •ID!non-null
The unique identifier for this condition.
- Anchor to relationrelation•Collection
Source Inclusion Condition Variant Compare At Price Relation! non-null The relationship between the variant compare at price and the condition values.
- Anchor to valuevalue•Money
V2 The variant compare at price to match against. Null when the relation is IS_SET or IS_NOT_SET.
- •ID!
- Anchor to CollectionSourceInclusionConditionVariantInventoryCollection•OBJECT
Source Inclusion Condition Variant Inventory A condition based on variant inventory quantities for including products in a collection.
- •ID!non-null
The unique identifier for this condition.
- Anchor to relationrelation•Collection
Source Inclusion Condition Variant Inventory Relation! non-null The relationship between the variant inventory and the condition values.
- Anchor to valuevalue•Int!non-null
The variant inventory to match against.
- •ID!
- Anchor to CollectionSourceInclusionConditionVariantPriceCollection•OBJECT
Source Inclusion Condition Variant Price A condition based on variant prices for including products in a collection.
- •ID!non-null
The unique identifier for this condition.
- Anchor to relationrelation•Collection
Source Inclusion Condition Variant Price Relation! non-null The relationship between the variant price and the condition values.
- Anchor to valuevalue•Money
V2! non-null The variant price to match against.
- •ID!
- Anchor to CollectionSourceInclusionConditionVariantTitleCollection•OBJECT
Source Inclusion Condition Variant Title A condition based on variant titles for including products in a collection.
- •ID!non-null
The unique identifier for this condition.
- Anchor to matchTypematch•Collection
Type Condition Match Type! non-null Determines how many values a metafield must match against in order to satisfy this condition. Will be either at least one given value, or all of the given values.
- Anchor to relationrelation•Collection
Source Inclusion Condition Variant Title Relation! non-null The relationship between the variant title and the condition values.
- Anchor to valuesvalues•[String!]!non-null
The variant title values to match against.
- •ID!
- Anchor to CollectionSourceInclusionConditionVariantWeightCollection•OBJECT
Source Inclusion Condition Variant Weight A condition based on variant weights for including products in a collection.
- •ID!non-null
The unique identifier for this condition.
- Anchor to relationrelation•Collection
Source Inclusion Condition Variant Weight Relation! non-null The relationship between the variant weight and the condition values.
- Anchor to valuevalue•Weight!non-null
The variant weight to match against.
- •ID!