Verifone · Schema

Affirm basket line items

The description of item(s) that was included in a transaction or purchase.

PaymentsPOSTerminal ManagementeCommerceFinTechPayment ProcessingOmnichannel

Properties

Name Type Description
image_url string Image URL for the line item
name string Descriptive name of the order line item
quantity integer Quantity of the order line item
unit_price integer Unit Price is charged without a decimal place e.g. $1.5 = 150. Currencies can have different decimals/exponentials, see Currencies Section for more details.
unit_price_tax integer Unit Price Tax is charged without a decimal place e.g. $1.5 = 150. Currencies can have different decimals/exponentials, see Currencies Section for more details.
tax_rate number Item Tax (VAT) Rate.
discount_amount integer Discount inclusive of tax. This is charged without a decimal place e.g. $1.5 = 150. Currencies can have different decimals/exponentials, see Currencies Section for more details.
total_tax_amount integer Total tax amount is charged without a decimal place e.g. $1.5 = 150. Currencies can have different decimals/exponentials, see Currencies Section for more details.
total_amount integer Total Amount is charged without a decimal place e.g. $1.5 = 150. Currencies can have different decimals/exponentials, see Currencies Section for more details.
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. This value is not currently supported for API ca
View JSON Schema on GitHub

JSON Schema

ecommerce-api-affirmlineitem.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/verifone/refs/heads/main/json-schema/ecommerce-api-affirmlineitem.json",
  "title": "Affirm basket line items",
  "description": "The description of item(s) that was included in a transaction or purchase.",
  "required": [
    "name",
    "suk",
    "unit_price",
    "quantity",
    "image_url",
    "item_url",
    "total_tax_amount",
    "total_amount"
  ],
  "type": "object",
  "properties": {
    "image_url": {
      "type": "string",
      "description": "Image URL for the line item"
    },
    "name": {
      "maxLength": 255,
      "type": "string",
      "description": "Descriptive name of the order line item"
    },
    "quantity": {
      "type": "integer",
      "description": "Quantity of the order line item"
    },
    "unit_price": {
      "type": "integer",
      "description": "Unit Price is charged without a decimal place  e.g. $1.5 = 150. Currencies can have different decimals/exponentials,  see Currencies Section for more details."
    },
    "unit_price_tax": {
      "type": "integer",
      "description": "Unit Price Tax is charged without a decimal place  e.g. $1.5 = 150. Currencies can have different decimals/exponentials,  see Currencies Section for more details."
    },
    "tax_rate": {
      "type": "number",
      "description": "Item Tax (VAT) Rate.",
      "format": "float"
    },
    "discount_amount": {
      "type": "integer",
      "description": "Discount inclusive of tax. This is charged without a decimal place  e.g. $1.5 = 150. Currencies can have different decimals/exponentials,  see Currencies Section for more details."
    },
    "total_tax_amount": {
      "type": "integer",
      "description": "Total tax amount is charged without a decimal place  e.g. $1.5 = 150. Currencies can have different decimals/exponentials,  see Currencies Section for more details."
    },
    "total_amount": {
      "type": "integer",
      "description": "Total Amount is charged without a decimal place  e.g. $1.5 = 150. Currencies can have different decimals/exponentials,  see Currencies Section for more details."
    },
    "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. This value is not currently supported for API callers that leverage the [PayPal for Commerce Platform](https://www.paypal.com/us/webapps/mpp/commerce-platform) product. <br />  * DIGITAL_GOODS - A tangible item that can be shipped with proof of delivery. <br />",
      "enum": [
        "DIGITAL_GOODS",
        "PHYSICAL_GOODS"
      ]
    }
  }
}