Prozedur, um ein Set von Bonus-Artikeln anlegen/ändern/löschen zu können, das als Benefit einer Verkaufs-Aktion verwendet werden soll.
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.
Anmerkung zum Parameter „ItemConditionID“ :
Die Definition einer Artikel-Bedingung (s. im_GetItemConditions_Ad) kann recht komplex sein (große Anzahl Bedingungs-Teile sowie viele Möglichkeiten, sie zu verknüpfen), auf der anderen Seite können gerade auch einfache Bedingungen dazu führen, daß sehr viele Elemente diese erfüllen. Beides ist für Bonus-Artikel recht problematisch, da dem Kunden ja eine Auswahl über om_GetCampaignBonusItems_Pu präsentiert werden muß - und das ist genau dann nachteilig, wenn die Ausführung sehr lange dauert (weil die Bedingung komplex ist) oder aber das Ergebnis zu groß ist (weil viele Elemente die Bedingung erfüllen). Deswegen gelten folgende Einschränkungen :
1.) Bei Erstellung eines Sets oder Änderung der „ItemConditionID“ eines bestehenden Sets wird geprüft, wieviele Elemente die Bedingung erfüllen. Übersteigt die Anzahl 100 bzw. den in „Settings“ zum Schlüssel „MaximumNumberOfBonusItemsPerSet“ konfigurierten Wert, gibt es einen Fehler.
2.) Derzeit darf die Bedingung lediglich aus einer einzigen Bedingungs-Gruppe und einem einzigen Bedingungs-Teil bestehen. Desweiteren gelten folgende Einschränkungen hinsichtlich der Eigenschafts-Bedingung (des einzigen Bedingungs-Teils) :
Anmerkungen zum Parameter „DeleteSet“ :
1.) Sofern „ItemSetID“ bereits in einem Benefit einer AKTIVEN Verkaufs-Aktion verwendet wird (s. om_GetCampaignBonusItems_Ad), kann NICHTS mehr verändert (also auch Löschen ist nicht möglich) werden (ggf. gibt es dann also einen Fehler) !
2.) Das Löschen eines Sets schlägt auch dann fehl, wenn es über ein entsprechendes Benefit einer INAKTIVEN Verkaufs-Aktion zugeordnet ist. Übergibt man aber den Wert „2“ für „DeleteSet“, werden evtl. vorhandene Zuordnungen zu (Verkaufs-Aktions-)Benefits vorher gelöscht (was man normalerweise mit om_ModifySetsForBonItBenefs_Ad macht), um dann das Set selbst zu löschen.
HTTP-Method | POST |
HTTP-Auth | Optional |
Tags | |
Engine-Kategorie | order management |
Engine-Typ | Daten-Änderung |
Letzte Aktualisierung | 7.0.7 (2015-01-29) |
ItemConditionID | ID einer Artikel-Bedingung, die das Bonus-Artikel-Set definiert (mögliche Werte : s. im_GetItemConditions_Ad). Hinweis : Es gelten gewisse Einschränkungen, die bei Überschreitung zu einem Fehler führen können (s. Beschreibung). | integer | 7.0.4 | |
MaxQuantity | 1 | Die Anzahl (verschiedener) Artikel, die der Kunde maximal aus dem Set auswählen darf (muß ein Wert „>= 0“ sein) | tinyint | 7.0.4 |
DeleteSet | 0 | Wird nur beachtet, wenn „ItemSetID“ angegeben ist ! Entscheidet, ob das bestehende Set geändert („0“) oder gelöscht („1“ bzw. „2“, s. Beschreibung !) werden soll. | tinyint | 7.0.4 |
Die Prozedur hat keine Rückgaben.
ItemSetID | ID eines Bonus-Artikel-Sets, das als Benefit einer Verkaufsaktion zu verwenden ist und je nach „DeleteSet“ geändert oder gelöscht werden soll. „NULL“ angeben, um ein neues Set anzulegen (die neue ID kann diesem Parameter entnommen werden). |
Code | Beschreibung | Quelle 1) |
---|---|---|
-1221 | Das Set kann nicht als Bonus-Artikel-Benefit dienen, weil es zu viele Elemente enthält | nur direkt |
-1218 | Das Set kann nicht gelöscht werden, da es als Benefit einer inaktiven Campaign verwendet wird | nur direkt |
-1217 | Das Set kann nicht geändert/gelöscht werden, da es als Benefit einer aktiven Campaign verwendet wird | nur direkt |
-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 |
-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 | Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf] |
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 POST 'http://<partner>-<project>.dstore.de/default/engine/om_ModifyBonusItemSets_Ad?ItemConditionID=<value>'
Mit xmllint 2) formatierte Ausgabe:
curl -X POST 'http://<partner>-<project>.dstore.de/default/engine/om_ModifyBonusItemSets_Ad?ItemConditionID=<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_ModifyBonusItemSets_Ad', array( 'ItemConditionID' => <value>, // 'MaxQuantity' => 1, // 'DeleteSet' => 0 ) ); $service->execute($request); $xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument(); $ResultSet = $xml_result->getRowsAsArray(); $OutputParams = $xml_result->getOutputParametersAsArray();
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_ModifyBonusItemSets_Ad"> <Parameters> <Parameter Name="ItemConditionID"><!-- integer value --></Parameter> <!-- <Parameter Name="MaxQuantity">1</Parameter> --> <!-- <Parameter Name="DeleteSet">0</Parameter> --> </Parameters> </Procedure> </Batch> </ListOfBatches>