Item: Difference between revisions
Jump to navigation
Jump to search
m (fixed typo) |
|||
| (4 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 = | |||
Items are used in the following structures: | Items are used in the following structures: | ||
| Line 9: | Line 9: | ||
* [[DetailedPaymentTransaction]] | * [[DetailedPaymentTransaction]] | ||
= Property list = | |||
{{api_input_table_header}} | {{api_input_table_header}} | ||
| Line 23: | 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 || | | 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 38: | 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. | || 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 |
|
The short name of the item. This is shown to the payer on the Barion Smart Gateway. |
| Description | string |
|
The detailed description of the item. This is NOT shown to the payer on the Barion Smart Gateway. |
| ImageUrl | string |
|
A URL pointing to an image that shows the item. This is optional and available for UX purposes only. |
| Quantity | decimal |
|
The total quantity of the item. |
| Unit | string |
|
The measurement unit of the item. |
| UnitPrice | decimal |
|
The price of one measurement unit of the item. It can be any value, even negative if it indicates e.g. discount. |
| ItemTotal | decimal |
|
The total price of the item. Doesn't necessarily equal Quantity × UnitPrice, as pricing is solely at the Barion shop's discretion.
|
| SKU | string |
|
The SKU value of the item in the shop's inventory system. |