Berechnet die Aufschläge bzw. Rabatte auf den (Gesamt-)Wert des Warenkorbs eines Besuchers.

Hinweis :

In der Ergebnismege ist IMMER eine „Kopf“- und eine „Summen“-Zeile enthalten, die an „PositionNo = 0“ bzw. „PositionNo = 255“ zu erkennen ist. „SurchargeTypeID“ enthält den Wert „-1“, in der „SurchargeTypeDescription“ steht „INPUT DATA“ bzw. „SUM“ und die beiden „Absolute…Surcharge“-Spalten enthalten …

• für die Kopfzeile den uns übergebenen Warenwert (Netto und Brutto) und
• für die Summenzeile eine Summe (Netto und Brutto), die aus dem übergebenen Warenwert plus sämtlichen errechneten „Surcharges“ besteht.

Im Fall „SplitByTaxes = 0“ gibt es ja noch weitere Rückgabespalten, die „0“ für die Kopf und „NULL“ für die Summen-Zeile enthalten.

Anmerkung zur Rückgabespalte „TaxesMultiplier“ im Fall „SplitByTaxes = 1“ :

Der „TaxesMultiplier“ KANN „NULL“ enthalten, falls für eine „Surcharge“-Position nicht explizit ein Steuersatz konfiguriert ist UND der Warenwert über die „…Sum“-Parameter übergeben wurde. Denn anhand des Warenwertes über die „…Sum“-Parameter ließe sich allenfalls nur ein „künstlicher“ Steuersatz errechnen (Verhältnis Brutto zu Netto), der aber noch dazu von Rundungsfehlern behaftet wäre.
Für den „TaxesMultiplier“ in der Kopf- und Summenzeile gilt im Falle der Übergabe des Warenwertes über die „…Sum“-Parameter, daß er GARANTIERT „NULL“ ist.

Wie die „Surcharge“-Berechnung abläuft :

1.) Es werden alle definierten „SurchargeTypeCategories“ (s. om_GetSurchargeTypeCategories) mit einer „PriorityNo > 0“ durchlaufen, und zwar aufsteigend nach der „PriorityNo“.
Diese besagt nämlich, daß die Berechnungs-Grundlage von „Surcharges“ einer Kategorie nicht nur der Warenwert ist, sondern die Summe aus Warenwert und bereits errechneten „Surcharges“ von Kategorien mit (echt) KLEINERER „PriorityNo“.

Anmerkungen :
(i) Besitzen zwei Kategorien dieselbe „PriorityNo“, wird zuerst die mit kleinerer ID abgearbeitet, beide bekommen aber dieselbe „Berechnungs-Grundlage“ (Warenwert + Surcharges aus Kategorien mit echt kleinerer „PriorityNo“) !
(ii) Man kann die Ausführung der Berechnung von „Surcharges“ einer Kategorie also KOMPLETT DEAKTIVIEREN, indem man die „PriorityNo“ auf „0“ setzt (da ja nur Kategorien mit „PriorityNo > 0“ durchlaufen werden) !

2.) Die Abarbeitung einer konkreten „SurchargeTypeCategory“ erfolgt dann nach folgendem Muster :

a) Falls durch entsprechende Konfiguration in „Settings“ zum Schlüssel „Fire_ac_om_GetTrolleyOrOrderSurch_SurCatIDs_before“ die („customize“bare) Prozedur „_ac_om_GetTrolleyOrOrderSurch“ aufgerufen werden soll, erfolgt ein entsprechender Aufruf.

b) Sofern…

• KEIN Aufruf von „_ac_om_GetTrolleyOrOrderSurch“ erfolgte

UND

• es für die aktuelle Kategorie eine Standard-Prozedur zur Berechnung gibt (s. 3. Punkt)

UND

• für die Standard-Berechnung auch evtl. benötigte zusätzliche Angaben via Parameter übergeben wurden (s. 3. Punkt)

… erfolgt die Standard-Berechnung der „Surcharges“ für die aktuelle Kategorie

c) Wenn nun (nach der erfolgten Standard-Berechnung) durch entsprechende Konfiguration in „Settings“ zum Schlüssel „Fire_ac_om_GetTrolleyOrOrderSurch_SurCatIDs_after“ die („customize“bare) Prozedur „_ac_om_GetTrolleyOrOrderSurch“ aufgerufen werden soll, erfolgt ein entsprechender Aufruf.

Hinweis: Ist für die aktuelle „SurchargeTypeCategory“ weder eine Standard-Prozedur bekannt noch der Aufruf von „_ac_om_GetTrolleyOrOrderSurch“ konfiguriert, passiert auch nichts (es gibt also nicht etwa einen Fehler).

3.) Hier eine Übersicht, bei welcher „SurchargeTypeCategory“ (in Klammern dahinter die ID) eine Standard-Behandlung grundsätzlich erfolgen kann, welche zusätzlichen Informationen bekannt sein müssen (damit dies auch geschehen kann) und evtl. Anmerkungen zum besseren Verständnis :

• Relative Rabatte (ID „1“)

Es müssen keine weiteren Informationen vorliegen. Behandelt werden Rabatte, die entweder durch einen Gutschein zustande kommen (Voraussetzung dafür ist ein vorheriger om_ValidateVoucherCode_Pu-Aufruf) oder (wenn in „Settings“ zum Schlüssel „CampaignSurchargesEnabled“ der Wert „1“ konfiguriert ist) die durch Verkaufs-Aktionen gewährt werden.

• Absolute Rabatte (ID „2“)

s. Anmerkung „Relative Rabatte“

• Versandkosten (ID „3“)

Behandlung kann nur erfolgen, wenn „ShippingTypeID“ bekannt ist.

• Zahlungskosten (ID „4“)

Behandlung kann nur erfolgen, wenn „PaymentTypeID“ bekannt ist

• Guthaben-Verrechnung (ID „5“)

Eine solche Verrechnung kann nur stattfinden, wenn…
(i) „PersonID“ angegeben wurde
(ii) „UseCashAccount_MaxValue“ entweder „> 0“ oder „= -1“ enthält

(parameterunabängige Sortierung)

• PositionNo (aufsteigend)

(parameterunabängige Sortierung)

• PositionNo (aufsteigend)
• TaxesMultiplier (aufsteigend)

Die Prozedur hat keine Output-Parameter.

Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.

Der folgende Link öffnet in einem separaten Fenster den Engine Playground der fest mit dem dbap-demo System verbunden ist:

• om_GetTrolleySurcharges_Pu im Engine Playground öffnen

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetTrolleySurcharges_Pu?UniqueID=<value>&CurrencyID=<value>'

Mit xmllint ⁷⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetTrolleySurcharges_Pu?UniqueID=<value>&CurrencyID=<value>' | xmllint --format -

use dStore_php\WebService;
 
$service = new WebService\Service( WebService\Scheme::HTTP,'<partner>-<project>.dstore.de', 80);
 
$request = new WebService\Requests\Engine\Procedure\Request(
			new WebService\Requests\AccessData('default'),
	'om_GetTrolleySurcharges_Pu',
		array(
			'UniqueID' => '<value>',
			'CurrencyID' => <value>,
			// 'GrossSum' => NULL,
			// 'NetSum' => NULL,
			// 'PersonID' => NULL,
			// 'DeliveryPersonID' => NULL,
			// 'ShippingTypeID' => NULL,
			// 'PaymentTypeID' => NULL,
			// 'UseCashAccount_MaxValue' => NULL,
			// 'SplitByTaxes' => 0
		)
);
 
$service->execute($request);
 
			$xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument();
			$ResultSet = $xml_result->getRowsAsArray();

XML zur Ausführung mit der Methode engine/execute, z.B. per

curl --header 'Content-Type: application/xml' -X POST 'http://<partner>-<kunde>.dstore.de/default/engine/execute' -d '<xml-daten>'

<?xml version="1.0" encoding="UTF-8"?>
<ListOfBatches>
	<Batch No="0">
		<Procedure Name="om_GetTrolleySurcharges_Pu">
			<Parameters>
				<Parameter Name="UniqueID"><!-- varchar value --></Parameter>
				<Parameter Name="CurrencyID"><!-- tinyint value --></Parameter>
				<!-- <Parameter Name="GrossSum">NULL</Parameter> -->
				<!-- <Parameter Name="NetSum">NULL</Parameter> -->
				<!-- <Parameter Name="PersonID">NULL</Parameter> -->
				<!-- <Parameter Name="DeliveryPersonID">NULL</Parameter> -->
				<!-- <Parameter Name="ShippingTypeID">NULL</Parameter> -->
				<!-- <Parameter Name="PaymentTypeID">NULL</Parameter> -->
				<!-- <Parameter Name="UseCashAccount_MaxValue">NULL</Parameter> -->
				<!-- <Parameter Name="SplitByTaxes">0</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>