Adyen · Schema

SaleItem

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.

PaymentsFinancial ServicesFintech

Properties

Name Type Description
ItemID integer Item identification inside a transaction (0 to n).
ProductCode integer Product code of item purchased with the transaction.
EanUpc integer If data sent, POI has to store it and send it if the host protocol allows it.
UnitOfMeasure object
Quantity string If data sent, POI has to store it and send it if the host protocol allows it.
UnitPrice number if Quantity present.
ItemAmount number Total amount of the item line.
TaxCode integer If data sent, POI has to store it and send it if the host protocol allows it.
SaleChannel integer If data sent, POI has to store it and send it if the host protocol allows it.
ProductLabel string
AdditionalProductInfo string If data sent, POI has to store it and send it if the host protocol allows it.
View JSON Schema on GitHub

JSON Schema

adyen-saleitem-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SaleItem",
  "title": "SaleItem",
  "type": "object",
  "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.",
  "properties": {
    "ItemID": {
      "type": "integer",
      "description": "Item identification inside a transaction (0 to n)."
    },
    "ProductCode": {
      "type": "integer",
      "minimum": 1,
      "maximum": 20,
      "description": "Product code of item purchased with the transaction."
    },
    "EanUpc": {
      "type": "integer",
      "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": "number",
      "maximum": 99999999.999999,
      "minimum": 0,
      "description": "if Quantity present."
    },
    "ItemAmount": {
      "type": "number",
      "maximum": 99999999.999999,
      "minimum": 0,
      "description": "Total amount of the item line."
    },
    "TaxCode": {
      "type": "integer",
      "description": "If data sent, POI has to store it and send it if the host protocol allows it."
    },
    "SaleChannel": {
      "type": "integer",
      "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"
  ]
}