Gibt die Bonus-Item-Benefits (bestehend aus „BonusItemSets“, siehe „Hintergrund“) eines „BenefitID“ gegebenen Benefits des Typs „Bonus-Item“ (ID „3“) aus.
Hintergrund : Der Benefit-Typ „Bonus-Artikel“ für Verkaufs-Aktionen bietet die Möglichkeit, sogenannte Sets von Artikeln (im Kern durch eine Artikel-Bedingung definiert, s. im_GetItemConditions_Ad) 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.
Hinweis : Wenn die möglichen Benefit-Artikel ermittelt werden („OnlyDefinition = 0“), filtert die Prozedur automatisch solche Artikel heraus, die nicht lieferbar sind (Eigenschaft zum Merkmal „Verfügbarkeit“, ID „9“, ist „ValueID = -1“ - für „Nicht lieferbar“), weil diese sowieso nicht in den Warenkorb gelegt werden können (om_InsertTrolley_Pu bzw. om_UpdateTrolley_Pu würden einen Fehler liefern) !
Anmerkung zur Sortierung der Rückgabemenge nach Eigenschaften (im Fall „OnlyDefinition = 0“) :
Man hat die Möglichkeit, das Ergebnis nach Eigenschaften der Elemente zu bestimten Merkmalen zu sortieren. Die Merkmal-IDs (maximal 3 !) sind (durch „¶“ getrennt) in „SortByCharacteristicIDList“ zu übergeben. Diese Sortierung gilt innerhalb eines „ItemSets“.
Sortiert wird in einem solchen Fall zuerst nach den Eigenschaften zum ersten Merkmal, dann (falls angegeben) zum zweiten Merkmal und schließlich (falls angegeben) zum dritten Merkmal.
WIE zu sortieren ist, muß man im Parameter „SortOptionList“ angeben. Dabei handelt es sich um eine Summe von Optionen, bzw. um eine Liste von „Options-Summen“ (durch „¶“ getrennt), die sich auf das Merkmal in „SortByCharacteristicIDList“ beziehen, das an der entsprechenden Stelle kommt.
Folgende Optionen sind derzeit möglich :
Logischerweise kann nur EINE von den Optionen „1“, „2“, „4“ und „8“ gewählt werden, und es kann natürlich nur entweder Option „16“ oder „32“ gewählt werden !
Haben zwei Elemente zu allen Merkmalen gleichwertige Eigenschaften, wird aufsteigend nach der „TreeNodeID“ sortiert !
Es ist möglich, für „SortOptionList“ nichts (also „NULL“) anzugeben - dann wird automatisch immer der Wert „17“ (also Optionen „1“ und „16“) gewählt.
Bei der Ermittlung der Eigenschaften gibt es durch die Parameter „InheritDepthOptionList“ und „RecursiveEvaluationOptionList“ die Möglichkeit, bzgl. Vererbung und rekursiver Auswertung Einschränkungen vorzunehmen. Es handelt sich wieder jeweils um eine Liste von Werten (durch „¶“), die sich auf das Merkmal in „SortByCharacteristicIDList“ beziehen, das an der entsprechenden Stelle kommt :
1.) Mit dem jeweiligen „InheritDepth“-Wert hat der Aufrufer die Möglichkeit, bei der Ermittlung der Eigenschaften zum entsprechenden Merkmal hinsichtlich der Vererbung Einschränkungen vorzunehmen :
usw.
2.) Es gibt sogenannte „REKURSIVE“ Merkmale, die als Ausprägung wiederum Merkmale haben, d.h. alle (vordefinierten) Eigenschaften sind IDs.
Beispiel : Es sind mehrere „Preis“-Merkmale definiert, „Preis in EUR“, „Sonderpreis in EUR“, etc. Das Merkmal „Verkaufspreis (EUR)“ sei die Angabe, welches von den Preisen denn der für den Verkauf relevante ist. Möchte ich nun nach dem Verkaufspreis sortieren, ist es in der Regel gewünscht, daß nach dem tatsächlichen Preis sortiert werden soll - und nicht nach den Merkmal-IDs, die direkt zum Merkmal Verkaufspreis gespeichert sind !
In diesem Fall übergebe ich an der entsprechenden Stelle im Parameter „RecursiveEvaluationOptionList“ den Wert „1“. Ist das nicht gewünscht oder ist das Merkmal überhaupt kein rekursives Merkmal, ist „0“ anzugeben.
Wie schon bei „SortOptionList“ kann man auch für diese beiden Parameter „NULL“ angeben. Es wird dann automatisch KEINE Vererbung berücksichtigt und auch KEINE rekursive Auswertung durchgeführt !
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 |
---|---|---|---|---|
BenefitID | ID eines Bonus-Items-Benefits zu dem die zugeordneten „BonusItems“ ermittelt werden sollen. | integer | 7.0.4 | |
OnlyDefinition | 1 | Steuert die Rückgabemenge. Mögliche Werte: * 0: Es werden die Artikel, gruppiert nach Sets, geliefert * 1: Es wird die Definition geliefert * 2: Es wird eine erweiterte Definition geliefert | tinyint | 7.0.4 |
SortByCharacteristicIDList | NULL | Liste von (durch „¶“ getrennt) bis zu drei Merkmal-IDs, zu denen die Eigenschaften der ermittelten Elemente bestimmt werden und nach denen dann („SortOptionList“ entsprechend) sortiert wird. Wird nur beachtet wenn „OnlyDefinition = 0“ ist ! | varchar(50) | 7.0.4 |
SortOptionList | NULL | Liste von (durch „¶“ getrennt) Optionen, WIE nach der Eigenschaft zum entsprechenden Merkmal in „SortByCharacteristicIDList“ sortiert werden soll. Genaueres : s. Beschreibung ! Wird nur beachtet, wenn „OnlyDefinition = 0“ ist! | varchar(50) | 7.0.4 |
InheritDepthOptionList | NULL | Gibt an, ob bei der Ermittlung der Eigenschaften zum entsprechenden Merkmal in „SortByCharacteristicIDList“ die Vererbung beachtet werden soll oder nicht. Genaueres : s. Beschreibung! Wird nur beachtet, wenn „OnlyDefinition = 0“ ist! | varchar(50) | 7.0.4 |
RecursiveEvaluationOptionList | NULL | Gibt an, ob bei der Ermittlung der Eigenschaften zum entsprechenden Merkmal in „SortByCharacteristicIDList“ evtl. eine rekursive Auswertung durchgeführt werden soll oder nicht. Genaueres : s. Beschreibung! Wird nur beachtet, wenn „OnlyDefinition = 0“ is | varchar(50) | 7.0.4 |
GetValuesForSortByCharacs | 0 | Gibt an, ob die Eigenschaften zu den in „SortByCharacteristicIDList“ angegeben Merkmalen in der Rückgabemenge (s. Spalten „Value_[1,2,3]“) enthalten sein sollen („1“) oder nicht („0“). Wird nur beachtet, wenn „OnlyDefinition = 0“ ist! | bit | 7.0.4 |
Spaltenname | Beschreibung | SQL-Datentyp4) | ab Version |
---|---|---|---|
ItemSetSortNo5) | Diese Spalte wird nicht ausgegeben, sondern dient nur dazu, die Sortierung zu erklären. Dieser Wert bestimmt die Reihenfolge der „ItemSetID“s in der Ergebnismenge. | tinyint | 7.0.4 |
ValueSortNo_16) | Diese Spalte wird nicht ausgegeben, sondern dient nur dazu, die Sortierung zu erklären, falls „SortByCharacteristicIDList“ angegeben wurde ! Dieser Wert bestimmt die Reihenfolge der Eigenschaft „Value_1“ von „NodeID“ innerhalb aller „Value_1“-Werte. | integer | 7.0.4 |
ValueSortNo_27) | Diese Spalte wird nicht ausgegeben, sondern dient nur dazu, die Sortierung zu erklären, falls „SortByCharacteristicIDList“ angegeben wurde ! Dieser Wert bestimmt die Reihenfolge der Eigenschaft „Value_2“ von „NodeID“ innerhalb aller „Value_2“-Werte. | integer | 7.0.4 |
ValueSortNo_38) | Diese Spalte wird nicht ausgegeben, sondern dient nur dazu, die Sortierung zu erklären, falls „SortByCharacteristicIDList“ angegeben wurde ! Dieser Wert bestimmt die Reihenfolge der Eigenschaft „Value_3“ von „NodeID“ innerhalb aller „Value_3“-Werte. | integer | 7.0.4 |
BonusFromOneSetOnly | Gibt an, ob Bonus-Artikel nur aus einem Set gewählt werden dürfen („1“) oder aus jedem einzelnen Set („0“) | bit | 7.0.4 |
ItemSetID | ID eines Bonus-Sets, das Teil des Benefits „BenefitID“ ist | integer | 7.0.4 |
MaxQuantity | Gibt an, wieviele unterschiedliche Bonus-Artikel aus dem Set „ItemSetID“ gewählt werden dürfen | tinyint | 7.0.4 |
NodeDescription | Bezeichnung der „NodeID“ | varchar(100) | 7.0.4 |
NodeID | ID des zugehörigen Artikel-Elementes | integer | 7.0.4 |
TreeNodeID | ID eines gefundenen Elementes im Artikelbaum, welches die Bedingungen der „ItemSetID“ erfüllt | integer | 7.0.4 |
Value_1 | Eigenschaften der „NodeID“ zum 1. Merkmal in „SortByCharacteristicIDList“ | varchar(1000) | 7.0.4 |
Value_2 | Eigenschaften der „NodeID“ zum 2. Merkmal in „SortByCharacteristicIDList“ | varchar(1000) | 7.0.4 |
Value_3 | Eigenschaften der „NodeID“ zum 3. Merkmal in „SortByCharacteristicIDList“ | varchar(1000) | 7.0.4 |
wenn SortByCharacteristicIDList is NULL
wenn SortByCharacteristicIDList is NOT NULL
Spaltenname | Beschreibung | SQL-Datentyp9) | ab Version |
---|---|---|---|
BonusFromOneSetOnly | Gibt an, ob Bonus-Artikel nur aus einem Set gewählt werden dürfen („1“) oder aus jedem einzelnen Set („0“). | bit | 7.0.4 |
ItemSetID | ID eines Bonus-Sets, das Teil des Benefits „BenefitID“ ist. | integer | 7.0.4 |
SortNo | Bestimmt die Reihenfolge von „ItemSetID“ innerhalb aller „BenefitID“ zugeordneten Sets | tinyint | 7.0.4 |
MaxQuantity | Gibt an, wieviele unterschiedliche Bonus-Artikel aus dem Set „ItemSetID“ gewählt werden dürfen | tinyint | 7.0.4 |
ItemConditionID | ID der Artikel-Bedingung, die das Set „ItemSetID“ definiert. Die genaue Definition der Bedingung erhält man durch den Aufruf dieser Prozedur mit „OnlyDefinition = 2“. | integer | 7.0.4 |
ItemConditionDescription | Bezeichnung der Artikel-Bedingung „ItemConditionID“ | varchar(255) | 7.0.4 |
(parameterunabängige Sortierung)
Spaltenname | Beschreibung | SQL-Datentyp10) | ab Version |
---|---|---|---|
BonusFromOneSetOnly | Gibt an, ob Bonus-Artikel nur aus einem Set gewählt werden dürfen („1“) oder aus jedem einzelnen Set („0“). | bit | 7.0.4 |
ItemSetID | ID eines Bonus-Sets, das Teil des Benefits „BenefitID“ ist. | integer | 7.0.4 |
SortNo | Bestimmt die Reihenfolge von „ItemSetID“ innerhalb aller „BenefitID“ zugeordneten Sets | tinyint | 7.0.4 |
MaxQuantity | Gibt an, wieviele unterschiedliche Bonus-Artikel aus dem Set „ItemSetID“ gewählt werden dürfen | tinyint | 7.0.4 |
ItemConditionID | ID der Artikel-Bedingung, die das Set „ItemSetID“ definiert. Die genaue Definition der Bedingung 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 der „ItemConditionID“ zugeordneten (Artikel-)Bedingungs-Gruppen logisch mit UND verknüpft werden („1“) oder mit ODER („0“) | 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 den (Artikel-)Bedingungs-Teil „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 den (Artikel-)Bedingungs-Teil „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“. Mögliche Werte : - „=„ - “!=“ / „<>“ - „~“ / „!~“ (LIKE / NOT LIKE) - „>„ - “<„ - “>=„ - “⇐„ - „IN“ / “!I“ (in / NICHT in Menge von „Value“-Werten) - „E“ / „!E“ (IRGENDEINE / KEINE Eigenschaft) | 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“. Mögliche Werte : - „<“ oder „⇐“, falls „Operator1“ „>“ oder „>=“ enthält - bel. Zeichen (Trennzeichen für Werte-Menge), falls „Operator1“ „IN“ oder „!I“ enthält | 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 11) |
---|---|---|
-621 | Fehlender oder falscher Eintrag in PersonTypeSettings | nur indirekt |
-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 |
-550 | Fehlender oder falscher Eintrag in Settings | 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 |
-502 | Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen) | nur indirekt |
-500 | Falsche Parameter | direkt und indirekt |
-286 | Der Benutzer hat nicht die Berechtigung(en), Eigenschaften zu diesem(n) Merkmal(en) zu lesen/ändern | nur indirekt |
-284 | Der Benutzer hat keine Berechtigung, Eigenschaften zu diesem(n) Merkmal(en) zu modifizieren | nur indirekt |
-283 | Der Benutzer hat keine Berechtigung, Eigenschaften zu diesem(n) Merkmal(en) zu ermitteln | nur indirekt |
-145 | Maximale Anzahl an Artikel-Elementen, die den Bedingungs-Teil erfüllen, ist überschritten | 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 | „Start-/Finish-Procedure“-Logik eingebaut, s. Ticket #3670 |
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_GetCampaignBonusItems_Pu?BenefitID=<value>'
Mit xmllint 12) formatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/om_GetCampaignBonusItems_Pu?BenefitID=<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_GetCampaignBonusItems_Pu', array( 'BenefitID' => <value>, // 'OnlyDefinition' => 1, // 'SortByCharacteristicIDList' => NULL, // 'SortOptionList' => NULL, // 'InheritDepthOptionList' => NULL, // 'RecursiveEvaluationOptionList' => NULL, // 'GetValuesForSortByCharacs' => 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_GetCampaignBonusItems_Pu"> <Parameters> <Parameter Name="BenefitID"><!-- integer value --></Parameter> <!-- <Parameter Name="OnlyDefinition">1</Parameter> --> <!-- <Parameter Name="SortByCharacteristicIDList">NULL</Parameter> --> <!-- <Parameter Name="SortOptionList">NULL</Parameter> --> <!-- <Parameter Name="InheritDepthOptionList">NULL</Parameter> --> <!-- <Parameter Name="RecursiveEvaluationOptionList">NULL</Parameter> --> <!-- <Parameter Name="GetValuesForSortByCharacs">0</Parameter> --> </Parameters> </Procedure> </Batch> </ListOfBatches>