Skip to main content

GiftCardEvent Object

History log of the gift card.

type GiftCardEvent implements Node {
  id: ID!
  date: DateTime
  type: GiftCardEventsEnum
  user: User
  app: App
  message: String
  email: String
  orderId: ID
  orderNumber: String
  tags: [String!]
  oldTags: [String!]
  balance: GiftCardEventBalance
  expiryDate: Date
  oldExpiryDate: Date
}

Fields​

id ● ID!​

ID of the event associated with a gift card.

date ● DateTime​

Date when event happened at in ISO 8601 format.

type ● GiftCardEventsEnum​

Gift card event type.

user ● User​

User who performed the action.

Requires one of the following permissions: MANAGE_USERSMANAGE_STAFFOWNER

app ● App​

App that performed the action.

Requires one of the following permissions: MANAGE_APPSOWNER

message ● String​

Content of the event.

email ● String​

Email of the customer.

orderId ● ID​

The order ID where gift card was used or bought.

orderNumber ● String​

User-friendly number of an order where gift card was used or bought.

tags ● [String!]​

The list of gift card tags.

oldTags ● [String!]​

The list of old gift card tags.

balance ● GiftCardEventBalance​

The gift card balance.

expiryDate ● Date​

The gift card expiry date.

oldExpiryDate ● Date​

Previous gift card expiry date.

Interfaces​

Node​

An object with an ID

Member Of​

GiftCard object ● GiftCardAddNote object