Geeignet für:
- Geschäftskunden der Deutsche Post AG
- Elektronisches Auftragsmanagement der kaufmännischen und logistischen Prozesse der Deutsche Post AG (Brief)
Sie befinden sich auf der Dokumentations-Seite der Post DE Auftragsmanagement (AM) API der Deutsche Post AG. In diesem und den folgenden Kapiteln bieten wir Ihnen:
- Einen Überblick der fachlichen Funktionen, die die API abdeckt
- Die technische Dokumentation der API als Zusammenstellung eines Entwicklerhandbuchs, das Themen zu Verbindungen, Authentifizierung, API Spezifikationen und Beispiele enthält.
- Weiterhin finden Sie Themen zum Support unter Weitere Informationen
- Am Ende befinden sich die Release Notes
Umfang
Mit dem elektronischen Auftragsmanagement wird der kaufmännische und logistische Prozess der Deutschen Post informationstechnisch begleitet. Der Kunde profitiert in mehrerer Hinsicht von diesen Möglichkeiten:
- Einfacher Informationsaustausch zwischen den Auftragsbeteiligten.
- Schlanker Vorankündigungs- und Einlieferungsprozess.
- Über ein Internet-Portal (AM.portal) bietet die Deutsche Post dem Kunden die Möglichkeit, seine Einlieferungen von der Vorankündigung über die Einlieferung bis zur erfolgten postalischen Prüfung bei der Sendungsannahme zu verfolgen.
- Für vorangekündigte Aufträge kann die Rechnungsstellung auf elektronischem Weg erfolgen.
Benutzung der API
Mit AM können alle Produktfamilien des Unternehmensbereichs Post und alle Freimachungsarten abgebildet werden, d.h. für:
- DIALOGPOST
- Briefsendungen
- POSTAKTUELL
- Postwurf Spezial
- Produkte der Presse Distribution
- Produkte international
AM.exchange
AM.exchange ist das B2B-Protokoll zum elektronischen Datenaustausch zwischen den Kunden, Systempartnern und der Deutschen Post.
AM.portal
AM.portal ist ein Internet-Portal, das Kunden und Systempartnern, die das AM.exchange-Protokoll nutzen, Informationen zu Aufträgen und zum Auftragsstatus zur Verfügung stellt.
Abbildung: Überblick Datenkommunikation zwischen Kunde und Deutsche Post
Kurzübersicht AM.exchange-Protokoll
Das AM.exchange-Protokoll bietet eine Sammlung von Nachrichten, sog. Requests und Responses, zum Austausch von Informationen mit dem Auftragsmanagement-System der Deutschen Post AG. Der entsprechende Service OrderManagement dient dem Austausch von auftragsbezogenen Informationen.
Schnittstelle Ordermanagement
Die Schnittstelle Ordermanagement dient dem Austausch von auftragsbezogenen Informationen. Den Kern dieser Nachrichtensammlung bildet die Nachricht zur Auftragsanlage: Serviceoperation createOrder. Darüberhinaus stehen noch weitere Serviceoperationen zur Verfügung: changeOrder (Änderung eines Auftrags), cancelOrder (Storno eines Auftrags), seekOrder (Suche nach Aufträgen), getOrder (Laden eines Auftrags) und seekOrderMessage (Suche nach Systemmeldungen).
Die folgende Informationssammlung gibt IT-Projektleitern und Softwareentwicklern alle wichtigen Informationen zum Thema AM.exchange-Protokoll der Deutschen Post an die Hand. Es beantwortet unter anderem die folgenden Fragen:
- Welche Möglichkeiten bietet das AM.exchange-Protokoll?
- Wie sehen die Prozesse im Detail aus?
- Welche Daten werden ausgetauscht?
- Welche technischen Übertragungskanäle können genutzt werden?
- Welche Produkte und Freimachungsarten werden unterstützt?
- Welche Möglichkeiten zum Testen stehen Ihnen zur Verfügung?
- Wer ist Ansprechpartner bei Fragen zu AM.exchange?
Weitere Details haben wir Ihnen als Download unter dem Punkt Entwicklerhandbuch zusammengestellt.
Bitte beachten Sie die folgenden Hinweise zu den aktuell gültigen Ordermanagement Versionen:
- Das Entwicklerhandbuch in der Version 5.3.1 enthält die zum 01.01.2025 geänderten Vorgaben im Hinblick auf die Teilleistung Brief sowie Rabattänderungen bei Dialogpost und gilt somit für Entwickler, die diese Vorgaben implementieren möchten.
- Das Entwicklerhandbuch in der Version 5.2.3 enthält die noch bis 31.12.2024 gültigen Vorgaben im Hinblick auf die Teilleistung und gilt somit für Entwickler, die noch 2024 die Teilleistung implementieren und produktiv nutzen möchten.
Die Deutsche Post bietet Ihren Kunden zwei Datenübertragungskanäle an. Jeder Kunde kann abhängig von den ihm zur Verfügung stehenden technischen Möglichkeiten und des Anwendungsfalls entscheiden, welche der folgenden Optionen er verwenden möchte:
SOAP-Webservice
Die Kommunikation mit dem Webservice AM.Exchange mit Ordermanagement läuft dabei ausschließlich auf Basis von SOAP über https. Damit ist eine sichere, verschlüsselte Übertragung der Daten zwischen Kunden und der Deutschen Post gewährleistet. Der Webservice ermöglicht eine synchrone Datenkommunikation zwischen Kunden und der Deutschen Post, das heißt, die Verbindung bleibt bestehen, bis die Anfrage beantwortet wurde und der Aufrufer kann anschließend umgehend die Antwort verarbeiten.
Secure File Transfer Protocol (SFTP)
Die Nutzung von SFTP ist aus Sicht des Benutzers der von FTP sehr ähnlich. Ein wesentlicher Unterschied ist jedoch, dass beim SFTP Protokoll die Daten bei der Datenübertragung durch Nutzung des SSH-Protokolls verschlüsselt werden. Bei dieser Übertragungsart erfolgt die Kommunikation asynchron, d. h. der Kunde legt auf dem ihm zugewiesenen SFTP Account eine Datei mit der Response ab und erhält, sobald die Verarbeitung des Requests abgeschlossen ist, im gleichen Account eine Datei mit der Response bereitgestellt.
Sie haben Fragen zu den aufgeführten Schnittstellen? Sie finden unseren Kontaktmöglichkeiten unter folgender Adresse: https://www.deutschepost.de/de/e/elektronisches_auftragsmanagement/kontakt.html
Generell
Dieser Anhang listet kurz die wesentlichen Änderungen für die verschiedenen Handbuchversionen auf.
Bitte beachten Sie die folgenden Hinweise zu den aktuell gültigen Ordermanagement Versionen:
- Das Entwicklerhandbuch in der Version 5.3 enthält die zum 01.01.2025 geänderten Vorgaben im Hinblick auf die Teilleistung und gilt somit für Entwickler, die diese Vorgaben implementieren möchten.
- Das Entwicklerhandbuch in der Version 5.2.3 enthält die noch bis 31.12.2024 gültigen Vorgaben im Hinblick auf die Teilleistung und gilt somit für Entwickler, die noch 2024 die Teilleistung implementieren und produktiv nutzen möchten.
Änderungen in der Handbuchversion 5.3.1
Anhang G:
Wegfall Beispiel 045,
Änderung Beispiele 23, 32, 33, 35, 36, 42,
teilweiser Wegfall Vorsortierungsrabatte
Änderung Beispiel 006: entfall Differenzierung
AM.exchange Produkttabellen: Produkttabelle aktualisiert
Änderungen in der Handbuchversion 5.3
Kapitel 5.4: Anpassung an neue Teilleistungsvorgaben ab 01.01.2025
Kapitel 8.13: Absatz Mehrfachversand entfernt
Kapitel 8.7: Anpassung an neue Teilleistungsvorgaben ab 01.01.2025
Kapitel 8.7.1 entfernt
Anhang D: Aktualisierung der Schemadokumentation im Hinblick auf die neuen Teilleistungsvorgaben ab 01.01.2025
Anhang E: Aktualisierung der Schemadokumentation im Hinblick auf die neuen Teilleistungsvorgaben ab 01.01.2025
Anhang G: Beispiel 016 erweitert um Bsp_016_06_ab_01012025_createOrder_Request: ZA - Anpassung an neue Teilleistungsvorgaben ab 01.01.2025;
Anhang H :
Aktualisierung der Code – Tabelle: Anpassung an neue Teilleistungsvorgaben ab 01.01.2025
AM.exchange Produkttabellen: Produkttabelle aktualisiert
Änderungen in der Handbuchversion 5.2.3
Diverse textuelle Anpassungen im ganzen Dokument AM.Portal -> AM.GKP;
Kapitel 8.18: das Kapitel wurde entfernt;
das Kapitel gezielte Auftragsanzeige im AM.portal wurde komplett herausgenommen.
Das bisherige Kapitel 9.2 Die Bedeutung der Service-Versionen erhält die Bezeichnung 9.1;
Anhang G – Wegfall Beispiele 004, 101, 127, 143, 144
Änderung Beispiele 006, 009, 011, 030, 122, 123, 128, 145
sowie alle Presse - Beispiele;
Anhang H :
Produktionsstätten – Tabelle aktualisiert;
AM.exchange Produkttabellen: Produkttabelle aktualisiert;
Anhang I – aktualisierte Meldungstexte hinzugefügt;
Änderungen in der Handbuchversion 5.2.2
Produktionsstätten – Tabelle aktualisiert;
26.Jan.2024
Produktionsstätten – Tabelle aktualisiert;
AM.exchange Produkttabellen: Produkttabelle aktualisiert
02.Okt.2023
Kapitel 8.11: Wegfall Frankierservice PWZ
Abbildungen 16, 18, 23 aktualisiert
Anhang G – Beispiele 023, 031, 042, 052 und 078: Änderung der Freimachung von AS /FS
PWZ auf FV (Ab 01.01.2024 AS und PWZ nicht mehr gültig);
Beispiel 117 entfernt
Anhanh H :
Allgemeine Code – Tabelle aktualisiert;
Produktionsstätten – Tabelle aktualisiert;
AM.exchange Produkttabellen: Produkttabelle aktualisiert
Die PDF -Form der Produkttabellen mit mehreren Seiten finden Sie im Entwicklerhandbuch unter:
Codetables\AM.exchange Produkte National_mehrseitig.pdf
Codetables\AM.exchange Produkte International_mehrseitig.pdf
Anhang I – aktualisierte Meldungstexte hinzugefügt
Anhang J – das Dokument Spezifikation Matrixcode wurde aktualisiert
Änderungen in der Handbuchversion 5.2.1
Anhang D – Präzisierung Schemabeschreibung createOrder Request, changeorder Request und getOrder Response: Sendungsnummern im Hinblick auf Teilleistung
Anhang E - Präzisierung Schemabeschreibung createOrder Request, changeorder Request und getOrder Response: Sendungsnummern im Hinblick auf Teilleistung
Anhang G – Dialogpost Beispiele hinsichtlich der Mindestmenge angepaßt, Beispiel 053: Ergänzung diverser Suchmuster um Orderheader (um geplante Aufträge zu finden), Beispiel 044 korrigiert, Beispiele 126, 131 und 132 entfernt
Anhang H - Produktionsstätten aktualisiert
AM.exchange Produkttabellen: Produkttabelle aktualisiert
Die PDF -Form der Produkttabellen mit mehreren Seiten finden Sie hier:
Codetables\AM.exchange Produkte National_mehrseitig.pdf
Codetables\AM.exchange Produkte International_mehrseitig.pdf
Änderungen in der Handbuchversion 5.2
Kapitel 2.1 Numbermanagement Webservice entfernt
Kapitel 8.3 Dialogpost Termin entfernt
Kapitel 8.18 elektronische Zollvorankündigung (Warenpost International) entfernt
Anhang D – Fehlerkorrektur Schemabeschreibung Packaging createOrder Request, changeorder Request und getOrder Response
Anhang E - Fehlerkorrektur Schemabeschreibung Packaging createOrder Request, changeorder Request und getOrder Response
Anhang G – Beispiel 016 (neue Teilleistungsstruktur) geändert: Qty in den lokalen Referenzen entfernt, Beispiele 140, 142, 146, 147 und 148 entfert, neues Beispiel 044 (Dialogpost mit Angabe des GSA Sortierprogramms) hinzugefügt
Anhang H - AM.exchange Produkttabellen: Produkttabelle aktualisiert
Die PDF -Form der Produkttabellen mit mehreren Seiten finden Sie hier:
Codetables\AM.exchange Produkte National_mehrseitig.pdf
Codetables\AM.exchange Produkte International_mehrseitig.pdf
Produktionsstätten aktualisiert
Anhang I – Meldungstexte aktualisiert
Änderungen in der Handbuchversion 5.1
Kapitel 5.4 Verweise auf die Sendungsnummern, weitere Rabattpositionen
Kapitel 8.7 Abbildung der FrankierID’s der Einlieferungsaufträge im Zusatzauftrag
Anhang D - Erweiterung der Schema – Beschreibung (Shipment – Sektion) im Hinblick auf die Erweiterung der Struktur der Teilleistungsaufträge
Anhang E - Erweiterung der Schema -Beschreibung (Shipment – Sektion) im Hinblick auf die Erweiterung der Struktur der Teilleistungsaufträge
Anhang G – neue Beispiele: 10 Kennzeichnung der Laufzeitoptionen und 016 Erweiterung der Teilleistungsstruktur
Anhang H - Codetables: Bezeichnung der GSA Sortierprogramme
AM.exchange Produkttabellen: neue Produkttabelle mit weiteren Rabatt – Produktnummern für Teilleistung (gültig ab 01.01.2023)
Die PDF -Form der Produkttabellen mit mehreren Seiten finden Sie hier:
Codetables\AM.exchange Produkte National_mehrseitig.pdf
Codetables\AM.exchange Produkte International_mehrseitig.pdf
Änderungen in der Handbuchversion 5.0.2
Kapitel 8.18 Ländernachweis entfernt
Anhang G – Korrektur Beispiel 99 und Erweiterung Beispiel 77 (Zusatzauftrag Abholung),
Anpassung der Abholproduktnummern in den entsprechenden Dialogpost - Beispielen
Anhang H – Codetables
AM.exchange Produkttabellen: neue Produkttabelle
Änderungen in der Handbuchversion 5.0.1
Anhang H – Codetables
AM.exchange Produkttabellen: weitere Produkttabellen, gültig ab 01.01.2022
Produktionsstätten
Änderungen in der Handbuchversion 5.0
Änderung der Ordermanagement Version von 4.4 auf 5.0
Absatz 2.7 und 8.16 hinzugefügt; 4.6 Änderugen zu OM 5.0 eingepflegt.
Anhang C - Neue Schemadateien in der Version 5.0 : neues Attribut bid im Versandplan, neue Attribute serNum, transport und sortProc im Packaging, Erweiterung der Serviceoperation seekOrder Request um die Suche nach Verfahren/Teilnahme mit/ohne Entgeltabrechnungsnummer
Anhang D – Neue Schemdokumentation als PDF
Anhang E – Neue Schemadokumentation als HTML
Anhang F – Neue WSDL Dateien in der Version 5.0
Anhang G – Anpassung aller Pressebeispiele im Hinblick auf Änderungen zum 01.01.2021, neues Beispiel 118, Erweiterung des Beispiels 053
Anhang H - AM.exchange Produkttabellen
- Siehe Änderungshistorie AM.exchange Produkte.pdf
Anhang I – aktualisierte Meldungstexte hinzugefügt
Anhnag J – neu hinzugefügt: Spezifikation Datamatrixcode für Bundaufschriftzettel Presse
Änderungen in der Handbuchversion 4.4.11
Kapitel 1.5 Änderung des Downloadlinks des Entwicklerhandbuchs
Anhang G – Neues Beispiel 105
Anhang H - AM.exchange Produkttabellen
Siehe Änderungshistorie AM.exchange Produkte.pdf
Änderungen in der Handbuchversion 4.4.10
Kapitel 6.3 eigenständige Schemaprüfung durch den Entwickler: Möglichkiet der Nutzung des Webcheckers
Anhang B – Versionsüberblick
Anhang D – XML-Schema Dokumentation (PDF)
Anhang E – XML- Schema Dokumentaion (HTML)
Anhang G – Neue Beispiele 007, 034 und 148, Wegfall Beispiel 105
Anhang H - AM.exchange Produkttabellen und Produktionsstätten
Siehe Änderungshistorie AM.exchange Produkte.pdf
Erweiterung um Kontaktdaten der Depots
Anhang J – Ansprechpartner Deutsche Post
AM.exchange- Handbuch für Software Entwickler Version 5.2.1 Seite 104 von 109
Änderung der Kontaktdaten und Servicezeiten
Anhang K – Änderungshistorie
Bereinigung: Entfernen der Historie < OM Schema 4.4
Änderungen in der Handbuchversion 4.4.9
Kapitel 6.3 eigenständige Schemaprüfung durch den Entwickler
Kapitel 8.18 Erweiterung der Beschreibung: Zusammenfassung von Sendungen zum (idealerweise) einen Auftrag
Anhang B – Versionsüberblick
Anhang D – XML-Schema Dokumentation (PDF)
Anhang E – XML- Schema Dokumentaion (HTML)
Anhang G – Änderung Beispiel 006, Wegfall Beispiele 007, 010, 057 und 124
Anhang H - AM.exchange Produkttabellen
Siehe Änderungshistorie AM.exchange Produkte.pdf
Änderungen in der Handbuchversion 4.4.8.1
Kapitel 8.18 Erweiterung der Beschreibung: Webservice nicht mehr verpflichtend
Anhang G Änderung Beispiele 142 und 147: Webservice nicht mehr verpflichtend
Änderungen in der Handbuchversion 4.4.8
Kapitel 2.1 Übertragungskanäle: Beschreibung Number-Management
Kapitel 8.18 Erweiterung der Beschreibung
Anhang B – Versionsüberblick
Anhang C – XML Schema Numbermanagement
Anhang D – XML-Schema Dokumentation (PDF)
Anhang E – XML- Schema Dokumentaion (HTML)
Anhang F – WSDL /WADL Dateien: WADL Dateien für Numbermanagement
Anhang G – Neue Beispieldateien für Abruf der Sendungsnummernkreise für Warenpost International (S10 IDS) und Übergabe der Sendungsnummer (S10 ID) direkt im createOrder Request
Anhang H - AM.exchange Produkttabellen
Siehe Änderungshistorie AM.exchange Produkte.pdf
Anhang I - Fehlercodes und Fehlermeldungen
Änderungen in der Handbuchversion 4.4.7
Kapitel 2.1 Übertragungskanäle: Wegfall Connect Direct und X400
Kapitel 7 Wegfall Beschreibung Connect Direct und X400
Anhang B – Versionsüberblick
Anhang D – XML-Schema Dokumentation (PDF)
Anhang E – XML- Schema Dokumentaion (HTML)
Anhang F – WSDL Dateien: Überarbeitete Version der WSDL Dateien
Anhang G – Neue Beispieldateien für Voranmeldung Digitale Kopie (gültig ab 01.01.2019), neues Beispiel mit der Rolle Vertragspartner Premiumadress
(gültig ab 01.01.2019), Wegfall Beispiel 019
Anhang H - AM.exchange Produkttabellen
Siehe Änderungshistorie AM.exchange Produkte.pdf
Anhang I - Fehlercodes und Fehlermeldungen
Changes in manual version 4.4.6.1
Kapitel 8.18 zusätzlicher Hinweis zur elektronischen Zollvorankündigung
Anhang B – Versionsüberblick
Anhang H – Hinweis zum Beispiel 142
Anhang I AM.exchange Produkttabellen
• Siehe Änderungshistorie AM.exchange Produkte.pdf
Änderungen in der Handbuchversion 4.4.6
Kapitel 8.18 Elektronische Zollvorankündigung
Kapitel 8.7.1 Anmeldung Infrastrukturrabatt
Kapitel 8.8 Ergänzung um Hinweis auf Kapitel 8.7.1
Anhang B – Versionsüberblick
Anhänge D – E Dokumentation des XML Schemas
Anhang H – Beispieldateien: Beispiel 142 für die elektronische Zollvorankündigung und
Beispiele 004 und 030 für die Anmeldung Infrastrukturrabatt
Anhang I - AM.exchange Produkttabellen
• Siehe Änderungshistorie AM.exchange Produkte.pdf
Anhang I - AM.exchange Code-Tabelle
Änderungen in der Handbuchversion4.4.5
Kapitel 8.4 Kennzeichnung und Kategorisierung der Dialogpost Einlieferungen
Kapitel 8.10 Postwurf Spezial (Kennzeichnung der Postwurf Spezial Einlieferungen)
Anhang B – Versionsüberblick
Anhänge D – E Dokumentation des XML Schemas
Anhang H – Beispieldateien: neues Beispiel für Postwurf Spezial (Darstellung SACHETS),
Neues Beispiels für Dialogpost (Darstellung SACHETS)
Änderung von Beispielen für Dialogpost (Kategorisierung der Dialogpost Einlieferungen)
Anhang I - AM.exchange Produkttabellen
• Siehe Änderungshistorie AM.exchange Produkte.pdf
Anhang I - AM.exchange Code-Tabelle
Änderungen in der Handbuchversion 4.4.4
Kapitel 8.9 Postwurf Spezial
Anhang B – Versionsüberblick
Anhänge D – E Dokumentation des XML Schemas
Anhang H – Beispieldateien: neue Beispiele für Postwurf Spezial,
Beispiele mit ZL Freimachung wurden entfernt
Anhang I - AM.exchange Produkttabellen
• Siehe Änderungshistorie AM.exchange Produkte.pdf
Anhang I - AM.exchange Code-Tabelle
Änderungen in der Handbuchversion 4.4.3
Anhang B – Versionsüberblick
Anhänge D – E Dokumentation des XML Schemas
Anhang H – Beispieldateien
Anhang I - AM.exchange Produkttabellen
• Siehe Änderungshistorie AM.exchange Produkte.pdf
Anhang I - AM.exchange Code-Tabelle
Änderungen in der Handbuchversion 4.4.2.1
Die nachfolgenden Datenblöcke wurden geändert:
Kapitel 8.3 Verwendung von Zusatzleistungen in Verbindung mit DIALOGPOST - Einlieferungen
Anhang B – Versionsüberblick
Anhang H – Beispieldateien
AM.exchange Produkttabellen
• Siehe Änderungshistorie AM.exchange Produkte.pdf
Änderungen in der Handbuchversion 4.4.2
Das Handbuch wurde im Hinblick auf die Weiterentwicklung der neuen Dialogmarketing-produkte ab 01.07.2016 angepasst.
Die nachfolgenden Datenblöcke wurden hierzu ergänzt.
Kapitel 8.3 Verwendung von Zusatzleistungen in Verbindung mit DIALOGPOST - Einlieferungen
Anhang B – Versionsüberblick
Anhänge D – E Dokumentation des XML Schemas
Anhang H – Beispieldateien
Anhang I – AM.exchange Codetables
Anhang J - Meldungstexte
AM.exchange Produkttabellen
• Siehe Änderungshistorie AM.exchange Produkte.pd
Änderungen in der Handbuchversion 4.4.1
Das Handbuch wurde komplett überarbeitet aufgrund der Einführung neuer Dialogmarketingprodukte ab 01.01.2016.
Die nachfolgenden Datenblöcke wurden hierzu ergänzt.
Anhang B – Versionsüberblick
Anhänge C – E Dokumentation des XML Schemas
Anhang H – Beispieldateien
Anhang J - Meldungstexte
AM.exchange Produkttabellen
• Siehe Änderungshistorie AM.exchange Produkte.pdf
Änderungen in der Handbuchversion 4.4
Diese Erweiterung ermöglicht Kunden, die von der DP DHL Group angebotene neue Dienstleistung „Ländernachweis“ zur Nachverfolgung ihrer nationalen und internationaler Sendungen zu nutzen. Zur Anlage bzw. Änderung von Kundenaufträgen wird die Funktionalität von „AM.exchange“ erweitert um die notwendigen Daten für die Aktivierung und Sendungsverfolgung für Sendungen mit RFID-Transponder an das AM System zu übermitteln.
Die nachfolgenden Datenblöcke wurden hierzu ergänzt.
Trackingdaten:
- Sendungs-ID
- Abgangsland
- Technische oder Kundenkennung
- Kundeneigene Sendungskennung
Kontaktdaten:
- Daten zum Sendungsempfänger
Zolldaten:
- Wareninformation
- Inhaltsliste
Anhang C – Versionsüberblick
Anhang I – Beispieldateien
AM.exchange Produkttabellen