Product Update Input
The input fields for updating a product.
Anchor to FieldsFields
- Anchor to categorycategory•ID
The ID of the category that's associated with the product.
- Anchor to collectionsToJoincollections•[ID!]
To Join A list of collection IDs to associate with the product.
- Anchor to collectionsToLeavecollections•[ID!]
To Leave The collection IDs to disassociate from the product.
- Anchor to descriptionHtmldescription•String
Html The description of the product, with HTML tags. For example, the description might include bold
<strong></strong>
and italic<i></i>
text.- Anchor to giftCardTemplateSuffixgift•String
Card Template Suffix The theme template that's used when customers view a gift card in a store.
- Anchor to handlehandle•String
A unique, human-readable string of the product's title. A handle can contain letters, hyphens (
-
), and numbers, but no spaces. The handle is used in the online store URL for the product. For example, if a product is titled "Black Sunglasses", then the handle isblack-sunglasses
.- •ID
The product's ID.
- Anchor to metafieldsmetafields•[Metafield
Input!] The custom fields to associate with the product for the purposes of adding and storing additional information.
- Anchor to productTypeproduct•String
Type The product type that merchants define.
- Anchor to redirectNewHandleredirect•Boolean
New Handle Whether a redirect is required after a new handle has been provided. If
true
, then the old handle is redirected to the new one automatically.- Anchor to requiresSellingPlanrequires•Boolean
Selling Plan Whether the product can only be purchased with a selling plan. Products that are sold on subscription (
) can be updated only for online stores. If you update a product to be subscription-only (
), then the product is unpublished from all channels except the online store.
- •SEOInput
The SEO title and description that are associated with a product.
- Anchor to statusstatus•Product
Status The product status, which controls visibility across all sales channels.