Verifone · Schema

LineItem

LineItem from Checkout API

PaymentsPOSTerminal ManagementeCommerceFinTechPayment ProcessingOmnichannel

Properties

Name Type Description
image_url string Image URL for the line item
item_url string Item URL for the line item
name string Descriptive name of the order line item
quantity integer Quantity of the order line item
unit_price number Unit Price
unit_price_tax number Unit Price Tax
tax_rate number Additional details specific to this type of event
total_tax_amount number Total tax amount
total_amount number Total Amount
sku string The stock keeping unit (SKU) for the item.
description string The detailed item description.
category string The item category type.
The possible values are:
* DIGITAL_GOODS - Goods that are stored, delivered, and used in their electronic format.
* PHYSICAL_GOODS - A tangible item that c
View JSON Schema on GitHub

JSON Schema

checkout-api-lineitem.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/verifone/refs/heads/main/json-schema/checkout-api-lineitem.json",
  "title": "LineItem",
  "description": "LineItem from Checkout API",
  "required": [
    "name",
    "total_amount"
  ],
  "type": "object",
  "properties": {
    "image_url": {
      "maxLength": 2000,
      "type": "string",
      "description": "Image URL for the line item"
    },
    "item_url": {
      "maxLength": 2000,
      "type": "string",
      "description": "Item URL for the line item"
    },
    "name": {
      "maxLength": 255,
      "type": "string",
      "description": "Descriptive name of the order line item"
    },
    "quantity": {
      "type": "integer",
      "default": 1,
      "description": "Quantity of the order line item"
    },
    "unit_price": {
      "type": "number",
      "description": "Unit Price"
    },
    "unit_price_tax": {
      "type": "number",
      "description": "Unit Price Tax"
    },
    "tax_rate": {
      "type": "number",
      "description": "Additional details specific to this type of event"
    },
    "total_tax_amount": {
      "type": "number",
      "description": "Total tax amount"
    },
    "total_amount": {
      "type": "number",
      "description": "Total Amount"
    },
    "sku": {
      "maxLength": 127,
      "type": "string",
      "description": "The stock keeping unit (SKU) for the item."
    },
    "description": {
      "maxLength": 127,
      "type": "string",
      "description": "The detailed item description."
    },
    "category": {
      "type": "string",
      "description": "The item category type. <br />  The possible values are: <br />  * DIGITAL_GOODS - Goods that are stored, delivered, and used in their electronic format. <br />  * PHYSICAL_GOODS - A tangible item that can be shipped with proof of delivery.",
      "enum": [
        "DIGITAL_GOODS",
        "PHYSICAL_GOODS"
      ]
    }
  }
}