View source for HVS32 REST Schnittstelle (Automatik-Polling)

[[en:HVS32_REST_Interface_(Polling)]]

<!-- ------------------------------------------------------------------------------- Voraussetzungen ------------------------------------------------------------------------------- -->
= Voraussetzungen =
{| class="wikitable"
|-
| DGS-Version || 3.8.23 oder höher
|-
| DGS-Plugins || HVS32Client, REST Server
|}
<!-- ------------------------------------------------------------------------------- ENDE Voraussetzungen ------------------------------------------------------------------------------- -->

= OpenAPI / Swagger =
[https://interface.heidler-strichcode.de?version=v1 RESTv1]
<!-- ------------------------------------------------------------------------------- Funktionsbeschreibung ------------------------------------------------------------------------------- -->

= Funktionsbeschreibung =
Bei der REST-Schnittstelle stellt der DataGatewayServer (DGS) einen REST Server mit folgenden [[#Übersicht der Funktionen|Funktionen]] zur Verfügung.
Dieser ist in der Standardkonfiguration unter '''http://<Servername>:<Port>/hvs32rest''' erreichbar. Dabei wird der Port 8081 verwendet, welcher bei Bedarf geändert werden kann.
<!-- ------------------------------------------------------------------------------- ENDE Funktionsbeschreibung ------------------------------------------------------------------------------- -->
<!-- ------------------------------------------------------------------------------- DATENTYPEN ------------------------------------------------------------------------------- -->

= Datentypen =
'''Integer''' - Zahl mit ausschließlich numerischen Zeichen (0-9).<br>
'''Decimal''' - Zahl mit Nachkommastellen (Dezimaltrennzeichen mit Punkt, anstelle von Komma)<br>
'''Calendar''' - Datum. Monat ist dabei 0-basierend (0 = Januar, 11 = Dezember)<br>
'''String''' - Beliebige Zeichen aus dem Zeichensatz ISO-8859-1. Maximale Länge darf nicht überschritten werden.<br>
'''Binary''' - Base64 kodierte Binärdaten<br>
'''Sequence''' - Eine Liste von Elementen<br>
'''Map''' - Key/Value Map<br>
<!-- ------------------------------------------------------------------------------- ENDE DATENTYPEN ------------------------------------------------------------------------------- -->
<!-- ------------------------------------------------------------------------------- ÜBERSICHT spezial Datentypen ------------------------------------------------------------------------------- -->

= Zusätzliche Datentypen =
Ein spezial Datentyp kann innerhalb der Anfrage / Rückmeldung einer [[#Übersicht der Funktionen|Funktion]] genutzt werden.
<!-- ------------------------------------------------------------------------------- artikelDaten ------------------------------------------------------------------------------- -->
== artikelDaten ==
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">Artikel-Daten</div>
<div class="mw-collapsible-content">
{| class="wikitable sortable"
|-
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
|-
| anzahlBuegel || [[#Datentypen|Integer]] || - || - || Nur für Hängeversand: Anzahl der Bügel auf welche die Artikelgruppe aufgeteilt ist
|-
| anzahlPosEtiketten || [[#Datentypen|Integer]] || - || - || Anzahl Artikeletiketten, welche gedruckt werden sollen
|-
| artikelBTNNr || [[#Datentypen|String]] || 25 || - || BTN Nummer / Zolltarifnummer
|-
| artikelEAN || [[#Datentypen|String]] || 20 || - || EAN Nummer
|-
| artikelEinheit || [[#Datentypen|String]] || 10 || - || Einheit der Artikelmenge
|-
| artikelGewicht || [[#Datentypen|Decimal]] || 9 || 3 || Gewicht des Arikels
|-
| artikelGruppe || [[#Datentypen|String]] || 50 || - || Artikelgruppe
|-
| artikelMenge || [[#Datentypen|Decimal]] || 9 || 3 || Menge des Artikels
|-
| artikelServices || [[#Datentypen|String]] || 100 || - || Pipe getrennte Services für diesen Artikel
|-
| artikelSollMenge || [[#Datentypen|Decimal]] || 9 || 3 || -
|-
| artikelText1 || [[#Datentypen|String]] || 100 || - || Artikelbezeichnung
|-
| artikelText2 || [[#Datentypen|String]] || 100 || - || Artikelbezeichnung
|-
| artikelText3 || [[#Datentypen|String]] || 100 || - || Artikelbezeichnung
|-
| artikelText4 || [[#Datentypen|String]] || 100 || - || Artikelbezeichnung
|-
| artikelVolumen || [[#Datentypen|Decimal]] || 9 || 3 || Volumen des Artikels
|-
| artikelWaehrung || [[#Datentypen|String]] || 3 || - || Währung in welcher der Wert des Artikels angegeben wird
|-
| artikelWert || [[#Datentypen|Decimal]] || 18 || 2 || Wert des Artikels
|-
| chargeFlag || [[#Datentypen|String]] || 1 || - || 
|-
| kundenArtikelNr || [[#Datentypen|String]] || 50 || - || Artikelnummer
|-
| kundenBestellNr || [[#Datentypen|String]] || 50 || - || Bestellnummer
|-
| posAuftragNr || [[#Datentypen|String]] || 50 || - || Auftragsnummer
|-
| posLieferNr || [[#Datentypen|String]] || 40 || - || Lieferscheinnummer
|-
| positionNr || [[#Datentypen|String]] || 50 || - || Laufende Nummer innerhalb des Packstücks
|-
| serienNr || [[#Datentypen|String]] || 30 || - || Seriennummer
|-
| ursprungLand || [[#Datentypen|String]] || 2 || - || Ursprungsland des Artikels
|-
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
|}
</div></div>
<!-- ------------------------------------------------------------------------------- ENDE artikelDaten ------------------------------------------------------------------------------- -->
<!-- ------------------------------------------------------------------------------- gefahrgut ------------------------------------------------------------------------------- -->

== gefahrgut ==
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">Gefahrgut-Daten</div>
<div class="mw-collapsible-content">
{| class="wikitable sortable"
|-
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
|-
| '''gefahrgutBefoerdKat''' ||[[#Datentypen|Integer]] || 1 || - || Beförderungskategorie, Pflicht (siehe ADR-Tabelle Spalte (15)), kann 0-4 sein. Achtung! Muss unbedingt korrekt sein.
|-
| gefahrgutBegrenzteMenge || [[#Datentypen|String]] || 1 || - || T wenn der Stoff mit Status LQ / Begrenzte Menge nach ADR 3.4 verschickt wird, ansonsten F, Pflicht
|-
| '''gefahrgutBezeichnung''' ||[[#Datentypen|String]] || 110 || - || Pflicht (siehe ADR-Tabelle Spalte (2))
|-
| gefahrgutBuchst640 || [[#Datentypen|String]] || 1 || - || Buchstabe für Sondervorschrift 640, bedingte Pflicht bei Stoffen, bei denen die Sondervorschrift 640 gilt (siehe ADR-Tabelle Spalte (6))
|-
| gefahrgutFFCode || [[#Datentypen|String]] || <!-- MAXLÄNGE --> || <!-- DEZ --> || <!-- BELEGUNG -->
|-
| gefahrgutFaktor || [[#Datentypen|Integer]] || 3 || - || Bewertungsfaktor für Punktesummation auf dem Beförderungspapier,  (kann 0, 1, 3, 50 oder 999 sein), eigentlich Pflicht, kann aber eindeutig aus der Beförderungskategorie geschlossen werden, daher muss es nicht unbedingt belegt sein
|-
| gefahrgutFreigestMenge || [[#Datentypen|String]] || 1 || - || T wenn der Stoff mit Status EQ / Excepted Quantities nach ADR 3.5 verschickt wird, ansonsten F, Pflicht
|-
| gefahrgutID || [[#Datentypen|String]] || 8 || - || Eindeutige Suchnummer für Gefahrgut-Stammdaten
|-
| gefahrgutKCode || [[#Datentypen|String]] || 10 || - || Klassifizierungscode, Pflicht (siehe ADR-Tabelle Spalte (3b))
|-
| '''gefahrgutKlasse''' ||[[#Datentypen|String]] || 100 || - || Pflicht (siehe ADR-Tabelle Spalte (3a))
|-
| '''gefahrgutMenge''' ||[[#Datentypen|Decimal]] || 8 || 3 || Stoff-Menge an Gefahrgut, die ADR-technisch zu deklarieren ist ( in Litern bei Flüssigkeiten und verdichteten Gasen, sonst in kg, bei LQ-Gefahrgut immer kg )
|-
| '''gefahrgutMengenEinheit''' ||[[#Datentypen|String]] || 2 || - || Mengeneinheit zur Stoff-Menge. ‚1‘ oder ‚l‘: Liter ; ‚0‘ oder ‚kg‘ oder leer: kg
|-
| gefahrgutNebenGefahr || [[#Datentypen|String]] || 10 || - || bedingte Pflicht bei Stoffen, bei denen neben der Hauptgefahr-Klasse/Zettelnummer noch Nebengefahr-Zettelnummern vorhanden sind (siehe ADR-Tabelle Spalte (5), wenn dort z.B. 3+6.1+8 eingetragen ist, sind 6.1 und 8 die Nebengefahr-Zettelnummern und als (6.1)(8) im Feld Nebengefahr zu übermitteln )
|-
| gefahrgutNettoExplMasse || [[#Datentypen|Decimal]] || 8 || 3 || Netto-Explosivmasse in kg, nur bei Gefahrgütern der Klasse 1
|-
| gefahrgutPositionNr || [[#Datentypen|Integer]] || - || - || Netto-Explosivmasse in kg, nur bei Gefahrgütern der Klasse 1
|-
| gefahrgutTechBenennung || [[#Datentypen|String]] || 150 || - || bedingt Pflicht bei N.A.G. Gefahrgut (d.h. wenn die Bezeichnung mit N.A.G. endet)
|-
| gefahrgutTunnelBCode || [[#Datentypen|String]] || 10 || - || Tunnelbeschränkungscode, Pflicht (siehe ADR-Tabelle Spalte (15))
|-
| '''gefahrgutUNNR''' ||[[#Datentypen|String]] || 10 || - || Pflicht (siehe ADR-Tabelle Spalte (1))
|-
| gefahrgutUmweltGef || [[#Datentypen|String]] || 1 || - || T wenn Stoff umweltgefährdend ist , ansonsten F, Pflicht bei umweltgefährdenden Stoffen
|-
| gefahrgutVPG || [[#Datentypen|String]] || 3 || - || Verpackungsgruppe, bedingt Pflicht bei den Stoffen, bei denen diese in der ADR-Tabelle belegt ist, kann I,II oder III sein oder gar nicht belegt (letzteres z.B. bei Klasse 2)) (siehe ADR-Tabelle Spalte (4))
|-
| '''gefahrgutVerpAnzahl''' ||[[#Datentypen|Integer]] || 4 || - || Anzahl der Einheiten, in denen das Gefahrgut verpackt ist (in Zusammenhang mit dem nächsten Feld GefahrgutVerpackungsart)
|-
| '''gefahrgutVerpackungsart''' ||[[#Datentypen|String]] || 5 || - || ADR-Code der Verpackungsart, z.B. 4G für Kiste (Pappe), Pflicht, siehe separate Doc f. Verpackungscodes
|-
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
|}
</div></div>
<!-- ------------------------------------------------------------------------------- ENDE gefahrgut ------------------------------------------------------------------------------- -->
<!-- ------------------------------------------------------------------------------- edistatus ------------------------------------------------------------------------------- -->

== edistatus ==
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">EDIStatus</div>
<div class="mw-collapsible-content">
{| class="wikitable sortable"
|-
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
|-
| fehlercode || [[#Datentypen|Integer]] || - || - || 0 = Erfolgreich
|-
| statuscode || [[#Datentypen|String]] || 2 || - ||  
01 = FFDatei wurde erzeugt.<br>
02 = FFDatei wurde geschrieben.<br>
03 = FFDatei wurde verschickt.<br>
11 = FFDatei konnte nicht erzeugt werden!<br>
12 = FFDatei konnte nicht geschrieben werden!<br>
13 = FFDatei konnte nicht verschickt werden!<br>

Es ist zu beachten, dass nicht jede FFDatei verschickt wird, dies hängt ab von der HVS32 Konfiguration.<br>
D.h. solange kein Status „1x“ enthalten ist, wurde mit der FFDatei gemäß der HVS32 Konfiguration verfahren.
|-
| statustext || [[#Datentypen|String]] || 200 || - || Klartext des Statuscodes
|-
| fftyp || [[#Datentypen|String]] || 50 || - || Frachtführertyp (z.B. UPS, GLS, DPD)
|-
| dateityp || [[#Datentypen|String]] || 50 || - || FFDateityp (z.B.: Standard, Express, etc.)
|-
| auftraggeber || [[#Datentypen|String]] || 10 || - || Auftraggebernummer ('''ACHTUNG!''' Nicht die AuftraggeberID)
|-
| ffdateinr || [[#Datentypen|String]] || 10 || - || Nummer der FF-Datei (ggf. im Fehlerfall nicht gefüllt)
|}
</div></div>
<!-- ------------------------------------------------------------------------------- ENDE edistatus ------------------------------------------------------------------------------- -->
<!-- ------------------------------------------------------------------------------- packstueckDaten ------------------------------------------------------------------------------- -->
== packStueckDaten ==
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">Packstückdaten</div>
<div class="mw-collapsible-content">
{| class="wikitable sortable"
|-
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
|-
| anzahlArtikel || [[#Datentypen|Integer]] || 6 || - || Anzahl Artikel (Druck auf Etikett)
|-
| [[#artikelDaten|artikelDaten]] || [[#Datentypen|Sequence]] '''[[#artikelDaten|<ArtikelDaten>]]''' || - || - || Eine Liste der [[#artikelDaten|Packstück-Artikel]] vom Typ '''[[#artikelDaten|ArtikelDaten]]''' (1:n)
|-
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
|-
| barcodeID || [[#Datentypen|String]] || - || - || Zusatzfeld für evtl. Erweiterungen
|-
| barcodeText || [[#Datentypen|String]] || - || - || Zusatzfeld für evtl. Erweiterungen
|-
| barcodeTyp || [[#Datentypen|String]] || - || - || Zusatzfeld für evtl. Erweiterungen
|-
| druckername || [[#Datentypen|String]] || 30 || - || Name eines Ausgabekanals (Drucker) im HVS32 über den das Etikett gedruckt wird. (Benötigt Druckerspooler Erweiterungsmodul)
|-
| [[#gefahrgut|gefahrgut]] || [[#Datentypen|Sequence]] '''[[#gefahrgut|<Gefahrgut>]]''' || - || - || Eine Liste der [[#gefahrgut|Gefahrgüter]] vom Typ '''[[#gefahrgut|Gefahrgut]]''' (1:n)
|-
| '''gewicht''' || [[#Datentypen|Decimal]] || 8 || 3 || Bruttogewicht in KG
|-
| hostTrackingNr || [[#Datentypen|String]] || 35 || - || Falls die Paketnummer aus dem Vorsystem verwendet werden soll.
|-
| infotext1 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
|-
| infotext2 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
|-
| infotext3 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
|-
| infotext4 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
|-
| infotext5 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
|-
| infotext6 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
|-
| infotext7 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
|-
| infotext8 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
|-
| infotext9 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
|-
| infotext10 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
|-
| letztesPackstueck || [[#Datentypen|String]] || 1 || - || T/F: T=letztes Packstück der Sendung (wird bei Hängeversand zum Drucken der Sendungs-Hängekarte benötigt)
|-
| nachnahme || [[#Datentypen|String]] || 3 || - || Warenwert - ISO-Währungscode
|-
| nettoGewicht || [[#Datentypen|Decimal]] || 8 || 3 || Nettogewicht in KG
|-
| nnVermerk || [[#Datentypen|String]] || 3 || - || Nachnahme - ISO-Währungscode
|-
| nnVerwendung || [[#Datentypen|String]] || 1 || - || 'B' = Bar, 'V' = Verrechnungsscheck
|-
| nnWaehrung || [[#Datentypen|String]] || 3 || - || Nachnahme - ISO-Währungscode
|-
| '''packStkNr''' || [[#Datentypen|Integer]] || - || - || Laufende Nummer pro Sendung
|-
| packstueckBreite || [[#Datentypen|Integer]] || - || - || Breite in cm
|-
| packstueckHoehe || [[#Datentypen|Integer]] || - || - || Höhe in cm
|-
| '''packstueckID''' || [[#Datentypen|String]] || 20 || - || '''Eindeutige''' Nummer für das Paket im Vorsystem. Wird als eindeutige Paketreferenz benötigt um das Etikett später zu stornieren oder zu Verladen.
|-
| packstueckLaenge || [[#Datentypen|Integer]] || - || - || Länge in cm
|-
| verpackungsart || [[#Datentypen|String]] || 6 || - || -
|-
| versicherungswert || [[#Datentypen|Decimal]] || 18 || 2 || Höhe-Versicherungswert
|-
| vwWaehrung || [[#Datentypen|String]] || 3 || - || Versicherungswert - ISO-Währungscode
|-
| warenwert || [[#Datentypen|Decimal]] || 18 || 2 || -
|-
| wwWaehrung || [[#Datentypen|String]] || 3 || - || Warenwert - ISO-Währungscode
|}
</div></div>
<!-- ------------------------------------------------------------------------------- ENDE packstueckDaten ------------------------------------------------------------------------------- -->
<!-- ------------------------------------------------------------------------------- ENDE ÜBERSICHT spezial Datentypen ------------------------------------------------------------------------------- -->
<!-- ------------------------------------------------------------------------------- ÜBERSICHT DER FUNTKIONEN ------------------------------------------------------------------------------- -->

= Übersicht der Funktionen =
<!-- ------------------------------------------------------------------------------- echo ------------------------------------------------------------------------------- -->
== Schnittstelle testen (echo) ==
Zum Testen der REST-Schnittstelle. Liefert die übergebene Nachricht unverändert zurück.<br><br>
{| class="wikitable"
|-
| '''Funktion (GET): /hvs32rest/echo/<Nachricht>'''
|}

<Nachricht> wird zurück gegeben.
<!-- ------------------------------------------------------------------------------- ENDE echo ------------------------------------------------------------------------------- -->
<!-- ------------------------------------------------------------------------------- versanddatenAnfrage ------------------------------------------------------------------------------- -->
== Packstück-Verarbeitung (versanddatenAnfrage) ==
Die Gatewayfunktion versanddatenAnfrage wird vom Data-Gateway-Server im Automatik-Polling Modus an das HVS32 gesendet, um dort ein Etikett für ein Packstück zu erzeugen und verbuchen. Ein Etikett wird für alle weiteren Funktionen wir Storno, Verladefreigabe, etc. anhand der hostseitigen Packstück-ID identifiziert. Diese wird im Feld PackstueckID übergeben und muss dementsprechend innerhalb des Versandsystems eindeutig sein.
<br>
{| class="wikitable"
|-
|'''Funktion (POST) || /hvs32rest/versanddatenAnfrage'''
|-
| '''MediaType || application/json; text/plain'''<br>
|-
| '''Charset || UTF-8'''<br>
|}


<br>
<!-- ------------------------------------------------------------------------------- Request ------------------------------------------------------------------------------- -->
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">'''Übergabe Parameter'''</div>
<div class="mw-collapsible-content">
<small>'''Fett''' dargestellte Felder müssen IMMER belegt sein</small>
{| class="wikitable sortable"
|-
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
|-
|absenderAdresseID
|[[#Datentypen|String]]
|10
| -
| Eindeutige ID um eine Neutrale-Absenderadresse aus dem HVS32 zu verwenden
|-
| ansprechpartner || [[#Datentypen|String]] || 20 || - || Empfänger Ansprechpartner
|-
| anzahlArtikel || [[#Datentypen|Integer]] || 6 || - || Anzahl Artikel (Druck auf Etikett)
|-
| [[#artikelDaten|artikelDaten]] || [[#Datentypen|Sequence]] '''[[#artikelDaten|<ArtikelDaten>]]''' || - || - || Eine Liste der [[#artikelDaten|Packstück-Artikel]] vom Typ '''[[#artikelDaten|ArtikelDaten]]''' (1:n)
|-
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
|-
| auftragNr || [[#Datentypen|String]] || 20 || - || -
|-
| '''auftraggeberID''' || [[#Datentypen|String]] || 10 || - || Mandantenkennung aus dem HVS32
|-
| avisHinweis1 || [[#Datentypen|String]] || 100 || - || -
|-
| avisHinweis2 || [[#Datentypen|String]] || 100 || - || -
|-
| avisZusatz1 || [[#Datentypen|String]] || 60 || - || Zusatz zu Fest-AVIS-Schlüssel 1
|-
| avisZusatz2 || [[#Datentypen|String]] || 60 || - || Zusatz zu Fest-AVIS-Schlüssel 2
|-
| barcodeID || [[#Datentypen|String]] || - || - || Zusatzfeld für evtl. Erweiterungen
|-
| barcodeText || [[#Datentypen|String]] || - || - || Zusatzfeld für evtl. Erweiterungen
|-
| barcodeTyp || [[#Datentypen|String]] || - || - || Zusatzfeld für evtl. Erweiterungen
|-
| bestellNr || [[#Datentypen|String]] || 20 || - || Metro-Bestellnr (Metro-Versand)
|-
| druckername || [[#Datentypen|String]] || 30 || - || Name eines Ausgabekanals (Drucker) im HVS32 über den das Etikett gedruckt wird. (Benötigt Druckerspooler Erweiterungsmodul)
|-
| email || [[#Datentypen|String]] || 100 || - || E-Mail Adresse des Empfängers (z.B.: für die Automatische E-Mail Avisierung)
|-
| empfMobilfunkNr || [[#Datentypen|String]] || 20 || - || Mobilfunknummer des Empfängers
|-
| faxNr || [[#Datentypen|String]] || 20 || - || Faxnummer des Empfängers
|-
| flexZustellungEmailadresse || [[#Datentypen|String]] || 80 || - || Flex-Zustellung Emailadresse
|-
| frachtBrief || [[#Datentypen|String]] || 20 || - || Frachtbrief Nummer falls Frachtbrief durch Vorsystem gedruckt werden soll
|-
| frachtfuehrerKdNr || [[#Datentypen|String]] || 10 || - || Kundennummer des Frachtzahlers beim Frachtführer
|-
|freiAvis1
|[[#Datentypen|String]]
| -
| -
| -
|-
|freiAvis2
|[[#Datentypen|String]]
| -
| -
| -
|-
| frankaturKennung || [[#Datentypen|String]] || 10 || - || -
|-
| [[#gefahrgut|gefahrgut]] || [[#Datentypen|Sequence]] [[#gefahrgut|<Gefahrgut>]] || - || - || Eine Liste der [[#gefahrgut|Gefahrgüter]] vom Typ '''[[#gefahrgut|Gefahrgut]]''' (1:n)
|-
| '''gewicht''' ||[[#Datentypen|Decimal]] || 8 || 3 || Bruttogewicht in KG
|-
| hostTrackingNr || [[#Datentypen|String]] || 35 || - || Paketnummer aus dem Hostsystem
|-
| ilnNr || [[#Datentypen|String]] || 20 || - || ILN des Empfängers (Pflicht bei Metro-Versand)
|-
| infotext1 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
|-
| infotext2 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
|-
| infotext3 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
|-
| infotext4 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
|-
| infotext5 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
|-
| infotext6 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
|-
| infotext7 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
|-
| infotext8 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
|-
| infotext9 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
|-
| infotext10 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
|-
| kostenstelle || [[#Datentypen|String]] || 30 || - || -
|-
| kundenNr || [[#Datentypen|String]] || 20 || - || Kundennummer des Empfängers beim Versender
|-
| lagerkennzeichen || [[#Datentypen|Integer]] || - || - || -
|-
| letztesPackstueck || [[#Datentypen|String]] || 1 || - || T/F: T=letztes Packstüeck der Sendung (wird bei Hängeversand zum Drucken der Sendungs-Hängekarte benötigt)
|-
| lieferantenID || [[#Datentypen|Integer]] || - || - || -
|-
| '''lieferscheinNr''' || [[#Datentypen|String]] || 40 || - || Wird im HVS32 als Such-Nummer verwendet
|-
| nachnahme || [[#Datentypen|Decimal]] || 18 || 2 || -
|-
| nettoGewicht || [[#Datentypen|Decimal]] || 8 || 3 || Nettogewicht in KG
|-
| neutBIC || [[#Datentypen|String]] || 11 || - || Nur bei Neutral-Absendern belegt
|-
| neutBankBezeichnung || [[#Datentypen|String]] || 40 || - || Nur bei Neutral-Absendern belegt
|-
| neutIBAN || [[#Datentypen|String]] || 31 || - || Nur bei Neutral-Absendern belegt
|-
| neutKontoInhaber || [[#Datentypen|String]] || 40 || - || Nur bei Neutral-Absendern belegt
|-
| neutabsenderLKZ || [[#Datentypen|String]] || 3 || - || Nur bei Neutral-Absendern belegt
|-
| neutabsenderName1 || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
|-
| neutabsenderName2 || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
|-
| neutabsenderName3 || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
|-
| neutabsenderOrt || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
|-
| neutabsenderPLZ || [[#Datentypen|String]] || 10 || - || Nur bei Neutral-Absendern belegt
|-
| neutabsenderStrasse || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
|-
| nnVermerk || [[#Datentypen|String]] || 1 || - || B': Bar / 'V': Verrechnungsscheck
|-
| nnVerwendung || [[#Datentypen|String]] || 30 || - || Nachnahme Verwendungszweck
|-
| nnWaehrung || [[#Datentypen|String]] || 3 || - || Nachnahme - ISO-Währungscode
|-
| '''packStkGes''' || [[#Datentypen|Integer]] || - || - || Gesamt-Anzahl Colli der Sendung
|-
| '''packStkNr''' || [[#Datentypen|Integer]] || - || - || Laufende Nr pro Sendung
|-
| packplatz || [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Auftrag verarbeten soll.
|-
| packstueckBreite || [[#Datentypen|Integer]] || - || - || Breite in cm
|-
| packstueckHoehe || [[#Datentypen|Integer]] || - || - || Höhe in cm
|-
| '''packstueckID''' || [[#Datentypen|String]] || 20 || - || Eindeutige Nummer für das Paket im Vorsystem. Wird als eindeutige Paketreferenz benötigt um das Etikett später zu stornieren oder zu Verladen.
|-
| packstueckLaenge || [[#Datentypen|Integer]] || - || - || Länge in cm
|-
| paperlessInvoice || [[#Datentypen|String]] || 1 || - || Nur im UPS PaperlessInvoice Fall (T=PaperlessInvoice / F=nicht PaperlessInvoice)
|-
| postLeitcode || [[#Datentypen|String]] || 15 || - || -
|-
| postZielFrachtzent || [[#Datentypen|String]] || 5 || - || -
|-
| rechnungsEmpfLKZ || [[#Datentypen|String]] || 5 || - || Rechnungsadresse
|-
| rechnungsEmpfName1 || [[#Datentypen|String]] || 50 || - || Rechnungsempfänger
|-
| rechnungsEmpfName2 || [[#Datentypen|String]] || 50 || - || Rechnungsempfänger
|-
| rechnungsEmpfName3 || [[#Datentypen|String]] || 50 || - || Rechnungsempfänger
|-
| rechnungsEmpfOrt || [[#Datentypen|String]] || 50 || - || Rechnungsadresse
|-
| rechnungsEmpfPLZ || [[#Datentypen|String]] || 10 || - || Rechnungsadresse
|-
| rechnungsEmpfStrasse || [[#Datentypen|String]] || 50 || - || Rechnungsadresse
|-
| rechnungsNr || [[#Datentypen|String]] || 20 || - || Rechnungsnummer
|-
| sendungsinhalt || [[#Datentypen|String]] || 30 || - || -
|-
| sonderdienste || [[#Datentypen|String]] || 30 || - || Versandart-spezifisch belegt
|-
| sperrFlag || [[#Datentypen|String]] || 1 || - || T/F: T=Sperren, sonst nicht sperren
|-
| telefonNr || [[#Datentypen|String]] || 20 || - || Telefonnummer des Empfängers
|-
| terminArt || [[#Datentypen|String]] || 1 || - || 'A' = ab diesem Tag liefern
'B' = bis zu diesem Tag liefern

'F' = an diesem Tag liefern
|-
| terminDatum || [[#Datentypen|String]] || 10 || - || TT.MM.JJJJ
|-
| terminZeit || [[#Datentypen|Calendar]] || 5 || - || HH:MM
|-
| ustIDNr || [[#Datentypen|String]] || 20 || - || UmsatzsteuerNr des Empfängers
|-
| verpackungsart || [[#Datentypen|String]] || 6 || - || -
|-
| '''versandartID''' || [[#Datentypen|String]] || 10 || - || Versandartkennung aus dem HVS32
|-
| versicherungswert || [[#Datentypen|Decimal]] || 18 || 2 || Höhe Versicherungswert
|-
| vorpackdatum || [[#Datentypen|String]] || 10 || - || TT.MM.JJJJ
|-
| vwWaehrung || [[#Datentypen|String]] || 3 || - || Versicherungswert - ISO-Währungscode
|-
| warenwert || [[#Datentypen|Decimal]] || 18 || 2 || -
|-
| wechselbruecke || [[#Datentypen|String]] || 20 || - || Wechselbrücke, die diesem Packstück zugewiesen wird
|-
| wwWaehrung || [[#Datentypen|String]] || 3 || - || Warenwert - ISO-Währungscode
|-
| zahlungsbedingung || [[#Datentypen|String]] || 10 || - || 'S' = Sender, 'R' = Empfänger
|-
| zbZoll || [[#Datentypen|String]] || 1 || - || Zahlungsbedingung für Zoll Steuern 'S' = Sender, 'R' = Empfänger
|-
| zielAdrBahnhof || [[#Datentypen|String]] || 30 || - || PLZ und Ort
|-
| '''zielAdrLKZ''' || [[#Datentypen|String]] || 5 || - || Lieferadresse
|-
| '''zielAdrName1''' || [[#Datentypen|String]] || 50 || - || Lieferadresse
|-
| zielAdrName2 || [[#Datentypen|String]] || 50 || - || Lieferadresse
|-
| zielAdrName3 || [[#Datentypen|String]] || 50 || - || Lieferadresse
|-
| zielAdrName4 || [[#Datentypen|String]] || 50 || - || Lieferadresse
|-
| '''zielAdrOrt''' || [[#Datentypen|String]] || 50 || - || Lieferadresse
|-
| '''zielAdrPLZ''' || [[#Datentypen|String]] || 10 || - || Lieferadresse
|-
| zielAdrRegion || [[#Datentypen|String]] || 20 || - || Staat/Provinz (z.B.: für Sendungen in die USA wichtig)
|-
| '''zielAdrStrasse''' || [[#Datentypen|String]] || 50 || - || Lieferadresse
|}
</div></div>
<!-- ------------------------------------------------------------------------------- ENDE Request ------------------------------------------------------------------------------- -->
<br>
<!-- ------------------------------------------------------------------------------- Response ------------------------------------------------------------------------------- -->
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">'''Rückgabe Parameter'''</div>
<div class="mw-collapsible-content">
{| class="wikitable sortable"
|-
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung|
|-
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
|-
| ausgangDateTime || [[#Datentypen|Calendar]] || 10 || - || Datum (Monat ist 0-basierend), wann das Etikett an den Frachtführer übermittelt worden ist
|-
| ausgangDateTimeString || [[#Datentypen|String]] || 10 || - || Datum, wann das Etikett an den Frachtführer übermittelt worden ist (TT.MM.JJJJ)
|-
| druckDateTime || [[#Datentypen|Calendar]] || 19 || - || Datum (Monat ist 0-basierend), wann das Etikett im HVS32 gedruckt worden ist
|-
| druckDateTimeString || [[#Datentypen|String]] || 19 || - || Datum, wann das Etikett im HVS32 gedruckt worden ist (TT.MM.JJJJ HH:mm:SS)
|-
| etikettDaten || [[#Datentypen|String]] || - || - || Binärdaten des Etiketts
|-
| etikettName || [[#Datentypen|String]] || - || - || Vorlagenname des Etiketts
|-
| fehlercode || [[#Datentypen|Integer]] || - || - || 0 wenn Erfolgreich
|-
| fehlertext1 || [[#Datentypen|String]] || 200 || - || Wird im Fehlerfall befüllt
|-
| fehlertext2 || [[#Datentypen|String]] || 200 || - || Wird im Fehlerfall befüllt
|-
| gebuehr || [[#Datentypen|Decimal]] || 18 || 2 || Frachtkosten
|-
| gebuehrWaehrung || [[#Datentypen|String]] || 3 || - || Frachkosten ISO-Währungscode
|-
| packstueckID || [[#Datentypen|String]] || 20 || - || PackstueckID aus der Anfrage
|-
| retourTrackingNr || [[#Datentypen|String]] || 50 || - || Paketnummer für die Retoure
|-
| trackingNr || [[#Datentypen|String]] || 35 || - || Paketnummer
|-
| trackingURL || [[#Datentypen|String]] || 255 || - || URL des Trackinglinks zur Sendungsverfolgung
|-
| versandSendungsNr || [[#Datentypen|String]] || - || - || -
|-
| zusatzEtikettenDaten || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Name und Binärdaten der Zusatzetiketten als Key/Value Map
|-
| zusatzfeld1 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
|-
| zusatzfeld2 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
|-
| zusatzfeld3 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
|-
| zusatzfeld4 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
|-
| zusatzfeld5 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
|-
| zusatzfeld6 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
|-
| zusatzfeld7 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
|-
| zusatzfeld8 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
|-
| zusatzfeld9 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
|-
| zusatzfeld10 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
|}
</div></div>
<!-- ------------------------------------------------------------------------------- ENDE Response ------------------------------------------------------------------------------- -->
<br>
<!-- ------------------------------------------------------------------------------- Beispiel ------------------------------------------------------------------------------- -->
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">'''Beispiele'''</div>
<div class="mw-collapsible-content">
;Request
<source lang="json">
{
	"absenderAdresseID": "",
	"ansprechpartner": "",
	"assoc": {
		"Key": "Value"
	},
	"artikelDaten": [
		{
			"anzahlBuegel": 0,
			"anzahlPosEtiketten": 0,
			"artikelBTNNr": "",
			"artikelEAN": "",
			"artikelEinheit": "",
			"artikelGewicht": 0,
			"artikelGruppe": "",
			"artikelMenge": 0,
			"artikelServices": "",
			"artikelSollMenge": 0,
			"artikelText1": "",
			"artikelText2": "",
			"artikelText3": "",
			"artikelText4": "",
			"artikelVolumen": 0,
			"artikelWaehrung": "",
			"artikelWert": 0,
			"chargeFlag": "",
			"kundenArtikelNr": "",
			"kundenBestellNr": "",
			"posAuftragNr": "",
			"posLieferNr": "",
			"positionNr": "",
			"serienNr": "",
			"ursprungLand": ""
		}
	],
	"auftragNr": "",
	"auftraggeberID": "",
	"avisHinweis1": "",
	"avisHinweis2": "",
	"avisZusatz1": "",
	"avisZusatz2": "",
	"bestellNr": "",
	"druckername": "",
	"email": "",
	"faxNr": "",
	"frachtBrief": "",
	"frachtfuehrerKdNr": "",
	"freiAvis1": "",
	"freiAvis2": "",
	"frankaturKennung": "",
	"gefahrgut": [
		{
			"gefahrgutBefoerdKat": 0,
			"gefahrgutBegrenzteMenge": "",
			"gefahrgutBezeichnung": "",
			"gefahrgutBuchst640": "",
			"gefahrgutFFCode": "",
			"gefahrgutFaktor": 0,
			"gefahrgutFreigestMenge": "",
			"gefahrgutKCode": "",
			"gefahrgutKlasse": "",
			"gefahrgutMenge": 0,
			"gefahrgutMengenEinheit": "",
			"gefahrgutNebenGefahr": "",
			"gefahrgutNettoExplMasse": 0,
			"gefahrgutTunnelBCode": "",
			"gefahrgutUNNR": "",
			"gefahrgutUmweltGef": "",
			"gefahrgutVPG": "",
			"gefahrgutVerpAnzahl": 0,
			"gefahrgutVerpackungsart": ""
		}
	],
	"gewicht": 0,
	"ilnNr": "",
	"infotext1": "",
	"infotext2": "",
	"infotext3": "",
	"infotext4": "",
	"infotext5": "",
	"infotext6": "",
	"infotext7": "",
	"infotext8": "",
	"infotext9": "",
	"infotext10": "",
	"kostenstelle": "",
	"kundenNr": "",
	"lieferscheinNr": "",
	"nachnahme": 0,
	"nettoGewicht": 0,
	"neutabsenderLKZ": "",
	"neutabsenderName1": "",
	"neutabsenderName2": "",
	"neutabsenderName3": "",
	"neutabsenderOrt": "",
	"neutabsenderPLZ": "",
	"neutabsenderStrasse": "",
	"nnVermerk": "",
	"nnVerwendung": "",
	"nnWaehrung": "",
	"packStkGes": 0,
	"packStkNr": 0,
	"packplatz": "",
	"packstueckBreite": 0,
	"packstueckHoehe": 0,
	"packstueckID": "",
	"packstueckLaenge": 0,
	"paperlessInvoice": "",
	"postLeitcode": "",
	"postZielFrachtzent": "",
	"rechnungsEmpfLKZ": "",
	"rechnungsEmpfName1": "",
	"rechnungsEmpfName2": "",
	"rechnungsEmpfName3": "",
	"rechnungsEmpfOrt": "",
	"rechnungsEmpfPLZ": "",
	"rechnungsEmpfStrasse": "",
	"sendungsinhalt": "",
	"sonderdienste": "",
	"telefonNr": "",
	"terminArt": "",
	"terminDatum": "",
	"terminZeit": "",
	"ustIDNr": "",
	"verpackungsart": "",
	"versandartID": "",
	"versicherungswert": 0,
	"vwWaehrung": "",
	"warenwert": 0,
	"wwWaehrung": "",
	"zahlungsbedingung": "",
	"zbZoll": "",
	"zielAdrBahnhof": "",
	"zielAdrLKZ": "",
	"zielAdrName1": "",
	"zielAdrName2": "",
	"zielAdrName3": "",
	"zielAdrOrt": "",
	"zielAdrPLZ": "",
	"zielAdrRegion": "",
	"zielAdrStrasse": ""
}
</source>
;Response
<source lang="json">
{
	"assoc": {
		"": ""
	},
	"packstueckID": "",
	"trackingNr": "",
	"retourTrackingNr": "",
	"versandSendungsNr": "",
	"druckDateTime": {
		"year": 2023,
		"month": 0,
		"dayOfMonth": 25,
		"hourOfDay": 8,
		"minute": 59,
		"second": 22
	},
	"druckDateTimeString": "25.01.2023 08:59:22",
	"ausgangDateTime": {
		"year": 2023,
		"month": 0,
		"dayOfMonth": 25,
		"hourOfDay": 0,
		"minute": 0,
		"second": 0
	},
	"ausgangDateTimeString": "25.01.2023",
	"gebuehr": 0,
	"gebuehrWaehrung": "",
	"fehlertext1": "",
	"fehlertext2": "",
	"etikettName": "",
	"etikettDaten": "",
	"zusatzEtikettenDaten": {
		"": ""
	},
	"trackingURL": "",
	"zusatzfeld1": "",
	"zusatzfeld2": "",
	"zusatzfeld3": "",
	"zusatzfeld4": "",
	"zusatzfeld5": "",
	"zusatzfeld6": "",
	"zusatzfeld7": "",
	"zusatzfeld8": "",
	"zusatzfeld9": "",
	"zusatzfeld10": ""
}
</source>
</div></div>
<!-- ------------------------------------------------------------------------------- ENDE Beispiel ------------------------------------------------------------------------------- -->
<!-- ------------------------------------------------------------------------------- ENDE versanddatenAnfrage ------------------------------------------------------------------------------- -->
<!-- ------------------------------------------------------------------------------- versanddatenNachdruckAnfrage ------------------------------------------------------------------------------- -->

== Etikett nachdrucken (versanddatenNachdruckAnfrage) ==
Die Gatewayfunktion versanddatenNachdruckAnfrage wird vom Data-Gateway-Server im Automatik-Polling Modus an das HVS32 gesendet, um dort ein Etikett für ein Packstück nachzudrucken. Ein Etikett wird anhand der hostseitigen Packstück-ID nachgedruckt. Diese wird im Feld PackstueckID übergeben. Bei manchen Frachtführern (z.B. DPD) werden beim Nachdruck neue Trackingnummern vergeben. Somit ist die alte Trackingnummer nicht mehr gültig und das alte Versandetikett muss vernichtet werden. Die neue Trackingnummer kann in der Rückmeldung zurückgemeldet werden.
<br>
{| class="wikitable"
|-
|'''Funktion (POST) || /hvs32rest/versanddatenNachdruckAnfrage'''
|-
| '''MediaType || application/json; text/plain'''<br>
|-
| '''Charset || UTF-8'''<br>
|}
<br>
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">'''Übergabe Parameter'''</div>
<div class="mw-collapsible-content">
<small>'''Fett''' dargestellte Felder müssen IMMER belegt sein</small>
{| class="wikitable sortable"
|-
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
|-
| druckername || [[#Datentypen|String]] || 30 || - || Name eines Ausgabekanals (Drucker) im HVS32 über den das Etikett gedruckt wird.
|-
| packplatz|| [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Auftrag verarbeiten soll.
|-
| '''packstueckID''' || [[#Datentypen|String]] || 30 || - || '''Eindeutige''' Nummer für das Paket im Vorsystem.
|-
| trackingNr|| [[#Datentypen|String]] || 35 || - || Paketnummer
|}
</div></div>
<br>
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">'''Rückgabe Parameter'''</div>
<div class="mw-collapsible-content">
{| class="wikitable sortable"
|-
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung|
|-
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
|-
| ausgangDateTime || [[#Datentypen|Calendar]] || 10 || - || Datum (Monat ist 0-basierend), wann das Etikett an den Frachtführer übermittelt worden ist
|-
| ausgangDateTimeString || [[#Datentypen|String]] || 10 || - || Datum, wann das Etikett an den Frachtführer übermittelt worden ist (TT.MM.JJJJ)
|-
| druckDateTime || [[#Datentypen|Calendar]] || 19 || - || Datum (Monat ist 0-basierend), wann das Etikett im HVS32 gedruckt worden ist
|-
| druckDateTimeString || [[#Datentypen|String]] || 19 || - || Datum, wann das Etikett im HVS32 gedruckt worden ist (TT.MM.JJJJ HH:mm:SS)
|-
| etikettDaten || [[#Datentypen|String]] || - || - || Binärdaten des Etiketts
|-
| etikettName || [[#Datentypen|String]] || - || - || Vorlagenname des Etiketts
|-
| fehlercode || [[#Datentypen|Integer]] || - || - || 0 wenn Erfolgreich
|-
| fehlertext1 || [[#Datentypen|String]] || 200 || - || Wird im Fehlerfall befüllt
|-
| fehlertext2 || [[#Datentypen|String]] || 200 || - || Wird im Fehlerfall befüllt
|-
| gebuehr || [[#Datentypen|Decimal]] || 18 || 2 || Frachtkosten
|-
| gebuehrWaehrung || [[#Datentypen|String]] || 3 || - || Frachkosten ISO-Währungscode
|-
| packstueckID || [[#Datentypen|String]] || 20 || - || PackstueckID aus der Anfrage
|-
| retourTrackingNr || [[#Datentypen|String]] || 50 || - || Paketnummer für die Retoure
|-
| trackingNr || [[#Datentypen|String]] || 35 || - || Paketnummer
|-
| trackingURL || [[#Datentypen|String]] || 255 || - || URL des Trackinglinks zur Sendungsverfolgung
|-
| versandSendungsNr || [[#Datentypen|String]] || - || - || -
|-
| zusatzEtikettenDaten || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Name und Binärdaten der Zusatzetiketten als Key/Value Map
|-
| zusatzfeld1 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
|-
| zusatzfeld2 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
|-
| zusatzfeld3 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
|-
| zusatzfeld4 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
|-
| zusatzfeld5 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
|-
| zusatzfeld6 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
|-
| zusatzfeld7 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
|-
| zusatzfeld8 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
|-
| zusatzfeld9 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
|-
| zusatzfeld10 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
|}
</div></div>
<br>
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">'''Beispiele'''</div>
<div class="mw-collapsible-content">
;Request
<source lang="json">
{
	"druckername": "",
	"packplatz": "",
	"packstueckID": "",
	"trackingNr": ""
}
</source>
;Response
<source lang="json">
{
	"assoc": {
		"": ""
	},
	"packstueckID": "",
	"trackingNr": "",
	"retourTrackingNr": "",
	"versandSendungsNr": "",
	"druckDateTime": {
		"year": 2023,
		"month": 0,
		"dayOfMonth": 25,
		"hourOfDay": 8,
		"minute": 59,
		"second": 22
	},
	"druckDateTimeString": "25.01.2023 08:59:22",
	"ausgangDateTime": {
		"year": 2023,
		"month": 0,
		"dayOfMonth": 25,
		"hourOfDay": 0,
		"minute": 0,
		"second": 0
	},
	"ausgangDateTimeString": "25.01.2023",
	"gebuehr": 0,
	"gebuehrWaehrung": "",
	"fehlertext1": "",
	"fehlertext2": "",
	"etikettName": "",
	"etikettDaten": "",
	"zusatzEtikettenDaten": {
		"": ""
	},
	"trackingURL": "",
	"zusatzfeld1": "",
	"zusatzfeld2": "",
	"zusatzfeld3": "",
	"zusatzfeld4": "",
	"zusatzfeld5": "",
	"zusatzfeld6": "",
	"zusatzfeld7": "",
	"zusatzfeld8": "",
	"zusatzfeld9": "",
	"zusatzfeld10": ""
}
</source>
</div></div>
<!-- ------------------------------------------------------------------------------- ENDE versanddatenNachdruckAnfrage ------------------------------------------------------------------------------- -->
<!-- ------------------------------------------------------------------------------- stornoVersanddaten ------------------------------------------------------------------------------- -->

== Packstück stornieren (stornoVersanddaten) ==
Die Gatewayfunktion stornoVersanddaten wird vom Data-Gateway-Server im Automatik-Polling Modus an das HVS32 gesendet, um dort bestehende Packstücke zu stornieren, die noch nicht auf einer Ausgangsliste sind. In der Regel wird ein Packstück anhand der hostseitigen Packstück-ID storniert. Diese wird im Feld PackstueckID übergeben. Zusätzlich zur hostseitigen Packstück-ID kann auch die TrackingNr zur Identifikation des Packstücks beitragen, für den Fall, dass die hostseitige Packstück-ID keine Eindeutigkeit garantieren kann. Es stehen keine Packstück-/Sendungs-Daten für die Rückmeldung zur Verfügung. Nach erfolgreichem Storno wird lediglich das Feld Fehler mit Wert 0 zurückgemeldet - bzw. im Fehlerfall wird Fehler mit dem Wert 1 sowie der Fehlertext1 zurückgemeldet.
<br>
{| class="wikitable"
|-
|'''Funktion (POST) || /hvs32rest/stornoVersanddaten'''
|-
| '''MediaType || application/json; text/plain'''<br>
|-
| '''Charset || UTF-8'''<br>
|}
<br>
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">'''Übergabe Parameter'''</div>
<div class="mw-collapsible-content">
<small>'''Fett''' dargestellte Felder müssen IMMER belegt sein</small>
{| class="wikitable sortable"
|-
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
|-
| packplatz|| [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Auftrag verarbeiten soll.
|-
| '''packstueckID'''|| [[#Datentypen|String]] || 30 || - || '''Eindeutige''' Nummer für das Paket im Vorsystem.
|-
| trackingNr|| [[#Datentypen|String]] || 35 || - || Paketnummer
|}
</div></div>
<br>
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">'''Rückgabe Parameter'''</div>
<div class="mw-collapsible-content">
{| class="wikitable sortable"
|-
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
|-
| fehlercode || [[#Datentypen|Integer]] || - || - || 0 = Erfolgreich
|-
| fehlertext1 || [[#Datentypen|String]] || 200 || - || -
|-
| fehlertext2 || [[#Datentypen|String]] || 200 || - || -
|}
</div></div>
<br>
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">'''Beispiele'''</div>
<div class="mw-collapsible-content">
;Request
<source lang="json">
{
	"packplatz": "",
	"packstueckID": "",
	"trackingNr": ""
}
</source>
;Response
<source lang="json">
{
	"fehlercode": 0,
	"fehlertext1": "",
	"fehlertext2": ""
}
</source>
</div></div>
<!-- ------------------------------------------------------------------------------- ENDE stornoversanddaten ------------------------------------------------------------------------------- -->
<!-- ------------------------------------------------------------------------------- verladeVersandaten ------------------------------------------------------------------------------- -->
== Packstück verladen / freigeben (verladeVersanddaten) ==
Die Gatewayfunktion verladeVersanddaten wird vom Data-Gateway-Server im Automatik-Polling Modus an das HVS32 gesendet, um dort Packstücke für den Ausgang frei zu geben. Nur Packstücke, welche für den Ausgang freigegeben wurden, werden für den Tagesabschluss berücksichtigt. Es stehen keine Packstück-/Sendungs-Daten für die Rückmeldung zur Verfügung. Nach erfolgreicher Freigabe wird lediglich das Feld Fehler mit Wert 0 zurückgemeldet - bzw. im Fehlerfall wird Fehler mit dem Wert 1 sowie der Fehlertext1 zurückgemeldet.
<br>
{| class="wikitable"
|-
|'''Funktion (POST) || /hvs32rest/verladeVersanddaten'''
|-
| '''MediaType || application/json; text/plain'''<br>
|-
| '''Charset || UTF-8'''<br>
|}
<br>
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">'''Übergabe Parameter'''</div>
<div class="mw-collapsible-content">
<small>'''Fett''' dargestellte Felder müssen IMMER belegt sein</small>
{| class="wikitable sortable"
|-
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
|-
| hostFreigabeNr || [[#Datentypen|String]] || 20 || - || Hostseitige Freigabenummer die für dieses Packstück gesetzt wird.
|-
| packplatz || [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Auftrag verarbeiten soll.
|-
| '''packstueckID''' || [[#Datentypen|String]] || 20 || - || Eindeutige Nummer für das Paket im Vorsystem. <br>
Beim Etikettendruck zuvor muss die gleiche ID übergeben worden sein, damit das HVS32 das zu verladene Packstück eindeutig identifizieren kann.
|-
| wechselbruecke || [[#Datentypen|String]] || 20 || - || Wechselbrücke, die diesem Packstück zugewiesen wird.
|}
</div></div>
<br>
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">'''Rückgabe Parameter'''</div>
<div class="mw-collapsible-content">
{| class="wikitable sortable"
|-
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
|-
| fehlercode || [[#Datentypen|Integer]] || - || - || 0 = Erfolgreich
|-
| fehlertext1 || [[#Datentypen|String]] || 200 || - || -
|-
| fehlertext1 || [[#Datentypen|String]] || 200 || - || -
|}
</div></div>
<br>
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">'''Beispiele'''</div>
<div class="mw-collapsible-content">
;Request
<source lang="json">
{
	"hostFreigabeNr": "",
	"packplatz": "",
	"packstueckID": "",
	"wechselbruecke": ""
}
</source>
;Response
<source lang="json">
{
	"fehlercode": 0,
	"fehlertext1": "",
	"fehlertext2": ""
}
</source>
</div></div>
<!-- ------------------------------------------------------------------------------- ENDE verladeVersandaten ------------------------------------------------------------------------------- -->
<!-- ------------------------------------------------------------------------------- sperreVersanddaten ------------------------------------------------------------------------------- -->

== Packstück sperren (sperreVersanddaten) ==
Die Gatewayfunktion sperreVersanddaten wird vom Data-Gateway-Server im Automatik-Polling Modus an das HVS32 gesendet, um dort Packstücke für den Ausgang zu sperren. Gesperrte Packstücke, werden für den Tagesabschluss nicht berücksichtigt. Es stehen keine Packstück-/Sendungs-Daten für die Rückmeldung zur Verfügung. Nach erfolgreicher Sperrung wird lediglich das Feld Fehler mit Wert 0 zurückgemeldet - bzw. im Fehlerfall wird Fehler mit dem Wert 1 sowie der Fehlertext1 zurückgemeldet.
<br>
{| class="wikitable"
|-
|'''Funktion (POST) || /hvs32rest/sperreVersanddaten'''
|-
| '''MediaType || application/json; text/plain'''<br>
|-
| '''Charset || UTF-8'''<br>
|}
<br>
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">'''Übergabe Parameter'''</div>
<div class="mw-collapsible-content">
<small>'''Fett''' dargestellte Felder müssen IMMER belegt sein</small>
{| class="wikitable sortable"
|-
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
|-
| packplatz|| [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Auftrag verarbeiten soll.
|-
| '''packstueckID'''|| [[#Datentypen|String]] || 20 || - || '''Eindeutige''' Nummer für das Paket im Vorsystem.
|}
</div></div>
<br>
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">'''Rückgabe Parameter'''</div>
<div class="mw-collapsible-content">
{| class="wikitable sortable"
|-
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
|-
| fehlercode || [[#Datentypen|Integer]] || - || - || 0 = Erfolgreich
|-
| fehlertext1 || [[#Datentypen|String]] || 200 || - || -
|-
| fehlertext2 || [[#Datentypen|String]] || 200 || - || -
|}
</div></div>
<br>
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">'''Beispiele'''</div>
<div class="mw-collapsible-content">
;Request
<source lang="json">
{
	"packplatz": "",
	"packstueckID": ""
}
</source>
;Response
<source lang="json">
{
	"fehlercode": 0,
	"fehlertext1": "",
	"fehlertext2": ""
}
</source>
</div></div>
<!-- ------------------------------------------------------------------------------- ENDE sperreversanddaten ------------------------------------------------------------------------------- -->
<!-- ------------------------------------------------------------------------------- tagesabschluss ------------------------------------------------------------------------------- -->

== Tagesabschluss (tagesabschluss) ==
Das Gateway sendet die tagesabschluss-Anfrage an das Automatik-Polling des HVS32. Im HVS32 wird somit ein Tagesabschluss anhand der zusätzlich übergebenen Parameter ausgelöst. Der Tagesabschluss setzt sich aus den Punkten Ausgangsliste erzeugen und Frachtführer DFÜ erzeugen zusammen. Nur Packstücke, welche für den Ausgang freigegeben wurden, werden für den Tagesabschluss berücksichtigt. Standardmäßig sind alle Packstücke freigegeben, außer sie wurden durch das Erweiterungsmodul Ausgangsscannung gesperrt. Die Rückmeldung im HVS32 findet nach dem Ausführen des Tagesabschluss statt. Es stehen keine Packstück-/Sendungs-Daten für die Rückmeldung zur Verfügung. Nach erfolgreichem Tagesabschluss wird lediglich das Feld Fehler mit Wert 0 zurückgemeldet - bzw. im Fehlerfall wird Fehler mit dem Wert 1 sowie der Fehlertext1 zurückgemeldet.
<br>
{| class="wikitable"
|-
|'''Funktion (POST) || /hvs32rest/tagesabschluss'''
|-
| '''MediaType || application/json; text/plain'''<br>
|-
| '''Charset || UTF-8'''<br>
|}
<br>
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">'''Übergabe Parameter'''</div>
<div class="mw-collapsible-content">
<small>'''Fett''' dargestellte Felder müssen IMMER belegt sein</small>
{| class="wikitable sortable"
|-
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
|-
| auftraggeberID || [[#Datentypen|Sequence<String>]] || 255 || - || Hier kann eine Semikolon separierte Liste mit den abzuschließenden Auftraggebern mitgegeben werden. Es können n-Auftraggeber abgeschlossen werden.
(Option MultiAGTagesabschluss muss im HVS32 aktiv sein)
|-
|assoc
|[[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]])
| -
| -
|Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
|-
| druckername || [[#Datentypen|String]] || 30 || - || Name eines Ausgabekanals (Drucker) im HVS32 über den die Listen gedruckt werden sollen.
(Benötigt Druckerspooler Erweiterungsmodul)
|-
| frachtfuehrerTyp || [[#Datentypen|Sequence<String>]] || 255 || - || Hier kann eine Semikolon separierte Liste mit den abzuschließenden Frachführern mitgegeben werden. Es können n-Frachtführer abgeschlossen werden.
(Option MultiFFTagesabschluss muss im HVS32 aktiv sein)
|-
| packplatz || [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Listenabschluss ausführen soll.
|-
| versandartID || [[#Datentypen|Sequence<String>]] || 255 || - || Hier kann eine Semikolon separierte Liste mit den abzuschließenden Versandarten mitgegeben werden. Es können n-Versandarten abgeschlossen werden.
(Option MultiVATagesabschluss muss im HVS32 aktiv sein)
|-
| wechselbruecke|| [[#Datentypen|String]] || 10 || - || Kennzeichen der abzuschließenden Wechselbrücke. Hiermit können nur bestimmte Sendungen abgeschlossen werden.
|}
</div></div>
<br>
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">'''Rückgabe Parameter'''</div>
<div class="mw-collapsible-content">
{| class="wikitable sortable"
|-
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
|-
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
|-
| [[#edistatus|edistatus]] || [[#Datentypen|Sequence]] '''[[#Sequence|<EDIStatus>]]''' || - || - || -
|-
| fehlercode || [[#Datentypen|Integer]] || - || - || 0 = Erfolgreich
|-
| fehlertext1 || [[#Datentypen|String]] || 200 || - || -
|-
| fehlertext2 || [[#Datentypen|String]] || 200 || - || -
|-
| listenDaten || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Name und Binärdaten der Listen als Key/Value Map.
|-
| etikettenDaten || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Name und Binärdaten der Etiketten als Key/Value Map.
|-
| ausgangsListeNr|| [[#Datentypen|Sequence<String>]] || - || - || Ausgangslisten-Nummer(n) der erzeugten Ausgangsliste(n).
|}
</div></div>
<br>
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">'''Beispiele'''</div>
<div class="mw-collapsible-content">
;Request
<source lang="json">
{
	"auftraggeberID": [
		""
	],
	"assoc": {
		"":""
	},
	"druckername": "",
	"frachtfuehrerTyp": [
		""
	],
	"packplatz": "",
	"versandartID": [
		""
	],
	"wechselbruecke": ""
}
</source>
;Response
<source lang="json">
{
	"assoc": {
		"":""
	},
	"fehlercode": 0,
	"fehlertext1": "",
	"edistatus": [
		{
			"fehlercode": 0,
			"statuscode": "",
			"statustext": "",
			"fftyp": "",
			"dateityp": "",
			"auftraggeber": "",
			"ffdateinr": ""
		}
	],
	"listenDaten": {},
	"ausgangsListeNr": [
		"75"
	]
}
</source>
</div></div>
<!-- ------------------------------------------------------------------------------- ENDE tagesabschluss ------------------------------------------------------------------------------- -->
<!-- ------------------------------------------------------------------------------- listenabschlussAnfrage ------------------------------------------------------------------------------- -->

== Ausgangsliste erzeugen (listenabschlussAnfrage) ==
Das Gateway sendet die listenabschlussAnfrage an das Automatik-Polling des HVS32. Im HVS32 wird somit eine Ausgangsliste anhand der zusätzlich übergebenen Parameter erzeugt. Nur Packstücke, welche für den Ausgang freigegeben wurden, werden für den Listenabschluss berücksichtigt. Standardmäßig sind alle Packstücke freigegeben, außer sie wurden durch das Erweiterungsmodul Ausgangsscannung gesperrt. Die Rückmeldung im HVS32 findet nach dem Erzeugen der Ausgangsliste statt. Es stehen keine Packstück-/Sendungs-Daten für die Rückmeldung zur Verfügung. Nach erfolgreichem Listenabschluss wird lediglich das Feld Fehler mit Wert 0 zurückgemeldet - bzw. im Fehlerfall wird Fehler mit dem Wert 1 sowie der Fehlertext1 zurückgemeldet.
<br>
{| class="wikitable"
|-
|'''Funktion (POST) || /hvs32rest/listenabschlussAnfrage'''
|-
| '''MediaType || application/json; text/plain'''<br>
|-
| '''Charset || UTF-8'''<br>
|}
<br>
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">'''Übergabe Parameter'''</div>
<div class="mw-collapsible-content">
<small>'''Fett''' dargestellte Felder müssen IMMER belegt sein</small>
{| class="wikitable sortable"
|-
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
|-
| auftraggeberID || [[#Datentypen|String]] || 255 || - || Hier kann eine Semikolon separierte Liste mit den abzuschließenden Auftraggebern mitgegeben werden. Es können n-Auftraggeber abgeschlossen werden.
(Option MultiAGTagesabschluss muss im HVS32 aktiv sein)
|-
| druckername || [[#Datentypen|String]] || 30 || - || Name eines Ausgabekanals (Drucker) im HVS32 über den die Listen gedruckt werden sollen.
(Benötigt Druckerspooler Erweiterungsmodul)
|-
| frachtfuehrerTyp || [[#Datentypen|String]] || 255 || - || Hier kann eine Semikolon separierte Liste mit den abzuschließenden Frachführern mitgegeben werden. Es können n-Frachtführer abgeschlossen werden.
(Option MultiFFTagesabschluss muss im HVS32 aktiv sein)
|-
| packplatz || [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Listenabschluss ausführen soll.
|-
| versandartID || [[#Datentypen|String]] || 255 || - || Hier kann eine Semikolon separierte Liste mit den abzuschließenden Versandarten mitgegeben werden. Es können n-Versandarten abgeschlossen werden.
(Option MultiVATagesabschluss muss im HVS32 aktiv sein)
|-
| wechselbruecke|| [[#Datentypen|String]] || 10 || - || Kennzeichen der abzuschließenden Wechselbrücke. Hiermit können nur bestimmte Sendungen abgeschlossen werden.
|}
</div></div>
<br>
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">'''Rückgabe Parameter'''</div>
<div class="mw-collapsible-content">
{| class="wikitable sortable"
|-
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
|-
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
|-
| fehlercode || [[#Datentypen|Integer]] || - || - || 0 = Erfolgreich
|-
| fehlertext1 || [[#Datentypen|String]] || 200 || - || -
|-
| fehlertext2 || [[#Datentypen|String]] || 200 || - || -
|-
| listenDaten || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Name und Binärdaten der Listen als Key/Value Map.
|-
| etikettenDaten || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Name und Binärdaten der Etiketten als Key/Value Map.
|-
| ausgangsListeNr|| [[#Datentypen|Sequence<String>]] || - || - || Ausgangslisten-Nummer(n) der erzeugten Ausgangsliste(n).
|}
</div></div>
<br>
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">'''Beispiele'''</div>
<div class="mw-collapsible-content">
;Request
<source lang="json">
{
	"auftraggeberID": [
		""
	],
	"druckername": "",
	"frachtfuehrerTyp": [
		""
	],
	"packplatz": "",
	"versandartID": [
		""
	],
	"wechselbruecke": ""
}
</source>
;Response
<source lang="json">
{
	"assoc": {
		"":""
	},
	"fehlercode": 0,
	"fehlertext1": "",
	"listenDaten": {
		"": ""
	},
	"ausgangsListeNr": [
		"75"
	]
}
</source>
</div></div>
<!-- ------------------------------------------------------------------------------- ENDE Listenabschluss ------------------------------------------------------------------------------- -->
<!-- ------------------------------------------------------------------------------- ListenNachdruck------------------------------------------------------------------------------- -->

== Ausgangsliste nachdrucken (listenNachdruckAnfrage) ==
Das Gateway sendet die listenNachdruckAnfrage an das Automatik-Polling des HVS32. Im HVS32 wird somit eine bereits erstellte Ausgangsliste anhand der übergebenen ausgangsListeNr anchgedruckt. Eine Liste kann nur nachgedruckt werden, wenn diese bereits über die Funktionen tagesabschluss, listenabschlussAnfrage oder manuell über die HVS32 Maske erzeugt wurde. Es stehen keine Packstück-/Sendungs-Daten für die Rückmeldung zur Verfügung. Nach erfolgreichem Listenabschluss wird lediglich das Feld Fehler mit Wert 0 zurückgemeldet - bzw. im Fehlerfall wird Fehler mit dem Wert 1 sowie der Fehlertext1 zurückgemeldet.
<br>
{| class="wikitable"
|-
|'''Funktion (POST) || /hvs32rest/listenNachdruckAnfrage'''
|-
| '''MediaType || application/json; text/plain'''<br>
|-
| '''Charset || UTF-8'''<br>
|}
<br>
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">'''Übergabe Parameter'''</div>
<div class="mw-collapsible-content">
<small>'''Fett''' dargestellte Felder müssen IMMER belegt sein</small>
{| class="wikitable sortable"
|-
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
|-
| ausgangsListeNr || [[#Datentypen|Sequence<String>]] || - || - || Liste der Ausgangslisten-Nr. der Listen, die nachgedruckt werden sollen.
|-
| druckername || [[#Datentypen|String]] || 30 || - || Name eines Ausgabekanals (Drucker) im HVS32 über den die Listen gedruckt werden sollen.
(Benötigt Druckerspooler Erweiterungsmodul)
|-
| auftraggeberID || [[#Datentypen|Sequence<String>]] || - || - || Liste der Auftraggerber-ID's, für welche die Listen nachgedruckt werden sollen.
|-
| frachtFuehrerTyp || [[#Datentypen|Sequence<String>]] || - || - || Liste der Frachtführertypen, für welche die Listen nachgedruckt werden sollen.
|-
| erstellDatum || [[#Datentypen|String]] || 10 || - || Erstelldatum der Ausgangslisten, die nachgedruckt werden sollen. Im Format "dd.mm.yyyy", z.B. 01.01.2001
|-
| druckDatum || [[#Datentypen|String]] || 10 || - || Druckdatum der Ausgangslisten, die nachgedruckt werden sollen. Im Format "dd.mm.yyyy", z.B. 01.01.2001 oder null wenn nur Listen nachgedruckt werden sollen, die noch nicht gedruckt wurden
|}
</div></div>
<br>
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">'''Rückgabe Parameter'''</div>
<div class="mw-collapsible-content">
{| class="wikitable sortable"
|-
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
|-
| ausgangsListeNr || [[#Datentypen|Sequence<String>]] || - || - || Liste der Ausgangslisten-Nr. der Listen, die nachgedruckt wurden.
|-
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
|-
| fehlercode || [[#Datentypen|Integer]] || - || - || 0 = Erfolgreich
|-
| fehlertext1 || [[#Datentypen|String]] || 200 || - || -
|-
| fehlertext2 || [[#Datentypen|String]] || 200 || - || -
|-
| listenDaten || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Name und Binärdaten der Listen als Key/Value Map.
|-
| etikettenDaten || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Name und Binärdaten der Etiketten als Key/Value Map.
|}
</div></div>
<br>
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">'''Beispiele'''</div>
<div class="mw-collapsible-content">
;Request
<source lang="json">
{
	"ausgangsListeNr": [
		"77"
	],
	"druckername": "",
	"auftraggeberID": [], 
	"frachtFuehrerTyp": [], 
	"erstellDatum": "", 
	"druckDatum": ""
}
</source>
;Response
<source lang="json">
{
	"ausgangsListeNr": [
		"77"
	]
	"assoc": {
		"":""
	},
	"fehlercode": 0,
	"fehlertext1": "",
	"listenDaten": {
		"": ""
	}
}
</source>
</div></div>
<!-- ------------------------------------------------------------------------------- ENDE ListenNachdruck ------------------------------------------------------------------------------- -->
<!-- ------------------------------------------------------------------------------- ediabschlussAnfrage ------------------------------------------------------------------------------- -->

== Frachtführer DFÜ erzeugen (ediabschlussAnfrage) ==
Das Gateway sendet die ediabschlussAnfrage an das Automatik-Polling des HVS32. Im HVS32 wird somit eine Frachtführer DFÜ anhand der zusätzlich übergebenen Parameter erzeugt und (falls konfiguriert) an den Frachtführer übertragen. Nur Packstücke, für welche zuvor eine Ausgangsliste erzeugt wurde, werden für eine Frachtführer DFÜ berücksichtigt. Die Rückmeldung im HVS32 findet nach dem Erzeugen der Frachtführer DFÜ statt. Es stehen keine Packstück-/Sendungs-Daten für die Rückmeldung zur Verfügung. Nach erfolgreichem EDIAbschluss wird lediglich das Feld Fehler mit Wert 0 zurückgemeldet - bzw. im Fehlerfall wird Fehler mit dem Wert 1 sowie der Fehlertext1 zurückgemeldet.
<br>
{| class="wikitable"
|-
|'''Funktion (POST) || /hvs32rest/ediabschlussAnfrage'''
|-
| '''MediaType || application/json; text/plain'''<br>
|-
| '''Charset || UTF-8'''<br>
|}
<br>
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">'''Übergabe Parameter'''</div>
<div class="mw-collapsible-content">
<small>'''Fett''' dargestellte Felder müssen IMMER belegt sein</small>
{| class="wikitable sortable"
|-
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
|-
| auftraggeberID || [[#Datentypen|Sequence]] [[#Datentypen|<String>]] || 255 || - || Hier kann eine Semikolon separierte Liste mit den abzuschließenden Auftraggebern mitgegeben werden. Es können n-Auftraggeber abgeschlossen werden.
(Option MultiAGTagesabschluss muss im HVS32 aktiv sein)
|-
| druckername || [[#Datentypen|String]] || 30 || - || Name eines Ausgabekanals (Drucker) im HVS32 über den z.B. die UPS Summary gedruckt wird.<br>
(Benötigt Druckerspooler Erweiterungsmodul)
|-
| frachtfuehrerTyp || [[#Datentypen|Sequence]] [[#Datentypen|<String>]] || 255 || - || Hier kann eine Semikolon separierte Liste mit den abzuschließenden Frachführern mitgegeben werden. Es können n-Frachtführer abgeschlossen werden.
(Option MultiFFTagesabschluss muss im HVS32 aktiv sein)
|-
| packplatz || [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Tagesabschluss ausführen soll.
|-
| versandartID || [[#Datentypen|Sequence]] [[#Datentypen|<String>]] || 255 || - || Hier kann eine Semikolon separierte Liste mit den abzuschließenden Versandarten mitgegeben werden. Es können n-Versandarten abgeschlossen werden.
(Option MultiVATagesabschluss muss im HVS32 aktiv sein)
|-
| wechselbruecke|| [[#Datentypen|String]] || 10 || - || Kennzeichen der abzuschließenden Wechselbrücke. Hiermit können nur bestimmte Sendungen abgeschlossen werden.
|}
</div></div>
<br>
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">'''Rückgabe Parameter'''</div>
<div class="mw-collapsible-content">
{| class="wikitable sortable"
|-
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
|-
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
|-
| [[#edistatus|edistatus]] || [[#Datentypen|Sequence]] [[#edistatus|<EDIStatus>]] || - || - || Liste mit Statusinformationen für EDIs.
|-
| fehlercode || [[#Datentypen|Integer]] || - || - || 0 = Erfolgreich
|-
| fehlertext1 || [[#Datentypen|String]] || 200 || - || -
|-
| listenDaten || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Name und Binärdaten der EDI-Listen (z.B. UPS Summary) als Key/Value Map.
|}
</div></div>
<br>
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">'''Beispiele'''</div>
<div class="mw-collapsible-content">
;Request
<source lang="json">
{
	"auftraggeberID": [
		""
	],
	"druckername": "",
	"frachtfuehrerTyp": [
		""
	],
	"packplatz": "",
	"versandartID": [
		""
	],
	"wechselbruecke": ""
}
</source>
;Response
<source lang="json">
{
	"assoc": {
		"":""
	},
	"fehlercode": 0,
	"fehlertext1": "",
	"edistatus": [
		{
			"fehlercode": 0,
			"statuscode": "",
			"statustext": "",
			"fftyp": "",
			"dateityp": "",
			"auftraggeber": "",
			"ffdateinr": ""
		}
	],
	"listenDaten": {}
}
</source>
</div></div>
<!-- ------------------------------------------------------------------------------- ENDE ediabschlussAnfrage ------------------------------------------------------------------------------- -->
<!-- ------------------------------------------------------------------------------- versanddatenPruefAnfrage ------------------------------------------------------------------------------- -->

== Packstückdaten prüfen (versanddatenPruefAnfrage) ==
Das Gateway sendet die versanddatenPruefAnfrage an das Automatik-Polling des HVS32. Im HVS32 wird somit eine VersandDatenAnfrage simuliert. Dabei werden keine Etiketten gedruckt und das Packstück bzw. das Etikett wird nicht verbucht, jedoch sind alle weiteren Prozesse identisch zur VersandDatenAnfrage (Routenermittlung, Trackingnummer-Ermittlung, Adressprüfung, etc.) Diese Funktion dient dazu im Vorfeld alle Versand-Daten zu validieren.
<br>
{| class="wikitable"
|-
|'''Funktion (POST) || /hvs32rest/versanddatenPruefAnfrage'''
|-
| '''MediaType || application/json; text/plain'''<br>
|-
| '''Charset || UTF-8'''<br>
|}
<br>
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">'''Übergabe Parameter'''</div>
<div class="mw-collapsible-content">
<small>'''Fett''' dargestellte Felder müssen IMMER belegt sein</small>
{| class="wikitable sortable"
|-
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
|-
| ansprechpartner || [[#Datentypen|String]] || 20 || - || Empfänger Ansprechpartner
|-
| [[#artikelDaten|artikelDaten]] || [[#Datentypen|Sequence]] '''[[#artikelDaten|<ArtikelDaten>]]''' || - || - || Eine Liste der [[#artikelDaten|Packstück-Artikel]] vom Typ '''[[#artikelDaten|ArtikelDaten]]''' (1:n)
|-
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
|-
| auftragNr || [[#Datentypen|String]] || 20 || - || -
|-
| '''auftraggeberID''' || [[#Datentypen|String]] || 10 || - || Mandantenkennung aus dem HVS32
|-
| avisHinweis1 || [[#Datentypen|String]] || 100 || - || -
|-
| avisHinweis2 || [[#Datentypen|String]] || 100 || - || -
|-
| avisZusatz1 || [[#Datentypen|String]] || 60 || - || Zusatz zu Fest-AVIS-Schlüssel 1
|-
| avisZusatz2 || [[#Datentypen|String]] || 60 || - || Zusatz zu Fest-AVIS-Schlüssel 2
|-
| bestellNr || [[#Datentypen|String]] || 20 || - || Metro-Bestellnr (Metro-Versand)
|-
| druckername || [[#Datentypen|String]] || 30 || - || Name eines Ausgabekanals (Drucker) im HVS32 über den das Etikett gedruckt wird. (Benötigt Druckerspooler Erweiterungsmodul)
|-
| email || [[#Datentypen|String]] || 100 || - || E-Mail Adresse des Empfängers (z.B.: für die Automatische E-Mail Avisierung)
|-
| faxNr || [[#Datentypen|String]] || 20 || - || Faxnummer des Empfängers
|-
| flexZustellungEmailadresse || [[#Datentypen|String]] || 80 || - || Flex-Zustellung Emailadresse
|-
| frachtBrief || [[#Datentypen|String]] || 20 || - || Frachtbrief Nummer falls Frachtbrief durch Vorsystem gedruckt werden soll
|-
| frachtfuehrerKdNr || [[#Datentypen|String]] || 10 || - || Kundennummer des Frachtzahlers beim Frachtführer
|-
| frankaturKennung || [[#Datentypen|String]] || 10 || - || -
|-
| [[#gefahrgut|gefahrgut]] || [[#Datentypen|Sequence]] '''[[#gefahrgut|<Gefahrgut>]]''' || - || - || Eine Liste der [[#gefahrgut|Gefahrgüter]] vom Typ '''[[#gefahrgut|Gefahrgut]]''' (1:n)
|-
| '''gewicht''' ||[[#Datentypen|Decimal]] || 8 || 3 || Bruttogewicht in KG
|-
| ilnNr || [[#Datentypen|String]] || 20 || - || ILN des Empfängers (Pflicht bei Metro-Versand)
|-
| infotext1 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
|-
| infotext2 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
|-
| infotext3 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
|-
| infotext4 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
|-
| infotext5 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
|-
| infotext6 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
|-
| infotext7 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
|-
| infotext8 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
|-
| infotext9 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
|-
| infotext10 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
|-
| kostenstelle || [[#Datentypen|String]] || 30 || - || -
|-
| kundenNr || [[#Datentypen|String]] || 20 || - || Kundennummer des Empfängers beim Versender
|-
| lieferscheinNr || [[#Datentypen|String]] || 40 || - || Wird im HVS32 als Such-Nummer verwendet
|-
| nachnahme || [[#Datentypen|Decimal]] || 18 || 2 || -
|-
| nettoGewicht || [[#Datentypen|Decimal]] || 8 || 3 || Nettogewicht in KG
|-
| neutabsenderLKZ || [[#Datentypen|String]] || 3 || - || Nur bei Neutral-Absendern belegt
|-
| neutabsenderName1 || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
|-
| neutabsenderName2 || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
|-
| neutabsenderName3 || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
|-
| neutabsenderOrt || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
|-
| neutabsenderPLZ || [[#Datentypen|String]] || 10 || - || Nur bei Neutral-Absendern belegt
|-
| neutabsenderStrasse || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
|-
| nnVermerk || [[#Datentypen|String]] || 1 || - || B': Bar / 'V': Verrechnungsscheck
|-
| nnVerwendung || [[#Datentypen|String]] || 30 || - || Nachnahme Verwendungszweck
|-
| nnWaehrung || [[#Datentypen|String]] || 3 || - || Nachnahme - ISO-Währungscode
|-
| '''packStkGes''' || [[#Datentypen|Integer]] || - || - || Gesamt-Anzahl Colli der Sendung
|-
| '''packStkNr''' || [[#Datentypen|Integer]] || - || - || Laufende Nr pro Sendung
|-
| packplatz || [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Auftrag verarbeten soll.
|-
| packstueckBreite || [[#Datentypen|Integer]] || - || - || Breite in cm
|-
| packstueckHoehe || [[#Datentypen|Integer]] || - || - || Höhe in cm
|-
| packstueckID || [[#Datentypen|String]] || 20 || - || Eindeutige Nummer für das Paket im Vorsystem. Wird als eindeutige Paketreferenz benötigt um das Etikett später zu stornieren oder zu Verladen.
|-
| packstueckLaenge || [[#Datentypen|Integer]] || - || - || Länge in cm
|-
| paperlessInvoice || [[#Datentypen|String]] || 1 || - || Nur im UPS PaperlessInvoice Fall (T=PaperlessInvoice / F=nicht PaperlessInvoice)
|-
| postLeitcode || [[#Datentypen|String]] || 15 || - || -
|-
| postZielFrachtzent || [[#Datentypen|String]] || 5 || - || -
|-
| rechnungsEmpfLKZ || [[#Datentypen|String]] || 5 || - || Rechnungsadresse
|-
| rechnungsEmpfName1 || [[#Datentypen|String]] || 50 || - || Rechnungsempfänger
|-
| rechnungsEmpfName2 || [[#Datentypen|String]] || 50 || - || Rechnungsempfänger
|-
| rechnungsEmpfName3 || [[#Datentypen|String]] || 50 || - || Rechnungsempfänger
|-
| rechnungsEmpfOrt || [[#Datentypen|String]] || 50 || - || Rechnungsadresse
|-
| rechnungsEmpfPLZ || [[#Datentypen|String]] || 10 || - || Rechnungsadresse
|-
| rechnungsEmpfStrasse || [[#Datentypen|String]] || 50 || - || Rechnungsadresse
|-
| rechnungsNr || [[#Datentypen|String]] || 20 || - || Rechnungsnummer
|-
| sonderdienste || [[#Datentypen|String]] || 30 || - || Versandart-spezifisch belegt
|-
| telefonNr || [[#Datentypen|String]] || 20 || - || Telefonnummer des Empfängers
|-
| terminArt || [[#Datentypen|String]] || 1 || - || 'A'b / 'B'is / 'F'ix
|-
| terminDatum || [[#Datentypen|String]] || 10 || - || TT.MM.JJJJ
|-
| terminZeit || [[#Datentypen|Calendar]] || 5 || - || HH:MM
|-
| ustIDNr || [[#Datentypen|String]] || 20 || - || UmsatzsteuerNr des Empfängers
|-
| verpackungsart || [[#Datentypen|String]] || 6 || - || -
|-
| '''versandartID''' || [[#Datentypen|String]] || 10 || - || Versandartkennung aus dem HVS32
|-
| versicherungswert || [[#Datentypen|Decimal]] || 18 || 2 || Höhe Versicherungswert
|-
| vwWaehrung || [[#Datentypen|String]] || 3 || - || Versicherungswert - ISO-Währungscode
|-
| warenwert || [[#Datentypen|Decimal]] || 18 || 2 || -
|-
| wwWaehrung || [[#Datentypen|String]] || 3 || - || Warenwert - ISO-Währungscode
|-
| zahlungsbedingung || [[#Datentypen|String]] || 10 || - || 'S' = Sender, 'R' = Empfänger
|-
| zbZoll || [[#Datentypen|String]] || 1 || - || Zahlungsbedingung für Zoll Steuern 'S' = Sender, 'R' = Empfänger
|-
| zielAdrBahnhof || [[#Datentypen|String]] || 30 || - || PLZ und Ort
|-
| '''zielAdrLKZ''' || [[#Datentypen|String]] || 5 || - || Lieferadresse
|-
| '''zielAdrName1''' || [[#Datentypen|String]] || 50 || - || Lieferadresse
|-
| zielAdrName2 || [[#Datentypen|String]] || 50 || - || Lieferadresse
|-
| zielAdrName3 || [[#Datentypen|String]] || 50 || - || Lieferadresse
|-
| zielAdrName4 || [[#Datentypen|String]] || 50 || - || Lieferadresse
|-
| '''zielAdrOrt''' || [[#Datentypen|String]] || 50 || - || Lieferadresse
|-
| '''zielAdrPLZ''' || [[#Datentypen|String]] || 10 || - || Lieferadresse
|-
| zielAdrRegion || [[#Datentypen|String]] || 20 || - || Staat/Provinz (z.B.: für Sendungen in die USA wichtig)
|-
| '''zielAdrStrasse''' || [[#Datentypen|String]] || 50 || - || Lieferadresse
|}
</div></div>
<br>
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">'''Rückgabe Parameter'''</div>
<div class="mw-collapsible-content">
{| class="wikitable sortable"
|-
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung|-
|-
| druckDateTime || [[#Datentypen|Calendar]] || 19 || - || Datum (Monat ist 0-basierend), wann das Etikett im HVS32 gedruckt worden ist
|-
| druckDateTimeString || [[#Datentypen|String]] || 19 || - || Datum, wann das Etikett im HVS32 gedruckt worden ist (TT.MM.JJJJ HH:mm:SS)
|-
| fehlertext1 || [[#Datentypen|String]] || 200 || - || -
|-
| fehlertext2 || [[#Datentypen|String]] || 200 || - || -
|}
</div></div>
<br>
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">'''Beispiele'''</div>
<div class="mw-collapsible-content">
;Request
<source lang="json">
{
	"ansprechpartner": "",
	"artikelDaten": [
		{
			"anzahlBuegel": 0,
			"anzahlPosEtiketten": 0,
			"artikelBTNNr": "",
			"artikelEAN": "",
			"artikelEinheit": "",
			"artikelGewicht": 0,
			"artikelGruppe": "",
			"artikelMenge": 0,
			"artikelServices": "",
			"artikelSollMenge": 0,
			"artikelText1": "",
			"artikelText2": "",
			"artikelText3": "",
			"artikelText4": "",
			"artikelVolumen": 0,
			"artikelWaehrung": "",
			"artikelWert": 0,
			"chargeFlag": "",
			"kundenArtikelNr": "",
			"kundenBestellNr": "",
			"posAuftragNr": "",
			"posLieferNr": "",
			"positionNr": "",
			"serienNr": "",
			"ursprungLand": ""
		}
	],
	"auftragNr": "",
	"auftraggeberID": "",
	"avisHinweis1": "",
	"avisHinweis2": "",
	"avisZusatz1": "",
	"avisZusatz2": "",
	"bestellNr": "",
	"druckername": "",
	"email": "",
	"faxNr": "",
	"frachtBrief": "",
	"frachtfuehrerKdNr": "",
	"frankaturKennung": "",
	"gefahrgut": [
		{
			"gefahrgutBefoerdKat": 0,
			"gefahrgutBegrenzteMenge": "",
			"gefahrgutBezeichnung": "",
			"gefahrgutBuchst640": "",
			"gefahrgutFFCode": "",
			"gefahrgutFaktor": 0,
			"gefahrgutFreigestMenge": "",
			"gefahrgutKCode": "",
			"gefahrgutKlasse": "",
			"gefahrgutMenge": 0,
			"gefahrgutMengenEinheit": "",
			"gefahrgutNebenGefahr": "",
			"gefahrgutNettoExplMasse": 0,
			"gefahrgutTunnelBCode": "",
			"gefahrgutUNNR": "",
			"gefahrgutUmweltGef": "",
			"gefahrgutVPG": "",
			"gefahrgutVerpAnzahl": 0,
			"gefahrgutVerpackungsart": ""
		}
	],
	"gewicht": 0,
	"ilnNr": "",
	"infotext1": "",
	"infotext2": "",
	"infotext3": "",
	"infotext4": "",
	"infotext5": "",
	"infotext6": "",
	"infotext7": "",
	"infotext8": "",
	"infotext9": "",
	"infotext10": "",
	"kostenstelle": "",
	"kundenNr": "",
	"lieferscheinNr": "",
	"nachnahme": 0,
	"nettoGewicht": 0,
	"neutabsenderLKZ": "",
	"neutabsenderName1": "",
	"neutabsenderName2": "",
	"neutabsenderName3": "",
	"neutabsenderOrt": "",
	"neutabsenderPLZ": "",
	"neutabsenderStrasse": "",
	"nnVermerk": "",
	"nnVerwendung": "",
	"nnWaehrung": "",
	"packStkGes": 0,
	"packStkNr": 0,
	"packplatz": "",
	"packstueckBreite": 0,
	"packstueckHoehe": 0,
	"packstueckID": "",
	"packstueckLaenge": 0,
	"paperlessInvoice": "",
	"postLeitcode": "",
	"postZielFrachtzent": "",
	"rechnungsEmpfLKZ": "",
	"rechnungsEmpfName1": "",
	"rechnungsEmpfName2": "",
	"rechnungsEmpfName3": "",
	"rechnungsEmpfOrt": "",
	"rechnungsEmpfPLZ": "",
	"rechnungsEmpfStrasse": "",
	"sendungsinhalt": "",
	"sonderdienste": "",
	"telefonNr": "",
	"terminArt": "",
	"terminDatum": "",
	"terminZeit": "",
	"ustIDNr": "",
	"verpackungsart": "",
	"versandartID": "",
	"versicherungswert": 0,
	"vwWaehrung": "",
	"warenwert": 0,
	"wwWaehrung": "",
	"zahlungsbedingung": "",
	"zbZoll": "",
	"zielAdrBahnhof": "",
	"zielAdrLKZ": "",
	"zielAdrName1": "",
	"zielAdrName2": "",
	"zielAdrName3": "",
	"zielAdrOrt": "",
	"zielAdrPLZ": "",
	"zielAdrRegion": "",
	"zielAdrStrasse": ""
}
</source>
;Response
<source lang="json">
{
	"druckDateTime": {
		"year": 2023,
		"month": 0,
		"dayOfMonth": 25,
		"hourOfDay": 8,
		"minute": 59,
		"second": 22
	},
	"druckDateTimeString": "25.01.2023 08:59:22",
	"fehlertext1": "",
	"fehlertext2": ""
}
</source>
</div></div>
<!-- ------------------------------------------------------------------------------- ENDE versanddatenPruefAnfrage ------------------------------------------------------------------------------- -->
<!-- ------------------------------------------------------------------------------- updateVersanddaten ------------------------------------------------------------------------------- -->

== Packstückdaten aktualisieren (updateVersanddaten) ==
Die Gatewayfunktion updateVersanddaten wird vom Data-Gateway-Server im Automatik-Polling Modus an das HVS32 gesendet, um dort die Daten von bestehende Packstücken zu verändern. Diese Anfrage wird zum Beispiel gesendet, wenn der Warenwert für ein Packstück erst zu einem späteren Zeitpunkt bekannt ist. Aktualisiert werden können Daten innerhalb der Tabellen Versandeinheit, Abrechnungseinheit und Lieferung. Dabei wird stets über das Feld PackstueckID und bei Belegung auch über das Feld TrackingNr gesucht.<br><br>
'''Bei dieser Anfrage werden allerdings die zu aktualisierenden Felder und Inhalte nicht mehr nach den Richtlinien des Frachtführers geprüft (z.B. Gewichtsgrenzen, etc.). Es muss somit vom Vorsystem sichergestellt werden, dass die aktualisierenden Werte mit den Richtlinien des Frachtführers übereinstimmen. Sollte dies nicht möglich sein, kann diese Funktion nicht genutzt werden, sondern das Etikett muss storniert und neu verarbeitet werden. Außerdem können Felder, welche bereits auf einem Etikett angedruckt oder vom Versandsystem HVS32 in einer Frachtführerabwicklung ermittelt wurden (z.B. Adresse, Route, TrackingNr, Sonderdienste, etc.) nicht manipuliert werden.'''<br><br>

'''ACHTUNG: Alle Felder, welche im Versandsystem aktualisiert werden sollen, müssen vor der Nutzung dieser Funktion abgestimmt und im Versandsystem entsprechend konfiguriert werden!'''<br><br>

Es stehen keine Packstück-/Sendungs-Daten für die Rückmeldung zur Verfügung. Nach erfolgreichem Update wird lediglich das Feld Fehler mit Wert 0 zurückgemeldet - bzw. im Fehlerfall wird Fehler mit dem Wert 1 sowie der Fehlertext1 zurückgemeldet.
<br>
{| class="wikitable"
|-
|'''Funktion (POST) || /hvs32rest/updateVersanddaten'''
|-
| '''MediaType || application/json; text/plain'''<br>
|-
| '''Charset || UTF-8'''<br>
|}
<br>
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">'''Übergabe Parameter'''</div>
<div class="mw-collapsible-content">
<small>'''Fett''' dargestellte Felder müssen IMMER belegt sein</small>
{| class="wikitable sortable"
|-
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
|-
| ansprechpartner || [[#Datentypen|String]] || 20 || - || Empfänger Ansprechpartner
|-
| anzahlArtikel || [[#Datentypen|Integer]] || 6 || - || Anzahl Artikel (Druck auf Etikett)
|-
| [[#artikelDaten|artikelDaten]] || [[#Datentypen|Sequence]] '''[[#artikelDaten|<ArtikelDaten>]]''' || - || - || Eine Liste der [[#artikelDaten|Packstück-Artikel]] vom Typ '''[[#artikelDaten|ArtikelDaten]]''' (1:n)
|-
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
|-
| auftragNr || [[#Datentypen|String]] || 20 || - || -
|-
| '''auftraggeberID''' || [[#Datentypen|String]] || 10 || - || Mandantenkennung aus dem HVS32
|-
| avisHinweis1 || [[#Datentypen|String]] || 100 || - || -
|-
| avisHinweis2 || [[#Datentypen|String]] || 100 || - || -
|-
| avisZusatz1 || [[#Datentypen|String]] || 60 || - || Zusatz zu Fest-AVIS-Schlüssel 1
|-
| avisZusatz2 || [[#Datentypen|String]] || 60 || - || Zusatz zu Fest-AVIS-Schlüssel 2
|-
| barcodeID || [[#Datentypen|String]] || - || - || Zusatzfeld für evtl. Erweiterungen
|-
| barcodeText || [[#Datentypen|String]] || - || - || Zusatzfeld für evtl. Erweiterungen
|-
| barcodeTyp || [[#Datentypen|String]] || - || - || Zusatzfeld für evtl. Erweiterungen
|-
| bestellNr || [[#Datentypen|String]] || 20 || - || Metro-Bestellnr (Metro-Versand)
|-
| druckername || [[#Datentypen|String]] || 30 || - || Name eines Ausgabekanals (Drucker) im HVS32 über den das Etikett gedruckt wird. (Benötigt Druckerspooler Erweiterungsmodul)
|-
| email || [[#Datentypen|String]] || 100 || - || E-Mail Adresse des Empfängers (z.B.: für die Automatische E-Mail Avisierung)
|-
| empfMobilfunkNr || [[#Datentypen|String]] || 20 || - || Mobilfunknummer des Empfängers
|-
| faxNr || [[#Datentypen|String]] || 20 || - || Faxnummer des Empfängers
|-
| flexZustellungEmailadresse || [[#Datentypen|String]] || 80 || - || Flex-Zustellung Emailadresse
|-
| frachtBrief || [[#Datentypen|String]] || 20 || - || Frachtbrief Nummer falls Frachtbrief durch Vorsystem gedruckt werden soll
|-
| frachtfuehrerKdNr || [[#Datentypen|String]] || 10 || - || Kundennummer des Frachtzahlers beim Frachtführer
|-
| frankaturKennung || [[#Datentypen|String]] || 10 || - || -
|-
| freiAvis1 || [[#Datentypen|String]] || 100 || - || -
|-
| freiAvis2 || [[#Datentypen|String]] || 100 || - || -
|-
| [[#gefahrgut|gefahrgut]] || [[#Datentypen|Sequence]] '''[[#gefahrgut|<Gefahrgut>]]''' || - || - || Eine Liste der [[#gefahrgut|Gefahrgüter]] vom Typ '''[[#gefahrgut|Gefahrgut]]''' (1:n)
|-
| gewicht || [[#Datentypen|Decimal]] || 8 || 3 || Bruttogewicht in KG
|-
| hostTrackingNr || [[#Datentypen|String]] || 35 || - || Paketnummer aus dem Hostsystem
|-
| ilnNr || [[#Datentypen|String]] || 20 || - || ILN des Empfängers (Pflicht bei Metro-Versand)
|-
| infotext1 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
|-
| infotext2 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
|-
| infotext3 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
|-
| infotext4 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
|-
| infotext5 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
|-
| infotext6 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
|-
| infotext7 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
|-
| infotext8 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
|-
| infotext9 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
|-
| infotext10 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
|-
| kostenstelle || [[#Datentypen|String]] || 30 || - || -
|-
| kundenNr || [[#Datentypen|String]] || 20 || - || Kundennummer des Empfängers beim Versender
|-
| lagerkennzeichen || [[#Datentypen|Integer]] || - || - || -
|-
| letztesPackstueck || [[#Datentypen|String]] || 1 || - || T/F: T=letztes Packstüeck der Sendung (wird bei Hängeversand zum Drucken der Sendungs-Hängekarte benötigt)
|-
| lieferantenID || [[#Datentypen|Integer]] || - || - || -
|-
| '''lieferscheinNr''' || [[#Datentypen|String]] || 40 || - || Wird im HVS32 als Such-Nummer verwendet
|-
| nachnahme || [[#Datentypen|Decimal]] || 18 || 2 || -
|-
| nettoGewicht || [[#Datentypen|Decimal]] || 8 || 3 || Nettogewicht in KG
|-
| neutBIC || [[#Datentypen|String]] || 11 || - || Nur bei Neutral-Absendern belegt
|-
| neutBankBezeichnung || [[#Datentypen|String]] || 40 || - || Nur bei Neutral-Absendern belegt
|-
| neutIBAN || [[#Datentypen|String]] || 31 || - || Nur bei Neutral-Absendern belegt
|-
| neutKontoInhaber || [[#Datentypen|String]] || 40 || - || Nur bei Neutral-Absendern belegt
|-
| neutabsenderLKZ || [[#Datentypen|String]] || 3 || - || Nur bei Neutral-Absendern belegt
|-
| neutabsenderName1 || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
|-
| neutabsenderName2 || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
|-
| neutabsenderName3 || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
|-
| neutabsenderOrt || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
|-
| neutabsenderPLZ || [[#Datentypen|String]] || 10 || - || Nur bei Neutral-Absendern belegt
|-
| neutabsenderStrasse || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
|-
| nnVermerk || [[#Datentypen|String]] || 1 || - || B': Bar / 'V': Verrechnungsscheck
|-
| nnVerwendung || [[#Datentypen|String]] || 30 || - || Nachnahme Verwendungszweck
|-
| nnWaehrung || [[#Datentypen|String]] || 3 || - || Nachnahme - ISO-Währungscode
|-
| packStkGes || [[#Datentypen|Integer]] || - || - || Gesamt-Anzahl Colli der Sendung
|-
| packStkNr || [[#Datentypen|Integer]] || - || - || Laufende Nr pro Sendung
|-
| packplatz || [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Auftrag verarbeten soll.
|-
| packstueckBreite || [[#Datentypen|Integer]] || - || - || Breite in cm
|-
| packstueckHoehe || [[#Datentypen|Integer]] || - || - || Höhe in cm
|-
| '''packstueckID''' || [[#Datentypen|String]] || 20 || - || Eindeutige Nummer für das Paket im Vorsystem. Wird als eindeutige Paketreferenz benötigt um das Etikett später zu stornieren oder zu Verladen.
|-
| packstueckLaenge || [[#Datentypen|Integer]] || - || - || Länge in cm
|-
| paperlessInvoice || [[#Datentypen|String]] || 1 || - || Nur im UPS PaperlessInvoice Fall (T=PaperlessInvoice / F=nicht PaperlessInvoice)
|-
| postLeitcode || [[#Datentypen|String]] || 15 || - || -
|-
| postZielFrachtzent || [[#Datentypen|String]] || 5 || - || -
|-
| rechnungsEmpfLKZ || [[#Datentypen|String]] || 5 || - || Rechnungsadresse
|-
| rechnungsEmpfName1 || [[#Datentypen|String]] || 50 || - || Rechnungsempfänger
|-
| rechnungsEmpfName2 || [[#Datentypen|String]] || 50 || - || Rechnungsempfänger
|-
| rechnungsEmpfName3 || [[#Datentypen|String]] || 50 || - || Rechnungsempfänger
|-
| rechnungsEmpfOrt || [[#Datentypen|String]] || 50 || - || Rechnungsadresse
|-
| rechnungsEmpfPLZ || [[#Datentypen|String]] || 10 || - || Rechnungsadresse
|-
| rechnungsEmpfStrasse || [[#Datentypen|String]] || 50 || - || Rechnungsadresse
|-
| rechnungsNr || [[#Datentypen|String]] || 20 || - || Rechnungsnummer
|-
| sendungsinhalt || [[#Datentypen|String]] || 30 || - || -
|-
| sonderdienste || [[#Datentypen|String]] || 30 || - || Versandart-spezifisch belegt
|-
| sperrFlag || [[#Datentypen|String]] || 1 || - || T/F: T=Sperren, sonst nicht sperren
|-
| telefonNr || [[#Datentypen|String]] || 20 || - || Telefonnummer des Empfängers
|-
| terminArt || [[#Datentypen|String]] || 1 || - || 'A'b / 'B'is / 'F'ix
|-
| terminDatum || [[#Datentypen|String]] || 10 || - || TT.MM.JJJJ
|-
| terminZeit || [[#Datentypen|Calendar]] || 5 || - || HH:MM
|-
| ustIDNr || [[#Datentypen|String]] || 20 || - || UmsatzsteuerNr des Empfängers
|-
| verpackungsart || [[#Datentypen|String]] || 6 || - || -
|-
| '''versandartID''' || [[#Datentypen|String]] || 10 || - || Versandartkennung aus dem HVS32
|-
| versicherungswert || [[#Datentypen|Decimal]] || 18 || 2 || Höhe Versicherungswert
|-
| vorpackdatum || [[#Datentypen|String]] || 10 || - || TT.MM.JJJJ
|-
| vwWaehrung || [[#Datentypen|String]] || 3 || - || Versicherungswert - ISO-Währungscode
|-
| warenwert || [[#Datentypen|Decimal]] || 18 || 2 || -
|-
| wechselbruecke || [[#Datentypen|String]] || 20 || - || Wechselbrücke, die diesem Packstück zugewiesen wird
|-
| wwWaehrung || [[#Datentypen|String]] || 3 || - || Warenwert - ISO-Währungscode
|-
| zahlungsbedingung || [[#Datentypen|String]] || 10 || - || 'S' = Sender, 'R' = Empfänger
|-
| zbZoll || [[#Datentypen|String]] || 1 || - || Zahlungsbedingung für Zoll Steuern 'S' = Sender, 'R' = Empfänger
|-
| zielAdrBahnhof || [[#Datentypen|String]] || 30 || - || PLZ und Ort
|-
| '''zielAdrLKZ''' || [[#Datentypen|String]] || 5 || - || Lieferadresse
|-
| '''zielAdrName1''' || [[#Datentypen|String]] || 50 || - || Lieferadresse
|-
| zielAdrName2 || [[#Datentypen|String]] || 50 || - || Lieferadresse
|-
| zielAdrName3 || [[#Datentypen|String]] || 50 || - || Lieferadresse
|-
| zielAdrName4 || [[#Datentypen|String]] || 50 || - || Lieferadresse
|-
| '''zielAdrOrt''' || [[#Datentypen|String]] || 50 || - || Lieferadresse
|-
| '''zielAdrPLZ''' || [[#Datentypen|String]] || 10 || - || Lieferadresse
|-
| zielAdrRegion || [[#Datentypen|String]] || 20 || - || Staat/Provinz (z.B.: für Sendungen in die USA wichtig)
|-
| '''zielAdrStrasse''' || [[#Datentypen|String]] || 50 || - || Lieferadresse
|}
</div></div>
<br>
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">'''Rückgabe Parameter'''</div>
<div class="mw-collapsible-content">
{| class="wikitable sortable"
|-
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung|
|-
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
|-
| ausgangDateTime || [[#Datentypen|Calendar]] || 10 || - || Datum (Monat ist 0-basierend), wann das Etikett an den Frachtführer übermittelt worden ist
|-
| ausgangDateTimeString || [[#Datentypen|String]] || 10 || - || Datum, wann das Etikett an den Frachtführer übermittelt worden ist (TT.MM.JJJJ)
|-
| druckDateTime || [[#Datentypen|Calendar]] || 19 || - || Datum (Monat ist 0-basierend), wann das Etikett im HVS32 gedruckt worden ist
|-
| druckDateTimeString || [[#Datentypen|String]] || 19 || - || Datum, wann das Etikett im HVS32 gedruckt worden ist (TT.MM.JJJJ HH:mm:SS)
|-
| etikettDaten || [[#Datentypen|String]] || - || - || Binärdaten des Etiketts
|-
| etikettName || [[#Datentypen|String]] || - || - || Vorlagenname des Etiketts
|-
| fehlercode || [[#Datentypen|Integer]] || - || - || 0 wenn Erfolgreich
|-
| fehlertext1 || [[#Datentypen|String]] || 200 || - || Wird im Fehlerfall befüllt
|-
| fehlertext2 || [[#Datentypen|String]] || 200 || - || Wird im Fehlerfall befüllt
|-
| gebuehr || [[#Datentypen|Decimal]] || 18 || 2 || Frachtkosten
|-
| gebuehrWaehrung || [[#Datentypen|String]] || 3 || - || Frachkosten ISO-Währungscode
|-
| packstueckID || [[#Datentypen|String]] || 20 || - || PackstueckID aus der Anfrage
|-
| retourTrackingNr || [[#Datentypen|String]] || 50 || - || Paketnummer für die Retoure
|-
| trackingNr || [[#Datentypen|String]] || 35 || - || Paketnummer
|-
| trackingURL || [[#Datentypen|String]] || 255 || - || URL des Trackinglinks zur Sendungsverfolgung
|-
| versandSendungsNr || [[#Datentypen|String]] || - || - || -
|-
| zusatzEtikettenDaten || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Name und Binärdaten der Zusatzetiketten als Key/Value Map
|-
| zusatzfeld1 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
|-
| zusatzfeld2 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
|-
| zusatzfeld3 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
|-
| zusatzfeld4 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
|-
| zusatzfeld5 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
|-
| zusatzfeld6 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
|-
| zusatzfeld7 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
|-
| zusatzfeld8 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
|-
| zusatzfeld9 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
|-
| zusatzfeld10 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
|}
</div></div>
<br>
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">'''Beispiele'''</div>
<div class="mw-collapsible-content">
;Request
<source lang="json">
{
	"absenderAdresseID": "",
	"ansprechpartner": "",
	"assoc": {
		"Key": "Value"
	},
	"artikelDaten": [
		{
			"anzahlBuegel": 0,
			"anzahlPosEtiketten": 0,
			"artikelBTNNr": "",
			"artikelEAN": "",
			"artikelEinheit": "",
			"artikelGewicht": 0,
			"artikelGruppe": "",
			"artikelMenge": 0,
			"artikelServices": "",
			"artikelSollMenge": 0,
			"artikelText1": "",
			"artikelText2": "",
			"artikelText3": "",
			"artikelText4": "",
			"artikelVolumen": 0,
			"artikelWaehrung": "",
			"artikelWert": 0,
			"chargeFlag": "",
			"kundenArtikelNr": "",
			"kundenBestellNr": "",
			"posAuftragNr": "",
			"posLieferNr": "",
			"positionNr": "",
			"serienNr": "",
			"ursprungLand": ""
		}
	],
	"auftragNr": "",
	"auftraggeberID": "",
	"avisHinweis1": "",
	"avisHinweis2": "",
	"avisZusatz1": "",
	"avisZusatz2": "",
	"bestellNr": "",
	"druckername": "",
	"email": "",
	"faxNr": "",
	"frachtBrief": "",
	"frachtfuehrerKdNr": "",
	"freiAvis1": "",
	"freiAvis2": "",
	"frankaturKennung": "",
	"gefahrgut": [
		{
			"gefahrgutBefoerdKat": 0,
			"gefahrgutBegrenzteMenge": "",
			"gefahrgutBezeichnung": "",
			"gefahrgutBuchst640": "",
			"gefahrgutFFCode": "",
			"gefahrgutFaktor": 0,
			"gefahrgutFreigestMenge": "",
			"gefahrgutKCode": "",
			"gefahrgutKlasse": "",
			"gefahrgutMenge": 0,
			"gefahrgutMengenEinheit": "",
			"gefahrgutNebenGefahr": "",
			"gefahrgutNettoExplMasse": 0,
			"gefahrgutTunnelBCode": "",
			"gefahrgutUNNR": "",
			"gefahrgutUmweltGef": "",
			"gefahrgutVPG": "",
			"gefahrgutVerpAnzahl": 0,
			"gefahrgutVerpackungsart": ""
		}
	],
	"gewicht": 0,
	"ilnNr": "",
	"infotext1": "",
	"infotext2": "",
	"infotext3": "",
	"infotext4": "",
	"infotext5": "",
	"infotext6": "",
	"infotext7": "",
	"infotext8": "",
	"infotext9": "",
	"infotext10": "",
	"kostenstelle": "",
	"kundenNr": "",
	"lieferscheinNr": "",
	"nachnahme": 0,
	"nettoGewicht": 0,
	"neutabsenderLKZ": "",
	"neutabsenderName1": "",
	"neutabsenderName2": "",
	"neutabsenderName3": "",
	"neutabsenderOrt": "",
	"neutabsenderPLZ": "",
	"neutabsenderStrasse": "",
	"nnVermerk": "",
	"nnVerwendung": "",
	"nnWaehrung": "",
	"packStkGes": 0,
	"packStkNr": 0,
	"packplatz": "",
	"packstueckBreite": 0,
	"packstueckHoehe": 0,
	"packstueckID": "",
	"packstueckLaenge": 0,
	"paperlessInvoice": "",
	"postLeitcode": "",
	"postZielFrachtzent": "",
	"rechnungsEmpfLKZ": "",
	"rechnungsEmpfName1": "",
	"rechnungsEmpfName2": "",
	"rechnungsEmpfName3": "",
	"rechnungsEmpfOrt": "",
	"rechnungsEmpfPLZ": "",
	"rechnungsEmpfStrasse": "",
	"sendungsinhalt": "",
	"sonderdienste": "",
	"telefonNr": "",
	"terminArt": "",
	"terminDatum": "",
	"terminZeit": "",
	"ustIDNr": "",
	"verpackungsart": "",
	"versandartID": "",
	"versicherungswert": 0,
	"vwWaehrung": "",
	"warenwert": 0,
	"wwWaehrung": "",
	"zahlungsbedingung": "",
	"zbZoll": "",
	"zielAdrBahnhof": "",
	"zielAdrLKZ": "",
	"zielAdrName1": "",
	"zielAdrName2": "",
	"zielAdrName3": "",
	"zielAdrOrt": "",
	"zielAdrPLZ": "",
	"zielAdrRegion": "",
	"zielAdrStrasse": ""
}
</source>
;Response
<source lang="json">
{
	"packstueckID": "",
	"trackingNr": "",
	"retourTrackingNr": "",
	"versandSendungsNr": "",
	"druckDateTime": {
		"year": 2023,
		"month": 0,
		"dayOfMonth": 25,
		"hourOfDay": 8,
		"minute": 59,
		"second": 22
	},
	"druckDateTimeString": "25.01.2023 08:59:22",
	"ausgangDateTime": {
		"year": 2023,
		"month": 0,
		"dayOfMonth": 25,
		"hourOfDay": 0,
		"minute": 0,
		"second": 0
	},
	"ausgangDateTimeString": "25.01.2023",
	"gebuehrWaehrung": "",
	"fehlercode": 0,
	"fehlertext1": "",
	"fehlertext2": "",
	"etikettName": "",
	"etikettDaten": "",
	"trackingURL": "",
	"zusatzfeld1": "",
	"zusatzfeld2": "",
	"zusatzfeld3": "",
	"zusatzfeld4": "",
	"zusatzfeld5": "",
	"zusatzfeld6": "",
	"zusatzfeld7": "",
	"zusatzfeld8": "",
	"zusatzfeld9": "",
	"zusatzfeld10": ""
}
</source>
</div></div>
<!-- ------------------------------------------------------------------------------- ENDE updateVersanddaten ------------------------------------------------------------------------------- -->
<!-- ------------------------------------------------------------------------------- anonymisiereVersandDaten ------------------------------------------------------------------------------- -->

== Packstückdaten anonymisieren (anonymisiereVersandDaten) ==
Das Gateway sendet die anonymisiereVersandDaten an das Automatik-Polling des HVS32. Im HVS32 werden somit Kunden bezogene Daten für den entsprechenden Datensatz gemäß DSGVO anonymisiert. Diese Anonymisierung wird unwiderruflich und endgültig auf der Datenbankebene des Versandsystems durchgeführt. Eine Wiederherstellung der ursprünglichen Daten ist somit nicht mehr möglich. Log-Dateien, Rückmelde-Dateien, bereits übertragene Frachtführer DFÜs etc. sind hiervon nicht betroffen. Es können ausschließlich Packstücke und Sendungen anonymisiert werden, welche bereits Tages abgeschlossen sind.
<br>
{| class="wikitable"
|-
|'''Funktion (POST) || /hvs32rest/anonymisiereVersandDaten'''
|-
| '''MediaType || application/json; text/plain'''<br>
|-
| '''Charset || UTF-8'''<br>
|}
<br>
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">'''Übergabe Parameter'''</div>
<div class="mw-collapsible-content">
<small>'''Fett''' dargestellte Felder müssen IMMER belegt sein</small>
{| class="wikitable sortable"
|-
! Feldname !! Typ !! Max Länge !! Nachkommastellen !! Belegung
|-
| auftragsNr || [[#Datentypen|String]] || 20 || - || -
|-
| lieferscheinNr || [[#Datentypen|String]] || 40 || - || Wird im HVS32 als Such-Nummer verwendet.
|-
| packplatz || [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Auftrag verarbeiten soll.
|-
| packstueckID || [[#Datentypen|String]] || 20 || - || '''Eindeutige''' Nummer für das Paket im Vorsystem.
|-
| trackingNr || [[#Datentypen|String]] || 35 || - || Paketnummer
|}
</div></div>
<br>
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">'''Rückgabe Parameter'''</div>
<div class="mw-collapsible-content">
{| class="wikitable sortable"
|-
! Feldname !! Typ !! Max Länge !! Nachkommastellen !! Belegung
|-
| fehlertext1 || [[#Datentypen|String]] || 200 || - || Wird im Fehlerfall befüllt
|-
| fehlertext2 || [[#Datentypen|String]] || 200 || - || Wird im Fehlerfall befüllt
|}
</div></div>
<br>
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">'''Beispiele'''</div>
<div class="mw-collapsible-content">
;Request
<source lang="json">
{
	"auftragNr": "",
	"lieferscheinNr": "",
	"packplatz": "",
	"packstueckID": "",
	"trackingNr": ""
}
</source>
;Response
<source lang="json">
{
	"fehlertext1": "",
	"fehlertext2": ""
}
</source>
</div></div>
<!-- ------------------------------------------------------------------------------- ENDE anonymisiereVersandDaten ------------------------------------------------------------------------------- -->
<!-- ------------------------------------------------------------------------------- sendungsdatenAnfrage ------------------------------------------------------------------------------- -->

== Sendungs-Verarbeitung (sendungsdatenAnfrage) ==
sendungsdatenAnfrage – wird zur Laufzeit in einzelne [[#versandDatenAnfragen|versandDatenAnfragen]] unterteilt. Muss bei einer Anfrage für das [[Shipment_Policy_Manager_(Tarifwerk)|SPM]] genutzt werden (requestSPM=TRUE)
<br>
{| class="wikitable"
|-
|'''Funktion (POST) || /hvs32rest/sendungsdatenAnfrage'''
|-
| '''MediaType || application/json; text/plain'''<br>
|-
| '''Charset || UTF-8'''<br>
|}
<br>
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">'''Übergabe Parameter'''</div>
<div class="mw-collapsible-content">
<small>'''Fett''' dargestellte Felder müssen IMMER belegt sein</small>
{| class="wikitable sortable"
|-
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
|-
| ansprechpartner || [[#Datentypen|String]] || 20 || - || Empfänger Ansprechpartner
|-
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
|-
| auftragNr || [[#Datentypen|String]] || 20 || - || -
|-
| '''auftraggeberID''' || [[#Datentypen|String]] || 10 || - || Mandantenkennung aus dem HVS32
|-
| ausschlussFrachtfuehrer || [[#Datentypen|String]] || 20 || - || Ausschluss-Frachtführer für SPM Anfrage
|-
| avisHinweis1 || [[#Datentypen|String]] || 100 || - || -
|-
| avisHinweis2 || [[#Datentypen|String]] || 100 || - || -
|-
| avisZusatz1 || [[#Datentypen|String]] || 60 || - || Zusatz zu Fest-AVIS-Schlüssel 1
|-
| avisZusatz2 || [[#Datentypen|String]] || 60 || - || Zusatz zu Fest-AVIS-Schlüssel 2
|-
| bestellNr || [[#Datentypen|String]] || 20 || - || -
|-
| email || [[#Datentypen|String]] || 100 || - || Für automatische Mailavisierung
|-
| empfMobilfunkNr || [[#Datentypen|String]] || 20 || - || Mobilfunknummer des Empfängers
|-
| faxNr || [[#Datentypen|String]] || 20 || - || Faxnummer des Empfängers
|-
| flexZustellungEmailadResponsese || [[#Datentypen|String]] || 80 || - || Flex-Zustellung Email-Adresse
|-
| frachtBrief || [[#Datentypen|String]] || 20 || - || Frachtbrief Nummer, falls Frachtbrief durch Vorsystem gedruckt wird.
|-
| frachtfuehrerKdNr || [[#Datentypen|String]] || 10 || - || Kundennummer des Frachtzahlers beim Frachtführer.
|-
| frankaturKennung || [[#Datentypen|String]] || 10 || - || -
|-
| ilnNr || [[#Datentypen|String]] || 20 || - || ILN des Empfängers (Pflicht bei Metro-Versand)
|-
| kostenstelle || [[#Datentypen|String]] || 30 || - || -
|-
| kundenNr || [[#Datentypen|String]] || 20 || - || Kundennummer des Empfängers beim Versender
|-
| Lagerkennzeichen || [[#Datentypen|String]] || <!-- MAXLÄNGE --> || <!-- DEZ --> || <!-- BELEGUNG -->
|-
| LieferantenID || [[#Datentypen|String]] || <!-- MAXLÄNGE --> || <!-- DEZ --> || <!-- BELEGUNG -->
|-
| '''lieferscheinNr''' || [[#Datentypen|String]] || 40 || - || Wird im HVS32 als Such-Nummer verwendet.
|-
| neutBIC || [[#Datentypen|String]] || 11 || - || Nur bei Neutral-Absendern belegt
|-
| neutBankBezeichnung || [[#Datentypen|String]] || 40 || - || Nur bei Neutral-Absendern belegt
|-
| neutIBAN || [[#Datentypen|String]] || 31 || - || Nur bei Neutral-Absendern belegt
|-
| neutKontoInhaber || [[#Datentypen|String]] || 40 || - || Nur bei Neutral-Absendern belegt
|-
| neutabsenderLKZ || [[#Datentypen|String]] || 3 || - || Nur bei Neutral-Absendern belegt
|-
| neutabsenderName1 || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
|-
| neutabsenderName2 || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
|-
| neutabsenderName3 || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
|-
| neutabsenderOrt || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
|-
| neutabsenderPLZ || [[#Datentypen|String]] || 10 || - || Nur bei Neutral-Absendern belegt
|-
| neutabsenderStrasse || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
|-
| '''packStkGes''' || [[#Datentypen|Integer]] || - || - || Gesamt-Anzahl Colli der Sendung
|-
| [[#packStueckDaten|packStueckDaten]] || [[#Datentypen|Sequence]] [[#packStueckDaten|<PackStueckDaten>]] || - || - || -
|-
| packplatz || [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Auftrag verarbeten soll.
|-
| paperlessInvoice || [[#Datentypen|String]] || 1 || - || Nur im UPS PaperlessInvoice Fall (T=PaperlessInvoice / F=nicht PaperlessInvoice)
|-
| postLeitcode || [[#Datentypen|String]] || 15 || - || -
|-
| postZielFrachtzent || [[#Datentypen|String]] || 5 || - || -
|-
| rechnungsEmpfLKZ || [[#Datentypen|String]] || 5 || - || Rechnungsadresse
|-
| rechnungsEmpfName1 || [[#Datentypen|String]] || 50 || - || Rechnungsempfänger
|-
| rechnungsEmpfName2 || [[#Datentypen|String]] || 50 || - || Rechnungsempfänger
|-
| rechnungsEmpfName3 || [[#Datentypen|String]] || 50 || - || Rechnungsempfänger
|-
| rechnungsEmpfOrt || [[#Datentypen|String]] || 50 || - || Rechnungsadresse
|-
| rechnungsEmpfPLZ || [[#Datentypen|String]] || 10 || - || Rechnungsadresse
|-
| rechnungsEmpfStrasse || [[#Datentypen|String]] || 50 || - || Rechnungsadresse
|-
| rechnungsNr || [[#Datentypen|String]] || 20 || - || Rechnungsnummer
|-
| requestSPM || [[#Datentypen|String]] || 5 || - || T/TRUE wenn die Entscheidungsmatrix angesprochen werden soll, sonst leer
|-
| sendungsinhalt || [[#Datentypen|String]] || 30 || - || -
|-
| sonderdienste || [[#Datentypen|String]] || 30 || - || Versandart-spezifisch belegt
|-
| sperrFlag || [[#Datentypen|String]] || 1 || - || T/F: T=Sperren, sonst nicht sperren
|-
| telefonNr || [[#Datentypen|String]] || 20 || - || Telefonnummer des Empfängers
|-
| terminArt || [[#Datentypen|String]] || 1 || - || 'A'b / 'B'is / 'F'ix
|-
| terminDatum || [[#Datentypen|String]] || 10 || - || TT.MM.JJJJ
|-
| terminZeit || [[#Datentypen|String]] || 5 || - || HH:MM
|-
| ustIDNr || [[#Datentypen|String]] || 20 || - || UmsatzsteuerNr des Empfängers
|-
| '''versandartID''' || [[#Datentypen|String]] || 10 || - || Versandartkennung aus dem HVS32
|-
| vorgabeFrachtfuehrer || [[#Datentypen|String]] || 20 || - || Vorgabe-Frachtführer für [[Shipment_Policy_Manager_(Tarifwerk)|SPM]] Anfrage
|-
| vorpackdatum || [[#Datentypen|String]] || 10 || - || TT.MM.JJJJ
|-
| wechselbruecke || [[#Datentypen|String]] || 20 || - || Wechselbrücke, die diesem Packstück zugewiesen werden soll
|-
| zahlungsbedingung || [[#Datentypen|String]] || 10 || - || 'S' = Sender, 'R' = Empfänger
|-
| zbZoll || [[#Datentypen|String]] || 1 || - || Zahlungsbedingung für Zoll Steuern 'S' = Sender, 'R' = Empfänger
|-
| zielAdrBahnhof || [[#Datentypen|String]] || 30 || - || PLZ und Ort des Bahnhofs
|-
| '''zielAdrLKZ''' || [[#Datentypen|String]] || 5 || - || Länderkennzeichen (LKZ)
|-
| '''zielAdrName1''' || [[#Datentypen|String]] || 50 || - || Lieferadresse
|-
| zielAdrName2 || [[#Datentypen|String]] || 50 || - || Lieferadresse
|-
| zielAdrName3 || [[#Datentypen|String]] || 50 || - || Lieferadresse
|-
| zielAdrName4 || [[#Datentypen|String]] || 50 || - || Lieferadresse
|-
| '''zielAdrOrt''' || [[#Datentypen|String]] || 50 || - || Lieferadresse
|-
| '''zielAdrPLZ''' || [[#Datentypen|String]] || 10 || - || Lieferadresse
|-
| zielAdrRegion || [[#Datentypen|String]] || 20 || - || Staat/Provinz (z.B.: für Sendungen in die USA wichtig)
|-
| '''zielAdrStrasse''' || [[#Datentypen|String]] || 50 || - || Lieferadresse
|}
</div></div>
<br>
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">'''Rückgabe Parameter'''</div>
<div class="mw-collapsible-content">
{| class="wikitable sortable"
|-
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
|-
| fehler || [[#Datentypen|String]] || - || - || Wird im Fehlerfall befüllt
|-
| sendungsGebuehr || [[#Datentypen|Decimal]] || 18 || 2 || Frachkosten
|-
| sendungsGebuehrWaehrung || [[#Datentypen|String]] || 3 || - || Frachkosten ISO-Währungscode
|-
| versandSendungsNr || [[#Datentypen|String]] || 20 || - || Sendungsnummer
|}

;Packstückdaten
{| class="wikitable sortable"
|-
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung|
|-
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
|-
| ausgangDateTime || [[#Datentypen|Calendar]] || 10 || - || Datum (Monat ist 0-basierend), wann das Etikett an den Frachtführer übermittelt worden ist
|-
| ausgangDateTimeString || [[#Datentypen|String]] || 10 || - || Datum, wann das Etikett an den Frachtführer übermittelt worden ist (TT.MM.JJJJ)
|-
| druckDateTime || [[#Datentypen|Calendar]] || 19 || - || Datum (Monat ist 0-basierend), wann das Etikett im HVS32 gedruckt worden ist
|-
| druckDateTimeString || [[#Datentypen|String]] || 19 || - || Datum, wann das Etikett im HVS32 gedruckt worden ist (TT.MM.JJJJ HH:mm:SS)
|-
| etikettDaten || [[#Datentypen|String]] || - || - || Binärdaten des Etiketts
|-
| etikettName || [[#Datentypen|String]] || - || - || Vorlagenname des Etiketts
|-
| fehlercode || [[#Datentypen|Integer]] || - || - || 0 wenn Erfolgreich
|-
| fehlertext1 || [[#Datentypen|String]] || 200 || - || Wird im Fehlerfall befüllt
|-
| fehlertext2 || [[#Datentypen|String]] || 200 || - || Wird im Fehlerfall befüllt
|-
| gebuehr || [[#Datentypen|Decimal]] || 18 || 2 || Frachtkosten
|-
| gebuehrWaehrung || [[#Datentypen|String]] || 3 || - || Frachkosten ISO-Währungscode
|-
| packstueckID || [[#Datentypen|String]] || 20 || - || PackstueckID aus der Anfrage
|-
| retourTrackingNr || [[#Datentypen|String]] || 50 || - || Paketnummer für die Retoure
|-
| trackingNr || [[#Datentypen|String]] || 35 || - || Paketnummer
|-
| trackingURL || [[#Datentypen|String]] || 255 || - || URL des Trackinglinks zur Sendungsverfolgung
|-
| zusatzEtikettenDaten || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Name und Binärdaten der Zusatzetiketten als Key/Value Map
|-
| zusatzfeld1 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
|-
| zusatzfeld2 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
|-
| zusatzfeld3 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
|-
| zusatzfeld4 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
|-
| zusatzfeld5 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
|-
| zusatzfeld6 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
|-
| zusatzfeld7 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
|-
| zusatzfeld8 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
|-
| zusatzfeld9 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
|-
| zusatzfeld10 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
|}
</div></div>
<br>
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">'''Beispiele'''</div>
<div class="mw-collapsible-content">
;Request
<source lang="json">
{
	"ansprechpartner": "",
	"assoc": {
		"":""
	},
	"auftragNr": "",
	"auftraggeberID": "",
	"ausschlussFrachtfuehrer": "",
 	"avisHinweis1": "",
	"avisHinweis2": "",
	"avisZusatz1": "",
	"avisZusatz2": "",
	"bestellNr": "",
	"email": "",
	"empfMobilfunkNr": "",
	"faxNr": "",
	"flexZustellungEmailadResponsese": "",
	"frachtBrief": "",
	"frachtfuehrerKdNr": "",
	"frankaturKennung": "",
	"ilnNr": "",
	"kostenstelle": "",
	"kundenNr": "",
	"Lagerkennzeichen": 0,
	"LieferantenID": 0,
	"lieferscheinNr": "",
	"neutBIC": "",
	"neutBankBezeichnung": "",
	"neutIBAN": "",
	"neutKontoInhaber": "",
	"neutabsenderLKZ": "",
	"neutabsenderName1": "",
	"neutabsenderName2": "",
	"neutabsenderName3": "",
	"neutabsenderOrt": "",
	"neutabsenderPLZ": "",
	"neutabsenderStrasse": "",
	"packStkGes": 0,
	"packStueckDaten": [
		{
			"anzahlArtikel": 0,
			"assoc": {
				"":""
			},
			"artikelDaten": [
				{
					"anzahlBuegel": 0,
					"anzahlPosEtiketten": 0,
					"artikelBTNNr": "",
					"artikelEAN": "",
					"artikelEinheit": "",
					"artikelGewicht": 0,
					"artikelGruppe": "",
					"artikelMenge": 0,
					"artikelServices": "",
					"artikelSollMenge": 0,
					"artikelText1": "",
					"artikelText2": "",
					"artikelText3": "",
					"artikelText4": "",
					"artikelVolumen": 0,
					"artikelWaehrung": "",
					"artikelWert": 0,
					"chargeFlag": "",
					"kundenArtikelNr": "",
					"kundenBestellNr": "",
					"posAuftragNr": "",
					"posLieferNr": "",
					"positionNr": "",
					"serienNr": "",
					"ursprungLand": ""
				}
			],
			"barcodeID": "",
			"barcodeText": "",
			"barcodeTyp": "",
			"druckername": "",
			"gefahrgut": [
				{
					"gefahrgutBefoerdKat": 0,
					"gefahrgutBegrenzteMenge": "",
					"gefahrgutBezeichnung": "",
					"gefahrgutBuchst640": "",
					"gefahrgutFFCode": "",
					"gefahrgutFaktor": 0,
					"gefahrgutFreigestMenge": "",
					"gefahrgutKCode": "",
					"gefahrgutKlasse": "",
					"gefahrgutMenge": 0,
					"gefahrgutMengenEinheit": "",
					"gefahrgutNebenGefahr": "",
					"gefahrgutNettoExplMasse": 0,
					"gefahrgutTunnelBCode": "",
					"gefahrgutUNNR": "",
					"gefahrgutUmweltGef": "",
					"gefahrgutVPG": "",
					"gefahrgutVerpAnzahl": 0,
					"gefahrgutVerpackungsart": ""
				}
			],
			"gewicht": 0,
			"hostTrackingNr": "",
			"infotext1": "",
			"infotext10": "",
			"infotext2": "",
			"infotext3": "",
			"infotext4": "",
			"infotext5": "",
			"infotext6": "",
			"infotext7": "",
			"infotext8": "",
			"infotext9": "",
			"letztesPackstueck": "",
			"nachnahme": 0,
			"nettoGewicht": 0,
			"nnVermerk": "",
			"nnVerwendung": "",
			"nnWaehrung": "",
			"packStkNr": 0,
			"packstueckBreite": 0,
			"packstueckHoehe": 0,
			"packstueckID": "",
			"packstueckLaenge": 0,
			"verpackungsart": "",
			"versicherungswert": 0,
			"vwWaehrung": "",
			"warenwert": 0,
			"wwWaehrung": ""
		}
	],
	"packplatz": "",
	"paperlessInvoice": "",
	"postLeitcode": "",
	"postZielFrachtzent": "",
	"rechnungsEmpfLKZ": "",
	"rechnungsEmpfName1": "",
	"rechnungsEmpfName2": "",
	"rechnungsEmpfName3": "",
	"rechnungsEmpfOrt": "",
	"rechnungsEmpfPLZ": "",
	"rechnungsEmpfStrasse": "",
	"rechnungsNr": "",
	"requestSPM": "",
	"sendungsinhalt": "",
	"sonderdienste": "",
	"sperrFlag": "",
	"telefonNr": "",
	"terminArt": "",
	"terminDatum": "",
	"terminZeit": "",
	"ustIDNr": "",
	"versandartID": "",
	"vorgabeFrachtfuehrer": "",
	"vorpackdatum": "",
	"wechselbruecke": "",
	"zahlungsbedingung": "",
	"zbZoll": "",
	"zielAdrBahnhof": "",
	"zielAdrLKZ": "",
	"zielAdrName1": "",
	"zielAdrName2": "",
	"zielAdrName3": "",
	"zielAdrName4": "",
	"zielAdrOrt": "",
	"zielAdrPLZ": "",
	"zielAdrRegion": "",
	"zielAdrStrasse": ""
}
</source>
;Response
<source lang="json">
{
	"versandSendungsNr": "",
	"sendungsGebuehrWaehrung": "",
	"fehler": "",
	"packStueckDaten": [
		{
			"assoc": {
				"": ""
			},
			"packstueckID": "",
			"trackingNr": "",
			"retourTrackingNr": "",
			"druckDateTime": {
				"year": 2023,
				"month": 0,
				"dayOfMonth": 25,
				"hourOfDay": 8,
				"minute": 59,
				"second": 22
			},
			"druckDateTimeString": "25.01.2023 08:59:22",
			"ausgangDateTime": {
				"year": 2023,
				"month": 0,
				"dayOfMonth": 25,
				"hourOfDay": 0,
				"minute": 0,
				"second": 0
			},
			"ausgangDateTimeString": "25.01.2023",
			"gebuehrWaehrung": "",
			"fehlertext1": "",
			"fehlertext2": "",
			"etikettName": "",
			"etikettDaten": "",
			"zusatzEtikettenDaten": {
				"": ""
			},
			"trackingURL": "",
			"zusatzfeld1": "",
			"zusatzfeld2": "",
			"zusatzfeld3": "",
			"zusatzfeld4": "",
			"zusatzfeld5": "",
			"zusatzfeld6": "",
			"zusatzfeld7": "",
			"zusatzfeld8": "",
			"zusatzfeld9": "",
			"zusatzfeld10": ""
		}
	]
}
</source>
</div></div>
<!-- ------------------------------------------------------------------------------- ENDE sendungsdatenAnfrage ------------------------------------------------------------------------------- -->
<!-- ------------------------------------------------------------------------------- ENDE ÜBERSICHT DER FUNTKIONEN ------------------------------------------------------------------------------- -->

= Beispiele =
Alle JSON Beispiele finden Sie auch hier: [[REST_Beispiel|REST SERVER JSON Beispiele]]