Skip to main content

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.

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
  usedByEmail: String @deprecated
  lastUsedOn: DateTime
  expiryDate: Date
  product: Product
  boughtInChannel: String
  isActive: Boolean!
  initialBalance: Money!
  currentBalance: Money!
  user: User @deprecated
  endDate: DateTime @deprecated
  startDate: DateTime @deprecated
}

Fields​

GiftCard.id ● ID! non-null scalar​

GiftCard.privateMetadata ● [MetadataItem!]! non-null object​

List of private metadata items. Requires staff permissions to access.

GiftCard.privateMetafield ● String scalar​

A single key from private metadata. Requires staff permissions to access.

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.3
This API is currently in Feature Preview and can be subject to changes at later point.
GiftCard.privateMetafield.key ● String! non-null scalar​

GiftCard.privateMetafields ● Metadata scalar​

Private metadata. Requires staff permissions to access. Use keys to control which fields you want to include. The default is to include everything.

Added in Saleor 3.3
This API is currently in Feature Preview and can be subject to changes at later point.
GiftCard.privateMetafields.keys ● [String!] list scalar​

GiftCard.metadata ● [MetadataItem!]! non-null object​

List of public metadata items. Can be accessed without permissions.

GiftCard.metafield ● String scalar​

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.3
This API is currently in Feature Preview and can be subject to changes at later point.
GiftCard.metafield.key ● String! non-null scalar​

GiftCard.metafields ● Metadata scalar​

Public metadata. Use keys to control which fields you want to include. The default is to include everything.

Added in Saleor 3.3
This API is currently in Feature Preview and can be subject to changes at later point.
GiftCard.metafields.keys ● [String!] list scalar​

GiftCard.displayCode ● String! non-null scalar​

Code in format which allows displaying in a user interface.

GiftCard.last4CodeChars ● String! non-null scalar​

Last 4 characters of gift card code.

GiftCard.code ● String! non-null scalar​

Gift card code. Can be fetched by a staff member with MANAGE_GIFT_CARD when gift card wasn't yet used and by the gift card owner.

GiftCard.created ● DateTime! non-null scalar​

GiftCard.createdBy ● User object​

The user who bought or issued a gift card.

Added in Saleor 3.1

GiftCard.usedBy ● User deprecated object​

DEPRECATED

This field will be removed in Saleor 4.0.

The customer who used a gift card.

Added in Saleor 3.1

GiftCard.usedByEmail ● String deprecated scalar​

DEPRECATED

This field will be removed in Saleor 4.0.

Email address of the customer who used a gift card.

Added in Saleor 3.1

GiftCard.lastUsedOn ● DateTime scalar​

GiftCard.expiryDate ● Date scalar​

GiftCard.product ● Product object​

Related gift card product.

Added in Saleor 3.1

GiftCard.boughtInChannel ● String scalar​

Slug of the channel where the gift card was bought.

Added in Saleor 3.1

GiftCard.isActive ● Boolean! non-null scalar​

GiftCard.initialBalance ● Money! non-null object​

GiftCard.currentBalance ● Money! non-null object​

GiftCard.user ● User deprecated object​

DEPRECATED

This field will be removed in Saleor 4.0. Use createdBy field instead.

The customer who bought a gift card.

GiftCard.endDate ● DateTime deprecated scalar​

DEPRECATED

This field will be removed in Saleor 4.0. Use expiryDate field instead.

End date of gift card.

GiftCard.startDate ● DateTime deprecated scalar​

DEPRECATED

This field will be removed in Saleor 4.0.

Start date of gift card.

Interfaces​

Node interface​

An object with an ID

ObjectWithMetadata interface​

Member of​

Checkout object ● GiftCardCountableEdge object ● Order object

Was this page helpful?