Inhaltsverzeichnis
om_GetGroupSurcharges_Ad
Gibt hinterlegte Preisrabatte bzw. -aufschläge für Personen-Gruppen aus.
Grundsätzliches zu „Surcharges“ :
1. Der „dStore“ versteht „Surcharges“ („Aufschläge“) als Prinzip, um zusätzlich entstehende Kosten oder aber Formen von Rabatten abzubilden - diese können sowohl relativ (also prozentual) als auch absolut angegeben werden (siehe om_GetSurchargeTypes_Ad). Rabatte zeichnen sich einfach dadurch aus, daß die Kosten mit negativem Vorzeichen behaftet sind.
2. Mögliche „Surcharges“ bei der Preisermittlung für Auftrags-Positionen (→ om_GetPrices_Pu) werden aus den Tabellen „PersonSurcharges“ (für Personen) und „GroupSourcharges“ (für Gruppen) ermittelt. „Surcharges“ sind in diesem Kontext immer für bestimmte Elemente des Artikelbaums definiert, wobei diese sich immer auf die NACHFOLGER übertragen und nicht - wie bei den Artikeleigenschaften - auf die „ERBEN“ (d.h. hier wird die „Predecessor“-Spalte aus „TreeView“ herangezogen und nicht die „InheritsFrom“-Spalte) !
Es gelten hierbei folgende Prioritäten:
- Direkt für ein Element des Artikelbaums definierte „Surcharges“ haben Vorrang vor hinterlegten „Surcharges“ zum Vorgänger-Element (analoges Prinzip zur Vererbung von Artikel-Eigenschaften).
- „Surcharges“, die direkt einer Person zugewiesen sind, haben Vorrang vor „Surcharges“, die für eine Gruppe, der die Person angehört, hinterlegt sind.
- Falls für den Auftraggeber „GroupSurcharges“ in Frage kommen, und die Person in MEHREREN Gruppen ist, zu denen „Surcharges“ hinterlegt sind, wird die Gruppe mit der höchsten Priorität gewählt - das ist die Gruppe mit der kleinsten „SortNo“ in der Rückgabemenge von pm_GetGroups_Ad mit entsprechend angegebener „PersonID“.
3. Es gibt seit Version 6.0.2 auch das Konzept von „Surcharges“ für einen gesamten Warenkorb bzw. Auftrag (→ om_GetTrolleySurcharges_Pu, om_GetOrderSurcharges_Ad). Dabei handelt es sich um Dinge wie Versandkosten, Skonti, Guthabenverrechnung oder ein (Gesamt-)Auftrags-Rabatt. Letzterer kann zwar auch in den meisten Fällen als Rabatt für alle Auftrags-Positionen abgebildet werden (s. 2.), aber bei absoluten Rabatten ist dies steuerlich nicht korrekt, falls unterschiedliche Steuersätze im Auftrag vorkommen !
| HTTP-Method | GET |
| HTTP-Auth | Optional |
| Tags | |
| Engine-Kategorie | order management |
| Engine-Typ | Daten-Ermittlung |
| Letzte Aktualisierung | 7.0.7 (2015-01-29) |
Parameter
| Name 1) | Standard-Wert | Beschreibung 2) | SQL-Datentyp3) | ab Version |
|---|---|---|---|---|
| GroupID | NULL | ID einer Personen-Gruppe. Wenn angegeben, werden nur die Aufschläge für diese Gruppe ermittelt - in diesem Fall wird „PaymentForShippingID“ NICHT beachtet ! | smallint | 3.5.3 |
| TreeNodeID | NULL | ID eines Elementes im Artikelbaum nach dem gefiltert werden soll. Es werden dann nur Aufschläge ermittelt, die direkt für dieses Element hinterlegt sind. | integer | 3.5.3 |
Rückgabe
(parameterunabhängig)
| Spaltenname | Beschreibung | SQL-Datentyp4) | ab Version |
|---|---|---|---|
| GroupID | ID einer Personen-Gruppe, für die (zum Element „TreeNodeID“) der Aufschlag „SurchargeValue“ hinterlegt ist | smallint | 3.5.3 |
| GroupDescription | Bezeichnung der Gruppe „GroupID“ | varchar(100) | 3.5.3 |
| TreeNodeID | ID eines Elementes im Artikelbaum, zu dem (für die Gruppe „GroupID“) der Aufschlag „SurchargeValue“ hinterlegt ist. Dieser gilt dann auch für alle NACHFOLGER (bis auf die, denen direkt eine andere „SurchargeTypeID“ zugwiesen ist). | integer | 3.5.3 |
| NodeID | ID des zur „TreeNodeID“ zugehörigen Artikel-Elementes | integer | 3.5.3 |
| NodeDescription | Bezeichnung des Artikel-Elementes „NodeID“ | varchar(100) | 3.5.3 |
| LevelID | ID der Hierarchie der „NodeID“ | tinyint | 3.5.3 |
| Active | Ist „TreeNodeID“ z.Zt. aktiviert ? („0“ : Nein, „1“ : Ja) | bit | 3.5.3 |
| SurchargeTypeID | ID einer Preis-Aufschlags/Rabatt-Art, wie z.B. „Versandkosten“, „Rabatt“, „Nachnahmegebühr“ o.ä. | smallint | 3.5.3 |
| SurchargeTypeDescription | Bezeichnung der „SurchargeTypeID“ | varchar(100) | 3.5.3 |
| Relative | Ist der Rabatt/Aufschlag „SurchargeValue“ ein absoluter Wert („0“) oder eine relative (d.h. Prozent-) Angabe („1“) ? | bit | 3.5.3 |
| Brutto | Der Parameter hat nur Bedeutung, wenn „Relative = 0“ ist. Er gibt an, ob der Rabatt/Aufschlag „SurchargeValue“ als Brutto- oder Nettobetrag angegeben ist. | bit | 3.5.3 |
| UnitID | ID einer Währungs-Einheit (wenn „Relative = 0“) oder der Prozent-Einheit (wenn „Relative = 1“ ist) - also die Einheit, in der „SurchargeValue“ angegeben ist | tinyint | 3.5.3 |
| UnitSymbol | Symbol (im Regelfall der ISO-Code) der Einheit „UnitID“ | varchar(10) | 3.5.3 |
| SurchargeValue | Der zur Gruppe „GroupID“ für das Element „TreeNodeID“ hinterlegte Rabatt/Aufschlag. Ein negativer Wert bedeutet, daß es sich um einen Rabatt handelt (z.B. wenn die Rabatt–/Aufschlagsart „Sonder-Rabatt“ o.ä. ist). | decimal(16,6) | 3.5.3 |
Sortierung der Rückgabe
(parameterunabängige Sortierung)
- GroupID (aufsteigend)
- TreeNodeID (aufsteigend)
Output-Parameter
Die Prozedur hat keine Output-Parameter.
Mögliche Return-Codes
| Code | Beschreibung | Quelle 5) |
|---|---|---|
| -569 | Der Benutzer hat kein Ausführungsrecht für die Prozedur | nur indirekt |
| -567 | Die Prozedur darf z. Zt. nicht ausgeführt werden | nur indirekt |
| -566 | Die Prozedur darf mit den übergebenen Parametern nicht ausgeführt werden | nur indirekt |
| -535 | Das Datum liegt nicht in der Vergangenheit | nur indirekt |
| -530 | Der Wert ist nicht konvertierbar | nur indirekt |
| -510 | Der Benutzer ist nicht registriert | nur indirekt |
| -504 | Es ist ein Problem aufgetreten, das nicht gelöst werden kann, Prozedur wird daher abgebrochen | nur indirekt |
| -500 | Falsche Parameter | nur indirekt |
XML-Schema
Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.
Historie
| 7.0.7 | 2015-01-29 | Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf] |
| 6.0.2 | 2011-06-08 | Tabelle „SurchargeTypes“ hat sich geändert [andere bzw. neue Spalten] ⇒ Anpassungen im Quellcode |
| 5.1.5 | 2006-08-29 | Explizites „ORDER BY“ eingefügt, um die Sortierung der Rückgabemenge zu garantieren |
| 4.0.14 | 2004-06-03 | 1. Aufruf der Prozeduren „_mi_StartProcedure“ und „_mi_FinishProcedure“ 2. Ausführen von „set transaction isolation level 1“ und „set rowcount 0“ zu Beginn der Prozedur |
| 3.5.3 | 2001-02-11 | Erstmalig in dieser Version erstellt |
Code-Snippets
Engine Playground
Der folgende Link öffnet in einem separaten Fenster den Engine Playground der fest mit dem dbap-demo System verbunden ist:
cURL
Unformatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/om_GetGroupSurcharges_Ad'
Mit xmllint 6) formatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/om_GetGroupSurcharges_Ad' | xmllint --format -
dStore_php
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_GetGroupSurcharges_Ad', array( // 'GroupID' => NULL, // 'TreeNodeID' => NULL ) ); $service->execute($request); $xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument(); $ResultSet = $xml_result->getRowsAsArray();
engine/execute
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_GetGroupSurcharges_Ad"> <Parameters> <!-- <Parameter Name="GroupID">NULL</Parameter> --> <!-- <Parameter Name="TreeNodeID">NULL</Parameter> --> </Parameters> </Procedure> </Batch> </ListOfBatches>