# Gift Cards

Gift Cards are ones that were purchased during an order.

# The Gift Card Object

# Sample

{
  "id": "8f89c458-5c57-4721-878e-23ca4c2cef2b",
  "amount": 100,
  "balance": 4.41325,
  "code": "12345",
  "created_at": "2020-01-05 10:04:34",
  "updated_at": "2020-01-05 10:12:09",
  "gift_card_product": {
    "id": "8f89c458"
  },
  "order": {
    "id": "8f89c6a"
  }
}

# Attributes

Field	Type	Rule	Description
`id`	`string`		Unique identifier for the gift card.
`amount`	`string`	`updatable`	The amount of the gift card
`balance`	`string`	`updatable`	The balance of the gift card
`code`	`string`	`nullable` `updatable`	The gift card code
`order`	`object`	`nullable` `updatable`	The details of the order attached to the gift card
`gift_card_product`	`object`	`includable` `updatable`	The details of the gift card product attached to the gift card

# Get Gift Card

GET /gift_cards/{code}

# Scope

orders.gift_cards.read

# Response

{
  "data": {
    "id": "8f89c458-5c57-4721-878e-23ca4c2cef2b",
    "amount": 100,
    "balance": 4.41325,
    "code": "12345",
    "created_at": "2020-01-05 10:04:34",
    "updated_at": "2020-01-05 10:12:09",
    "gift_card_product": {
      "id": "8f89c458"
    },
    "order": {
      "id": "8f89c6a"
    }
  }
}

← Gift Card Transactions Groups →