Beschreibung
Basisinformationen übertragen
Nachrichten mit Basisinformationen zu Artikeln enthalten allgemeine, vom Kunden unabhängige Angaben über Artikel.
Feld | Wert |
|---|
Nachrichtenkopf - Nachrichtentyp | ProductUpdate |
Nachrichtenkopf - Version des Typs
Letzte Version | 8
|
Nachrichtenkopf - Häufigkeit: 1
Nachrichtenkopf
Der Kopf einer Nachricht setzt sich immer aus folgenden Feldern zusammen:
| # | | | | | | |
|---|
| 1 | Nachrichtentyp | Type | M | alph | 30 | Kennung/Bezeichnung des Typs der Nachricht. Die einzelnen Typen werden im Folgenden vorgestellt. |
| 2 | Version des Typs | Version | M | int |
| Kennung der Version des Nachrichtentyps bzw. des Formats |
| 3 | Datum & Uhrzeit | Date | M | dt |
| Datum und Uhrzeit der Erstellung der Nachricht |
| 4 | Sender | SenderId | M | alph | 50 | Kennung des Senders |
| 5 | Empfänger | ReceiverId | M | alph | 50 | Kennung des Empfängers |
| 6 | Kennung der Transaktion | TransactionId | K | alph | 32 | siehe folgender Abschnitt „Transaktionen".
Leer bei nicht Verwendung des Transaktionsprotokolls. |
| 7 | Kennung der Nachricht | MessageId | M | alph | 32 | Fortlaufende Nummer um die Nachricht eindeutig zu identizieren.
siehe folgender Abschnitt „Transaktionen" |
| 8 | Sequenznummer des Senders der Nachricht | SequenceNrSender | K | int |
| Fortlaufende Zahl, die sicherstellt, dass ankommende Nachrichten in der richtigen Reihenfolge abgearbeitet werden |
| 9 | Sequenznummer des Empfängers der Nachricht | SequenceNrReceiver | K | int |
| Fortlaufende Zahl, die sicherstellt, dass ankommende Nachrichten in der richtigen Reihenfolge abgearbeitet werden |
| 10 | Timeout | Timeout | K | int |
| Zeit in Minuten, in der der Sender eine Antwort erwartet. Kein Timeout (unendliches Warten) wird durch den Wert 0 (null) ausgedrückt. |
| 11 | Nachrichtenlänge | NumberOfLines | M | int | 10 | Anzahl der Zeilen der Nachricht , inkl. Der ersten Zeile. Dieser Wert dient zur Überprüfung, ob die Nachricht komplett übertragen wurde. |
Mit der Version 2.2 der Schnittstelle wird das Feld „Version" genutzt. Alle bisherigen Schnittstellenversionen hatten hier den Wert „1". Ab der aktuellen Version wird der Wert mit jeder Version hochgezählt. Alle Satzarten und Felder die aktuell keine Versionsangabe besitzen, müssen unterstützt werden. Alle Felder und Satzarten die eine Angabe besitzen, müssen erst ab der angegebenen Version unterstützt werden.
Die Werte für die Felder „Kennung des Senders" und „Kennung des Empfängers" müssen im Vorfeld festgelegt werden. Durch sie werden konkrete Instanzen eines ordermanager und einer Warenwirtschaft eindeutig identifizert.
Die „Kennung der Nachricht" sollte, wenn möglich, mit einer fortlaufenden Nummern gefüllt werden. Wird auf das Transaktionsprotokoll verzichtet, so müssen die Felder „Kennung der Transaktion" sowie beide Sequenznrn Felder leer bleiben. Ab der Version 2.4 wird der Einsatz des Transaktionsprotokolls nicht mehr empfohlen.
ProductBase - Häufigkeit: 1..*
| # | | | | | | | |
|---|
| 1 | Artikelnr. | ArticleId | M | Alph | 30 |
| Nummer der Artikels in der Warenwirtschaft |
| 2 | Gruppen-Artikelnr. | ArticleIdGroup | K | Alph | 30 |
| Gruppen-übergreifende Artikelnr. (relevant bei Verbundgruppen) |
| 3 | EAN | EAN | K | EAN | 16 |
| EAN des Artikels |
| 4 | Hersteller-Artikelnr. | ManufacturerArticleId | K | Alph | 30 |
| Nummer, die der Hersteller/Lieferant an den Artikel vergeben hat |
| 5 | Name | Name | M | Alph | 200 |
| Name des Artikels |
| 6 | Kurzbeschreibung | ShortDescription | K | Alph | 400000 |
| Kurze Charakterisierung des Artikels (im HTML-Format) |
| 7 | Langbeschreibung | LongDescription | K | Alph | 400000 |
| Detaillierte Charakterisierung des Artikels (im HTML-Format) |
| 8 | Suchbegriffe | Keywords | K | Alph | 500 |
| Suchbegriffe für Unterstützung der Besteller bei der Suche nach Artikel |
| 9 | Bestelleinheit UNECE Code | OrderUnitUNECE | K | Alph | 3 |
| UNECE Abkürzung der Bestelleinheit (Beispiel: CT für Karton) |
| 10 | Bestelleinheit | OrderUnit | M | Alph | 100 |
| Name der Bestelleinheit und Bezug des Preises, gibt den Bezug für alle Mengenangaben an. (Beispiel: „Karton") |
| 11 | VPE Zusatzinfo | Packaging | K | Alph | 100 |
| Zusätzliche Informationen zur Verpackung (Beispiel: „10 Stück pro Karton") |
| 12 | Lieferzeit | LeadTime | K | dezimal |
|
| Zeit von der Bestellung bis zur Auslieferung in Tagen |
| 13 | MwSt-Satz | VatPercent | M | dezimal |
|
| MwSt-Satz in Prozent (z.B. 19.00) |
| 14 | Änderungsdatum | LastChangeDate | K | Datum |
|
| Datum der letzten Änderung des Artikel-Datensatzes |
| 15 | Erstelldatum | CreateDate | K | Datum |
|
| Datum der Erstanlage des Datensatzes |
| 16 | Hersteller | Manufacturer | K | Alph | 20 |
| Wawi-interne Kennzeichnung des Lieferanten (Id, Nummer o.ä.) |
| 17 | Haupt-Kategorie/Warengruppe | Category | K | Alph | 20 |
| Wawi-interne Kennzeichnung der Warengruppe oder einer Artikelkategorie (Id, Nummer, o.ä.) |
| 18 | Bestelleinheit Menge | OrderUnitQuantity | K | Dezimal |
| 2 | Anzahl der Bestelleinheiten, die den Preisbezug definieren |
| 19 | Sprache | Language | K | Alph | 7 | 3 | Iso-Code nach ISO 639-1 der Sprache in der die Texte verfasst sind. z.B. de. Wird keine Sprache übermittelt, wird die Systemsprache angenommen. |
| 20 | Nachfolger | Successor | K | Alph | 30 | 7 | Artikelnummer des Nachfolge-Produkts |
| 21 | Inhaltseinheit UNECE Code | ContentUnitUNECE | K | Alph | 3 | 17 | UNECE Abkürzung der Inhaltseinheit (Beispiel: CT für Karton) |
| 22 | Verpackungsmenge | ContentUnitQuantity | K | Dezimal |
| 17 | Anzahl Inhaltseinheiten pro Bestelleinheiten |
ProductBaseTag - Häufigkeit: 0..*
Ein Tag zeichnet ein Produkt entsprechend aus. Zu einem Produkt können beliebig viele Tags angelegt werden. Wird ein Produkt an den ordermanager übertragen, müssen immer alle relevanten Tags mit übertragen werden. Alle nicht vorhanden Tags werden bei der Aktualisierung vom Produkt entfernt.
| # | | | | | | |
|---|
| 1 | Artikelnr. | ArticleId | M | alph | 30 | Nummer der Artikels in der Warenwirtschaft |
| 2 | Tag Name | TagName | M | alph | 255 | Name des Tags in der jeweiligen Sprache |
| 3 | Sprache | Language | K | Alph | 7 | Iso-Code nach ISO 639-1 der Sprache in der die Texte verfasst sind. z.B. de. Wird keine Sprache übermittelt, wird die Systemsprache angenommen. |
ProductBaseRelation - Häufigkeit: 0..*
Mittels dieser Satzart können Beziehungen zwischen Produkten an den ordermanager übermittelt werden z.B. Zubehör, Ersatzteil etc.
Eine Beziehung gilt immer zwischen 2 Produkten und hat einen bestimmten Typ. Diese sind vorab abzustimmen. Zusätzlich kann eine Reihenfolge sowie eine Referenznummer übermittelt werden. Die Reihenfolge steuert den Aufbau der Auflistung der Beziehungen. Mittels der Referenznummer kann auf externe Informationen referenziert werden wie z.B. eine Explosionszeichnung.
| # | | | | | | |
|---|
| 1 | Artikelnr. von | ArticleIdFrom | M | alph | 30 | Nummer der Artikels in der Warenwirtschaft |
| 2 | Artikelnr. zu | ArticleIdTo | M | alph | 30 | Nummer der Artikels in der Warenwirtschaft |
| 3 | Beziehungstyp | ReleationType | M | Alph | 50 | Die Standard Typen, die bereits im orderManager sind in der untenstehenden Liste zu finden. Weitere Typen können anlegt werden. |
| 4 | Menge | Quantity | K | Dezimal | | In welcher Menge die Artikel in Beziehung stehen.
z.B. Artikel A enthält 2 von Artikeln B. |
| 5 | Referenz-Nummer | ReferenceNumber | K | Alph | 30 | Zur Referenzierung von externen Inhalten wie Eintrag in Explosionszeichnung |
| 6 | Reihenfolge | Order | K | Int | | Reihenfolge in der die Beziehungen angezeigt werden sollen. |
Standard-Beziehungstypen des orderManager
| # | Beziehungstyp Wert | Beschreibung |
| 1 | alternative | Alternativen / Up-Selling |
| 2 | crosssell | Cross-Selling |
| 3 | accessory | Zubehör |
| 4 | sparepart | Ersatzteil |
| 5 | other | Sonstige |
ProductBaseCategory - Häufigkeit: 0..*
Über diese Satzart kann man dem Produkt weitere Kategorien zuordnen (Zusätzlich zur Hauptkategorie)
| # | | | | | | |
|---|
| 1 | Artikelnr. | ArticleId | M | alph | 30 | Nummer der Artikels in der Warenwirtschaft |
| 2 | Kategorie/ Warengruppe | Category | M | alph | 20 | Wawi-interne Kennzeichnung der Warengruppe oder einer Artikelkategorie (Id, Nummer, o.ä.) |
Feature - Häufikeit: 0..*
Pro Artikelposition kann es mehrere Merkmals-Positionen geben. Die Referenzierung zur Artikelposition geschieht auch hier über die Artikelnummer.
| # | Feld | XML Attribut | Muss/ Kann | Typ | h9.Länge | Info | Version |
| 1 | Artikelnr. | ArticleId | M | alph | 30 | Primäre Artikelnummer die auch in der Artikelposition verwendet wurde. |
|
| 2 | Name | Name | M | alph | 100 | Name des Merkmals z.B. Grösse |
|
| 3 | Kennung | Number | K | alph | 50 | Kennung des Merkmals
Vordefinierte Merkmale:
andavis_weight → Dieser Wert wird in das Feld "Gewicht" im Artikel übernommen und nicht als Merkmal angelegt. |
|
| 4 | Wert | Value | K | alph | 256000 | Wert des Merkmals als String, muss jedoch dem Format, das unter Datentyp angegeben wurde, folgen. |
|
| 5 | Datentyp | DataType | M | alph | 10 | Datentyp des Wertes. Mögliche Werte ("INTEGER", "DECIMAL", "STRING", "VALUES", "LONGTEXT", "HTML"). |
|
| 6 | Einheit Name | UnitName | K | alph | 30 | Einheit des Merkmals als Text |
|
| 7 | Einheit | Unit | K | alph | 3 | UN/ECE-Code ((nach UN/ECE Rec. 20/21) |
|
| 8 | Sprache | Language | K | Alph | 7 | Sprache des Merkmals | 3 |
| 9 | Gruppennummer | GroupNumber | K | Alph | 50 | Nummer der Merkmalsgruppe in der das Merkmal befindet | 4 |
| 10 | Zeilennummer | RowNumber | K | Int |
| Zeilennummer des Merkmals. Nur Relevant bei Merkmalen innerhalb einer Merkmalsgruppe mit Wiederholungen.
Fasst Merkmal einer Gruppe in Zeilen zusammen. | 4 |
Document - Häufigkeit: 0..*
Pro Artikelposition kann es mehrere Dokumente geben. Die Referenzierung zum Artikel findet über die Artikelnummer statt.
| # | | | | | | | Version |
|---|
| 1 | Artikelnr. | ArticleId | M | Alph | 30 | Nummer der Artikels in der Warenwirtschaft |
|
| 2 | Dokumententyp | DocType | M | Alph | 50 | Kennzeichner für Dokumenttyp. Muss Kundenindividuell spezifiziert werden.
Die Standard Typen, die bereits im orderManager sind in der untenstehenden Liste zu finden. |
|
| 3 | Dateiname | FileName | M | Alph | 1000 | Der Name der Datei ohne Endung. |
|
| 4 | Dateinamens-
erweiterung | FileExtension | M | Alph | 10 | Die Endung der Datei, z.B. „.jpg" |
|
| 5 | Ist neues Dokument | IsNewDocument | M | Bool |
| Handelt es sich bei dem Dokument um ein Dokument, welches das erste Mal übertragen wird? |
|
| 6 | Gültig ab | ValidFrom | K | DateTime |
| gibt an, ab wann das Dokument gültig ist | 8 |
| 7 | Beschreibung | Description | K | Alph | 500 | Name des Dokuments | 8 |
| 8 | Inhalt | Content | K | Alph | 400.000 | Base64-Codierter Inhalt der Datei | 17 |
Standard-Dokumententypen des ordermanager
| Dokumenttyp Wert | Beschreibung |
|---|
| 1 | 1 | Listenbild (Standardbild) |
| 2 | 2 | Sicherheitsdatenblatt |
| 3 | 3 | Produktdatenblatt |
| 4 | 4 | Betriebsanleitung |
| 5 | 999 | Sonstiges |
| 6 | 6 | Detailbild |
| 7 | 7 | Galeriebild (groß) |
| 8 | 8 | Galeriebild (klein) |
Es müssen immer alle Dokumente eines Artikels angegeben werden. Wird ein Dokument nicht mehr im ProductUpdate angegeben, so wird es aus dem Artikel entfernt. Eine Datei muss nur übermittelt werden bei "IsNewDocument" auf "true" steht. Und nur in diesem Fall wird der Inhalt in das System übernommen.
In der Regel müssen nicht alle Artikel der Warenwirtschaft in einer „ProductUpdate"-Nachricht enthalten sein, sondern es reicht aus, nur diejenigen Artikel zu übermitteln, die von Kunden, die über ordermanager bestellen, bezogen werden. Das ProductUpdate bewirkt im orderManager immer ein Überschreiben von bereits vorhandenen Datensätzen oder Neuanlage von nicht vorhandenen Datensätzen. Die Artikelnummer aus der Warenwirtschaft ist der Primärschlüssel.
