productUpdate mutation

Version unstable

Updates a product. If you update a product, and only include some variants in the update, then any variants not included will be deleted. To safely manage variants without the risk of deleting excluded variants, use productVariantsBulkUpdate. If you want to update a single variant, then use productVariantUpdate.

Required access

write_products access scope.

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.


Arguments

Argument Description
input ( ProductInput! ) required

The updated properties for a product.

ProductInput fields

  • bodyHtml (String)

    A description of the product. Supports HTML formatting. This argument is deprecated: Use descriptionHtml instead.

  • collectionsToJoin ([ID!])

    The IDs of the collections that this product will be added to.

  • collectionsToLeave ([ID!])

    The IDs of collections that will no longer include the product.

  • descriptionHtml (String)

    The description of the product, complete with HTML formatting.

  • giftCard (Boolean)

    Whether the product is a gift card.

  • giftCardTemplateSuffix (String)

    The theme template used when viewing the gift card in a store.

  • handle (String)

    A unique human-friendly string for the product. Automatically gene