ProductSetInput
The input fields required to create or update a product via ProductSet mutation.
Anchor to FieldsFields
- Anchor to claimOwnershipclaim•
Ownership The input field to enable an app to provide additional product features. For example, you can specify
bundles: truein thefield to let an app add a product configuration extension.- Anchor to collectionscollections•
The IDs of collections that this product will be a member of.
- Anchor to customProductTypecustom•
Product Type The custom product type that merchants define.
- 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 giftCardgift•
Card Whether the product is a gift card.
- 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.- Anchor to metafieldsmetafields•
The metafields to associate with this product.
- Anchor to productOptionsproduct•
Options [OptionSet requiredInput!]! List of custom product options and option values (maximum of 3 per product).
- 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 (subscription). Products that are sold exclusively on subscription can only be created on online stores. If set to
trueon an already existing product, then the product will be marked unavailable on channels that don't support subscriptions.- •
The SEO title and description that are associated with a product.
- Anchor to statusstatus•
The status of the product.
- 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 variantsvariants•[Product
Variant requiredSet Input!]! A list of variants associated with the product.
- Anchor to vendorvendor•
The name of the product's vendor.