Choose a version:

GiftCard

object

Requires read_gift_cards access scope.

A gift card that customers use as a payment method. Stores the initial value, current balance, and expiration date.

You can issue gift cards to a specific Customer or send them to a GiftCardRecipient with a personalized message. The card tracks its transaction history through GiftCardCreditTransaction and GiftCardDebitTransaction records. You can create and deactivate gift cards using the GiftCardCreate and GiftCardDeactivate mutations, respectively.

Note

After a gift card is deactivated, it can't be used for further purchases or re-enabled.

Anchor to FieldsFields

Anchor to balancebalance •MoneyV2! non-null: The gift card's remaining balance.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time at which the gift card was created.
Anchor to customercustomer •Customer: The customer who will receive the gift card.
Anchor to deactivatedAtdeactivatedAt •DateTime: The date and time at which the gift card was deactivated.
Anchor to enabledenabled •Boolean! non-null: Whether the gift card is enabled.
Anchor to expiresOnexpiresOn •Date: The date at which the gift card will expire.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to initialValueinitialValue •MoneyV2! non-null: The initial value of the gift card.
Anchor to lastCharacterslastCharacters •String! non-null: The final four characters of the gift card code.
Anchor to maskedCodemaskedCode •String! non-null: The gift card code. Everything but the final four characters is masked.
Anchor to notenote •String: The note associated with the gift card, which isn't visible to the customer.
Anchor to notifynotify •Boolean! non-null: Whether the customer and recipient will be notified when the gift card is issued.
Anchor to orderorder •Order: The order associated with the gift card. This value is null if the gift card was issued manually.
Anchor to recipientAttributesrecipientAttributes •GiftCardRecipient: The recipient who will receive the gift card.
Anchor to templateSuffixtemplateSuffix •String: The theme template used to render the gift card online.
Anchor to transactionstransactions •GiftCardTransactionConnection: The transaction history of the gift card.
Anchor to updatedAtupdatedAt •DateTime! non-null: The date and time at which the gift card was updated.

Was this section helpful?

Anchor to QueriesQueries

Anchor to giftCard giftCard •query: Retrieves a GiftCard by its ID. Returns the gift card's balance, transaction history, Customer information, and whether it's enabled.

Additional fields include the initial value, expiration date, deactivation timestamp (if applicable), and the associated Order if the gift card was purchased by a customer through checkout. Gift cards that merchants create manually won't have an associated order.
Anchor to giftCards giftCards •query: Returns a paginated list of GiftCard objects issued for the shop.

You can filter gift cards by attributes such as status, last characters of the code, balance status, and other values using the query parameter. You can also apply SavedSearch objects to filter results.

Was this section helpful?

Anchor to MutationsMutations

Anchor to giftCardCreate giftCardCreate •mutation: Creates a new GiftCard with a specified initial value. You can assign the gift card to a Customer or create it without assignment for manual distribution.

You can customize the gift card with an optional code, expiration date, and internal note. If you don't provide a code, the system generates a random 16 character alphanumeric code. The mutation also supports scheduling gift card notifications to recipients, with a personalized message, through the recipientAttributes field on the GiftCardCreateInput input object.
Anchor to giftCardDeactivate giftCardDeactivate •mutation: Deactivate a gift card. A deactivated gift card cannot be used by a customer. A deactivated gift card cannot be re-enabled.
Anchor to giftCardSendNotificationToCustomer giftCardSendNotificationToCustomer •mutation: Send notification to the customer of a gift card.
Anchor to giftCardSendNotificationToRecipient giftCardSendNotificationToRecipient •mutation: Send notification to the recipient of a gift card.
Anchor to giftCardUpdate giftCardUpdate •mutation: Update a gift card.

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to Node Node •interface

Was this section helpful?