Skip to main content

giftCard Query

Look up a gift card by ID.

Requires the MANAGE_GIFT_CARDpermission.
giftCard(
  id: ID!
): GiftCard
Details
type GiftCard implements Node, ObjectWithMetadata {
  id: ID!
  privateMetadata: [MetadataItem!]!
  privateMetafield(
    key: String!
  ): String
  privateMetafields(
    keys: [String!]
  ): Metadata
  metadata: [MetadataItem!]!
  metafield(
    key: String!
  ): String
  metafields(
    keys: [String!]
  ): Metadata
  displayCode: String!
  last4CodeChars: String!
  code: String!
  created: DateTime!
  createdBy: User
  usedBy: User @deprecated
  createdByEmail: String
  usedByEmail: String @deprecated
  lastUsedOn: DateTime
  expiryDate: Date
  app: App
  product: Product
  events(
    filter: GiftCardEventFilterInput
  ): [GiftCardEvent!]!
  tags: [GiftCardTag!]!
  boughtInChannel: String
  isActive: Boolean!
  initialBalance: Money!
  currentBalance: Money!
  user: User @deprecated
  endDate: DateTime @deprecated
  startDate: DateTime @deprecated
}

Arguments​

id ● ID!​

ID of the gift card.

Type​

GiftCard​

A gift card is a prepaid electronic payment card accepted in stores. They can be used during checkout by providing a valid gift card codes.