Aufbau der Order
Bestelldokumente Vertragsinformationen werden nur ab der API Version 2.1 verarbeiten.
Es gilt der gleiche Aufbau wie im Artikel „Aufbau des Order Dokuments einer Standard Bestellung“ beschrieben
Bestellungen mit Laufzeitprodukten / Subscriptions
Für die Bestellung von Laufzeitprodukten haben wir folgenden zusätzlichen Aufbau der OpenTrans Order vorgesehen:
Alle Produkte mit Laufzeit benötigen Informationen zur Dauer der Laufzeit, Einheit in der Laufzeit angegeben ist, sowieso Angaben zum Abrechnungsintervall und Einheit des Abrechnungsintervalls.
Alle benötigten Informationen: Laufzeit, Einheit der Laufzeit, Abrechnungsintervall werden in den CONTRACT_INFORMATION hinterlegt.
Laufzeitdauer (SUBSCRIPTION_PERIOD):
- Dieses Feld ist die Dauer der Laufzeit des Produktes
Mengeneinheit der Laufzeit (SUBSCRIPTION_PERIOD_UNIT):
- Dieses Feld ist die Mengeneinheit der Laufzeit
- Für dieses Feld wird in der ISO-Produkteinheit für „Monat“ verwendet
Abrechnungsintervall (BILLING_PERIOD):
- Dieses Feld ist das Intervall in dem das Produkt berechnet wird
Basis Kaufpreis (SOURCE_PRICE_AMOUNT):
- In diesem Feld wird der Basis Kaupfpreis des Miet Dienstleisters gespeichert (das Feld wird nur in Verbindung mit topi Leasing / Miet Aufträgen gesetzt)
Beispiel einer Bestellung mit 2 Positionen: 1 Subscription Position und 1 normale Position
Die Beispieldatei kann in diesem Artikel weiter unter runtergeladen werden „Example_ORDER_Laufzeitprodukt_Bestellung.xml“
In der Position 1 befindet sich ein Produkt mit einer Subscription
- Laufzeit 12 Monate a 49.90€ pro Monat und monatlichem Abrechnungsintervall.
Die Einheit des Abrechnungsintervalls wird innerhalb des ORDER_ITEM in der ORDER_UNIT angegeben. Bei einem Laufzeit Produkt ist es zwingend nötigt alle benötigten Informationen im ORDER_ITEM zu hinterlegen, z.B. ein Abrechnungsintervall Monat
Der Subscription Block hält die Informationen wie Lange die Laufzeit geht (SUBSCRIPTION_PERIOD = 12), welche Einheit die Laufzeit hat (SUBSCRIPTION_PERIOD_UNIT = MON), also 12 Monate
Über Abrechnungsintervall (BILLING_PERIOD=1) der jeweiligen Mengeneinheit (ORDER_UNIT = MON) und dem Preis der Einheit (PRICE_AMOUNT =49.90€) wird festgelegt, das monatlich 49.99€ gezahlt werden.
<ORDER_ITEM>
<LINE_ITEM_ID>00001</LINE_ITEM_ID>
<PRODUCT_ID>
<ns2:SUPPLIER_PID type="supplier_specific">123002</ns2:SUPPLIER_PID>
<ns2:DESCRIPTION_SHORT>APPLE iPad Pro Wi-Fi 256 GB Grau - 11" Tablet - 27,9cm-Display</ns2:DESCRIPTION_SHORT>
</PRODUCT_ID>
<QUANTITY>1</QUANTITY>
<!-- Mengeneinheit (ISO-Produkteinheit für "Monat") -->
<ns2:ORDER_UNIT>MON</ns2:ORDER_UNIT>
<PRODUCT_PRICE_FIX>
<ns2:PRICE_AMOUNT>49.99</ns2:PRICE_AMOUNT>
</PRODUCT_PRICE_FIX>
<PRICE_LINE_AMOUNT>49.99</PRICE_LINE_AMOUNT>
<CONTRACT_INFORMATION>
<SUBSCRIPTION_PERIOD>10</SUBSCRIPTION_PERIOD>
<SUBSCRIPTION_PERIOD_UNIT>MON</SUBSCRIPTION_PERIOD_UNIT>
<BILLING_PERIOD>1</BILLING_PERIOD>
</CONTRACT_INFORMATION>
</ORDER_ITEM>
Die 2te Position ist ohne Subscription und kostet 1158.00€, weswegen die Gesamtsumme nur normale Positionen erhällt.
Als zusätzliche Sicherheit kann in der ORDER_SUMMARY der TOTAL_RECURRING_AMOUNT hinterlegt werden. Er beschreibt die Gesamtsumme über alle wiederkehrenden Positionen. Der angegebene „type“ des TOTAL_RECURRING_AMOUNT entspricht der Einheit des Abrechnungsintervalls, wie sie in der ORDER_UNIT angegeben ist. (type=“MON“)
Dies ist kein Pflichtfeld, dient aber als Übersicht über alle Positionen mit wiederkehrenden Preisen.
<ORDER_SUMMARY>
<TOTAL_ITEM_NUM>2</TOTAL_ITEM_NUM>
<TOTAL_AMOUNT>1158.00</TOTAL_AMOUNT>
<!-- Gesamtsumme über alle wiederkehrenden Positionen -->
<TOTAL_RECURRING_AMOUNT type="MON">49.99</TOTAL_RECURRING_AMOUNT>
</ORDER_SUMMARY>
Beispiel einer Miet/Leasing Bestellung mit 1 Position bei topi
Die Beispieldatei kann in diesem Artikel weiter unter runtergeladen werden „Example_ORDER_Laufzeitprodukt_topi-Bestellung.xml“
In der Position 1 befindet sich ein Produkt mit einer Subscription
- Laufzeit 36 Monate a 24.49€ pro Monat und monatlichem Abrechnungsintervall und dem Preis von 898.50€ den topi als Miet Dienstleister für diese Produkt beim Verkäufer bezahlt.
Die Einheit des Abrechnungsintervalls wird innerhalb des ORDER_ITEM in der ORDER_UNIT angegeben. Bei einem Laufzeit Produkt ist es zwingend nötigt alle benötigten Informationen im ORDER_ITEM zu hinterlegen, z.B. ein Abrechnungsintervall Monat
Der Subscription Block hält die Informationen, wie lange die Laufzeit geht (SUBSCRIPTION_PERIOD = 36), welche Einheit die Laufzeit hat (SUBSCRIPTION_PERIOD_UNIT = MON). Also 36 Monate.
Über Abrechnungsintervall (BILLING_PERIOD=1) der jeweiligen Mengeneinheit (ORDER_UNIT = MON) und dem Preis der Einheit (PRICE_AMOUNT =24.49€) wird festgelegt, das monatlich 24.49€ gezahlt werden.
Der Basis-Kaufpreis von 898.50€ für den Topi den Artikel beim Verkäufer einkauft und somit vom Verkäufer an topi als PAYER verrechnet wird steht im Feld SOURCE_PRICE_AMOUNT = 898.50.
<ORDER_ITEM>
<LINE_ITEM_ID>00001</LINE_ITEM_ID>
<PRODUCT_ID>
<ns2:SUPPLIER_PID type="supplier_specific">123456</ns2:SUPPLIER_PID>
<ns2:DESCRIPTION_SHORT>iPhone 15 - 5G Smartphone - Dual-SIM / Interner Speicher 128GB - OLED-Display - 6,1" - 2556 x 1179 Pixel - 2 x Rückkamera 48 MP, 12 MP - front camera </ns2:DESCRIPTION_SHORT>
<ns2:DESCRIPTION_SHORT>12 MP - Schwarz (MTP03ZD/A)</ns2:DESCRIPTION_SHORT>
</PRODUCT_ID>
<QUANTITY>1</QUANTITY>
<ns2:ORDER_UNIT>MON</ns2:ORDER_UNIT>
<PRODUCT_PRICE_FIX>
<ns2:PRICE_AMOUNT>24.49</ns2:PRICE_AMOUNT>
</PRODUCT_PRICE_FIX>
<PRICE_LINE_AMOUNT>24.49</PRICE_LINE_AMOUNT>
<CONTRACT_INFORMATION>
<SUBSCRIPTION_PERIOD>36</SUBSCRIPTION_PERIOD>
<SUBSCRIPTION_PERIOD_UNIT>MON</SUBSCRIPTION_PERIOD_UNIT>
<BILLING_PERIOD>1</BILLING_PERIOD>
<SOURCE_PRICE_AMOUNT>898.50</SOURCE_PRICE_AMOUNT>
</CONTRACT_INFORMATION>
</ORDER_ITEM>Download von Beispiel Order Dateien
Die Beispieldateien sind mit XML Kommentaren versehen, um den Aufbau einer ORDER besser verstehen zu können.