DeliveryNotice
Funktion
Lieferschein aus dem ERP System, der in den ordermanager importiert und der Bestellung zugeordnet wird.
Beispiele
| Nachrichtentyp | Format | Version | Link |
|---|---|---|---|
| DeliveryNotice | CSV | 4 | DeliveryNotice_969_37.csv |
| DeliveryNotice | XML | 4 | |
| DeliveryNotice | CSV | 22 | DeliveryNotice1128.msg |
| DeliveryNotice | XML | 22 | DeliveryNotice1109.xml |
Beschreibung
Nachrichtenkopf
Der Kopf einer Nachricht setzt sich immer aus folgenden Feldern zusammen:
| # | Feld | XML-Attribut | Muß/ | Format | max. Länge | Beschreibung |
|---|---|---|---|---|---|---|
| 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". |
| 7 | Kennung der Nachricht | MessageId | M | alph | 32 | Fortlaufende Nummer um die Nachricht eindeutig zu identizieren. |
| 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.
Diese Satzart enthält Informationen, um die Bestellung, zu der die Nachricht gehört, eindeutig zu identifizieren.
| # | Feld | XML Attribut | Muß/ | Format | max. Länge | Beschreibung |
|---|---|---|---|---|---|---|
| 1 | Id | Id | M/K*1 | alph | 30 | ordermanager–interne Id der Bestellung |
| 2 | Auftragsnr. | VendorOrderCode | M/K | alph | 30 | Wawi-interne Auftragsnummer |
Die Wawi-interne Auftragsnummer muss in der ersten Rückmeldung der Warenwirtschaft an ordermanager nach der Meldung „PurchaseOrderSubmit" übermittelt werden und ist ab dann zusammen mit der ordermanager-internen Id in jeder Nachricht enthalten.
*1 Angabe ist nicht erforderlich bei Nachrichten vom Typ „PurchaseOrderCreate".
| # | Feld | XML Attribut | Muß/ | Format | max. Länge | Beschreibung | Version |
|---|---|---|---|---|---|---|---|
| 1 | LS-Datum | DeliveryNoteDate | M | date |
| Datum des Lieferscheins | |
| 2 | LS-Nummer | NoticeNumber | M | alph | 30 | Wawi-interne Nummer des Lieferscheins | |
| 3 | Lieferdatum | DeliveryDate | K | date |
| Datum, an dem die Lieferung ausgeführt wird | |
| 4 | Wawi-interne Auftragsnummer | VendorOrderCode | M | alph | 30 | Nummer des Auftrags in der Wawi, auf den sich diese Liefermeldung bezieht | |
| 5 | Wawi-interne Nummer des Folgeauftrags | NextVendorOrderCode | K | alph | 30 | Bei Teillieferungen ggf. die Nummer des Auftrags, über den die folgenden Lieferungen abgewickelt werden; leer, wenn es keinen Folgeauftrag gibt | |
| 6 | letzte Lieferung | LastDelivery | M | bool |
| Ja, wenn die Bestellung mit diesem Lieferschein vollständig ausliefert worden ist | |
| 7 | Kundennr. | CustomerId | K | alph | 30 | Wawi-interne Nummer des Kunden | 2 |
Das Format der Lieferadresse entspricht dem Format der Lieferadresse der Bestellung.
Hinweis: Das es sich aber trotzdem um eine andere Satzart handelt, wird die Lieferadresse in einer Nachricht vom Typ „DeliveryNotice" auch durch ein eigenes Kürzel für die Satzart gekennzeichnet (siehe Tabelle im letzten Abschnitt).
| # | Feld | XML Attribut | Muß/ | Format | max. Länge | Beschreibung | Version |
|---|---|---|---|---|---|---|---|
| 1 | Positionsnr. | LineNumber | M | int | Nummer der entsprechenden Position der Bestellung. | ||
| 2 | Positionskennung | LineIdentifier | M | int | eindeutige Kennung der Position im ordermanager auf die sich diese Lieferscheinposition bezieht. Ist keine Zuordnung zur Bestellposition möglich, so muss „0" eingetragen werden. | ||
| 3 | Artikelnr. | ArticleId | M/K | alph | 30 | Wawi-interne Artikelnummer. Bei Textpositionen leer | |
| 4 | EAN | EAN | K | EAN | 14 | EAN des Artikels | |
| 5 | Artikelbezeichnung | ArticleName | K | alph | 200 | Bezeichnung des Artikels in der Wawi oder im ordermanager | |
| 6 | Text | Text | K | alph | 200 | ergänzender Text zur Position oder Textposition | |
| 7 | Menge | Quantity | M | dez | ausgelieferte Menge | ||
| 8 | Einheit | Unit | M | alph | 100 | Einheit, auf die sich die Mengenangabe bezieht | |
| 9 | Unece Einheit | UneceUnit | K | alph | 3 | Einheit, auf die sich die Mengenangabe bezieht, als Unece-Code | 2 |
| 10 | Unece Einheit Menge | UneceUnitQuantity | K | dez | Anzahl der Unece Einheiten, auf die sich die Mengenangabe bezieht | 2 | |
| 11 | Lieferinformation | DeliveryComment | K | alph | 500 | Kommentar mit Lieferinformationen wird in die Bestellung übertragen und auf der Bestelldetailseite angezeigt | 17 |
| # | Feld | XML Attribut | Muß/ | Format | max. Länge | Beschreibung |
|---|---|---|---|---|---|---|
| 1 | Bearbeiter | Editor | M | alph | 100 | Der Bearbeiter, der den Kommentar erfasst hat |
| 2 | Datum/Uhrzeit | Date | M | dt |
| Der Zeitpunkt, an dem der Kommentar erfasst worden ist |
| 3 | Kommentar | Text | M | alph | 200 | Kommentar |
In Kommentaren, die von der Warenwirtschaft an den ordermanager übertragen werden, kann als Bearbeiter auch die Benutzerkennung oder –nummer eingetragen werden, die der Sachbearbeiter beim Händler zur Anmeldung an der Warenwirtschaft verwendet. Dazu müssen aber in der Benutzerverwaltung des ordermanager die dazugehörigen Benutzer angelegt sein und diese Kennungen oder Nummern in dem dafür vorgesehenen Feld hinterlegt
Das Format der Unterposition entspricht dem Format der Unterposition aus der Bestellung, siehe Bestellung - Unterposition.
Referenz auf einen Anhang zu einem Beleg.
Der Anhang selbst wird über einen Http-Endpoint (/api/v1/attachments) in den ordermanager hochgeladen. Die dabei erzeugte "upload_id" wird hier als Referenz übermittelt. siehe dazu Dokumentation Upload Dateien zu Belegen
Die Satzart wird innerhalb der Belegnachrichten verwendet, um die Verknüpfung zwischen dem bereits hochgeladenen Anhang und dem Beleg herzustellen.
| # | Feld | XML Attribut | Muß / Kann | Format | max. Länge | Beschreibung |
|---|---|---|---|---|---|---|
| 1 | Upload-ID | UploadId | M | alph | 50 | upload_id aus Rückgabewert von Http-Endpoint /api/v1/attachments |
| 2 | Dateiname | Filename | M | alph | 255 | Dateiname des Anhanges. |