Anchor to section titled 'undefined'tags
tags
mutation
Unstable
Add tags to an order, a draft order, a customer, a product, or an online store article.
Anchor to section titled 'Arguments'
Arguments
The ID of a resource to add tags to.
A list of tags to add to the resource. Can be an array of strings or a single string composed of a comma-separated list of values. Example values:
["tag1", "tag2", "tag3"],"tag1, tag2, tag3".
Was this section helpful?
Anchor to section titled 'TagsAddPayload returns'
TagsAddPayload returns
The object that was updated.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: tagsAdd
Query Reference for MUTATION: tagsAdd
"mutation tagsAdd($id: ID!, $tags: [String!]!) {\n tagsAdd(id: $id, tags: $tags) {\n node {\n # Node fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: tagsAdd
"{\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"tags\": [\n \"<your-tags>\"\n ]\n}"Schema Reference for MUTATION: tagsAdd
""
Display Examples for MUTATION: tagsAdd
[
{
"example": {
"type_name": "tagsadd",
"title": "Add tags to a customer",
"query_string": "mutation addTags($id: ID!, $tags: [String!]!) {\n tagsAdd(id: $id, tags: $tags) {\n node {\n id\n }\n userErrors {\n message\n }\n }\n}",
"variables": {
"id": "gid://shopify/Customer/544365967",
"tags": "one, two, three"
},
"response": {
"data": {
"tagsAdd": {
"node": {
"id": "gid://shopify/Customer/544365967"
},
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/customers/test/unit/graph_api/admin/mutations/customer_tags_add_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation addTags($id: ID!, $tags: [String!]!) { tagsAdd(id: $id, tags: $tags) { node { id } userErrors { message } } }\",\n \"variables\": {\n \"id\": \"gid://shopify/Customer/544365967\",\n \"tags\": \"one, two, three\"\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation addTags($id: ID!, $tags: [String!]!) {\n tagsAdd(id: $id, tags: $tags) {\n node {\n id\n }\n userErrors {\n message\n }\n }\n }`,\n {\n variables: {\n \"id\": \"gid://shopify/Customer/544365967\",\n \"tags\": \"one, two, three\"\n },\n },\n);\n\nconst data = await response.json();\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 addTags($id: ID!, $tags: [String!]!) {\n tagsAdd(id: $id, tags: $tags) {\n node {\n id\n }\n userErrors {\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"id\": \"gid://shopify/Customer/544365967\",\n \"tags\": \"one, two, three\"\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation addTags($id: ID!, $tags: [String!]!) {\n tagsAdd(id: $id, tags: $tags) {\n node {\n id\n }\n userErrors {\n message\n }\n }\n }`,\n \"variables\": {\n \"id\": \"gid://shopify/Customer/544365967\",\n \"tags\": \"one, two, three\"\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation addTags($id: ID!, $tags: [String!]!) {\n tagsAdd(id: $id, tags: $tags) {\n node {\n id\n }\n userErrors {\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"id\" => \"gid://shopify/Customer/544365967\",\n \"tags\" => \"one, two, three\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "id",
"description": "The ID of a resource to add tags to.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "id",
"argValue": " \"gid://shopify/Customer/544365967\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "tags",
"description": "A list of tags to add to the resource. Can be an array of strings or a single string composed of a comma-separated list of values. Example values: `[\"tag1\", \"tag2\", \"tag3\"]`, `\"tag1, tag2, tag3\"`.",
"type": {
"kind": "SCALAR",
"name": "String",
"list": true,
"non_null": true
},
"defaultValue": null,
"typeSignature": "[String!]!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "tags",
"argValue": " \"one, two, three\"",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "tagsadd",
"title": "Add tags to a product",
"query_string": "mutation addTags($id: ID!, $tags: [String!]!) {\n tagsAdd(id: $id, tags: $tags) {\n node {\n id\n }\n userErrors {\n message\n }\n }\n}",
"variables": {
"id": "gid://shopify/Product/20995642",
"tags": "one, two, three"
},
"response": {
"data": {
"tagsAdd": {
"node": {
"id": "gid://shopify/Product/20995642"
},
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/platform/admin/test/unit/graph_api/admin/mutations/tags_add_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation addTags($id: ID!, $tags: [String!]!) { tagsAdd(id: $id, tags: $tags) { node { id } userErrors { message } } }\",\n \"variables\": {\n \"id\": \"gid://shopify/Product/20995642\",\n \"tags\": \"one, two, three\"\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation addTags($id: ID!, $tags: [String!]!) {\n tagsAdd(id: $id, tags: $tags) {\n node {\n id\n }\n userErrors {\n message\n }\n }\n }`,\n {\n variables: {\n \"id\": \"gid://shopify/Product/20995642\",\n \"tags\": \"one, two, three\"\n },\n },\n);\n\nconst data = await response.json();\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 addTags($id: ID!, $tags: [String!]!) {\n tagsAdd(id: $id, tags: $tags) {\n node {\n id\n }\n userErrors {\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"id\": \"gid://shopify/Product/20995642\",\n \"tags\": \"one, two, three\"\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation addTags($id: ID!, $tags: [String!]!) {\n tagsAdd(id: $id, tags: $tags) {\n node {\n id\n }\n userErrors {\n message\n }\n }\n }`,\n \"variables\": {\n \"id\": \"gid://shopify/Product/20995642\",\n \"tags\": \"one, two, three\"\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation addTags($id: ID!, $tags: [String!]!) {\n tagsAdd(id: $id, tags: $tags) {\n node {\n id\n }\n userErrors {\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"id\" => \"gid://shopify/Product/20995642\",\n \"tags\" => \"one, two, three\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "id",
"description": "The ID of a resource to add tags to.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "id",
"argValue": " \"gid://shopify/Product/20995642\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "tags",
"description": "A list of tags to add to the resource. Can be an array of strings or a single string composed of a comma-separated list of values. Example values: `[\"tag1\", \"tag2\", \"tag3\"]`, `\"tag1, tag2, tag3\"`.",
"type": {
"kind": "SCALAR",
"name": "String",
"list": true,
"non_null": true
},
"defaultValue": null,
"typeSignature": "[String!]!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "tags",
"argValue": " \"one, two, three\"",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "tagsadd",
"title": "Attempt to add tags to an product that does not exist",
"query_string": "mutation addTags($id: ID!, $tags: [String!]!) {\n tagsAdd(id: $id, tags: $tags) {\n node {\n id\n }\n userErrors {\n message\n }\n }\n}",
"variables": {
"id": "gid://shopify/Product/12345",
"tags": "one, two, three"
},
"response": {
"data": {
"tagsAdd": {
"node": null,
"userErrors": [
{
"message": "Product does not exist"
}
]
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/platform/admin/test/unit/graph_api/admin/mutations/tags_add_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation addTags($id: ID!, $tags: [String!]!) { tagsAdd(id: $id, tags: $tags) { node { id } userErrors { message } } }\",\n \"variables\": {\n \"id\": \"gid://shopify/Product/12345\",\n \"tags\": \"one, two, three\"\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation addTags($id: ID!, $tags: [String!]!) {\n tagsAdd(id: $id, tags: $tags) {\n node {\n id\n }\n userErrors {\n message\n }\n }\n }`,\n {\n variables: {\n \"id\": \"gid://shopify/Product/12345\",\n \"tags\": \"one, two, three\"\n },\n },\n);\n\nconst data = await response.json();\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 addTags($id: ID!, $tags: [String!]!) {\n tagsAdd(id: $id, tags: $tags) {\n node {\n id\n }\n userErrors {\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"id\": \"gid://shopify/Product/12345\",\n \"tags\": \"one, two, three\"\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation addTags($id: ID!, $tags: [String!]!) {\n tagsAdd(id: $id, tags: $tags) {\n node {\n id\n }\n userErrors {\n message\n }\n }\n }`,\n \"variables\": {\n \"id\": \"gid://shopify/Product/12345\",\n \"tags\": \"one, two, three\"\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation addTags($id: ID!, $tags: [String!]!) {\n tagsAdd(id: $id, tags: $tags) {\n node {\n id\n }\n userErrors {\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"id\" => \"gid://shopify/Product/12345\",\n \"tags\" => \"one, two, three\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "id",
"description": "The ID of a resource to add tags to.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "id",
"argValue": " \"gid://shopify/Product/12345\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "tags",
"description": "A list of tags to add to the resource. Can be an array of strings or a single string composed of a comma-separated list of values. Example values: `[\"tag1\", \"tag2\", \"tag3\"]`, `\"tag1, tag2, tag3\"`.",
"type": {
"kind": "SCALAR",
"name": "String",
"list": true,
"non_null": true
},
"defaultValue": null,
"typeSignature": "[String!]!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "tags",
"argValue": " \"one, two, three\"",
"typeKind": "MUTATION"
}
]
}
]