giftCertificate_Full

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/giftCertificate_Full",
  "title": "giftCertificate_Full",
  "description": "",
  "allOf": [
    {
      "$ref": "#/components/schemas/giftCertificate_Base"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "The ID of the gift certificate. This is a READ-ONLY field; do not set or modify its value in a POST or PUT request.",
          "example": 1
        },
        "customer_id": {
          "type": "integer",
          "description": "The ID of the customer placing the order.",
          "example": 5
        },
        "order_id": {
          "type": "integer",
          "description": "The ID of the order.",
          "example": 116
        },
        "balance": {
          "type": "string",
          "description": "Remaining value of the gift certificate. If not set, will default to the amount.",
          "example": "0"
        },
        "purchase_date": {
          "type": "string",
          "description": "Date the gift certificate was purchased. If not assigned, this will be set to today\u2019s date. Date displays in the [RFC 2822](https://www.rfc-editor.org/rfc/rfc2822#section-3.3) timestamp format.",
          "example": "Tue, 20 Jan 1970 08:45:38 CST"
        },
        "expiry_date": {
          "type": "string",
          "description": "Date on which the gift certificate is set to expire. Date displays in the [RFC 2822](https://www.rfc-editor.org/rfc/rfc2822#section-3.3) timestamp format.",
          "example": "Mon, 2 Jan 2023 08:45:38 CST"
        },
        "template": {
          "type": "string",
          "description": "The email theme to use in the message sent to the recipient.",
          "example": "celebration.html",
          "enum": [
            "birthday.html",
            "girl.html",
            "boy.html",
            "celebration.html",
            "christmas.html",
            "general.html"
          ]
        },
        "message": {
          "type": "string",
          "description": "Text that will be sent to the recipient, such as \u201cCongratulations.\u201d",
          "example": "Congratulations!"
        },
        "code": {
          "maxLength": 255,
          "type": "string",
          "description": "A unique string that a customer can input to redeem a gift certificate. Values greater than 20 characters will be trimmed down to the first 20 characters and returned in the response.\nIf this field is not set, a value will be autogenerated.",
          "example": "FFZ-5N4-C7M-S78"
        },
        "status": {
          "type": "string",
          "example": "active",
          "enum": [
            "active",
            "pending",
            "disabled",
            "expired"
          ]
        },
        "currency_code": {
          "type": "string",
          "description": "A currency code, following the ISO 4217 standard. The currency has to exist in the store first.\n\nGift Certificates can only be used if the transactional currency of the cart is the same as the one defined in the gift certificate. If this value is not provided, the gift certificate is created using the store's default transactional currency.",
          "example": "USD"
        }
      }
    }
  ],
  "x-internal": false
}