GiftCard
object

Choose a version:

Requires read_gift_cards access scope.

Represents an issued gift card.

Anchor to section titled 'Fields and connections'

Fields and connections

Anchor to GiftCard.balance balance MoneyV2! non-null: The gift card's remaining balance.
Anchor to GiftCard.createdAt createdAt DateTime! non-null: The date and time at which the gift card was created.
Anchor to GiftCard.customer customer Customer: The customer who will receive the gift card.
Anchor to GiftCard.deactivatedAt deactivatedAt DateTime: The date and time at which the gift card was deactivated.
Anchor to GiftCard.enabled enabled Boolean! non-null: Whether the gift card is enabled.
Anchor to GiftCard.expiresOn expiresOn Date: The date at which the gift card will expire.
Anchor to GiftCard.id id ID! non-null: A globally-unique ID.
Anchor to GiftCard.initialValue initialValue MoneyV2! non-null: The initial value of the gift card.
Anchor to GiftCard.lastCharacters lastCharacters String! non-null: The final four characters of the gift card code.
Anchor to GiftCard.maskedCode maskedCode String! non-null: The gift card code. Everything but the final four characters is masked.
Anchor to GiftCard.note note String: The note associated with the gift card, which isn't visible to the customer.
Anchor to GiftCard.order order Order: The order associated with the gift card. This value is null if the gift card was issued manually.
Anchor to GiftCard.recipientAttributes recipientAttributes GiftCardRecipient: The recipient who will receive the gift card.
Anchor to GiftCard.templateSuffix templateSuffix String: The theme template used to render the gift card online.
Anchor to GiftCard.transactions transactions GiftCardTransactionConnection: The transaction history of the gift card.
Anchor to GiftCard.updatedAt updatedAt DateTime! non-null: The date and time at which the gift card was updated.

Was this section helpful?

Anchor to section titled 'Queries'

Queries

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?

<?>

GiftCard Queries

GiftCard

Queried by

Anchor to section titled 'Mutations'

Mutations

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?

<~>

GiftCard Mutations

GiftCard

Mutated by

Anchor to section titled 'Implements'

Implements

Anchor to Node Node interface

Was this section helpful?

||-

GiftCard Implements

GiftCard

Implements

Node

GiftCardobject

Fields and connections

Fields and connections from

Queries

Queried by

Mutations

Mutated by

Implements

Implements

GiftCard
object