ProductUpdateInput
The input fields for updating a product.
Anchor to FieldsFields
- Anchor to categorycategory•
The ID of the category that's associated with the product.
- Anchor to collectionsToJoincollections•
To Join A list of collection IDs to associate with the product.
- Anchor to collectionsToLeavecollections•
To Leave The collection IDs to disassociate from the product.
- Anchor to deleteConflictingConstrainedMetafieldsdelete•
Conflicting Constrained Metafields BooleanDefault:false Whether to delete metafields whose constraints don't match the product's category. Can only be used when updating the product's category.
- Anchor to descriptionHtmldescription•
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•
Card Template Suffix The theme template that's used when customers view a gift card in a store.
- Anchor to handlehandle•
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.- •
The product's ID.
- Anchor to metafieldsmetafields•
The custom fields to associate with the product for the purposes of adding and storing additional information.
- Anchor to productTypeproduct•
Type The product type that merchants define.
- Anchor to redirectNewHandleredirect•
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•
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.- •
The SEO title and description that are associated with a product.
- Anchor to statusstatus•
The product status, which controls visibility across all sales channels.
- Anchor to tagstags•
A comma-separated list of searchable keywords that are associated with the product. For example, a merchant might apply the
sportsandsummertags to products that are associated with sportwear for summer.Updating
tagsoverwrites any existing tags that were previously added to the product. To add new tags without overwriting existing tags, use themutation.- Anchor to templateSuffixtemplate•
Suffix The theme template that's used when customers view a product in a store.
- Anchor to titletitle•
The name for the product that displays to customers. The title is used to construct the product's handle. For example, if a product is titled "Black Sunglasses", then the handle is
black-sunglasses.- Anchor to vendorvendor•
The name of the product's vendor.