Gift
The input fields for creating or updating a gift card product with the
mutation.
For list fields like
variants,
the mutation creates new entries, updates existing ones, and deletes any entries not included
in the input. All other fields update only when explicitly provided, leaving omitted fields
unchanged.
Anchor to FieldsFields
- collections ([ID!])
- crossCurrencyRedeemable (Boolean)
- descriptionHtml (String)
- files ([FileSetInput!])
- giftCardTemplateSuffix (String)
- handle (String)
- issuanceCurrency (CurrencyCode)
- metafields ([MetafieldInput!])
- productOptions ([OptionSetInput!])
- productType (String)
- redirectNewHandle (Boolean)
- seo (SEOInput)
- status (ProductStatus)
- tags ([String!])
- templateSuffix (String)
- title (String)
- variants ([GiftCardProductVariantSetInput!])
- vendor (String)
- Anchor to collectionscollections•[ID!]
The IDs of collections that this product will be a member of.
- Anchor to crossCurrencyRedeemablecross•Boolean
Currency Redeemable Whether gift cards fulfilled from this product are redeemable in any payment currency supported by the store.
Note This value can't be changed after the product is created.
- 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.
Complexity cost: 1.9 per file.
- 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 that's used to identify the product in URLs. A handle can contain letters, hyphens (
-), and numbers, but no spaces. If no handle is explicitly provided, then the title is used to construct the product's handle. For example, if a product is titled "Black Sunglasses" and no handle is provided, then the handleblack-sunglassesis generated (unless that handle is already taken, in which case a suffix is added to make the handle unique).- Anchor to issuanceCurrencyissuance•Currency
Currency Code The issuance currency for gift cards fulfilled from this product.
Note This value can't be changed after the product is created.
- Anchor to metafieldsmetafields•[Metafield
Input!] The metafields to associate with this product.
Complexity cost: 0.4 per metafield.
- 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.- •SEOInput
The SEO title and description that are associated with a product.
- Anchor to statusstatus•Product
Status The status of the product.
- •[String!]
A 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•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. If no handle is explicitly provided, then the title is used to construct the product's handle. For example, if a product is titled "Black Sunglasses" and no handle is provided, then the handle
black-sunglassesis generated.- Anchor to variantsvariants•[Gift
Card Product Variant Set Input!] A list of variants associated with the gift card product.
Complexity cost: 0.2 per variant.
- Anchor to vendorvendor•String
The name of the product's vendor.