PDF Export

Artikel

Liest Artikeldaten aus dem Backend.

Dieser Webservice kann für AVS Angebote und VHS Artikel genutzt werden.

AVS Artikel

Path mapping(intern): /net/dsb/avs3/ArticleMaster/getArticleComplete-1.0.0
SAP REST: /GET_SHOP_ARTICLES oder /GET_SHOP_ARTICLES_BY_NUMBER

URL

GET: /rest/{client}/articles?so=xx&sales-channel=xx&articleupdated-since=xxx

Parameter Beschreibung
client Mandantennummer
sp Dienstleisterkennung. (Pflichtfeld, falls der Benutzeraccount mehrere Dienstleisterkennungen haben kann.)
so VkOrg. (Pflichtfeld, falls der Benutzeraccount nur spezielle VkOrgs des Mandanten nutzen darf.)
sales-channel Vertriebskanal (optional)
max-hit-count Maximale Anzahl Erebnis Datensätze
from-hit Start Artikelnummer des Ergebnisses
articleupdated-since Lese geänderte Artikel nur ab dieser Zeit. (optional) Timestamp in ISO Format, Bsp.: 2017-01-01T12:00:00Z
deleted Wenn true: Lese auch gelöschte. (optional)
prev-unread-only Wenn true: Bringt alle noch nicht bestätigten geänderte Artikel zurück. (default:false). Die Bestätigung erfolgt mit Bestätigung verarbeiteter Artikel zw. or Bestätigung gelöschter Artikel. (optional)
articles 0 … 100 Artikelnummern (optional) → nur in Verbindung mit sp, so BETA

Für Anfragen mit paging können with max-hit-count und from-hit count genutzt werden. Bitte lassen sie beim paging die anderen Parameter unverändert bis sie weniger Ergebnissätze wie max-hit-count erhalten.

Beispiel:

  1. query from-hit=1;max-hit-count=100 –> 100 Ergebnissätze
  2. query from-hit=101;max-hit-count=100 –> 100 Ergebnissätze
  3. query from-hit-count=201;max-hit-count=100 –> 87 Ergebnissätze –> Anfrage ist komplett.

Response

HTTP Response Status Bedeutung
200 Success
401 Authorization required
500 Internal error

AVS Artikelalternativen || Recom-Engine

Im AVS/3 gibt es ein Mapping von Auftrags-Attributen mit einer Parent-Child Zuordnung für verschiedene Business-Cases (Kategorien). Folgende Attribute können jeweils definiert werden: BQ, BQ-Var, Angebot, Gültig-Von, Drerz, PVA, Beztyp, Abotyp, Zahlweg. Wenn keine Explizite Definition vorhanden ist, handelt es sich um einen Wildcard. Hierdurch können zu Führenden-Auftrags-Attributen die jeweiligen Alternativ-Auftrags-Attribute zugeordnet werden.

Je nach Anwendungsfall wird dieser Service in verschiedenen Ausprägungen genutzt. Diese sind zum Teil nicht bei allen Mandanten verfügbar.

Path mapping(intern): /net/dsb/avs3/ArticleMaster/getArticleAlternatives-1.0.0
SAP REST: /GET_ALT_ARTICLES
Allen Varianten gemeinsam sind diese Parameter:

Parameter Beschreibung
client Mandantennummer
sp Dienstleisterkennung. (Pflichtfeld, falls der Benutzeraccount mehrere Dienstleisterkennungen haben kann.)
category Umfasst bestimme Business-Cases in der Recom-Engine Bsp.: category=SCRIPT
campaign Umfasst bestimme Kampagnen in der Recom-Engine Bsp.: campaign=SCRIPT
source Umfasste bestimmte Quellen Bsp.: source=SCR01
activity Umfasst bestimmte Aktionen Bsp.: activity=SC01
actionType DM = DarkMode, TF = To Forward
channel Channel als Filter

Bitte immer nur jeweils einen Wert mitgeben. Wenn diese Parameter weggelassen werden, handelt es sich bei der Kategorie um einen Wildcard (alle Einträge sind relevant) und bei Source und Activity wird explizit nach leer gesucht.

nur bei deutschen Mandanten

alle alternativen Artikel zu einer Artikel ID ermitteln

Bei deutschen Mandanten wird eine Artikelnummer aus der /DSB/JET_SHOPD mitgegeben. Danach werden Alternativ-Artikel-Nummern ausgegeben.

URL

GET: /rest/{client}/articles/{articleId}/articlealternatives?sp=xx

Parameter Beschreibung
articleId Artikel ID

Response

alle alternativen Artikel ermitteln

Alternativ können bei einem deutschen Mandanten auch alle Alternativen ausgegeben werden.

URL

GET: /rest/{client}/articlealternatives/full?sp=xx

Response

Verfügbar in allen Mandanten

alle alternativen Artikel zu einem Abo ermitteln

Anhand der Abo-Nummer werden für das Renewal-Modell oder DACH-Modell die zugehörigen Auftrags-Attribute ermittelt um danach die Recomms ausgegeben.

URL

GET: /rest/{client}/subscriptions/{orderNumber}/articlealternatives?sp=xx&filter=PUBLICATION

Parameter Beschreibung
orderNumber Auftragsnummer
filter Mit einem Filter Parameter kann man Filterungen durchführen. Mehrere Filter können kommasepariert übergeben werden. Beispiel: FILTER=PUBLICATION,SHOPARTICLES).
PUBLICATION: es wird nach dem Druckerzeugnis welches im mitgegebenen Auftrag vorhanden ist, gefiltert.
SHOP_ARTICLES: es werden nur Recomms mit Shop-Artikel-ID ausgegeben. Wenn keine vorhanden, dann No-Recoms. Wenn es sich bei den definierten Alternativen um eine BQ aus dem deutschen-Abo-Modell handelt, werden Artikel aus dem deutschen Shop-Umfeld ermittelt. Sobald sich die definierte Alternativ-BQ auf das Renewal-Abomodell bezieht, werden Artikel aus dem Renwal-Shop-Umfeld ermittelt.

Response

alternative Artikel mit Suchkriterien ermitteln

Die Auftrags-Attribute können auch direkt mitgegeben werden (BQ, BQ-Var, Angebot, Gültig-Von, Drerz, PVA, Beztyp, Abotyp, Zahlweg) um danach die Alternativen zu ermitteln und auszugeben. GET: /rest/{client}/articlealternatives?sp=xx&sourceCode=ABC&….

Parameter Beschreibung
sourceCode BQ
sourceCodeVariant BQ Variante
validFrom Gültig Ab Datum (ISO Format)
publication DRERZ
edition PVA
offerCode Angebotscode
mixType Bezugstyp
filter Mit einem Filter Parameter kann man Filterungen durchführen. Mehrere Filter können kommasepariert übergeben werden. Beispiel: FILTER=PUBLICATION,SHOPARTICLES).
PUBLICATION: es wird nach dem Druckerzeugnis welches im mitgegebenen Auftrag vorhanden ist, gefiltert.
SHOP_ARTICLES: es werden nur Recomms mit Shop-Artikel-ID ausgegeben. Wenn keine vorhanden, dann No-Recoms. Wenn es sich bei den definierten Alternativen um eine BQ aus dem deutschen-Abo-Modell handelt, werden Artikel aus dem deutschen Shop-Umfeld ermittelt. Sobald sich die definierte Alternativ-BQ auf das Renewal-Abomodell bezieht, werden Artikel aus dem Renwal-Shop-Umfeld ermittelt.

Response

HTTP Status bei allen Varianten

HTTP Response Status Bedeutung
200 Success
401 Authorization required
500 Internal error

VHS Artikel / back issues, marketing articles, ..-

URL

GET: /rest/{client}/articles?max-hit-count=xx&from-hit=xx

Parameter Beschreibung
client Mandantennummer
sp Dienstleisterkennung. (Pflichtfeld, falls der Benutzeraccount mehrere Dienstleisterkennungen haben kann.)
response Typ des Responses:
- articles-complete : liefert komplette Artikel wie beim SOAP service zurück ArticleMaster:getArticleComplete.
Nur „articles-complete“ wir aktuell unterstützt
max-hit-count Maximale Anzahl Erebnis Datensätze
from-hit Start Artikelnummer des Ergebnisses
include-inactive true / false (default). Liest auch inaktive Artikel
articleupdated-since Lese geänderte Artikel nur ab dieser Zeit. (optional) Timestamp in ISO Format, e.g. 2017-01-01T12:00:00Z
price-lists Preislisten, für die Sie die Preise abfragen möchten. Format: price-lists=ABC,DEF. Wenn sie alle Preise wollen, nutzen sie bitte price-lists=ALL_PRICES.
with-sc Liefert die BQ mit der Preisliste (true/false) (default: false)
omitProductGroups Liste mit Produktgruppen, die nicht geliefert werden sollen

Um lang laufende Anfragen zu verhindern sollten sie einen paging Mechanismus implementieren. Nutzen sie max-hit-count um die Responsegröße zu beschränken. Nutzen sie from-hit um die nächste Ergebnismenge anzufordern.

Korrespondierender SOAP Service: getArticleComplete.

Response

HTTP Response Status Bedeutung
200 Success
401 Authorization required

Einzelner VHS Artikel

BETA

URL

GET: /rest/{client}/article?sp=xxx&distArticleNr=xxx

Parameter Beschreibung
client VHS Mandantennummer
sp Dienstleisterkennung. (Pflichtfeld, falls der Benutzeraccount mehrere Dienstleisterkennungen haben kann.)
priceLists 0 .. n Preislisten, zu denen die Preise geliefert werden sollen.
distArticleNr Vertriebsartikel-Nr. des Artikels. eine der Beiden Artikelnummern muss angegeben sein
distArticleNrExt Externe Vertriebsartikel-Nr.des Artikels. Eine der Beiden Artikelnummern muss angegeben sein
countryCodeType Steuert, in welcher Form die Ländercodes zurückgeliefert werden.
car = 3-stell. KFZ-Ländercode
iso = 2-stell. ISO-Ländercode

Korrespondierender SOAP Service: getarticle_1_0_0.

Response

HTTP Response Status Bedeutung
200 Success
401 Authorization required

ProductSales Artikel(SAP) abrufen

URL

GET: /rest/{client}/articles?productSales=true&fromHitPsArticleNumber={fromHitPsArticleNumber}&max-hit-count=10

Parameter Beschreibung
client AVS Mandantennummer
sp Dienstleisterkennung. (Pflichtfeld, falls der Benutzeraccount mehrere Dienstleisterkennungen haben kann.)
so VkOrg. (Pflichtfeld, falls der Benutzeraccount nur spezielle VkOrgs des Mandanten nutzen darf.)
max-hit-count Maximale Anzahl Ergebnis Datensätze
productSales true/false(default) für Abruf der ProductSales Artikel muss dieser Parameter auf true gesetzt werden
fromHitPsArticleNumber Für paging muss hier die Artikelnummer aus dem vorherig zurückgelieferten Feld lastHitPsArticleNumber eingetragen werden
articles 0 … 100 Artikelnummern (optional) → nur in Verbindung mit sp, so BETA

Um lang laufende Anfragen zu verhindern sollten sie einen paging Mechanismus implementieren. Nutzen sie max-hit-count um die Responsegröße zu beschränken. Nutzen sie fromHitPsArticleNumber um die nächste Ergebnismenge anzufordern.

Korrespondierender SOAP Service: getArticleComplete.

Response

HTTP Response Status Bedeutung
200 Success
401 Authorization required

Lagerartikel (ProductSales) abrufen

URL

GET: /rest/{client}/stockArticles?fromHitStockArticleNumber={fromHitStockArticleNumber}&max-hit-count=10

Parameter Beschreibung
client AVS Mandantennummer
sp Dienstleisterkennung. (Pflichtfeld, falls der Benutzeraccount mehrere Dienstleisterkennungen haben kann.)
so VkOrg. (Pflichtfeld, falls der Benutzeraccount nur spezielle VkOrgs des Mandanten nutzen darf.)
max-hit-count Maximale Anzahl Ergebnis Datensätze
fromHitStockArticleNumber Für paging muss hier die Artikelnummer aus dem vorherig zurückgelieferten Feld lastHitStockArticleNumbereingetragen werden
articleupdated-since Lese geänderte Artikel nur ab dieser Zeit. (optional) Timestamp in ISO Format, e.g. 2017-01-01T12:00:00Z
articles 0 … 100 Artikelnummern (optional) → nur in Verbindung mit sp, so BETA

Um lang laufende Anfragen zu verhindern sollten sie einen paging Mechanismus implementieren. Nutzen sie max-hit-count um die Responsegröße zu beschränken. Nutzen sie fromHitStockArticleNumber um die nächste Ergebnismenge anzufordern.

Response

HTTP Response Status Bedeutung
200 Success
401 Authorization required

ProductSales Artikel anlegen/ändern

POST: /rest/{client}/articles

Parameter Beschreibung
client AVS Mandantennummer
sp Dienstleisterkennung. (Pflichtfeld, falls der Benutzeraccount mehrere Dienstleisterkennungen haben kann.)
so VkOrg. (Pflichtfeld, falls der Benutzeraccount nur spezielle VkOrgs des Mandanten nutzen darf.)

Request

ProductSales Lagerartikel anlegen/ändern

POST: /rest/{client}/stockArticles

Parameter Beschreibung
client AVS Mandantennummer
sp Dienstleisterkennung. (Pflichtfeld, falls der Benutzeraccount mehrere Dienstleisterkennungen haben kann.)
so VkOrg. (Pflichtfeld, falls der Benutzeraccount nur spezielle VkOrgs des Mandanten nutzen darf.)

Request

ProductSales Artikelattribut löschen

DELETE: /rest/{client}/articles/{distributionArticleNumber}/attributes/{dimension}/{type}/{language}

Löschen eines Artikelattributs bzw. nur einer Sprachvariante eines Attributs.

Parameter Beschreibung
client AVS Mandantennummer
sp Dienstleisterkennung. (Pflichtfeld, falls der Benutzeraccount mehrere Dienstleisterkennungen haben kann.)
so VkOrg. (Pflichtfeld, falls der Benutzeraccount nur spezielle VkOrgs des Mandanten nutzen darf.)
distributionArticleNumber Artikelnummer (mandatory)
dimension Schlüsselfeld des Attributs (mandatory)
type Schlüsselfeld des Attributs (mandatory)
language Nur die Sprachvariante löschen (optional)

ProductSales Artikelbeschreibung löschen

DELETE: /rest/{client}/articles/{distributionArticleNumber}/descriptions/{language}

Löschen einer Artikelbeschreibung.

Parameter Beschreibung
client AVS Mandantennummer
sp Dienstleisterkennung. (Pflichtfeld, falls der Benutzeraccount mehrere Dienstleisterkennungen haben kann.)
so VkOrg. (Pflichtfeld, falls der Benutzeraccount nur spezielle VkOrgs des Mandanten nutzen darf.)
distributionArticleNumber Artikelnummer (mandatory)
language Sprachvariante (mandatory)

ProductSales Komponente löschen

DELETE: /rest/{client}/articles/{distributionArticleNumber}/setComponents/{id}

Löschen einer Artikelkomponente.

Parameter Beschreibung
client AVS Mandantennummer
sp Dienstleisterkennung. (Pflichtfeld, falls der Benutzeraccount mehrere Dienstleisterkennungen haben kann.)
so VkOrg. (Pflichtfeld, falls der Benutzeraccount nur spezielle VkOrgs des Mandanten nutzen darf.)
distributionArticleNumber Artikelnummer (mandatory)
id ID der zu löschenden Komponente (mandatory)

ProductSales Vertriebskanal löschen

DELETE: /rest/{client}/articles/{distributionArticleNumber}/distributionChannels/{channel}

Löschen eines Vertriebskanals.

Parameter Beschreibung
client AVS Mandantennummer
sp Dienstleisterkennung. (Pflichtfeld, falls der Benutzeraccount mehrere Dienstleisterkennungen haben kann.)
so VkOrg. (Pflichtfeld, falls der Benutzeraccount nur spezielle VkOrgs des Mandanten nutzen darf.)
distributionArticleNumber Artikelnummer (mandatory)
channel Vertriebskanal (mandatory)
Cookies helfen bei der Bereitstellung von Inhalten. Durch die Nutzung dieser Seiten erklären Sie sich damit einverstanden, dass Cookies auf Ihrem Rechner gespeichert werden. Weitere Information