# productChangeStatus - admin-graphql - MUTATION Version: 2025-01 ## Description Changes the status of a product. This allows you to set the availability of the product across all channels. ### Access Scopes `write_products` access scope. Also: The user must have a permission to change products status. ## Arguments * [productId](/docs/api/admin-graphql/2025-01/scalars/ID): ID! - The ID of the product. * [status](/docs/api/admin-graphql/2025-01/enums/ProductStatus): ProductStatus! - The status to be assigned to the product. ## Returns * [product](/docs/api/admin-graphql/2025-01/objects/Product): Product The product object. * [userErrors](/docs/api/admin-graphql/2025-01/objects/ProductChangeStatusUserError): ProductChangeStatusUserError! The list of errors that occurred from executing the mutation. ## Examples ### Update a product's status and return its ID and new status Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2025-01/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" 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" 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" 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" Graphql 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}" #### Graphql Input { "productId": "gid://shopify/Product/108828309", "status": "ARCHIVED" } #### Graphql Response { "data": { "productChangeStatus": { "product": { "id": "gid://shopify/Product/108828309", "status": "ARCHIVED" }, "userErrors": [] } } } ### Update the status of a product that doesn't exist Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2025-01/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" 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" 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" 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" Graphql 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}" #### Graphql Input { "productId": "gid://shopify/Product/-1", "status": "ARCHIVED" } #### Graphql Response { "data": { "productChangeStatus": { "product": null, "userErrors": [ { "field": [ "productId" ], "message": "Product does not exist" } ] } } }