giftCardBalanceAdjust Mutation

Adjust a gift card’s balance by a delta.

Added in Saleor 3.23.

Triggers the following webhook events:

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

Applied directives

@webhookEventsInfo(asyncEvents: [GIFT_CARD_UPDATED], syncEvents: [])

giftCardBalanceAdjust(amount: Decimal!, id: ID!): GiftCardBalanceAdjust

Returns

GiftCardBalanceAdjust

type GiftCardBalanceAdjust {
  giftCard: GiftCard
  giftCardErrors: [GiftCardError!]! @deprecated(reason: "Use `errors` field instead.")
  errors: [GiftCardError!]!
}

Arguments

amount

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.

id

id · ID!

ID of the gift card to adjust.

Schema: Saleor 3.23.43. Download SDL.