Gift Card Product Set User Error
Defines errors for GiftCardProductSet mutation.
Anchor to FieldsFields
- code (GiftCardProductSetUserErrorCode)
- field ([String!])
- message (String!)
- Anchor to codecode•Gift
Card Product Set User Error Code The error code.
- Anchor to fieldfield•[String!]
The path to the input field that caused the error.
- Anchor to messagemessage•String!non-null
The error message.
Anchor to MutationsMutations
- giftCardProductSet (GiftCardProductSetPayload)
- •mutation
Creates or updates a
gift cardproduct. This mutation is specifically designed for gift card products and automatically sets thefield totrue, 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: falseto receive aobject instead. Use thequery to check the status and retrieve the product details when running asynchronously.NoteNote: The <a href="https://shopify.dev/docs/api/admin-graphql/latest/mutations/giftCardProductSet#arguments-input.fields.issuanceCurrency"><code><span class="PreventFireFoxApplyingGapToWBR">issuance<wbr/>Currency</span></code></a> and <a href="https://shopify.dev/docs/api/admin-graphql/latest/mutations/giftCardProductSet#arguments-input.fields.crossCurrencyRedeemable"><code><span class="PreventFireFoxApplyingGapToWBR">cross<wbr/>Currency<wbr/>Redeemable</span></code></a> fields can only be set during product creation. They can't be changed after the product is created.
- Anchor to inputinput•Gift
Card Product Set Input! required The properties of the gift card product to create or update.
- Anchor to synchronoussynchronous•BooleanDefault:true
Whether the mutation should be run synchronously or asynchronously.
If
true, the mutation will return the updatedproduct. Iffalse, the mutation will return a.Defaults to
true.- Anchor to identifieridentifier•Product
Set Identifiers Specifies the identifier that will be used to lookup the resource.
Arguments