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 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 orderorder • Order: The order associated with the gift card. This value is null if the gift card was issued manually.
Anchor to disabledAtdisabledAt • DateTimeDeprecated: The date and time at which the gift card was disabled. Use deactivatedAt instead.

Was this section helpful?

Was this section helpful?

Anchor to giftCardCreate giftCardCreate • mutation: Create a gift card.
Anchor to giftCardUpdate giftCardUpdate • mutation: Update a gift card.
Anchor to giftCardDisable giftCardDisable • mutationDeprecated: Disable a gift card. A disabled gift card cannot be used by a customer. A disabled gift card cannot be re-enabled. Use giftCardDeactivate instead.

Was this section helpful?

Was this section helpful?