> Documentation index: [Saleor](/llms.txt) · [This section](/api-reference/gift-cards/llms.txt)
> Source: https://docs.saleor.io/api-reference/gift-cards/objects/gift-card

# GiftCard Object

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.

```graphql
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
  assignedTo: User
  assignedToEmail: String
  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
}
```

<a id="fields"></a>

### Fields

<a id="id"></a>

#### [`id`](#id) ● [`ID!`](/api-reference/miscellaneous/scalars/id.md)

ID of the gift card.

<a id="private-metadata"></a>

#### [`privateMetadata`](#private-metadata) ● [`[MetadataItem!]!`](/api-reference/miscellaneous/objects/metadata-item.md)

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

<a id="private-metafield"></a>

#### [`privateMetafield`](#private-metafield) ● [`String`](/api-reference/miscellaneous/scalars/string.md)

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

Tip: Use GraphQL aliases to fetch multiple keys.

<a id="gift-card-private-metafield-key"></a>

##### [`key`](#gift-card-private-metafield-key) ● [`String!`](/api-reference/miscellaneous/scalars/string.md)

<a id="private-metafields"></a>

#### [`privateMetafields`](#private-metafields) ● [`Metadata`](/api-reference/miscellaneous/scalars/metadata.md)

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

<a id="gift-card-private-metafields-keys"></a>

##### [`keys`](#gift-card-private-metafields-keys) ● [`[String!]`](/api-reference/miscellaneous/scalars/string.md)

<a id="metadata"></a>

#### [`metadata`](#metadata) ● [`[MetadataItem!]!`](/api-reference/miscellaneous/objects/metadata-item.md)

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

<a id="metafield"></a>

#### [`metafield`](#metafield) ● [`String`](/api-reference/miscellaneous/scalars/string.md)

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

<a id="gift-card-metafield-key"></a>

##### [`key`](#gift-card-metafield-key) ● [`String!`](/api-reference/miscellaneous/scalars/string.md)

<a id="metafields"></a>

#### [`metafields`](#metafields) ● [`Metadata`](/api-reference/miscellaneous/scalars/metadata.md)

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

<a id="gift-card-metafields-keys"></a>

##### [`keys`](#gift-card-metafields-keys) ● [`[String!]`](/api-reference/miscellaneous/scalars/string.md)

<a id="display-code"></a>

#### [`displayCode`](#display-code) ● [`String!`](/api-reference/miscellaneous/scalars/string.md)

Code in format which allows displaying in a user interface.

<a id="last-4-code-chars"></a>

#### [`last4CodeChars`](#last-4-code-chars) ● [`String!`](/api-reference/miscellaneous/scalars/string.md)

Last 4 characters of gift card code.

<a id="code"></a>

#### [`code`](#code) ● [`String!`](/api-reference/miscellaneous/scalars/string.md)

Gift card code. It can be fetched both by a staff member with 'MANAGE\_GIFT\_CARD' when gift card hasn't been used yet or a user who bought or issued the gift card.

Requires one of the following permissions: MANAGE\_GIFT\_CARD OWNER

<a id="created"></a>

#### [`created`](#created) ● [`DateTime!`](/api-reference/miscellaneous/scalars/date-time.md)

Date and time when gift card was created.

<a id="created-by"></a>

#### [`createdBy`](#created-by) ● [`User`](/api-reference/users/objects/user.md)

The user who bought or issued a gift card.

<a id="created-by-email"></a>

#### [`createdByEmail`](#created-by-email) ● [`String`](/api-reference/miscellaneous/scalars/string.md)

Email address of the user who bought or issued gift card.

Requires one of the following permissions: MANAGE\_USERS OWNER

<a id="assigned-to"></a>

#### [`assignedTo`](#assigned-to) ● [`User`](/api-reference/users/objects/user.md)

The customer the gift card usage is restricted to.

Requires one of the following permissions: MANAGE\_USERS OWNER

Added in Saleor 3.23

<a id="assigned-to-email"></a>

#### [`assignedToEmail`](#assigned-to-email) ● [`String`](/api-reference/miscellaneous/scalars/string.md)

Email of the customer the gift card is restricted to.

Requires one of the following permissions: MANAGE\_GIFT\_CARD OWNER

Added in Saleor 3.23

<a id="last-used-on"></a>

#### [`lastUsedOn`](#last-used-on) ● [`DateTime`](/api-reference/miscellaneous/scalars/date-time.md)

Date and time when gift card was last used.

<a id="expiry-date"></a>

#### [`expiryDate`](#expiry-date) ● [`Date`](/api-reference/miscellaneous/scalars/date.md)

Expiry date of the gift card.

<a id="app"></a>

#### [`app`](#app) ● [`App`](/api-reference/apps/objects/app.md)

App which created the gift card.

Requires one of the following permissions: MANAGE\_APPS OWNER

<a id="product"></a>

#### [`product`](#product) ● [`Product`](/api-reference/products/objects/product.md)

Related gift card product.

<a id="events"></a>

#### [`events`](#events) ● [`[GiftCardEvent!]!`](/api-reference/gift-cards/objects/gift-card-event.md)

List of events associated with the gift card. Requires MANAGE\_GIFT\_CARD permission to access all events. Users with MANAGE\_ORDERS permission can access only USED\_IN\_ORDER and REFUNDED\_IN\_ORDER events.

Requires one of the following permissions: MANAGE\_GIFT\_CARD MANAGE\_ORDERS

<a id="gift-card-events-filter"></a>

##### [`filter`](#gift-card-events-filter) ● [`GiftCardEventFilterInput`](/api-reference/gift-cards/inputs/gift-card-event-filter-input.md)

Filtering options for gift card events.

<a id="tags"></a>

#### [`tags`](#tags) ● [`[GiftCardTag!]!`](/api-reference/gift-cards/objects/gift-card-tag.md)

The gift card tag.

Requires the MANAGE\_GIFT\_CARD permission.

<a id="bought-in-channel"></a>

#### [`boughtInChannel`](#bought-in-channel) ● [`String`](/api-reference/miscellaneous/scalars/string.md)

Slug of the channel where the gift card was bought.

<a id="is-active"></a>

#### [`isActive`](#is-active) ● [`Boolean!`](/api-reference/miscellaneous/scalars/boolean.md)

<a id="initial-balance"></a>

#### [`initialBalance`](#initial-balance) ● [`Money!`](/api-reference/miscellaneous/objects/money.md)

<a id="current-balance"></a>

#### [`currentBalance`](#current-balance) ● [`Money!`](/api-reference/miscellaneous/objects/money.md)

Show deprecatedHide deprecated

<a id="used-by"></a>

#### [`usedBy`](#used-by) ● [`User`](/api-reference/users/objects/user.md)

DEPRECATED

No longer supported

The customer who used a gift card.

<a id="used-by-email"></a>

#### [`usedByEmail`](#used-by-email) ● [`String`](/api-reference/miscellaneous/scalars/string.md)

DEPRECATED

No longer supported

Email address of the customer who used a gift card.

<a id="user"></a>

#### [`user`](#user) ● [`User`](/api-reference/users/objects/user.md)

DEPRECATED

Use `createdBy` field instead.

The customer who bought a gift card.

<a id="end-date"></a>

#### [`endDate`](#end-date) ● [`DateTime`](/api-reference/miscellaneous/scalars/date-time.md)

DEPRECATED

Use `expiryDate` field instead.

End date of gift card.

<a id="start-date"></a>

#### [`startDate`](#start-date) ● [`DateTime`](/api-reference/miscellaneous/scalars/date-time.md)

DEPRECATED

No longer supported

Start date of gift card.

<a id="interfaces"></a>

### Interfaces

<a id="node"></a>

#### [`Node`](/api-reference/miscellaneous/interfaces/node.md)

An object with an ID

<a id="objectwithmetadata"></a>

#### [`ObjectWithMetadata`](/api-reference/miscellaneous/interfaces/object-with-metadata.md)

<a id="returned-by"></a>

### Returned By

[`giftCard`](/api-reference/gift-cards/queries/gift-card.md) query

<a id="member-of"></a>

### Member Of

[`Checkout`](/api-reference/checkout/objects/checkout.md) object  ● [`GiftCardActivate`](/api-reference/gift-cards/objects/gift-card-activate.md) object  ● [`GiftCardAddNote`](/api-reference/gift-cards/objects/gift-card-add-note.md) object  ● [`GiftCardAssignUser`](/api-reference/gift-cards/objects/gift-card-assign-user.md) object  ● [`GiftCardBalanceAdjust`](/api-reference/gift-cards/objects/gift-card-balance-adjust.md) object  ● [`GiftCardBulkCreate`](/api-reference/gift-cards/objects/gift-card-bulk-create.md) object  ● [`GiftCardCountableEdge`](/api-reference/gift-cards/objects/gift-card-countable-edge.md) object  ● [`GiftCardCreate`](/api-reference/gift-cards/objects/gift-card-create.md) object  ● [`GiftCardCreated`](/api-reference/gift-cards/objects/gift-card-created.md) object  ● [`GiftCardDeactivate`](/api-reference/gift-cards/objects/gift-card-deactivate.md) object  ● [`GiftCardDelete`](/api-reference/gift-cards/objects/gift-card-delete.md) object  ● [`GiftCardDeleted`](/api-reference/gift-cards/objects/gift-card-deleted.md) object  ● [`GiftCardMetadataUpdated`](/api-reference/gift-cards/objects/gift-card-metadata-updated.md) object  ● [`GiftCardResend`](/api-reference/gift-cards/objects/gift-card-resend.md) object  ● [`GiftCardSent`](/api-reference/gift-cards/objects/gift-card-sent.md) object  ● [`GiftCardStatusChanged`](/api-reference/gift-cards/objects/gift-card-status-changed.md) object  ● [`GiftCardUnassignUser`](/api-reference/gift-cards/objects/gift-card-unassign-user.md) object  ● [`GiftCardUpdate`](/api-reference/gift-cards/objects/gift-card-update.md) object  ● [`GiftCardUpdated`](/api-reference/gift-cards/objects/gift-card-updated.md) object  ● [`Order`](/api-reference/orders/objects/order.md) object