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

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation productChangeStatus($productId: ID!, $status: ProductStatus!) {
6    productChangeStatus(productId: $productId, status: $status) {
7      product {
8        id
9        status
10      }
11      userErrors {
12        field
13        message
14      }
15    }
16  }`,
17  {
18    variables: {
19      "productId": "gid://shopify/Product/108828309",
20      "status": "ARCHIVED"
21    },
22  },
23);
24
25const data = await response.json();
26

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-10/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

1{
2  "productId": "gid://shopify/Product/108828309",
3  "status": "ARCHIVED"
4}

Response

JSON

1{
2  "productChangeStatus": {
3    "product": {
4      "id": "gid://shopify/Product/108828309",
5      "status": "ARCHIVED"
6    },
7    "userErrors": []
8  }
9}