Product Create Input
The input fields required to create a product.
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 collectionsToJoincollections•[ID!]
To Join A list of collection IDs to associate with the product.
- Anchor to combinedListingRolecombined•Combined
Listing Role Listings Role The role of the product in a combined listing.
- 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 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
.- Anchor to metafieldsmetafields•[Metafield
Input!] The custom fields to associate with the product for the purposes of adding and storing additional information.
- Anchor to productOptionsproduct•[Option
Options Create Input!] A list of product options and option values. Maximum product options: three. There's no limit on the number of option values.
- Anchor to productTypeproduct•String
Type The product type that merchants define.
- 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.
- •[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 vendorvendor•String
The name of the product's vendor.