Liefert zu einer Versandart die konfigurierten Aufschläge und Rabatte (sogenannte „Surcharges“) zurück.
HTTP-Method | GET |
HTTP-Auth | Optional |
Alias | om_GetShippingTypeSurcharges_Ad |
Tags | |
Engine-Kategorie | order management |
Engine-Typ | Daten-Ermittlung |
Letzte Aktualisierung | 7.0.7 (2015-01-29) |
Name 1) | Standard-Wert | Beschreibung 2) | SQL-Datentyp3) | ab Version |
---|---|---|---|---|
ShippingTypeID | NULL | ID einer Versandart, für die die konfigurierten „Surcharges“ ausgegeben werden sollen (Pflicht-Angabe) | tinyint | 6.0.2 |
SurchargeTypeID | NULL | ID einer Aufschlags-/Rabattart (wie z.B. „Skonto“). Falls angegeben, wird nur dieser spezielle „Surcharge“-Datensatz zur Versandart „ShippingTypeID“ ermittelt (falls vorhanden). | smallint | 6.0.2 |
ValidFrom | NULL | Falls angegeben, werden nur „PaymentTypeSurcharges“ in die Ergebnismenge aufgenommen, die AB dem hier angegebenen Zeitpunkt gültig sind. Ist hier und für „ValidTo“ „NULL“ angegeben, erhält man die aktuelle Konfiguration. | datetime | 6.0.2 |
ValidTo | NULL | Falls angegeben, werden nur „PaymentTypeSurcharges“ in die Ergebnismenge aufgenommen, die BIS ZU dem hier angegebenen Zeitpunkt gültig sind. Ist hier und für „ValidFrom“ „NULL“ angegeben, erhält man die aktuelle Konfiguration. | datetime | 6.0.2 |
Spaltenname | Beschreibung | SQL-Datentyp4) | ab Version |
---|---|---|---|
ShippingTypeID | Die ID der Versandart für die der Aufschlag/Rabatt gilt (z.Zt. also immer „ShippingTypeID“) | tinyint | 6.0.2 |
ShippingTypeDescription | Die Bezeichnung der Versandart für die der Aufschlag/Rabatt gilt | varchar(100) | 6.0.2 |
SurchargeTypeID | Die ID der Aufschlags-/Rabatt-Art, die für „ShippingTypeID“ im Zeitraum „ValidFrom“ bis „ValidTo“ konfiguriert ist/war | smallint | 6.0.2 |
SurchargeTypeDescription | Bezeichnung der „SurchargeTypeID“ | varchar(100) | 6.0.2 |
ValidFrom | Der Zeitpunkt ab dem der Rabatt/Aufschlag gültig ist | datetime | 6.0.2 |
ValidTo | Der Zeitpunkt bis zu dem ein Rabatt/Aufschlag gültig ist | datetime | 6.0.2 |
PriorityNo | Die Priorität des Rabatts/Aufschlags. Bestimmt die Reihenfolge, in der Rabatte/Aufschläge berechnet und gelistet werden. Bei relativen „Surcharges“ wichtig, da der Betrag, auf den er anzuwenden ist, „Surcharges“ mit kleinerer „PriorityNo“ enthält. | tinyint | 6.0.2 |
SurchargeValue | Der Wert des Aufschlags/Rabatts | decimal(16,6) | 6.0.2 |
SurchargeIsAbsoluteValue | Gibt an, wie „SurchargeValue“ zu verstehen ist : „0“ : Es ist eine relative (d.h. prozentuale) Angabe „1“ : Es ist eine absolute Währungs-Angabe in der Einheit „UnitID“, und zwar ein NETTO-Wert „2“ : Wie „1“ nur als BRUTTO-Wert zu verstehen | tinyint | 6.0.2 |
UnitID | ID der Einheit, in der „SurchargeValue“ angegeben ist | tinyint | 6.0.2 |
UnitSymbol | Symbol/Abkürzung der Einheit „SurchargeUnitID | varchar(10) | 6.0.2 |
wenn ValidTo is NULL und ValidFrom is NULL
wenn ValidFrom is NOT NULL
wenn ValidFrom is NULL und ValidTo is NOT NULL
Die Prozedur hat keine Output-Parameter.
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 | direkt und indirekt |
Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.
7.0.7 | 2015-01-29 | Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf] |
6.0.2 | 2011-06-08 | Erstmalig in dieser Version erstellt |
Der folgende Link öffnet in einem separaten Fenster den Engine Playground der fest mit dem dbap-demo System verbunden ist:
Unformatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/om_GetShippTypeSurcharges_Ad'
Mit xmllint 6) formatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/om_GetShippTypeSurcharges_Ad' | 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_GetShippTypeSurcharges_Ad', array( // 'ShippingTypeID' => NULL, // 'SurchargeTypeID' => NULL, // 'ValidFrom' => NULL, // 'ValidTo' => NULL ) ); $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_GetShippTypeSurcharges_Ad"> <Parameters> <!-- <Parameter Name="ShippingTypeID">NULL</Parameter> --> <!-- <Parameter Name="SurchargeTypeID">NULL</Parameter> --> <!-- <Parameter Name="ValidFrom">NULL</Parameter> --> <!-- <Parameter Name="ValidTo">NULL</Parameter> --> </Parameters> </Procedure> </Batch> </ListOfBatches>