Product Set Input
The input fields required to create or update a product via ProductSet mutation.
Anchor to FieldsFields
- Anchor to categorycategory•ID
The ID of the category that's associated with the product.
- Anchor to claimOwnershipclaim•Product
Ownership Claim Ownership Input The input field to enable an app to provide additional product features. For example, you can specify
bundles: true
in thefield to let an app add a product configuration extension.
- Anchor to collectionscollections•[ID!]
The IDs of collections that this product will be a member of.
- Anchor to combinedListingRolecombined•Combined
Listing Role Listings Role The role of the product in a product grouping. It can only be set during creation.
- 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 filesfiles•[File
Set Input!] The files to associate with the product.
- Anchor to giftCardgift•Boolean
Card Whether the product is a gift card.
- 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
- Anchor to metafieldsmetafields•[Metafield
Input!] The metafields to associate with this product.
- Anchor to productOptionsproduct•[Option
Options Set Input!] List of custom product options and option values (maximum of 3 per product).
- 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 (subscription). Products that are sold exclusively on subscription can only be created on online stores. If set to
true
on an already existing product, then the product will be marked unavailable on channels that don't support subscriptions.- •SEOInput
The SEO title and description that are associated with a product.
- Anchor to statusstatus•Product
Status The status of the product.
- •[String!]
A comma-separated list of searchable keywords that are associated with the product. For example, a merchant might apply the
sports
andsummer
tags to products that are associated with sportwear for summer.Updating
tags
overwrites any existing tags that were previously added to the product. To add new tags without overwriting existing tags, use themutation.
- Anchor to templateSuffixtemplate•String
Suffix The theme template that's used when customers view a product in a store.
- Anchor to titletitle•String
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 Set Input!] A list of variants associated with the product.
- Anchor to vendorvendor•String
The name of the product's vendor.