Choose a version:

GiftCard

object

Requires read_gift_cards access scope.

Represents an issued gift card.

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: Returns a gift card resource by ID.
Anchor to giftCards giftCards •query: Returns a list of gift cards.

Was this section helpful?

Anchor to MutationsMutations

Anchor to giftCardCreate giftCardCreate •mutation: Create a gift card.
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?