Skip to main content
Anchor to GiftCardProductSetUserError

GiftCardProductSetUserError

object

Defines errors for GiftCardProductSet mutation.

•GiftCardProductSetUserErrorCode

The error code.

•[String!]

The path to the input field that caused the error.

•String!
non-null

The error message.


Was this section helpful?

•mutation

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.


Arguments

•GiftCardProductSetInput!
required

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

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

•ProductSetIdentifiers

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



Was this section helpful?


Was this section helpful?