Featureinformationen
Artikelbezogene Kommunikation
Hinterlegen Sie zu jeder einzelnen Artikelposition eines Lieferscheins Freitext-Notizen – direkt über die API, nahtlos integriert in Ihren bestehenden Systemprozess. Ob Hinweise zur Verpackung, Informationen zur Chargenqualität oder Abstimmungen mit dem Wareneingang: Ihre Anmerkungen erreichen die richtige Stelle genau dort, wo sie gebraucht werden – an der konkreten Artikelposition.
Sie entscheiden, welche Notizen für den Wareneingang sichtbar sind und welche nur intern bleiben. Umgekehrt können Sie Notizen einsehen, die der Empfänger zu Ihren Artikeln hinterlegt und freigegeben hat. So entsteht ein strukturierter, artikelbezogener Kommunikationskanal entlang der gesamten Lieferkette.
Fachlicher Mehrwert
Bisher konnten Anmerkungen zu einer Artikelposition nur über den Umweg einer Abweichung hinterlegt werden — mit Pflichtangaben zu Abweichungsgrund, Menge und Einheit, bevor ein Freitextfeld verfügbar war. Mit Artikelnotizen entfällt dieser Umweg: Notizen können direkt an jeder Artikelposition hinterlegt werden, unabhängig davon, ob eine Abweichung vorliegt.
- Warenausgang (WA): Kann vor dem Checkout Notizen an Artikelpositionen hinterlegen, z.B. Hinweise zu MHD, Verpackung oder Chargenqualität. Diese Notizen sind für den Wareneingang sofort nach Versand lesbar.
- Wareneingang (WE): Kann nach dem Checkout und vor dem Checkin eigene Notizen erfassen, z.B. Anmerkungen zu Qualitätsprüfungen oder Lieferzustand. Der WE entscheidet pro Notiz, ob diese für den WA sichtbar (freigegeben) oder nur intern sichtbar sein soll.
- Unveränderbarkeit: Notizen können nach dem Anlegen nicht mehr geändert oder gelöscht werden. Mehrere Notizen pro Artikel sind möglich — die chronologische Abfolge bildet eine nachvollziehbare Historie.
- Merged-PDF: Freigegebene Notizen werden automatisch auf einer separaten Seite im zusammengefassten PDF aufgenommen (Position, Artikelnummer Empfänger, Bestellnummer, Beschreibung, Notiztext). Nicht freigegebene WE-Notizen erscheinen nur im PDF des WE.
Information für Frontend-Nutzer
Die Notizfunktion ist im Checkin-Bereich des Wareneingangs (Artikelansicht) integriert. Dort steht ein Notizdialog je Artikelposition zur Verfügung:
- Notiz erstellen: Freitext bis max. 1.024 Zeichen. Beim Anlegen kann über einen Schieberegler festgelegt werden, ob die Notiz für den Warenausgang sichtbar sein soll (Standard: freigegeben).
- Notizen lesen: Alle eigenen Notizen sowie freigegebene Notizen der Gegenseite werden chronologisch sortiert (neueste zuerst) angezeigt.
- Nachträgliche Freigabe: Wurde eine Notiz zunächst als „nicht sichtbar" angelegt, kann sie jederzeit bis zum Checkin über einen Button freigegeben werden. Die Freigabe kann nicht zurückgenommen werden.
- Keine Bearbeitung/Löschung: Angelegte Notizen können weder geändert noch gelöscht werden.
Hinweis für den Warenausgang: Es gibt derzeit keine WA-Frontend-Ansicht für Artikelnotizen. Das Anlegen von Notizen durch den WA ist ausschließlich über die API möglich.
Information für API-Nutzer
Voraussetzungen (Feature-Flags):
| Aktion | WA (Consignor) | WE (Consignee) |
|---|---|---|
| Notizen lesen | consignorArticlesRead |
consigneeArticlesRead |
| Notizen anlegen | consignorArticlesEditing |
consigneeArticlesEditing |
Endpunkte (v3):
| Methode | Endpunkt | Beschreibung |
|---|---|---|
| POST | /v3/organization-sites/{siteKey}/consignor/delivery-notes/{dnKey}/articles/{articleKey}/notes |
Erstellt eine Notiz zu einer Artikelposition durch den Warenausgang (Consignor). Nur möglich, solange sich die Mappe im Status open befindet. |
| POST | /v3/organization-sites/{siteKey}/consignee/delivery-notes/{dnKey}/articles/{articleKey}/notes |
Erstellt eine Notiz zu einer Artikelposition durch den Warenempfänger (Consignee). Nur möglich, solange sich die Mappe im Status sent befindet. |
| GET | /v3/organization-sites/{siteKey}/delivery-notes/{dnKey}/articles/{articleKey}/notes |
Ruft alle für den Benutzer sichtbaren Notizen einer Artikelposition ab. |
| POST | /v3/organization-sites/{siteKey}/consignee/delivery-notes/{dnKey}/articles/{articleKey}/notes/{articleNoteKey}/visible |
Gibt eine bisher nicht freigegebene Notiz des Warenempfängers für den Warenausgang frei (One-Way-Freigabe). |
Request-Body WA-Notiz (ConsignorArticleNote): { "noteText": "string (1–1024 Zeichen)" } WA-Notizen sind immer für den WE sichtbar (kein Sichtbarkeitsfeld).
Request-Body WE-Notiz (ArticleNote): { "noteText": "string (1–1024 Zeichen)", "noteVisibleForOthers": true } noteVisibleForOthers steuert die Sichtbarkeit für den WA. Empfohlener Default: true.
Response-Objekt (ArticleNoteResponse):
| Feld | Typ | Beschreibung |
|---|---|---|
_key |
string |
Eindeutiger Schlüssel der Notiz. |
noteText |
string |
Inhalt der Notiz. |
authorOrganizationSiteKey |
string |
Eindeutiger Standort-Schlüssel des Autors. |
authorOrganizationSiteName |
string |
Anzeigename des Standorts des Autors. |
dateNoteCreated |
timestamp |
Zeitpunkt der Erstellung der Notiz. |
noteVisibleForOthers |
boolean |
Kennzeichnet, ob die Notiz für andere Beteiligte sichtbar ist. |
Sichtbarkeitsregeln:
- WA-Notizen sind immer für beide Seiten sichtbar
- WE-Notizen mit noteVisibleForOthers: false sind nur für den WE des eigenen Unternehmens sichtbar
- Die Freigabe (/visible-Endpunkt) ist eine Einweg-Operation — Rücknahme ist nicht möglich
Hinweise für Entwickler
Notiz anlegen (WA): POST /v3/organization-sites/{siteKey}/consignor/delivery-notes/{dnKey}/articles/{articleKey}/notes Body: { "noteText": "MHD-Hinweis: 15.09.2026" } Nur möglich wenn Mappe im Status open. Antwort: 204 No Content. Bei falschem Status: 409.
Notiz anlegen (WE): POST /v3/organization-sites/{siteKey}/consignee/delivery-notes/{dnKey}/articles/{articleKey}/notes Body: { "noteText": "Ware einwandfrei", "noteVisibleForOthers": true Nur möglich wenn Mappe im Status sent. Antwort: 204 No Content.
Notiz anlegen (WE): POST /v3/organization-sites/{siteKey}/consignee/delivery-notes/{dnKey}/articles/{articleKey}/notes Body: { "noteText": "Ware einwandfrei", "noteVisibleForOthers": true } Liefert ein Array, sortiert nach dateNoteCreated absteigend. Die API filtert automatisch: eigene Notizen sind immer sichtbar, fremde nur wenn noteVisibleForOthers: true.
Notiz freigeben: GET /v3/organization-sites/{siteKey}/delivery-notes/{dnKey}/articles/{articleKey}/notes Antwort: 204. Fehler: 409 wenn bereits freigegeben, 404 wenn Notiz nicht gefunden oder nicht eigene.
Merged-PDF: Notizen werden automatisch in das zusammengefasste PDF aufgenommen. Die Sichtbarkeitsregeln gelten auch dort — nicht freigegebene WE-Notizen erscheinen nur im PDF des WE.