Skip to main content

GiftcardRedemption

Representation of a gift card redemption

type GiftcardRedemption {
  id: Int!
  giftCardId: Int!
  createdAt: DateTime
  customerId: Int!
  value: MonetaryValue
  orderId: Int!
  orderRowId: Int!
  giftCard: GiftcardPurchase!
}

Fields​

id ● Int!​

Id of redemption

giftCardId ● Int!​

Id of the gift card

createdAt ● DateTime​

Timestamp when the row was created

customerId ● Int!​

Redeemed by

value ● MonetaryValue​

Redeemed value, and currency

orderId ● Int!​

Redeemed on order id

orderRowId ● Int!​

Redeemed on order row id

giftCard ● GiftcardPurchase!​

The giftcard that was redeemed

Example​

{
  "id": 1345,
  "giftCardId": 342,
  "createdAt": "2024-05-03T11:52:33Z",
  "customerId": 2,
  "value": {
    "currency": {
      "code": "USD",
      "rate": 11.355,
      "prefix": "$"
    },
    "tax": {}
  },
  "orderId": 10341,
  "orderRowId": 23422,
  "giftCard": {}
}