discount_application オブジェクト

{
  "access": {
    "global": false,
    "parents": [
      {
        "object": "cart",
        "property": "discount_applications"
      },
      {
        "object": "order",
        "property": "discount_applications"
      },
      {
        "object": "discount_allocation",
        "property": "discount_application"
      }
    ],
    "template": []
  },
  "deprecated": false,
  "deprecation_reason": "",
  "description": "To learn about how to display discounts in your theme, refer to [Discounts](/themes/pricing-payments/discounts).",
  "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 total amount of the discount in the currency's subunit.",
      "name": "total_allocated_amount"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "",
      "examples": [],
      "return_type": [
        {
          "type": "string",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The customer-facing name of the discount.",
      "name": "title"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "How this value is interpreted depends on the [value type](/docs/api/liquid/objects/discount_application#discount_application-value_type) of the\ndiscount. The following table outlines what the value represents for each value type:\n\n| Value type | Value |\n| --- | --- |\n| `fixed_amount` | The amount of the discount in the currency's subunit. |\n| `percentage` | The percent amount of the discount. |\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 price.",
      "examples": [],
      "return_type": [
        {
          "type": "number",
          "name": "",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The value of the discount.",
      "name": "value"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "> Note:\n> Whether the selection method applies to line items or shipping lines depends on the discount's\n> [target type](/docs/api/liquid/objects/discount_application#discount_application-target_type).",
      "examples": [],
      "return_type": [
        {
          "type": "string",
          "name": "all",
          "description": "The discount applies to all line items or shipping lines.",
          "array_value": ""
        },
        {
          "type": "string",
          "name": "entitled",
          "description": "The discount applies to a specific set of line items or shipping lines based on some criteria.",
          "array_value": ""
        },
        {
          "type": "string",
          "name": "explicit",
          "description": "The discount applies to a specific line item or shipping line.",
          "array_value": ""
        }
      ],
      "summary": "The selection method for line items or shipping lines to be discounted.",
      "name": "target_selection"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "",
      "examples": [],
      "return_type": [
        {
          "type": "string",
          "name": "automatic",
          "description": "",
          "array_value": ""
        },
        {
          "type": "string",
          "name": "discount_code",
          "description": "",
          "array_value": ""
        },
        {
          "type": "string",
          "name": "manual",
          "description": "",
          "array_value": ""
        },
        {
          "type": "string",
          "name": "script",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The type of the discount.",
      "name": "type"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "",
      "examples": [],
      "return_type": [
        {
          "type": "string",
          "name": "fixed_amount",
          "description": "",
          "array_value": ""
        },
        {
          "type": "string",
          "name": "percentage",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The value type of the discount.",
      "name": "value_type"
    },
    {
      "deprecated": false,
      "deprecation_reason": "",
      "description": "",
      "examples": [],
      "return_type": [
        {
          "type": "string",
          "name": "line_item",
          "description": "",
          "array_value": ""
        },
        {
          "type": "string",
          "name": "shipping_line",
          "description": "",
          "array_value": ""
        }
      ],
      "summary": "The type of item that the discount applies to.",
      "name": "target_type"
    }
  ],
  "summary": "Information about the intent of a discount.",
  "name": "discount_application",
  "examples": [],
  "json_data": {
    "path": "/",
    "handle": "cart.discount_applications[0]",
    "data_from_file": ""
  },
  "return_type": []
}