Adyen · JSON Structure

Terminal Sale Item Structure

In loyalty or value added payment card transaction, the items of the sale are entering in the processing of the transaction. Sale items of a transaction.

Type: object Properties: 11 Required: 3

PaymentsFinancial ServicesFintech

SaleItem is a JSON Structure definition published by Adyen, describing 11 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

ItemID ProductCode EanUpc UnitOfMeasure Quantity UnitPrice ItemAmount TaxCode SaleChannel ProductLabel AdditionalProductInfo

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-structure/terminal-sale-item-structure.json",
  "description": "In loyalty or value added payment card transaction, the items of the sale are entering in the processing of the transaction. Sale items of a transaction.",
  "type": "object",
  "properties": {
    "ItemID": {
      "type": "int32",
      "description": "Item identification inside a transaction (0 to n)."
    },
    "ProductCode": {
      "type": "int32",
      "minimum": 1,
      "maximum": 20,
      "description": "Product code of item purchased with the transaction."
    },
    "EanUpc": {
      "type": "int32",
      "description": "If data sent, POI has to store it and send it if the host protocol allows it."
    },
    "UnitOfMeasure": {
      "$ref": "#/components/schemas/UnitOfMeasure"
    },
    "Quantity": {
      "type": "string",
      "description": "If data sent, POI has to store it and send it if the host protocol allows it."
    },
    "UnitPrice": {
      "type": "double",
      "maximum": 99999999.999999,
      "minimum": 0,
      "description": "if Quantity present."
    },
    "ItemAmount": {
      "type": "double",
      "maximum": 99999999.999999,
      "minimum": 0,
      "description": "Total amount of the item line."
    },
    "TaxCode": {
      "type": "int32",
      "description": "If data sent, POI has to store it and send it if the host protocol allows it."
    },
    "SaleChannel": {
      "type": "int32",
      "description": "If data sent, POI has to store it and send it if the host protocol allows it."
    },
    "ProductLabel": {
      "type": "string",
      "pattern": "^.+$"
    },
    "AdditionalProductInfo": {
      "type": "string",
      "pattern": "^.+$",
      "description": "If data sent, POI has to store it and send it if the host protocol allows it."
    }
  },
  "required": [
    "ItemID",
    "ProductCode",
    "ItemAmount"
  ],
  "name": "SaleItem"
}