productChangeStatus

mutationDeprecated

Requires write_products 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 productUpdate instead.

Arguments

Anchor to productIdproductId • ID!required: The ID of the product.
Anchor to statusstatus • ProductStatus!required: The status to be assigned to the product.

Was this section helpful?

Anchor to ProductChangeStatusPayload returnsProductChangeStatusPayload returns

Anchor to productproduct • Product: The product object.
Anchor to userErrorsuserErrors • [ProductChangeStatusUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Update a product's status and return its ID and new status
Update the status of a product that doesn't exist
productChangeStatus reference

Examples

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

const response = await admin.graphql(

`#graphql

mutation productChangeStatus($productId: ID!, $status: ProductStatus!) {

productChangeStatus(productId: $productId, status: $status) {

product {

status

}

userErrors {

field

message

}

}`,

{

variables: {

"productId": "gid://shopify/Product/108828309",

"status": "ARCHIVED"

);

const data = await response.json();

mutation productChangeStatus($productId: ID!, $status: ProductStatus!) {
  productChangeStatus(productId: $productId, status: $status) {
    product {
      id
      status
    }
    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 productChangeStatus($productId: ID!, $status: ProductStatus!) { productChangeStatus(productId: $productId, status: $status) { product { id status } userErrors { field message } } }",
 "variables": {
    "productId": "gid://shopify/Product/108828309",
    "status": "ARCHIVED"
  }
}'

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

const response = await admin.graphql(
  `#graphql
  mutation productChangeStatus($productId: ID!, $status: ProductStatus!) {
    productChangeStatus(productId: $productId, status: $status) {
      product {
        id
        status
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
      "productId": "gid://shopify/Product/108828309",
      "status": "ARCHIVED"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation productChangeStatus($productId: ID!, $status: ProductStatus!) {
      productChangeStatus(productId: $productId, status: $status) {
        product {
          id
          status
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
      "productId": "gid://shopify/Product/108828309",
      "status": "ARCHIVED"
    },
  },
});

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 productChangeStatus($productId: ID!, $status: ProductStatus!) {
    productChangeStatus(productId: $productId, status: $status) {
      product {
        id
        status
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "productId": "gid://shopify/Product/108828309",
  "status": "ARCHIVED"
}

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

Input variables

JSON

{

"productId": "gid://shopify/Product/108828309",

"status": "ARCHIVED"

}

Response

JSON

{

"productChangeStatus": {

"product": {

"id": "gid://shopify/Product/108828309",

"status": "ARCHIVED"

"userErrors": []

}