Skip to main content

giftCardBalanceAdjust Mutation

Adjust a gift card's balance by a signed delta atomically.

Added in Saleor 3.23.

Requires the MANAGE_GIFT_CARDpermission.

Triggers the following webhook events:

  • GIFT_CARD_UPDATED (async): A gift card was updated.
giftCardBalanceAdjust(
  amount: Decimal!
  id: ID!
): GiftCardBalanceAdjust
Details
type GiftCardBalanceAdjust {
  giftCard: GiftCard
  giftCardErrors: [GiftCardError!]! @deprecated
  errors: [GiftCardError!]!
}

Arguments​

amount ● Decimal!​

Signed amount to adjust the current balance by. Positive tops up, negative deducts. A deduction below zero clamps the balance to zero. A top-up above the initial balance raises the initial balance to the new current balance.

Added in Saleor 3.23.

id ● ID!​

ID of the gift card to adjust.

Type​

GiftCardBalanceAdjust​

Adjust a gift card's balance by a signed delta atomically.

Added in Saleor 3.23.

Requires the MANAGE_GIFT_CARDpermission.

Triggers the following webhook events:

  • GIFT_CARD_UPDATED (async): A gift card was updated.