collectionUpdate

mutation

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

Updates a collection.

Arguments

Anchor to inputinput • CollectionInput!required: The updated properties for the collection.

Was this section helpful?

Anchor to CollectionUpdatePayload returnsCollectionUpdatePayload returns

Anchor to collectioncollection • Collection: The updated collection.
Anchor to jobjob • Job: The asynchronous job updating the products based on the new rule set.
Anchor to userErrorsuserErrors • [UserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Apply a rule on a manual collection
Create a new metafield and update another on an existing collection
Delete the collection's image
Update the collection's handle
Update the collection's rule set
Updates an existing custom collection
Updates an existing smart collection
collectionUpdate reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation updateCollectionRules($input: CollectionInput!) {
6    collectionUpdate(input: $input) {
7      collection {
8        id
9        title
10        description
11        handle
12        ruleSet {
13          rules {
14            column
15            relation
16            condition
17          }
18          appliedDisjunctively
19        }
20      }
21      userErrors {
22        field
23        message
24      }
25    }
26  }`,
27  {
28    variables: {
29      "input": {
30        "id": "gid://shopify/Collection/442946009",
31        "ruleSet": {
32          "rules": [
33            {
34              "column": "IS_PRICE_REDUCED",
35              "relation": "IS_NOT_SET",
36              "condition": ""
37            }
38          ],
39          "appliedDisjunctively": true
40        }
41      }
42    },
43  },
44);
45
46const data = await response.json();
47

mutation updateCollectionRules($input: CollectionInput!) {
  collectionUpdate(input: $input) {
    collection {
      id
      title
      description
      handle
      ruleSet {
        rules {
          column
          relation
          condition
        }
        appliedDisjunctively
      }
    }
    userErrors {
      field
      message
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation updateCollectionRules($input: CollectionInput!) { collectionUpdate(input: $input) { collection { id title description handle ruleSet { rules { column relation condition } appliedDisjunctively } } userErrors { field message } } }",
 "variables": {
    "input": {
      "id": "gid://shopify/Collection/442946009",
      "ruleSet": {
        "rules": [
          {
            "column": "IS_PRICE_REDUCED",
            "relation": "IS_NOT_SET",
            "condition": ""
          }
        ],
        "appliedDisjunctively": true
      }
    }
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation updateCollectionRules($input: CollectionInput!) {
    collectionUpdate(input: $input) {
      collection {
        id
        title
        description
        handle
        ruleSet {
          rules {
            column
            relation
            condition
          }
          appliedDisjunctively
        }
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
      "input": {
        "id": "gid://shopify/Collection/442946009",
        "ruleSet": {
          "rules": [
            {
              "column": "IS_PRICE_REDUCED",
              "relation": "IS_NOT_SET",
              "condition": ""
            }
          ],
          "appliedDisjunctively": true
        }
      }
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation updateCollectionRules($input: CollectionInput!) {
      collectionUpdate(input: $input) {
        collection {
          id
          title
          description
          handle
          ruleSet {
            rules {
              column
              relation
              condition
            }
            appliedDisjunctively
          }
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
      "input": {
        "id": "gid://shopify/Collection/442946009",
        "ruleSet": {
          "rules": [
            {
              "column": "IS_PRICE_REDUCED",
              "relation": "IS_NOT_SET",
              "condition": ""
            }
          ],
          "appliedDisjunctively": true
        }
      }
    },
  },
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation updateCollectionRules($input: CollectionInput!) {
    collectionUpdate(input: $input) {
      collection {
        id
        title
        description
        handle
        ruleSet {
          rules {
            column
            relation
            condition
          }
          appliedDisjunctively
        }
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "input": {
    "id": "gid://shopify/Collection/442946009",
    "ruleSet": {
      "rules": [{"column"=>"IS_PRICE_REDUCED", "relation"=>"IS_NOT_SET", "condition"=>""}],
      "appliedDisjunctively": true
    }
  }
}

response = client.query(query: query, variables: variables)

Input variables

JSON

1{
2  "input": {
3    "id": "gid://shopify/Collection/442946009",
4    "ruleSet": {
5      "rules": [
6        {
7          "column": "IS_PRICE_REDUCED",
8          "relation": "IS_NOT_SET",
9          "condition": ""
10        }
11      ],
12      "appliedDisjunctively": true
13    }
14  }
15}

Response

JSON

1{
2  "collectionUpdate": {
3    "collection": null,
4    "userErrors": [
5      {
6        "field": [
7          "id"
8        ],
9        "message": "Cannot update rule set of a custom collection"
10      }
11    ]
12  }
13}