# metafieldsSet - admin-graphql - MUTATION Version: 2024-10 ## Description Sets metafield values. Metafield values will be set regardless if they were previously created or not. Allows a maximum of 25 metafields to be set at a time. This operation is atomic, meaning no changes are persisted if an error is encountered. As of `2024-07`, this operation supports compare-and-set functionality to better handle concurrent requests. If `compareDigest` is set for any metafield, the mutation will only set that metafield if the persisted metafield value matches the digest used on `compareDigest`. If the metafield doesn't exist yet, but you want to guarantee that the operation will run in a safe manner, set `compareDigest` to `null`. The `compareDigest` value can be acquired by querying the metafield object and selecting `compareDigest` as a field. If the `compareDigest` value does not match the digest for the persisted value, the mutation will return an error. You can opt out of write guarantees by not sending `compareDigest` in the request. ### Access Scopes the same access level needed to mutate the owner resource. For instance, if you want to set a metafield on a product, you need the same permissions as you would need to mutate a product. ## Arguments * [metafields](/docs/api/admin-graphql/2024-10/input-objects/MetafieldsSetInput): MetafieldsSetInput! - The list of metafield values to set. Maximum of 25. ## Returns * [metafields](/docs/api/admin-graphql/2024-10/objects/Metafield): Metafield The list of metafields that were set. * [userErrors](/docs/api/admin-graphql/2024-10/objects/MetafieldsSetUserError): MetafieldsSetUserError! The list of errors that occurred from executing the mutation. ## Examples ### Create a metafield Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation MetafieldsSet($metafields: [MetafieldsSetInput!]!) { metafieldsSet(metafields: $metafields) { metafields { key namespace value createdAt updatedAt } userErrors { field message code } } }\",\n \"variables\": {\n \"metafields\": [\n {\n \"key\": \"example_key\",\n \"namespace\": \"example_namespace\",\n \"ownerId\": \"gid://shopify/Product/20995642\",\n \"type\": \"single_line_text_field\",\n \"value\": \"Example Value\"\n }\n ]\n }\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation MetafieldsSet($metafields: [MetafieldsSetInput!]!) {\n metafieldsSet(metafields: $metafields) {\n metafields {\n key\n namespace\n value\n createdAt\n updatedAt\n }\n userErrors {\n field\n message\n code\n }\n }\n }`,\n \"variables\": {\n \"metafields\": [\n {\n \"key\": \"example_key\",\n \"namespace\": \"example_namespace\",\n \"ownerId\": \"gid://shopify/Product/20995642\",\n \"type\": \"single_line_text_field\",\n \"value\": \"Example Value\"\n }\n ]\n },\n },\n});\n" Ruby example: "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation MetafieldsSet($metafields: [MetafieldsSetInput!]!) {\n metafieldsSet(metafields: $metafields) {\n metafields {\n key\n namespace\n value\n createdAt\n updatedAt\n }\n userErrors {\n field\n message\n code\n }\n }\n }\nQUERY\n\nvariables = {\n \"metafields\": [{\"key\"=>\"example_key\", \"namespace\"=>\"example_namespace\", \"ownerId\"=>\"gid://shopify/Product/20995642\", \"type\"=>\"single_line_text_field\", \"value\"=>\"Example Value\"}]\n}\n\nresponse = client.query(query: query, variables: variables)\n" Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation MetafieldsSet($metafields: [MetafieldsSetInput!]!) {\n metafieldsSet(metafields: $metafields) {\n metafields {\n key\n namespace\n value\n createdAt\n updatedAt\n }\n userErrors {\n field\n message\n code\n }\n }\n }`,\n {\n variables: {\n \"metafields\": [\n {\n \"key\": \"example_key\",\n \"namespace\": \"example_namespace\",\n \"ownerId\": \"gid://shopify/Product/20995642\",\n \"type\": \"single_line_text_field\",\n \"value\": \"Example Value\"\n }\n ]\n },\n },\n);\n\nconst data = await response.json();\n" Graphql query: "mutation MetafieldsSet($metafields: [MetafieldsSetInput!]!) {\n metafieldsSet(metafields: $metafields) {\n metafields {\n key\n namespace\n value\n createdAt\n updatedAt\n }\n userErrors {\n field\n message\n code\n }\n }\n}" #### Graphql Input { "metafields": [ { "key": "example_key", "namespace": "example_namespace", "ownerId": "gid://shopify/Product/20995642", "type": "single_line_text_field", "value": "Example Value" } ] } #### Graphql Response { "data": { "metafieldsSet": { "metafields": [ { "key": "example_key", "namespace": "example_namespace", "value": "Example Value", "createdAt": "2024-11-18T21:40:28Z", "updatedAt": "2024-11-18T21:40:28Z" } ], "userErrors": [] } } } ### Creating and updating metafields Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation MetafieldsSet($metafields: [MetafieldsSetInput!]!) { metafieldsSet(metafields: $metafields) { metafields { key namespace value createdAt updatedAt } userErrors { field message code } } }\",\n \"variables\": {\n \"metafields\": [\n {\n \"key\": \"materials\",\n \"namespace\": \"my_fields\",\n \"ownerId\": \"gid://shopify/Product/20995642\",\n \"type\": \"multi_line_text_field\",\n \"value\": \"95% Cotton\\n5% Spandex\"\n },\n {\n \"key\": \"manufactured\",\n \"namespace\": \"my_fields\",\n \"ownerId\": \"gid://shopify/Product/20995642\",\n \"type\": \"single_line_text_field\",\n \"value\": \"Made in Canada\"\n }\n ]\n }\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation MetafieldsSet($metafields: [MetafieldsSetInput!]!) {\n metafieldsSet(metafields: $metafields) {\n metafields {\n key\n namespace\n value\n createdAt\n updatedAt\n }\n userErrors {\n field\n message\n code\n }\n }\n }`,\n \"variables\": {\n \"metafields\": [\n {\n \"key\": \"materials\",\n \"namespace\": \"my_fields\",\n \"ownerId\": \"gid://shopify/Product/20995642\",\n \"type\": \"multi_line_text_field\",\n \"value\": \"95% Cotton\\n5% Spandex\"\n },\n {\n \"key\": \"manufactured\",\n \"namespace\": \"my_fields\",\n \"ownerId\": \"gid://shopify/Product/20995642\",\n \"type\": \"single_line_text_field\",\n \"value\": \"Made in Canada\"\n }\n ]\n },\n },\n});\n" Ruby example: "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation MetafieldsSet($metafields: [MetafieldsSetInput!]!) {\n metafieldsSet(metafields: $metafields) {\n metafields {\n key\n namespace\n value\n createdAt\n updatedAt\n }\n userErrors {\n field\n message\n code\n }\n }\n }\nQUERY\n\nvariables = {\n \"metafields\": [{\"key\"=>\"materials\", \"namespace\"=>\"my_fields\", \"ownerId\"=>\"gid://shopify/Product/20995642\", \"type\"=>\"multi_line_text_field\", \"value\"=>\"95% Cotton\\n5% Spandex\"}, {\"key\"=>\"manufactured\", \"namespace\"=>\"my_fields\", \"ownerId\"=>\"gid://shopify/Product/20995642\", \"type\"=>\"single_line_text_field\", \"value\"=>\"Made in Canada\"}]\n}\n\nresponse = client.query(query: query, variables: variables)\n" Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation MetafieldsSet($metafields: [MetafieldsSetInput!]!) {\n metafieldsSet(metafields: $metafields) {\n metafields {\n key\n namespace\n value\n createdAt\n updatedAt\n }\n userErrors {\n field\n message\n code\n }\n }\n }`,\n {\n variables: {\n \"metafields\": [\n {\n \"key\": \"materials\",\n \"namespace\": \"my_fields\",\n \"ownerId\": \"gid://shopify/Product/20995642\",\n \"type\": \"multi_line_text_field\",\n \"value\": \"95% Cotton\\n5% Spandex\"\n },\n {\n \"key\": \"manufactured\",\n \"namespace\": \"my_fields\",\n \"ownerId\": \"gid://shopify/Product/20995642\",\n \"type\": \"single_line_text_field\",\n \"value\": \"Made in Canada\"\n }\n ]\n },\n },\n);\n\nconst data = await response.json();\n" Graphql query: "mutation MetafieldsSet($metafields: [MetafieldsSetInput!]!) {\n metafieldsSet(metafields: $metafields) {\n metafields {\n key\n namespace\n value\n createdAt\n updatedAt\n }\n userErrors {\n field\n message\n code\n }\n }\n}" #### Graphql Input { "metafields": [ { "key": "materials", "namespace": "my_fields", "ownerId": "gid://shopify/Product/20995642", "type": "multi_line_text_field", "value": "95% Cotton\n5% Spandex" }, { "key": "manufactured", "namespace": "my_fields", "ownerId": "gid://shopify/Product/20995642", "type": "single_line_text_field", "value": "Made in Canada" } ] } #### Graphql Response { "data": { "metafieldsSet": { "metafields": [ { "key": "materials", "namespace": "my_fields", "value": "95% Cotton\n5% Spandex", "createdAt": "2024-11-08T19:49:56Z", "updatedAt": "2024-11-08T19:49:56Z" }, { "key": "manufactured", "namespace": "my_fields", "value": "Made in Canada", "createdAt": "2024-11-18T21:41:06Z" } ], "userErrors": [] } } } ### Creating and updating metafields using compare-and-swap (CAS) Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation MetafieldsSet($metafields: [MetafieldsSetInput!]!) { metafieldsSet(metafields: $metafields) { metafields { key namespace value compareDigest createdAt updatedAt } userErrors { field message code } } }\",\n \"variables\": {\n \"metafields\": [\n {\n \"key\": \"materials\",\n \"namespace\": \"my_fields\",\n \"ownerId\": \"gid://shopify/Product/20995642\",\n \"type\": \"multi_line_text_field\",\n \"value\": \"95% Cotton\\n5% Spandex\",\n \"compareDigest\": \"fd6b73725c9e83da2d2bcfaf90b27305b9058a48a1565639aa00d718d4caf8e8\"\n },\n {\n \"key\": \"manufactured\",\n \"namespace\": \"my_fields\",\n \"ownerId\": \"gid://shopify/Product/20995642\",\n \"type\": \"single_line_text_field\",\n \"value\": \"Made in Canada\",\n \"compareDigest\": null\n }\n ]\n }\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation MetafieldsSet($metafields: [MetafieldsSetInput!]!) {\n metafieldsSet(metafields: $metafields) {\n metafields {\n key\n namespace\n value\n compareDigest\n createdAt\n updatedAt\n }\n userErrors {\n field\n message\n code\n }\n }\n }`,\n \"variables\": {\n \"metafields\": [\n {\n \"key\": \"materials\",\n \"namespace\": \"my_fields\",\n \"ownerId\": \"gid://shopify/Product/20995642\",\n \"type\": \"multi_line_text_field\",\n \"value\": \"95% Cotton\\n5% Spandex\",\n \"compareDigest\": \"fd6b73725c9e83da2d2bcfaf90b27305b9058a48a1565639aa00d718d4caf8e8\"\n },\n {\n \"key\": \"manufactured\",\n \"namespace\": \"my_fields\",\n \"ownerId\": \"gid://shopify/Product/20995642\",\n \"type\": \"single_line_text_field\",\n \"value\": \"Made in Canada\",\n \"compareDigest\": null\n }\n ]\n },\n },\n});\n" Ruby example: "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation MetafieldsSet($metafields: [MetafieldsSetInput!]!) {\n metafieldsSet(metafields: $metafields) {\n metafields {\n key\n namespace\n value\n compareDigest\n createdAt\n updatedAt\n }\n userErrors {\n field\n message\n code\n }\n }\n }\nQUERY\n\nvariables = {\n \"metafields\": [{\"key\"=>\"materials\", \"namespace\"=>\"my_fields\", \"ownerId\"=>\"gid://shopify/Product/20995642\", \"type\"=>\"multi_line_text_field\", \"value\"=>\"95% Cotton\\n5% Spandex\", \"compareDigest\"=>\"fd6b73725c9e83da2d2bcfaf90b27305b9058a48a1565639aa00d718d4caf8e8\"}, {\"key\"=>\"manufactured\", \"namespace\"=>\"my_fields\", \"ownerId\"=>\"gid://shopify/Product/20995642\", \"type\"=>\"single_line_text_field\", \"value\"=>\"Made in Canada\", \"compareDigest\"=>nil}]\n}\n\nresponse = client.query(query: query, variables: variables)\n" Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation MetafieldsSet($metafields: [MetafieldsSetInput!]!) {\n metafieldsSet(metafields: $metafields) {\n metafields {\n key\n namespace\n value\n compareDigest\n createdAt\n updatedAt\n }\n userErrors {\n field\n message\n code\n }\n }\n }`,\n {\n variables: {\n \"metafields\": [\n {\n \"key\": \"materials\",\n \"namespace\": \"my_fields\",\n \"ownerId\": \"gid://shopify/Product/20995642\",\n \"type\": \"multi_line_text_field\",\n \"value\": \"95% Cotton\\n5% Spandex\",\n \"compareDigest\": \"fd6b73725c9e83da2d2bcfaf90b27305b9058a48a1565639aa00d718d4caf8e8\"\n },\n {\n \"key\": \"manufactured\",\n \"namespace\": \"my_fields\",\n \"ownerId\": \"gid://shopify/Product/20995642\",\n \"type\": \"single_line_text_field\",\n \"value\": \"Made in Canada\",\n \"compareDigest\": null\n }\n ]\n },\n },\n);\n\nconst data = await response.json();\n" Graphql query: "mutation MetafieldsSet($metafields: [MetafieldsSetInput!]!) {\n metafieldsSet(metafields: $metafields) {\n metafields {\n key\n namespace\n value\n compareDigest\n createdAt\n updatedAt\n }\n userErrors {\n field\n message\n code\n }\n }\n}" #### Graphql Input { "metafields": [ { "key": "materials", "namespace": "my_fields", "ownerId": "gid://shopify/Product/20995642", "type": "multi_line_text_field", "value": "95% Cotton\n5% Spandex", "compareDigest": "fd6b73725c9e83da2d2bcfaf90b27305b9058a48a1565639aa00d718d4caf8e8" }, { "key": "manufactured", "namespace": "my_fields", "ownerId": "gid://shopify/Product/20995642", "type": "single_line_text_field", "value": "Made in Canada", "compareDigest": null } ] } #### Graphql Response { "data": { "metafieldsSet": { "metafields": [ { "key": "materials", "namespace": "my_fields", "value": "95% Cotton\n5% Spandex", "compareDigest": "8164fa2a8e66a6bb54181ac0c095375c701ae276e801f43efa16ea7be516f678", "createdAt": "2024-11-18T21:40:47Z", "updatedAt": "2024-11-18T21:40:47Z" }, { "key": "manufactured", "namespace": "my_fields", "value": "Made in Canada", "compareDigest": "f8c307f7c79ec624884e1c71640ee3e6441cf7bb4589b9e3cc551ab3e3b95ff1", "createdAt": "2024-11-18T21:40:47Z", "updatedAt": "2024-11-18T21:40:47Z" } ], "userErrors": [] } } } ### Updates a metafield Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation MetafieldsSet($metafields: [MetafieldsSetInput!]!) { metafieldsSet(metafields: $metafields) { metafields { key namespace value createdAt updatedAt } userErrors { field message code } } }\",\n \"variables\": {\n \"metafields\": [\n {\n \"key\": \"materials\",\n \"namespace\": \"my_fields\",\n \"ownerId\": \"gid://shopify/Product/20995642\",\n \"type\": \"multi_line_text_field\",\n \"value\": \"95% Cotton\\n5% Spandex\"\n }\n ]\n }\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation MetafieldsSet($metafields: [MetafieldsSetInput!]!) {\n metafieldsSet(metafields: $metafields) {\n metafields {\n key\n namespace\n value\n createdAt\n updatedAt\n }\n userErrors {\n field\n message\n code\n }\n }\n }`,\n \"variables\": {\n \"metafields\": [\n {\n \"key\": \"materials\",\n \"namespace\": \"my_fields\",\n \"ownerId\": \"gid://shopify/Product/20995642\",\n \"type\": \"multi_line_text_field\",\n \"value\": \"95% Cotton\\n5% Spandex\"\n }\n ]\n },\n },\n});\n" Ruby example: "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation MetafieldsSet($metafields: [MetafieldsSetInput!]!) {\n metafieldsSet(metafields: $metafields) {\n metafields {\n key\n namespace\n value\n createdAt\n updatedAt\n }\n userErrors {\n field\n message\n code\n }\n }\n }\nQUERY\n\nvariables = {\n \"metafields\": [{\"key\"=>\"materials\", \"namespace\"=>\"my_fields\", \"ownerId\"=>\"gid://shopify/Product/20995642\", \"type\"=>\"multi_line_text_field\", \"value\"=>\"95% Cotton\\n5% Spandex\"}]\n}\n\nresponse = client.query(query: query, variables: variables)\n" Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation MetafieldsSet($metafields: [MetafieldsSetInput!]!) {\n metafieldsSet(metafields: $metafields) {\n metafields {\n key\n namespace\n value\n createdAt\n updatedAt\n }\n userErrors {\n field\n message\n code\n }\n }\n }`,\n {\n variables: {\n \"metafields\": [\n {\n \"key\": \"materials\",\n \"namespace\": \"my_fields\",\n \"ownerId\": \"gid://shopify/Product/20995642\",\n \"type\": \"multi_line_text_field\",\n \"value\": \"95% Cotton\\n5% Spandex\"\n }\n ]\n },\n },\n);\n\nconst data = await response.json();\n" Graphql query: "mutation MetafieldsSet($metafields: [MetafieldsSetInput!]!) {\n metafieldsSet(metafields: $metafields) {\n metafields {\n key\n namespace\n value\n createdAt\n updatedAt\n }\n userErrors {\n field\n message\n code\n }\n }\n}" #### Graphql Input { "metafields": [ { "key": "materials", "namespace": "my_fields", "ownerId": "gid://shopify/Product/20995642", "type": "multi_line_text_field", "value": "95% Cotton\n5% Spandex" } ] } #### Graphql Response { "data": { "metafieldsSet": { "metafields": [ { "key": "materials", "namespace": "my_fields", "value": "95% Cotton\n5% Spandex", "createdAt": "2024-11-18T21:40:55Z", "updatedAt": "2024-11-18T21:40:55Z" } ], "userErrors": [] } } }