Gift
Requires access scope.
Represents an issued gift card.
Anchor to Fields and connectionsFields and connections
- Anchor to balancebalance•Money
V2!non-null The gift card's remaining balance.
- Anchor to createdAtcreated•Date
At Time!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 deactivatedAtdeactivated•Date
At Time 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 expiresOnexpires•Date
On The date at which the gift card will expire.
- •ID!non-null
A globally-unique ID.
- Anchor to initialValueinitial•Money
Value V2!non-null The initial value of the gift card.
- Anchor to lastCharacterslast•String!non-null
Characters The final four characters of the gift card code.
- Anchor to maskedCodemasked•String!non-null
Code 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
nullif the gift card was issued manually.- Anchor to recipientAttributesrecipient•Gift
Attributes Card Recipient The recipient who will receive the gift card.
- Anchor to templateSuffixtemplate•String
Suffix The theme template used to render the gift card online.
- Anchor to transactionstransactions•Gift
Card Transaction Connection The transaction history of the gift card.
- Anchor to updatedAtupdated•Date
At Time!non-null The date and time at which the gift card was updated.
Anchor to QueriesQueries
- •query
Returns a gift card resource by ID.
- •query
Returns a list of gift cards.
Anchor to MutationsMutations
- •mutation
Create a gift card.
- Anchor to inputinput•Gift
Card Create Input!required The input fields to create a gift card.
Arguments
- Anchor to giftCardgift•Gift
Card Card The created gift card.
- Anchor to giftCardCodegift•String
Card Code The created gift card's code.
- Anchor to userErrorsuser•[Gift
Errors Card User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Deactivate a gift card. A deactivated gift card cannot be used by a customer. A deactivated gift card cannot be re-enabled.
- •ID!required
The ID of the gift card to deactivate.
Arguments
- Anchor to giftCardgift•Gift
Card Card The deactivated gift card.
- Anchor to userErrorsuser•[Gift
Errors Card Deactivate User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Send notification to the customer of a gift card.
- •ID!required
The ID of the gift card to send.
Arguments
- Anchor to giftCardgift•Gift
Card Card The gift card that was sent.
- Anchor to userErrorsuser•[Gift
Errors Card Send Notification To Customer User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Send notification to the recipient of a gift card.
- •ID!required
The ID of the gift card to send.
Arguments
- Anchor to giftCardgift•Gift
Card Card The gift card that was sent.
- Anchor to userErrorsuser•[Gift
Errors Card Send Notification To Recipient User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Update a gift card.
- •ID!required
The ID of the gift card to be updated.
- Anchor to inputinput•Gift
Card Update Input!required The input fields to update the gift card.
Arguments
- Anchor to giftCardgift•Gift
Card Card The updated gift card.
- Anchor to userErrorsuser•[User
Errors Error!]!non-null The list of errors that occurred from executing the mutation.
Fields