Gibt die Gesamt-Definition einer auf Artikel-Bedingungen basierenden Verkaufs-Aktions-Bedingung zurück.
Hintergrund : Eine Artikel-Bedingung (deren Aufbau im Detail in im_GetItemConditions_Ad beschrieben ist) besteht aus einer oder mehreren Bedingungs-Gruppe(n), die sich wiederum (jeweils) aus einem oder mehreren Bedingungs-Teil(en) zusammensetzt/zusammensetzen. So können (Artikel-)Bedingungen wie „Schuhe der Marke X ODER grüne Hosen“ gebildet werden. Häufig müssen solche Bedingungen und/oder ihre einzelnen Bestandteile (Bedingungs-Gruppen u. -Teile) noch ein Mengen- und/oder Warenwert-Kriterium bekommen, um eine „vollständigen Bedingung“ zu erhalten - wie etwa : „mind. 2 Schuhe der Marke X ODER 3 grüne Hosen im Gesamt-Wert von 250 Euro“.
Hinweise :
1.) Ob die „…PriceSum…“-Angaben in Brutto oder Netto angegeben sind, bestimmt ein entsprechender „CampaignSettings“-Eintrag (s. om_GetCampaignSettingEntry) zum Schlüssel „PriceConditionsInNet“ (zu der Verkaufs-Aktion, der die Bedingung „ConditionID“ zugeordnet ist).
2.) Die Grenzen der durch die „From…“- und „To…“-Werte bzw. „Min…“- und „Max…“-Angaben definierten Bereiche (wenn nicht „NULL“) sind immer als „einschließlich“ zu verstehen.
3.) Wurde ein „ItemConditionPart“ oder eine „ItemConditionGroup“ nicht um Mengen- und/oder Warenwert-Kriterium erweitert, sind die Werte in den „_Part“- bzw. „_Group“-Spalten „NULL“.
4.) „NULL“ für „ConditionID“ UND „ItemConditionID“ anzugeben ist nur im Fall „GetUnusedConditions = 1“ erlaubt !
HTTP-Method | GET |
HTTP-Auth | Optional |
Alias | om_GetCampaignItemConditions_Ad |
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 |
---|---|---|---|---|
ConditionID | ID einer auf Artikel-Bedingungen basierenden Verkaufs-Aktions-Bedingung, zu der die Definition ermittelt werden soll. Mögliche Werte : s. om_GetCampaignConditions_Ad (Rückgabespalte „ConditionID“ zur „CriteriaTypeID = 1“). | integer | 6.0.7 | |
ItemConditionID | NULL | Wird nur beachtet, wenn „NULL“ für „ConditionID“ angegeben wurde ! ID einer Artikel-Bedingung. Angeben, um alle Verkaufs-Aktions-Bedingungen zu erhalten, die auf dieser Artikel-Bedingung basieren. | integer | 6.0.7 |
GetUnusedConditions | 0 | Um an alle Bedingungen zu kommen, die noch gar keiner Verkaufs-Aktion zugeordnet wurden, hier „1“ angeben - „ConditionID“ und „ItemConditionID“ werden dann natürlich ignoriert ! | bit | 6.0.7 |
Spaltenname | Beschreibung | SQL-Datentyp4) | ab Version |
---|---|---|---|
ConditionID | ID einer Verkaufs-Aktions-Bedingung (die auf einer Artikel-Bedingung basiert) - natürlich identisch mit „ConditionID“ wenn angegeben | integer | 6.0.7 |
ConditionDescription | Bezeichnung der Verkaufs-Aktions-Bedingung (also quasi die Bezeichnung der um Mengen- und/oder Warenwert-Kriterium erweiterten Artikel-Bedingung „ItemConditionID“) | varchar(255) | 6.0.7 |
ItemConditionID | ID der Artikel-Bedingung, auf der „ConditionID“ basiert - natürlich identisch mit „ItemConditionID“ wenn angegeben | integer | 6.0.7 |
ItemConditionDescription | Bezeichnung der Artikel-Bedingung „ItemConditionID“ | varchar(255) | 6.0.7 |
MinNumberOfItems | Die Anzahl VERSCHIEDENER Artikel-Elemente, die die Bedingung „ItemConditionID“ erfüllen, muß zwischen diesem Wert und „MaxNumberOfItems“ (sofern nicht „NULL“) liegen (um „ConditionID“ zu erfüllen) | integer | 6.0.7 |
MaxNumberOfItems | Die Anzahl VERSCHIEDENER Artikel-Elemente, die die Bedingung „ItemConditionID“ erfüllen, muß zwischen „MinNumberOfItems“ und diesem Wert (sofern nicht „NULL“) liegen (um „ConditionID“ zu erfüllen) | integer | 6.0.7 |
FromQuantity | Die Gesamt-Menge (Summe „Quantity“) ALLER Artikel-Elemente, die die Bedingung „ItemConditionID“ erfüllen, muß zwischen diesem Wert und „ToQuantity“ (sofern nicht „NULL“) liegen (um „ConditionID“ zu erfüllen) | integer | 6.0.7 |
ToQuantity | Die Gesamt-Menge (Summe „Quantity“) ALLER Artikel-Elemente, die die Bedingung „ItemConditionID“ erfüllen, muß zwischen „FromQuantity“ und diesem Wert (sofern nicht „NULL“) liegen (um „ConditionID“ zu erfüllen) | integer | 6.0.7 |
FromItemBasicPrice | Der EINZEL-Preis, den „_om_GetBasicPrices“ für ein Artikel-Element, das die Bedingung „ItemConditionID“ erfüllt, liefert, muß zwischen diesem Wert und „ToItemBasicPrice“ (sofern nicht „NULL“) liegen (um „ConditionID“ zu erfüllen) | money | 6.0.7 |
ToItemBasicPrice | Der EINZEL-Preis, den „_om_GetBasicPrices“ für ein Artikel-Element, das die Bedingung „ItemConditionID“ erfüllt, liefert, muß zwischen „FromItemBasicPrice“ und diesem Wert (sofern nicht „NULL“) liegen (um „ConditionID“ zu erfüllen) | money | 6.0.7 |
FromBasicPriceSum | Die Gesamt-Summe für alle Artikel-Elemente (Summe aller Einzelpreise, die „_om_GetBasicPrices“ liefert, mit der jeweiligen „Quantity“ multipliziert), die die Bedingung „ItemConditionID“ erfüllen, muß zwischen diesem Wert und „ToBasicPriceSum“ liegen | money | 6.0.7 |
ToBasicPriceSum | Die Gesamt-Summe für alle Artikel-Elemente (Summe aller Einzelpreise, die „_om_GetBasicPrices“ liefert, mit der jeweiligen „Quantity“ multipliziert), die die Bedingung „ItemConditionID“ erfüllen, muß zwischen „FromBasicPriceSum“ und diesem Wert liegen | money | 6.0.7 |
CombineGroupsWithANDOperator | Gibt an, ob die der „ItemConditionID“ zugeordneten (Artikel-)Bedingungs-Gruppen logisch mit UND verknüpft werden („1“) oder mit ODER („0“) | bit | 6.0.7 |
ItemConditionGroupID | ID einer Bedingungs-Gruppe, die Bestandteil von „ItemConditionID“ ist | integer | 6.0.7 |
ItemGroupSortNo | Bestimmt die Reihenfolge von „ItemConditionGroupID“ innerhalb aller der Artikel-Bedingung „ItemConditionID“ zugeordneten Bedingungs-Gruppen | tinyint | 6.0.7 |
ItemConditionGroupDescription | Bezeichnung der Bedingungs-Gruppe „ItemConditionGroupID“ | varchar(255) | 6.0.7 |
ExtendedItemCondGroupDescr | Bezeichnung der um Mengen- und/oder Warenwert-Kriterium erweiterten Bedingungs-Gruppe „ItemConditionGroupID“ („NULL“, wenn die Bedingungs-Gruppe nicht erweitert ist) | varchar(255) | 6.0.7 |
MinNumberOfItems_Group | Die Anzahl VERSCHIEDENER Artikel-Elemente, die die Bedingungs-Gruppe „ItemConditionGroupID“ erfüllen, muß zwischen diesem Wert und „MaxNumberOfItems“ (sofern nicht „NULL“) liegen (um „ConditionID“ zu erfüllen) | integer | 6.0.7 |
MaxNumberOfItems_Group | Die Anzahl VERSCHIEDENER Artikel-Elemente, die die Bedingungs-Gruppe „ItemConditionGroupID“ erfüllen, muß zwischen „MinNumberOfItems“ und diesem Wert (sofern nicht „NULL“) liegen (um „ConditionID“ zu erfüllen) | integer | 6.0.7 |
FromQuantity_Group | Die Gesamt-Menge (Summe „Quantity“) ALLER Artikel-Elemente, die die Bedingungs-Gruppe „ItemConditionGroupID“ erfüllen, muß zwischen diesem Wert und „ToQuantity“ (sofern nicht „NULL“) liegen (um „ConditionID“ zu erfüllen) | integer | 6.0.7 |
ToQuantity_Group | Die Gesamt-Menge (Summe „Quantity“) ALLER Artikel-Elemente, die die Bedingungs-Gruppe „ItemConditionGroupID“ erfüllen, muß zwischen „FromQuantity“ und diesem Wert (sofern nicht „NULL“) liegen (um „ConditionID“ zu erfüllen) | integer | 6.0.7 |
FromItemBasicPrice_Group | Der EINZEL-Preis, den „_om_GetBasicPrices“ für ein Artikel-Element, das die Bedingungs-Gruppe „ItemConditionGroupID“ erfüllt, liefert, muß zwischen diesem Wert und „ToItemBasicPrice“ (sofern nicht „NULL“) liegen (um „ConditionID“ zu erfüllen) | money | 6.0.7 |
ToItemBasicPrice_Group | Der EINZEL-Preis, den „_om_GetBasicPrices“ für ein Artikel-Element, das die Bedingungs-Gruppe „ItemConditionGroupID“ erfüllt, liefert, muß zwischen „FromItemBasicPrice“ und diesem Wert (sofern nicht „NULL“) liegen (um „ConditionID“ zu erfüllen) | money | 6.0.7 |
FromBasicPriceSum_Group | Die Gesamt-Summe für alle Artikel-Elemente (Summe aller Einzelpreise, die „_om_GetBasicPrices“ liefert, mit der jew. „Quantity“ multipliziert), die die Bedingungs-Gruppe „ItemConditionGroupID“ erfüllen, muß zw. diesem Wert und „ToBasicPriceSum“ liegen | money | 6.0.7 |
ToBasicPriceSum_Group | Die Gesamt-Summe für alle Artikel-Elemente (Summe aller Einzelpreise, die „_om_GetBasicPrices“ liefert, mit der jew. „Quantity“ multipliziert), die die Bedingungs-Gruppe „ItemConditionGroupID“ erfüllen, muß zw. „FromBasicPriceSum“ und diesem Wert liegen | money | 6.0.7 |
CombinePartsWithANDOperator | Gibt an, ob die der „ItemConditionGroupID“ zugeordneten Bedingungs-Teile logisch mit UND verknüpft werden („1“) oder mit ODER („0“) | bit | 6.0.7 |
ItemConditionPartID | ID eines Bedingungs-Teils, das Bestandteil von „ItemConditionGroupID“ ist | integer | 6.0.7 |
ItemPartSortNo | Bestimmt die Reihenfolge von „ItemConditionPartID“ innerhalb aller der Bedingungs-Gruppe „ItemConditionGroupID“ zugeordneten Bedingungs-Teile | tinyint | 6.0.7 |
ItemConditionPartDescription | Bezeichnung des Bedingungs-Teils „ItemConditionPartID“ | varchar(255) | 6.0.7 |
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) | 6.0.7 |
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) | 6.0.7 |
NodeCharacteristicID | ID eines Merkmals. Um „ItemConditionPartID“ zu erfüllen, muß ein Element im Artikelbaum eine Eigenschaft zu diesem Merkmal besitzen, die der Bedingung („Operator1“ etc.) genügt. Sonderfall „-1“ : „KEINE Eigenschafts-Bedingung“ (ist also immer erfüllt). | smallint | 6.0.7 |
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) | 6.0.7 |
Condition1 | Bedingung, die in Verbindung mit „Operator1“ anzuwenden ist („NULL“, falls „Operator1“ den Wert „E“ oder „!E“ hat) | varchar(2000) | 6.0.7 |
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) | 6.0.7 |
Condition2 | Bedingung, die in Verbindung mit „Operator2“ anzuwenden ist (nur belegt, wenn „Operator2“ den Wert „<“ oder „⇐“ enthält) | varchar(1000) | 6.0.7 |
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 | 6.0.7 |
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 | 6.0.7 |
ExtendedItemCondPartDescr | Bezeichnung des um Mengen- und/oder Warenwert-Kriterium erweiterten Bedingungs-Teils „ItemConditionPartID“ („NULL“, wenn der Bedingungs-Teil nicht erweitert ist) | varchar(255) | 6.0.7 |
MinNumberOfItems_Part | Die Anzahl VERSCHIEDENER Artikel-Elemente, die den Bedingungs-Teil „ItemConditionPartID“ erfüllen, muß zwischen diesem Wert und „MaxNumberOfItems“ (sofern nicht „NULL“) liegen (um „ConditionID“ zu erfüllen) | integer | 6.0.7 |
MaxNumberOfItems_Part | Die Anzahl VERSCHIEDENER Artikel-Elemente, die den Bedingungs-Teil „ItemConditionPartID“ erfüllen, muß zwischen „MinNumberOfItems“ und diesem Wert (sofern nicht „NULL“) liegen (um „ConditionID“ zu erfüllen) | integer | 6.0.7 |
FromQuantity_Part | Die Gesamt-Menge (Summe „Quantity“) ALLER Artikel-Elemente, die den Bedingungs-Teil „ItemConditionPartID“ erfüllen, muß zwischen diesem Wert und „ToQuantity“ (sofern nicht „NULL“) liegen (um „ConditionID“ zu erfüllen) | integer | 6.0.7 |
ToQuantity_Part | Die Gesamt-Menge (Summe „Quantity“) ALLER Artikel-Elemente, die den Bedingungs-Teil „ItemConditionPartID“ erfüllen, muß zwischen „FromQuantity“ und diesem Wert (sofern nicht „NULL“) liegen (um „ConditionID“ zu erfüllen) | integer | 6.0.7 |
FromItemBasicPrice_Part | Der EINZEL-Preis, den „_om_GetBasicPrices“ für ein Artikel-Element, das den Bedingungs-Teil „ItemConditionPartID“ erfüllt, liefert, muß zwischen diesem Wert und „ToItemBasicPrice“ (sofern nicht „NULL“) liegen (um „ConditionID“ zu erfüllen) | money | 6.0.7 |
ToItemBasicPrice_Part | Der EINZEL-Preis, den „_om_GetBasicPrices“ für ein Artikel-Element, das den Bedingungs-Teil „ItemConditionPartID“ erfüllt, liefert, muß zwischen „FromItemBasicPrice“ und diesem Wert (sofern nicht „NULL“) liegen (um „ConditionID“ zu erfüllen) | money | 6.0.7 |
FromBasicPriceSum_Part | Die Gesamt-Summe für alle Artikel-Elemente (Summe aller Einzelpreise, die „_om_GetBasicPrices“ liefert, mit der jew. „Quantity“ multipliziert), die den Bedingungs-Teil „ItemConditionPartID“ erfüllen, muß zwischen diesem Wert und „ToBasicPriceSum“ liegen | money | 6.0.7 |
ToBasicPriceSum_Part | Die Gesamt-Summe für alle Artikel-Elemente (Summe aller Einzelpreise, die „_om_GetBasicPrices“ liefert, mit der jew. „Quantity“ multipliziert), die den Bedingungs-Teil „ItemConditionPartID“ erfüllen, muß zwischen „FromBasicPriceSum“ und diesem Wert liegen | money | 6.0.7 |
(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 | Fehler in der Sortierung sowie der Parameter-Prüfung behoben und fehlende „set forceplan“-Option ergänzt |
6.5.1 | 2012-11-02 | Fehler in der Doku zu „GetUnusedConditions“ |
6.0.7 | 2012-05-08 | 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_GetCampaignItemConds_Ad?ConditionID=<value>'
Mit xmllint 6) formatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/om_GetCampaignItemConds_Ad?ConditionID=<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_GetCampaignItemConds_Ad', array( 'ConditionID' => <value>, // 'ItemConditionID' => NULL, // 'GetUnusedConditions' => 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_GetCampaignItemConds_Ad"> <Parameters> <Parameter Name="ConditionID"><!-- integer value --></Parameter> <!-- <Parameter Name="ItemConditionID">NULL</Parameter> --> <!-- <Parameter Name="GetUnusedConditions">0</Parameter> --> </Parameters> </Procedure> </Batch> </ListOfBatches>