Gibt die Definition von Bonus-Item-Benefits zurück.
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 |
---|---|---|---|---|
CampaignID | ID einer Verkaufs-Aktion, zu der die Bonus-Artikel-Definitionen ausgegeben werden sollen | integer | 7.0.4 | |
BenefitID | NULL | ID eines Bonus-Items-Benefits, dessen Definition ausgegeben werden soll. Wird nur beachtet, wenn „CampaignID = NULL“ ist. | integer | 7.0.4 |
GetAssignedSets | 1 | Gibt an, ob in der Rückgabemenge auch die zugeordneten Sets ermittelt werden sollen („1“ - wenn gar keine Sets zugeordnet sind, ist das Ergebnis leer !) oder nicht („0“). | bit | 7.0.5 |
Spaltenname | Beschreibung | SQL-Datentyp4) | ab Version |
---|---|---|---|
BenefitID | ID eines Bonus-Item-Benefits für Verkaufs-Aktionen - natürlich identisch mit „BenefitID“ wenn angegeben | integer | 7.0.5 |
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.5 |
Spaltenname | Beschreibung | SQL-Datentyp5) | ab Version |
---|---|---|---|
BenefitID | ID eines Bonus-Item-Benefits für Verkaufs-Aktionen - natürlich identisch mit „BenefitID“ wenn angegeben | 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 |
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 im_GetItemConditions_Ad. | integer | 7.0.4 |
ItemConditionDescription | Bezeichnung der Artikel-Bedingung „ItemConditionID“ | varchar(255) | 7.0.4 |
(parameterunabängige Sortierung)
Die Prozedur hat keine Output-Parameter.
Code | Beschreibung | Quelle 6) |
---|---|---|
-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 | 1. Neuer Parameter „GetAssignedSets“ 2. Fehler : Rückgabespalte „MaxQuantity“ wurde als „SetMaxQuantity“ und „ItemCondition…“ als „SetCondition…“ zurückgegeben 3. Kleine Performance-Verbesserung |
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_Ad?CampaignID=<value>'
Mit xmllint 7) formatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/om_GetCampaignBonusItems_Ad?CampaignID=<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_Ad', array( 'CampaignID' => <value>, // 'BenefitID' => NULL, // 'GetAssignedSets' => 1 ) ); $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_Ad"> <Parameters> <Parameter Name="CampaignID"><!-- integer value --></Parameter> <!-- <Parameter Name="BenefitID">NULL</Parameter> --> <!-- <Parameter Name="GetAssignedSets">1</Parameter> --> </Parameters> </Procedure> </Batch> </ListOfBatches>