giftCardProductSet

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…

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the giftCardProductSet action (under Gift).
Fill in the fields below, then reference the result from later steps as {{giftcardproductset.response.data}}.

Query

This is the mutation the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

mutation GiftCardProductSet($input: GiftCardProductSetInput!, $synchronous: Boolean, $identifier: ProductSetIdentifiers) {
  giftCardProductSet(
    input: $input
    synchronous: $synchronous
    identifier: $identifier
  ) {
    product {
      availablePublicationsCount {
        count
        precision
      }
      bodyHtml
      bundleConsolidatedOptions {
        name
        selections
      }
      category {
        ancestorIds
        childrenIds
        fullName
        id
        isArchived
        isLeaf
        isRoot
        level
        name
        parentId
      }
      combinedListing {
        parentProduct
      }
      combinedListingRole
      compareAtPriceRange {
        maxVariantCompareAtPrice
        minVariantCompareAtPrice
      }
      createdAt
      customProductType
      defaultCursor
      descriptionHtml
      descriptionPlainSummary
      featuredImage {
        altText
        height
        id
        originalSrc
        src
        thumbhash
        width
      }
      featuredMedia {
        alt
        id
        mediaContentType
        mediaErrors
        mediaWarnings
        preview
        status
      }
      feedback {
        appFeedback
        details
        summary
      }
      giftCardSettings {
        crossCurrencyRedeemable
        issuanceCurrency
      }
      giftCardTemplateSuffix
      handle
      hasOnlyDefaultVariant
      hasOutOfStockVariants
      hasVariantsThatRequiresComponents
      id
      isGiftCard
      legacyResourceId
      mediaCount {
        count
        precision
      }
      onlineStorePreviewUrl
      onlineStoreUrl
      priceRange {
        maxVariantPrice
        minVariantPrice
      }
      priceRangeV2 {
        maxVariantPrice
        minVariantPrice
      }
      productCategory {
        productTaxonomyNode
      }
      productComponentsCount {
        count
        precision
      }
      productType
      publishedAt
      publishedOnCurrentChannel
      publishedOnCurrentPublication
      requiresSellingPlan
      resourcePublicationOnCurrentPublication {
        isPublished
        publication
        publishDate
        publishable
      }
      sellingPlanGroupCount
      sellingPlanGroupsCount {
        count
        precision
      }
      seo {
        description
        title
      }
      standardizedProductType {
        productTaxonomyNode
      }
      status
      storefrontId
      tags
      templateSuffix
      title
      totalInventory
      totalVariants
      tracksInventory
      updatedAt
      variantsCount {
        count
        precision
      }
      vendor
    }
    productSetOperation {
      id
      product {
        availablePublicationsCount
        bodyHtml
        bundleConsolidatedOptions
        category
        combinedListing
        combinedListingRole
        compareAtPriceRange
        createdAt
        customProductType
        defaultCursor
        descriptionHtml
        descriptionPlainSummary
        featuredImage
        featuredMedia
        feedback
        giftCardSettings
        giftCardTemplateSuffix
        handle
        hasOnlyDefaultVariant
        hasOutOfStockVariants
        hasVariantsThatRequiresComponents
        id
        isGiftCard
        legacyResourceId
        mediaCount
        onlineStorePreviewUrl
        onlineStoreUrl
        priceRange
        priceRangeV2
        productCategory
        productComponentsCount
        productType
        publishedAt
        publishedOnCurrentChannel
        publishedOnCurrentPublication
        requiresSellingPlan
        resourcePublicationOnCurrentPublication
        sellingPlanGroupCount
        sellingPlanGroupsCount
        seo
        standardizedProductType
        status
        storefrontId
        tags
        templateSuffix
        title
        totalInventory
        totalVariants
        tracksInventory
        updatedAt
        variantsCount
        vendor
      }
      status
      userErrors {
        code
        field
        message
      }
    }
    userErrors {
      code
      field
      message
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

inputobjectrequired

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

descriptionHtmlstring

handlestring

seoobject2 fields

productTypestring

tagsarray<string>

templateSuffixstring

giftCardTemplateSuffixstring

titlestring

vendorstring

redirectNewHandleboolean

statusstring

One ofACTIVEARCHIVEDDRAFTUNLISTED

collectionsarray<string>

metafieldsarray<object>5 fields

filesarray<object>6 fields

productOptionsarray<object>5 fields

issuanceCurrencystring

One ofUSDEURGBPCADAFNALLDZDAOAARSAMDAWGAUDBBDAZNBDTBSDBHDBIFBYNBZDBMDBTNBAMBRLBOBBWPBNDBGNMMKKHRCVEKYDXAFCLPCNYCOPKMFCDFCRCHRK

crossCurrencyRedeemableboolean

variantsarray<object>9 fields

synchronousboolean

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`.

identifierobject

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

idstring

handlestring

customIdobject3 fields

json

{
  "input": {
    "descriptionHtml": "string",
    "handle": "string",
    "seo": {
      "title": "string",
      "description": "string"
    },
    "productType": "string",
    "tags": [
      "string"
    ],
    "templateSuffix": "string",
    "giftCardTemplateSuffix": "string",
    "title": "string",
    "vendor": "string",
    "redirectNewHandle": false,
    "status": "ACTIVE",
    "collections": [
      "string"
    ]
  },
  "synchronous": false,
  "identifier": {
    "id": "string",
    "handle": "string",
    "customId": {
      "key": "string",
      "value": "string",
      "namespace": "string"
    }
  }
}

Response

Read the result with {{giftcardproductset.response.data.data.giftCardProductSet}}. If the API returns errors, the step fails and they are at {{giftcardproductset.response.data.errors}}.

productobject

availablePublicationsCountobject2 fields

bodyHtmlstring

bundleConsolidatedOptionsarray<object>

categoryobject10 fields

combinedListingobject1 fields

combinedListingRolestring

One ofPARENTCHILD

compareAtPriceRangeobject2 fields

createdAtstring

customProductTypestring

defaultCursorstring

descriptionHtmlstring

descriptionPlainSummarystring

featuredImageobject7 fields

featuredMediaobject7 fields

feedbackobject3 fields

giftCardSettingsobject2 fields

giftCardTemplateSuffixstring

handlestring

hasOnlyDefaultVariantboolean

hasOutOfStockVariantsboolean

hasVariantsThatRequiresComponentsboolean

idstring

isGiftCardboolean

legacyResourceIdstring

mediaCountobject2 fields

onlineStorePreviewUrlstring

onlineStoreUrlstring

priceRangeobject2 fields

priceRangeV2object2 fields

productCategoryobject1 fields

productComponentsCountobject2 fields

productTypestring

publishedAtstring

publishedOnCurrentChannelboolean

publishedOnCurrentPublicationboolean

requiresSellingPlanboolean

resourcePublicationOnCurrentPublicationobject4 fields

sellingPlanGroupCountnumber

sellingPlanGroupsCountobject2 fields

seoobject2 fields

productSetOperationobject

idstring

productobject40 fields

statusstring

One ofCREATEDACTIVECOMPLETE

userErrorsarray<object>

codeobject

fieldobject

messageobject

Need more? See the Shopify guide for connection setup and behaviour shared by every action.

Was this page helpful?