Gibt die Definition von Bonus-Artikel-Sets zurück, die als Benefit einer Verkaufs-Aktion dienen
Hintergrund : Der Benefit-Typ „Bonus-Artikel“ für Verkaufs-Aktionen bietet die Möglichkeit, sogenannte Sets von Artikeln definieren zu können, aus denen der Kunde sich ein oder mehrere Artikel aussuchen darf, die er kostenlos erhält - sofern die zur Verkaufs-Aktion definierten Bedingungen erfüllt sind.
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 |
---|---|---|---|---|
ItemSetID | Wird nur beachtet, wenn „GetUnusedSets = 0“ ist ! ID eines Bonus-Artikel-Sets, dessen Definition ermittelt werden soll. Muß (im Fall „GetUnusedSets = 0“) angegeben werden, wenn „ItemConditionID = NULL“ ist ! | integer | 7.0.4 | |
ItemConditionID | NULL | Wird nur beachtet, wenn „GetUnusedSets = 0“ und „ItemSetID = NULL“ ist ! ID einer Artikel-Bedingung (mögliche Werte : s. im_GetItemConditions_Ad). Wenn angegeben, werden alle Sets ermittelt, die auf dieser Artikel-Bedingung basieren. | integer | 7.0.4 |
GetUnusedSets | 0 | „1“ angeben, um alle Sets zu ermitteln, die gar keinem Verkaufs-Aktions-Benefit zugeordnet wurden (durch om_ModifySetsForBonItBenefs_Ad) - „ItemSetID“ und „ItemConditionID“ werden dann natürlich ignoriert ! | bit | 7.0.4 |
Spaltenname | Beschreibung | SQL-Datentyp4) | ab Version |
---|---|---|---|
ItemSetID | ID eines Bonus-Artikel-Sets - natürlich identisch mit „ItemSetID“ wenn angegeben | integer | 7.0.4 |
MaxQuantity | Wieviele Artikel der Kunde maximal aus dem Set auswählen darf, die er kostenlos erhält (sofern die Bedingungen der Verkaufs-Aktion erfüllt sind) | tinyint | 7.0.4 |
ItemConditionID | ID der Artikel-Bedingung, die das Set „ItemSetID“ definiert (die genaue Definition ergibt sich durch die Rückgabespalten „CombineGroupsWithANDOperator“ bis „RecursiveEvaluation“) | integer | 7.0.4 |
ItemConditionDescription | Bezeichnung der Artikel-Bedingung „ItemConditionID“ | varchar(255) | 7.0.4 |
CombineGroupsWithANDOperator | Gibt an, ob die Bedingungs-Gruppen, die der Bedingung „ItemConditionID“ zugeordnet sind, mit „UND“ („1“) oder „ODER“ („0“) verknüpft sind | bit | 7.0.4 |
ItemConditionGroupID | ID einer Bedingungs-Gruppe, die Bestandteil von „ItemConditionID“ ist | integer | 7.0.4 |
ItemGroupSortNo | Bestimmt die Reihenfolge von „ItemConditionGroupID“ innerhalb aller der Artikel-Bedingung „ItemConditionID“ zugeordneten Bedingungs-Gruppen | tinyint | 7.0.4 |
ItemConditionGroupDescription | Bezeichnung der Bedingungs-Gruppe „ItemConditionGroupID“ | varchar(255) | 7.0.4 |
CombinePartsWithANDOperator | Gibt an, ob die der „ItemConditionGroupID“ zugeordneten Bedingungs-Teile logisch mit UND verknüpft werden („1“) oder mit ODER („0“) | bit | 7.0.4 |
ItemConditionPartID | ID eines Bedingungs-Teils, das Bestandteil von „ItemConditionGroupID“ ist | integer | 7.0.4 |
ItemPartSortNo | Bestimmt die Reihenfolge von „ItemConditionPartID“ innerhalb aller der Bedingungs-Gruppe „ItemConditionGroupID“ zugeordneten Bedingungs-Teile | tinyint | 7.0.4 |
ItemConditionPartDescription | Bezeichnung des Bedingungs-Teils „ItemConditionPartID“ | varchar(255) | 7.0.4 |
LevelIDs | Um „ItemConditionPartID“ zu erfüllen, muß die Hierarchie („LevelID“) eines Artikel-Elementes aus der hier angegebenen Menge der Hierarchien („LevelID“s) kommen. Sonderfall „,,“ bedeutet „beliebige Hierarchie“. | varchar(50) | 7.0.4 |
DomainTreeNodeIDs | Um „ItemConditionPartID“ zu erfüllen, muß ein Element im Artikelbaum ein Vorgänger-Element besitzen, dessen „TreeNodeID“ aus der hier angegebenen Menge von IDs kommt. Sonderfall „,,“ bedeutet „beliebiger Vorgänger“. | varchar(200) | 7.0.4 |
NodeCharacteristicID | Um „ItemConditionPartID“ zu erfüllen, muß ein Element im Artikelbaum eine Eigenschaft zu diesem Merkmal besitzen, die der durch „Operator1“ bis „Condition2“ formulierten Bedingung genügt. Sonderfall „-1“ : „KEINE Eigenschafts-Bedingung“ (immer erfüllt). | smallint | 7.0.4 |
Operator1 | Operator für die Bedingung „Condition1“ | varchar(2) | 7.0.4 |
Condition1 | Bedingung, die in Verbindung mit „Operator1“ anzuwenden ist („NULL“, falls „Operator1“ den Wert „E“ oder „!E“ hat) | varchar(2000) | 7.0.4 |
Operator2 | Operator für die Bedingung „Condition2“. Sonderfall : falls „Operator1“ „IN“ oder „!I“ enthält, steht hier das Trennzeichen für die in „Condition1“ angegebene Werte-Menge. | varchar(2) | 7.0.4 |
Condition2 | Bedingung, die in Verbindung mit „Operator2“ anzuwenden ist (nur belegt, wenn „Operator2“ den Wert „<“ oder „⇐“ enthält) | varchar(1000) | 7.0.4 |
InheritDepth | Welche Eigenschaften zu „NodeCharacteristicID“ hinsichtlich Vererbung sollen bei Prüfung der Eigenschafts-Bedingung beachtet werden : „-1“ : Alle „0“ : unvererbte „1“ : direkte u. einfach geerbte „2“ : direkte u. einfach oder zweifach geerbte usw. | smallint | 7.0.4 |
RecursiveEvaluation | Was soll zwecks Prüfung der Bedingung zu „NodeCharacteristicID“ (wenn rekursiv) gewählt werden ? „0“ : direkte Eigenschaft (also eine Merkmal-ID) „1“ : rekursiv ausgewertete Eigenschaft „2“ : zugehör. Beschreibung der Eigenschaft (also der Merkmal-ID) | tinyint | 7.0.4 |
(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 | 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] |
7.0.5 | 2014-05-26 | Doku bzgl. Datentyp der Rückgabespalten „Condition1“ und „COndition2“ angepasst |
7.0.4 | 2014-03-19 | 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_GetBonusItemSets_Ad?ItemSetID=<value>'
Mit xmllint 6) formatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/om_GetBonusItemSets_Ad?ItemSetID=<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_GetBonusItemSets_Ad', array( 'ItemSetID' => <value>, // 'ItemConditionID' => NULL, // 'GetUnusedSets' => 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_GetBonusItemSets_Ad"> <Parameters> <Parameter Name="ItemSetID"><!-- integer value --></Parameter> <!-- <Parameter Name="ItemConditionID">NULL</Parameter> --> <!-- <Parameter Name="GetUnusedSets">0</Parameter> --> </Parameters> </Procedure> </Batch> </ListOfBatches>