Aufbau des Order Dokuments bei einer Bestellung Vertragsinformationen (Laufzeit oder Herstellerparameter)

Last modified: 29. August 2022

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

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 der Intervall in der das Produkt berechnet wird
<CONTRACT_INFORMATION>
	<SUBSCRIPTION_PERIOD>10</SUBSCRIPTION_PERIOD>
	<SUBSCRIPTION_PERIOD_UNIT>MON</SUBSCRIPTION_PERIOD_UNIT>
	<BILLING_PERIOD>1</BILLING_PERIOD>
</CONTRACT_INFORMATION>

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.

<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>

Als zusätzliche Sicherheit kann in der ORDER_SUMMARY der TOTAL_RECURRING_AMOUNT hinterlegt werden.

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>

Der type entspricht hier, dem in der ORDER_UNIT angegebenen Einheit des Abrechnungsintervalls.

Bestellungen mit Vertragsparameter

Bei bestimmten Kombinationen von Distributoren und Herstellern werden zusätzliche Vertragsparameter benötigt, damit die Bestellung ohne Rückfrage des Distributors verarbeitet werden kann. Die notwendigen Parameter können über den Produktexport ausgelesen werden und sind unter „contractParameter“ im standard und developer Format zu finden.

Die Parameter müssen bei der Position im Feld CONTRACT_INFORMATION unter PARAMETERS hinterlegt werden:

<ORDER_ITEM>
	<LINE_ITEM_ID>00001</LINE_ITEM_ID>
	...
	<CONTRACT_INFORMATION>
		<PARAMETERS>
			<PARAMETER type="purchaseDate">2022-04-12</PARAMETER>
			<PARAMETER type="serial">same</PARAMETER>
		</PARAMETERS>
	</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. Diese Dateien können auch als Referenzdatei für den Testversand einer Bestellung über die ITscope API Methode business/deals/send an die „Partner Test“ DistributorId 10000735 verwendet werden.

Bei der Datei Example_ORDER_LaufzeitProdukt_Bestellung.xml handelt es sich um eine Bestellung mit einem Laufzeit Produkt und einem Produkt ohne Laufzeit.

Was this article helpful?
Dislike 0
Views: 179