Item: Difference between revisions

From Barion Documentation
Jump to navigation Jump to search
No edit summary
m (fixed typo)
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
= Item structure =
{{PageTitle|title=Item structure}}


This structure represents an included in a payment transaction. An item can describe a product or service.
This structure represents an item included in a payment transaction. An item can describe a product or service.


== Included in ==  
= Included in =


Items are used in the following structures:
Items are used in the following structures:
* [[PaymentTransaction]]
* [[PaymentTransaction]]
* [[DetailedPaymentTransaction]]


== Property list ==
= Property list =


{{api_input_table_header}}
{{api_input_table_header}}
Line 22: Line 23:
|| The detailed description of the item. This is NOT shown to the payer on the Barion Smart Gateway.
|| The detailed description of the item. This is NOT shown to the payer on the Barion Smart Gateway.
|-
|-
| ImageUrl || decimal ||  
| ImageUrl || string ||  
* Optional
* Optional
|| A URL pointing to an image that shows the item. This is optional and available for UX purposes only.
|| A URL pointing to an image that shows the item. This is optional and available for UX purposes only.
Line 37: Line 38:
| UnitPrice || decimal ||  
| UnitPrice || decimal ||  
* Required
* Required
|| The price of one measurement unit of the item.
|| The price of one measurement unit of the item. It can be any value, even negative if it indicates e.g. discount.
|-
|-
| ItemTotal || decimal ||  
| ItemTotal || decimal ||  
* Required
* Required
|| The total price of the item. This is not necessarily equals <code>Quanitity × UnitPrice</code>. Pricing can be determined freely by the shop.
|| The total price of the item. Doesn't necessarily equal <code>Quantity × UnitPrice</code>, as pricing is solely at the Barion shop's discretion.
|-
|-
| SKU || string ||  
| SKU || string ||  

Latest revision as of 08:29, 12 June 2024

Item structure

This structure represents an item included in a payment transaction. An item can describe a product or service.

Included in

Items are used in the following structures:

Property list

Property name Property type Limitations and constraints Description
Name string
  • Required
  • Maximum length: 250 characters
The short name of the item. This is shown to the payer on the Barion Smart Gateway.
Description string
  • Required
  • Maximum length: 500 characters
The detailed description of the item. This is NOT shown to the payer on the Barion Smart Gateway.
ImageUrl string
  • Optional
A URL pointing to an image that shows the item. This is optional and available for UX purposes only.
Quantity decimal
  • Required
The total quantity of the item.
Unit string
  • Required
  • Maximum length: 50 characters
The measurement unit of the item.
UnitPrice decimal
  • Required
The price of one measurement unit of the item. It can be any value, even negative if it indicates e.g. discount.
ItemTotal decimal
  • Required
The total price of the item. Doesn't necessarily equal Quantity × UnitPrice, as pricing is solely at the Barion shop's discretion.
SKU string
  • Optional
  • Maximum length: 100 characters
The SKU value of the item in the shop's inventory system.