gift_card オブジェクト

{
  "access": {
    "global": false,
    "parents": [],
    "template": [
      "gift_card.liquid"
    ]
  },
  "deprecated": false,
  "deprecation_reason": "",
  "description": "",
  "properties": [
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.",
      "examples": [],
      "return_type": [
        {
          "type": "number",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The remaining balance of the gift card in the currency's subunit.",
      "name": "balance"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "",
      "examples": [],
      "return_type": [
        {
          "type": "string",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The code used to redeem the gift card.",
      "name": "code"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "",
      "examples": [],
      "return_type": [
        {
          "type": "string",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The [ISO code](https://www.iso.org/iso-4217-currency-codes.html) of the currency that the gift card was issued in.",
      "name": "currency"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "",
      "examples": [],
      "return_type": [
        {
          "type": "customer",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The customer associated with the gift card.",
      "name": "customer"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "If there is no recipient associated with the gift card, then `nil` is returned.",
      "examples": [],
      "return_type": [
        {
          "type": "recipient",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The recipient associated with the gift card.",
      "name": "recipient"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "If there is no message intended for the recipient, then `nil` is returned.",
      "examples": [],
      "return_type": [
        {
          "type": "string",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The personalized message intended for the recipient.",
      "name": "message"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "If the gift card does not have a scheduled date, then `nil` is returned.\n> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the date.",
      "examples": [],
      "return_type": [
        {
          "type": "string",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The scheduled date on which the gift card will be sent to the recipient.",
      "name": "send_on"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "",
      "examples": [],
      "return_type": [
        {
          "type": "boolean",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "Returns `true` if the gift card is enabled. Returns `false` if not.",
      "name": "enabled"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "",
      "examples": [],
      "return_type": [
        {
          "type": "boolean",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "Returns `true` if the gift card is expired. Returns `false` if not.",
      "name": "expired"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "If the gift card never expires, then `nil` is returned.\n> Tip:\n> Use the [`date` filter](/docs/api/liquid/filters/date) to format the timestamp.",
      "examples": [],
      "return_type": [
        {
          "type": "string",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "A timestamp for when the gift card expires.",
      "name": "expires_on"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "The value is output in the customer's local (presentment) currency.\n\nFor currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.\n\n> Tip:\n> Use [money filters](/docs/api/liquid/filters/money-filters) to output a formatted amount.",
      "examples": [],
      "return_type": [
        {
          "type": "number",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The initial balance of the gift card in the currency's subunit.",
      "name": "initial_value"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "> Tip:\n> The page at this URL is rendered through the [`gift_card.liquid` template](/themes/architecture/templates/gift-card-liquid)\n> of the theme.",
      "examples": [],
      "return_type": [
        {
          "type": "string",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The URL to view the gift card. This URL is on the `checkout.shopify.com` domain.",
      "name": "url"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "The name doesn't include the `gift_card.` prefix, or the `.liquid` file extension.\n\n If a custom template isn't assigned to the gift card, then `nil` is returned.",
      "examples": [],
      "return_type": [
        {
          "type": "string",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The name of the [custom template](/themes/architecture/templates#alternate-templates) assigned to the gift card.",
      "name": "template_suffix"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "If there aren't any line item properties, then an [`EmptyDrop`](/docs/api/liquid/basics#emptydrop) is returned.",
      "examples": [],
      "return_type": [
        {
          "type": "array",
          "name": "",
          "description": "",
          "array_value": "untyped"
        }
      ],
      "summary": "The [line item properties](/docs/api/liquid/objects/line_item#line_item-properties) assigned to the gift card.",
      "name": "properties"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "",
      "examples": [],
      "return_type": [
        {
          "type": "string",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "A string used to generate a QR code for the gift card.",
      "name": "qr_identifier"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "",
      "examples": [],
      "return_type": [
        {
          "type": "string",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The URL to download the gift card as an Apple Wallet Pass.",
      "name": "pass_url"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "",
      "examples": [],
      "return_type": [
        {
          "type": "product",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The product associated with the gift card.",
      "name": "product"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "If there is no variant associated with the gift card, then `nil` is returned.",
      "examples": [],
      "return_type": [
        {
          "type": "variant",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The variant associated with the gift card.",
      "name": "variant"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "",
      "examples": [],
      "return_type": [
        {
          "type": "string",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The last 4 characters of the code used to redeem the gift card.",
      "name": "last_four_characters"
    }
  ],
  "summary": "A [gift card](https://help.shopify.com/manual/products/gift-card-products) that's been issued to a customer or a recipient.",
  "name": "gift_card",
  "examples": [],
  "json_data": {
    "path": "",
    "handle": "",
    "data_from_file": "{\"balance\":5000,\"code\":\"WCGX 7X97 K9HJ DFR8\",\"currency\":\"CAD\",\"customer\":{},\"enabled\":true,\"expired\":false,\"expires_on\":null,\"initial_value\":5000,\"last_four_characters\":\"DFR8\",\"message\":null,\"send_on\":null,\"pass_url\":\"https://polinas-potent-potions.myshopify.com/v1/passes/pass.com.shopify.giftcardnext/94af7fbe55d010130df8d8bc4a338d36/\",\"product\":{},\"variant\":{},\"properties\":{},\"qr_identifier\":\"shopify-giftcard-v1-3TKWJKJBM3X7PBRK\",\"recipient\":null,\"template_suffix\":null,\"url\":\"https://checkout.shopify.com/gift_cards/56174706753/0011c591fc720d0a51b80cdb694f969e\"}"
  },
  "return_type": []
}