collectionConditionsSourceCreate

mutation

Requires write_products access scope. Also: The app must have access to the input fields used to create a collection source. Further, the store must not be on the Starter or Retail plans and the user must have permission to manage products.

Creates a shareable collection source that can later be linked to one or more collections.

Anchor to Arguments

Arguments

Anchor to inputinput

•CollectionCreateConditionsSourceInput!

required

The input fields for the source to create.

Was this section helpful?

Anchor to CollectionConditionsSourceCreatePayload returnsCollectionConditionsSourceCreatePayload returns

Anchor to sourcesource •CollectionConditionsSource: The created collection source.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

collectionConditionsSourceCreate reference

Mutation Reference

mutation collectionConditionsSourceCreate($input: CollectionCreateConditionsSourceInput!) {

collectionConditionsSourceCreate(input: $input) {

source {

# CollectionConditionsSource fields

}

userErrors {

field

message

}

Input

{

"input": {

"description": "<your-description>",

"exclusion": {

"collectionIds": [

"gid://shopify/<objectName>/10079785100"

"conditions": [

{}

"matchType": "ALL",

"selections": [

{}

]

"inclusion": {

"conditions": [

{}

"matchType": "ALL",

"selections": [

{}

]

"targetType": "PRODUCTS",

"title": "<your-title>"

}

Variables

{
  "input": {
    "description": "<your-description>",
    "exclusion": {
      "collectionIds": [
        "gid://shopify/<objectName>/10079785100"
      ],
      "conditions": [
        {}
      ],
      "matchType": "ALL",
      "selections": [
        {}
      ]
    },
    "inclusion": {
      "conditions": [
        {}
      ],
      "matchType": "ALL",
      "selections": [
        {}
      ]
    },
    "targetType": "PRODUCTS",
    "title": "<your-title>"
  }
}

Schema

input CollectionCreateConditionsSourceInput {
  description: String
  exclusion: CollectionCreateSourceExclusionInput
  inclusion: CollectionCreateSourceInclusionInput
  targetType: CollectionSourceTargetType
  title: String!
}

input CollectionCreateSourceExclusionInput {
  collectionIds: [ID!]
  conditions: [CollectionSourceExclusionConditionInput!]!
  matchType: CollectionConditionMatchType!
  selections: [CollectionExclusionProductSelectionInput!]!
}

input CollectionCreateSourceInclusionInput {
  conditions: [CollectionSourceInclusionConditionInput!]
  matchType: CollectionConditionMatchType
  selections: [CollectionInclusionProductSelectionInput!]
}