Improvements in the GiftCard GraphQL endpoints and introducing GiftCardTransaction types

API

As of the GraphQL Admin API version 2024-10, we're improving the GiftCard endpoints and introducing GiftCardTransaction types. The gift card endpoints are now open to all apps and shops, with no additional approval scopes or flags required.

We have added the following mutations:

• giftCardDeactivate renamed from giftCardDisable (deprecated).
• giftCardCredit to apply credit to a gift card returning a GiftCardCreditTransaction.
• giftCardDebit to apply debit to a gift card returning a GiftCardDebitTransaction.
• giftCardSendNotificationToCustomer to send the notification to the customer.
• giftCardSendNotificationToRecipient to send the notification to the recipient.

We have updated the following mutations:

• giftCardCreate to add recipientAttributes.
• giftCardUpdate to add recipientAttributes.

We have added and modified fields in the GiftCard object:

• Added updatedAt.
• Added recipientAttributes.
• Added transactions returning all transactions created by credits and debits.
• Renamed disabledAt to deactivatedAt (deprecated).

Developer action required

Developers using the existing giftCardDisable mutation will need to replace it with giftCardDeactivate

Developers using the disableAt property on the GiftCard object will need to replace it with deactivatedAt

To learn more about gift cards, refer to the gift cards documentation. To learn more about gift card recipient functionality, refer to the help center documentation for recipient fields