Choose a version:

giftCardProductSet

mutation

Requires write_products access scope. Also: The user must have a permission to create products.

Creates or updates a gift card product. This mutation is specifically designed for gift card products and automatically sets the giftCard field to true, applies gift card variant defaults (non-taxable, no shipping required, inventory untracked), and omits fields that aren't relevant to gift cards.

For list fields like variants, the mutation performs a full replacement: it creates new entries, updates existing ones, and removes any entries not included in the input. For all other fields, only included fields change and omitted fields remain unchanged.

You can run the mutation synchronously to receive the updated product immediately, or asynchronously by setting synchronous: false to receive a ProductSetOperation object instead. Use the productOperation query to check the status and retrieve the product details when running asynchronously.

Note

The issuanceCurrency and crossCurrencyRedeemable fields can only be set during product creation. They can't be changed after the product is created.

Anchor to Arguments

Arguments

Anchor to identifieridentifier

•ProductSetIdentifiers

Specifies the identifier that will be used to lookup the resource.

Anchor to inputinput

•GiftCardProductSetInput!

required

The properties of the gift card product to create or update.

Anchor to synchronoussynchronous

•Boolean

Default:true

Whether the mutation should be run synchronously or asynchronously.

If true, the mutation will return the updated product. If false, the mutation will return a productSetOperation.

Defaults to true.

Was this section helpful?

Anchor to GiftCardProductSetPayload returnsGiftCardProductSetPayload returns

Anchor to productproduct •Product: The gift card product object.
Anchor to productSetOperationproductSetOperation •ProductSetOperation: The product set operation, returned when run in asynchronous mode.
Anchor to userErrorsuserErrors •[GiftCardProductSetUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

giftCardProductSet reference

Mutation Reference

mutation giftCardProductSet($input: GiftCardProductSetInput!, $synchronous: Boolean, $identifier: ProductSetIdentifiers) {

giftCardProductSet(input: $input, synchronous: $synchronous, identifier: $identifier) {

product {

# Product fields

}

productSetOperation {

# ProductSetOperation fields

}

userErrors {

field

message

}

Input

{

"input": {

"descriptionHtml": "<your-descriptionHtml>",

"handle": "<your-handle>",

"seo": {

"title": "<your-title>",

"description": "<your-description>"

"productType": "<your-productType>",

"tags": [

"<your-tags>"

"templateSuffix": "<your-templateSuffix>",

"giftCardTemplateSuffix": "<your-giftCardTemplateSuffix>",

"title": "<your-title>",

"vendor": "<your-vendor>",

"redirectNewHandle": true,

"status": "ACTIVE",

"collections": [

"gid://shopify/<objectName>/10079785100"

"metafields": [

{

"id": "gid://shopify/<objectName>/10079785100",

"namespace": "<your-namespace>",

"key": "<your-key>",

"value": "<your-value>",

"type": "<your-type>"

}

"files": [

{

"filename": "<your-filename>",

"contentType": "IMAGE",

"alt": "<your-alt>",

"duplicateResolutionMode": "APPEND_UUID",

"id": "gid://shopify/<objectName>/10079785100",

"originalSource": "<your-originalSource>"

}

"productOptions": [

{

"id": "gid://shopify/<objectName>/10079785100",

"name": "<your-name>",

"position": 1,

"values": [

{}

"linkedMetafield": {}

}

"issuanceCurrency": "USD",

"crossCurrencyRedeemable": true,

"variants": [

{

"id": "gid://shopify/<objectName>/10079785100",

"optionValues": [

{}

"price": "100.57",

"sku": "<your-sku>",

"barcode": "<your-barcode>",

"position": 1,

"file": {},

"metafields": [

{}

"published": true

}

]

"synchronous": true,

"identifier": {

"id": "gid://shopify/<objectName>/10079785100",

"handle": "<your-handle>",

"customId": {

"namespace": "<your-namespace>",

"key": "<your-key>",

"value": "<your-value>"

}

Variables

{
  "input": {
    "descriptionHtml": "<your-descriptionHtml>",
    "handle": "<your-handle>",
    "seo": {
      "title": "<your-title>",
      "description": "<your-description>"
    },
    "productType": "<your-productType>",
    "tags": [
      "<your-tags>"
    ],
    "templateSuffix": "<your-templateSuffix>",
    "giftCardTemplateSuffix": "<your-giftCardTemplateSuffix>",
    "title": "<your-title>",
    "vendor": "<your-vendor>",
    "redirectNewHandle": true,
    "status": "ACTIVE",
    "collections": [
      "gid://shopify/<objectName>/10079785100"
    ],
    "metafields": [
      {
        "id": "gid://shopify/<objectName>/10079785100",
        "namespace": "<your-namespace>",
        "key": "<your-key>",
        "value": "<your-value>",
        "type": "<your-type>"
      }
    ],
    "files": [
      {
        "filename": "<your-filename>",
        "contentType": "IMAGE",
        "alt": "<your-alt>",
        "duplicateResolutionMode": "APPEND_UUID",
        "id": "gid://shopify/<objectName>/10079785100",
        "originalSource": "<your-originalSource>"
      }
    ],
    "productOptions": [
      {
        "id": "gid://shopify/<objectName>/10079785100",
        "name": "<your-name>",
        "position": 1,
        "values": [
          {}
        ],
        "linkedMetafield": {}
      }
    ],
    "issuanceCurrency": "USD",
    "crossCurrencyRedeemable": true,
    "variants": [
      {
        "id": "gid://shopify/<objectName>/10079785100",
        "optionValues": [
          {}
        ],
        "price": "100.57",
        "sku": "<your-sku>",
        "barcode": "<your-barcode>",
        "position": 1,
        "file": {},
        "metafields": [
          {}
        ],
        "published": true
      }
    ]
  },
  "synchronous": true,
  "identifier": {
    "id": "gid://shopify/<objectName>/10079785100",
    "handle": "<your-handle>",
    "customId": {
      "namespace": "<your-namespace>",
      "key": "<your-key>",
      "value": "<your-value>"
    }
  }
}

Schema

input GiftCardProductSetInput {
  descriptionHtml: String
  handle: String
  seo: SEOInput
  productType: String
  tags: [String!]
  templateSuffix: String
  giftCardTemplateSuffix: String
  title: String
  vendor: String
  redirectNewHandle: Boolean
  status: ProductStatus
  collections: [ID!]
  metafields: [MetafieldInput!]
  files: [FileSetInput!]
  productOptions: [OptionSetInput!]
  issuanceCurrency: CurrencyCode
  crossCurrencyRedeemable: Boolean
  variants: [GiftCardProductVariantSetInput!]
}

input SEOInput {
  title: String
  description: String
}

input MetafieldInput {
  id: ID
  namespace: String
  key: String
  value: String
  type: String
}

input FileSetInput {
  filename: String
  contentType: FileContentType
  alt: String
  duplicateResolutionMode: FileCreateInputDuplicateResolutionMode
  id: ID
  originalSource: String
}

input OptionSetInput {
  id: ID
  name: String
  position: Int
  values: [OptionValueSetInput!]
  linkedMetafield: LinkedMetafieldCreateInput
}

input GiftCardProductVariantSetInput {
  id: ID
  optionValues: [VariantOptionValueInput!]!
  price: Money
  sku: String
  barcode: String
  position: Int
  file: FileSetInput
  metafields: [MetafieldInput!]
  published: Boolean
}

input ProductSetIdentifiers {
  id: ID
  handle: String
  customId: UniqueMetafieldValueInput
}

input UniqueMetafieldValueInput {
  namespace: String
  key: String!
  value: String!
}