item
➡ Request Parameter
<item>
Product name
| Type | Condition | Restriction |
|---|---|---|
| xs:string | Mandatory | Length <=255 |
<item@article-number>
Merchant's product number or other identifier like SKU, EAN, GTIN, ISBN etc.
| Type | Condition | Restriction |
|---|---|---|
| xs:string | Mandatory | Length <=255 |
<item@unique-article-number>
| Type | Condition | Restriction |
|---|---|---|
| xs:string | Optional, if <item@article-number> is unique |
Length <=255 |
attention
Each item within a shopping basket must be uniquely identifiable, either by the <item@article-number> or in combination with the <item@unique-article-number>, or both.
Example
Imagine, all shirts within the shopping-basket have the same article-number. To make them unique, additionally submit size, color, printing, etc. by using the <item@unique-article-number>.
<item@quantity>
Quantity
| Type | Condition |
|---|---|
| xs:int | Mandatory |
attention
The details of the purchased goods are defined by the shopping basket items. One <item>-element defines the purchased good/service. If several items of the exact same kind have been purchased, use <item@quantity>.
<item@unit-price-gross>
Gross price of one unit (including tax)
| Type | Condition |
|---|---|
| xs:decimal | Mandatory |
attention
If an amount with more than 4 decimals is provided, it will be rounded to 4 decimals internally.
<item@tax-rate>
Tax rate that applies to the item, e.g. 19% send like 19
| Type | Condition |
|---|---|
| xs:decimal | Mandatory |
<item@category>
Optional article category. The interpretation of this value is defined by Ratepay's risk management process.
| Type | Condition | Restriction |
|---|---|---|
| xs:string | Optional | Length <=511 |
attention
According to ISO 18245.
<item@discount>
Item-specific discount
| Type | Condition | Restriction |
|---|---|---|
| xs:decimal | Optional | Negative value |
attention
If an amount with more than 4 decimals is provided, it will be rounded to 4 decimals internally.
<item@description-addition>
With this attribute an additional text can be submitted to be used as additional description for correspondence sent by Ratepay to the customer, e.g. download codes, descriptions of patterns, services details etc.
| Type | Condition | Restriction |
|---|---|---|
| xs:string | Optional | Length <=511 |
<item@shop-id>
danger
Only for marketplace transactions!
warning
The shop_id needs to be unique under the respective partner profile.
This attribute is mandatory in order to process mixed baskets in marketplace scenarios.
| Type | Condition | Restriction |
|---|---|---|
| xs:string | Mandatory | Length <=255 |