Gibt die im „dStore“ definierten Versandarten zurück.
HTTP-Method | GET |
HTTP-Auth | Optional |
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 |
---|---|---|---|---|
LanguageID | 0 | ID einer Sprache, in der die Bezeichnung der Versandart übersetzt werden soll (→ Rückgabespalte „TranslatedDescription“) | tinyint | 3.5.0 |
ShippingTypeID | NULL | ID einer Versandart. Angeben, um nur den zugehörigen Datensatz zu erhalten. | tinyint | 3.5.16 |
OnlyActive | 0 | „1“ angeben, um nur die aktiven (momentan gültigen) Versandarten zu erhalten | bit | 3.5.20 |
ValidAtDateAndTime | NULL | Über die Änderungen einer Versandart wird eine Historie gepflegt, daher kann man sich mit diesem Parameter die zu einem bestimmten Zeitpunkt definierten Versandarten ermitteln lassen (bei „NULL“ wird die aktuelle Konfiguration herangezogen) | datetime | 5.0.2 |
Spaltenname | Beschreibung | SQL-Datentyp4) | ab Version |
---|---|---|---|
ShippingTypeID | ID einer Versandart | smallint | 3.5.0 |
ShippingTypeDescription | Bezeichnung der Versandart „ShippingTypeID“ | varchar(100) | 3.5.0 |
TranslatedDescription | Übersetzung von „ShippingTypeDescription“ in der durch „LanguageID“ angegebenen Sprache. Immer „NULL“, wenn „LanguageID“ „0“ oder „NULL“ ist, oder ein Wert für „ValidAtDateAndTime“ gesetzt ist (da es für die Übersetzungen KEINE Historie gibt) ! | varchar(100) | 3.5.0 |
RegionID | ID einer Region, die bestimmte Länder („Countries“) zusammenfaßt. om_GetPaymentAndShipping_Pu bietet die Versandart „ShippingTypeID“ nur dann an, wenn die Person, an die die Ware geliefert werden soll, aus einem Land kommt, das dieser Region angehört. | smallint | 3.5.0 |
Region | Bezeichnung der Region „RegionID“ | varchar(100) | 3.5.0 |
GrossSumFrom | om_GetPaymentAndShipping_Pu bietet die Versandart ShippingTypeID nur dann an, wenn der Brutto-Bestellwert (in der Einheit CurrencyID) mindestens so hoch wie dieser Betrag ist | money | 6.0.2 |
GrossSumTo | om_GetPaymentAndShipping_Pu bietet die Versandart ShippingTypeID nur dann an, wenn der Brutto-Bestellwert (in der Einheit CurrencyID) höchstens so hoch wie dieser Betrag ist | money | 6.0.2 |
CurrencyID | ID einer Währung, in der „GrossSumFrom“ und „GrossSumTo“ angegeben sind | tinyint | 3.5.0 |
CurrencySymbol | Symbol (im Regelfall der ISO-Code) der Einheit „CurrencyID“ | varchar(10) | 3.5.0 |
Active | „0“ : Die Versandart ist nicht mehr aktiv, d.h. kann für neue Aufträge nicht mehr verwendet werden (wird aber noch in alten Aufträgen referenziert und kann daher nicht gelöscht werden) „1“ : „ShippingTypeID“ ist aktiv, also aktuell auswählbar | bit | 3.5.20 |
CreatedAtDateAndTime | Wann wurde die Versandsart angelegt. Anmerkung : Kann „NULL“ sein, da diese Spalte erst seit Version 5.0.2 der Tabelle „PaymentTypes“ hinzugefügt wurde ! | datetime | 5.0.2 |
SurchargeTypeID | ID einer Preis-Aufschlags/Rabatt-Art, die bei der Versandart „ShippingTypeID“ anfällt, wie z.B. „Versandkosten Inland“ o.ä. | smallint | 3.5.0 |
PriorityNo | Bestimmt die Reihenfolge bei der Berechnung aller „ShippingTypeID“ zugeordneten „Surcharges“ | tinyint | 6.0.2 |
SurchargeTypeDescription | Bezeichnung der „SurchargeTypeID“ | varchar(100) | 3.5.0 |
SurchargeValue | Aufschlag/Rabatt, der bei Wahl der „ShippingTypeID“ in einem Auftrag berechnet/gewährt wird | 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 SurchargeUnitID, und zwar ein als NETTO-Wert „2“ : Wie „1“ nur als BRUTTO-Wert zu verstehen | tinyint | 6.0.2 |
SurchargeUnitID | ID der Einheit, in der „SurchargeValue“ angegeben ist | tinyint | 6.0.2 |
SurchargeUnitSymbol | Symbol/Abkürzung der Einheit „SurchargeUnitID“ | varchar(10) | 6.0.2 |
BruttoSumFrom | Nicht verwenden, stattdessen : „GrossSumFrom“ | money | 3.5.0 |
BruttoSumTo | Nicht verwenden, stattdessen : „GrossSumTo“ | money | 3.5.0 |
Cost | Nicht verwenden, stattdessen : „SurchargeValue“ | decimal(16,6) | 3.5.0 |
CostCurrencyID | Nicht verwenden, stattdessen : „SurchargeUnitID“ | tinyint | 5.0.2 |
CostCurrencySymbol | Nicht verwenden, stattdessen : „SurchargeUnitSymbol“ | varchar(10) | 5.0.2 |
(parameterunabängige Sortierung)
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 | nur 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] |
7.0.4 | 2014-03-19 | „set forceplan off“-Anweisung fehlte an einer Stelle |
6.0.2 | 2011-06-08 | 1. Konzept-Änderungen bzgl. „Surcharges“-Logik 2. Neue Rückgabespalten „PriorityNo“, „SurchargeValue“, „SurchargeIsAbsoluteValue“, „SurchargeUnitID“ und „SurchargeUnitSymbol“ 3. Neue Sortierung der Rückgabemenge |
5.0.2 | 2005-04-29 | 1. Berücksichtigung von „ShippingTypesHistory“ ⇒ Neuer Parameter „ValidAtDateAndTime“ 2. Interne Optimierungen 3. Neue Rückgabespalten „CostCurrencyID“, „CostCurrencySymbol“ und „CreatedAtDateAndTime“ |
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.20 | 2002-07-22 | |
3.5.16 | 2002-04-25 | |
3.5.0 | 2000-11-23 | 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_GetShippingTypes_Ad'
Mit xmllint 6) formatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/om_GetShippingTypes_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_GetShippingTypes_Ad', array( // 'LanguageID' => 0, // 'ShippingTypeID' => NULL, // 'OnlyActive' => 0, // 'ValidAtDateAndTime' => 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_GetShippingTypes_Ad"> <Parameters> <!-- <Parameter Name="LanguageID">0</Parameter> --> <!-- <Parameter Name="ShippingTypeID">NULL</Parameter> --> <!-- <Parameter Name="OnlyActive">0</Parameter> --> <!-- <Parameter Name="ValidAtDateAndTime">NULL</Parameter> --> </Parameters> </Procedure> </Batch> </ListOfBatches>