productChangeStatus mutation

Change status of a product.

Required access

write_products access scope.

On this page

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.

mutation productChangeStatus($productId: ID!, $status: ProductStatus!) { productChangeStatus(productId: $productId, status: $status) { 
  1. <font style="color:#1F61A0;">product</font> <font style="color:#555555;">{</font>
  3.   <font style="color:#1F61A0;">id</font>
  5. <font style="color:#555555;">}</font>
  7. <font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  9.   <font style="color:#1F61A0;">code</font>
  11.   <font style="color:#1F61A0;">field</font>
  13.   <font style="color:#1F61A0;">message</font>
  15. <font style="color:#555555;">}</font>
} } { “productId”: “Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=”, “status”: “placeholder” }

Arguments

Argument Description
productId
(
[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)

) REQUIRED		 The ID of the product.
status
(
[ProductStatus!](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/productstatus)

) REQUIRED		 The status to be assigned to the product.

Return fields

  • product ([Product](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/product))
    The product object.
  • userErrors ([[ProductChangeStatusUserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/productchangestatususererror))
    List of errors that occurred executing the mutation.