Anchor to section titled 'undefined'product
product
mutation
deprecated
2024-07
Requires write access scope. Also: The user must have a permission to change products status.
Changes the status of a product. This allows you to set the availability of the product across all channels. Use product instead.
Anchor to section titled 'Arguments'
Arguments
The ID of the product.
The status to be assigned to the product.
Was this section helpful?
Anchor to section titled 'ProductChangeStatusPayload returns'
ProductChangeStatusPayload returns
The product object.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: productChangeStatus
Query Reference for MUTATION: productChangeStatus
"mutation productChangeStatus($productId: ID!, $status: ProductStatus!) {\n productChangeStatus(productId: $productId, status: $status) {\n product {\n # Product fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: productChangeStatus
"{\n \"productId\": \"gid://shopify/<objectName>/10079785100\",\n \"status\": \"ACTIVE\"\n}"Schema Reference for MUTATION: productChangeStatus
""
Display Examples for MUTATION: productChangeStatus
[
{
"example": {
"type_name": "productchangestatus",
"title": "Update a product's status and return its ID and new status",
"query_string": "mutation productChangeStatus($productId: ID!, $status: ProductStatus!) {\n productChangeStatus(productId: $productId, status: $status) {\n product {\n id\n status\n }\n userErrors {\n field\n message\n }\n }\n}",
"variables": {
"productId": "gid://shopify/Product/108828309",
"status": "ARCHIVED"
},
"response": {
"data": {
"productChangeStatus": {
"product": {
"id": "gid://shopify/Product/108828309",
"status": "ARCHIVED"
},
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/merchandising/test/unit/graph_api/admin/mutations/product_change_status_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation productChangeStatus($productId: ID!, $status: ProductStatus!) { productChangeStatus(productId: $productId, status: $status) { product { id status } userErrors { field message } } }\",\n \"variables\": {\n \"productId\": \"gid://shopify/Product/108828309\",\n \"status\": \"ARCHIVED\"\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation productChangeStatus($productId: ID!, $status: ProductStatus!) {\n productChangeStatus(productId: $productId, status: $status) {\n product {\n id\n status\n }\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"productId\": \"gid://shopify/Product/108828309\",\n \"status\": \"ARCHIVED\"\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 productChangeStatus($productId: ID!, $status: ProductStatus!) {\n productChangeStatus(productId: $productId, status: $status) {\n product {\n id\n status\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"productId\": \"gid://shopify/Product/108828309\",\n \"status\": \"ARCHIVED\"\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 productChangeStatus($productId: ID!, $status: ProductStatus!) {\n productChangeStatus(productId: $productId, status: $status) {\n product {\n id\n status\n }\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"productId\": \"gid://shopify/Product/108828309\",\n \"status\": \"ARCHIVED\"\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 productChangeStatus($productId: ID!, $status: ProductStatus!) {\n productChangeStatus(productId: $productId, status: $status) {\n product {\n id\n status\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"productId\" => \"gid://shopify/Product/108828309\",\n \"status\" => \"ARCHIVED\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "productId",
"description": "The ID of the product.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "productId",
"argValue": " \"gid://shopify/Product/108828309\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "status",
"description": "The status to be assigned to the product.",
"type": {
"kind": "ENUM",
"name": "ProductStatus",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ProductStatus!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "status",
"argValue": " \"ARCHIVED\"",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "productchangestatus",
"title": "Update the status of a product that doesn't exist",
"query_string": "mutation productChangeStatus($productId: ID!, $status: ProductStatus!) {\n productChangeStatus(productId: $productId, status: $status) {\n product {\n id\n status\n }\n userErrors {\n field\n message\n }\n }\n}",
"variables": {
"productId": "gid://shopify/Product/-1",
"status": "ARCHIVED"
},
"response": {
"data": {
"productChangeStatus": {
"product": null,
"userErrors": [
{
"field": [
"productId"
],
"message": "Product does not exist"
}
]
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/merchandising/test/unit/graph_api/admin/mutations/product_change_status_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation productChangeStatus($productId: ID!, $status: ProductStatus!) { productChangeStatus(productId: $productId, status: $status) { product { id status } userErrors { field message } } }\",\n \"variables\": {\n \"productId\": \"gid://shopify/Product/-1\",\n \"status\": \"ARCHIVED\"\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation productChangeStatus($productId: ID!, $status: ProductStatus!) {\n productChangeStatus(productId: $productId, status: $status) {\n product {\n id\n status\n }\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"productId\": \"gid://shopify/Product/-1\",\n \"status\": \"ARCHIVED\"\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 productChangeStatus($productId: ID!, $status: ProductStatus!) {\n productChangeStatus(productId: $productId, status: $status) {\n product {\n id\n status\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"productId\": \"gid://shopify/Product/-1\",\n \"status\": \"ARCHIVED\"\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 productChangeStatus($productId: ID!, $status: ProductStatus!) {\n productChangeStatus(productId: $productId, status: $status) {\n product {\n id\n status\n }\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"productId\": \"gid://shopify/Product/-1\",\n \"status\": \"ARCHIVED\"\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 productChangeStatus($productId: ID!, $status: ProductStatus!) {\n productChangeStatus(productId: $productId, status: $status) {\n product {\n id\n status\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"productId\" => \"gid://shopify/Product/-1\",\n \"status\" => \"ARCHIVED\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "productId",
"description": "The ID of the product.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "productId",
"argValue": " \"gid://shopify/Product/-1\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "status",
"description": "The status to be assigned to the product.",
"type": {
"kind": "ENUM",
"name": "ProductStatus",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ProductStatus!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "status",
"argValue": " \"ARCHIVED\"",
"typeKind": "MUTATION"
}
]
}
]