HVS32 SOAP Schnittstelle (Automatik-Polling): Unterschied zwischen den Versionen
K (Bhauser verschob die Seite HVS32 SOAP Schnittstelle nach HVS32 SOAP Schnittstelle (Automatik-Polling)) |
|||
Zeile 1: | Zeile 1: | ||
− | DataGatewayServer | + | <!-- ------------------------------------------------------------------------------- Voraussetzungen ------------------------------------------------------------------------------- --> |
+ | = Voraussetzungen = | ||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | | DGS-Version || 3.6.0.XXX oder höher | ||
+ | |- | ||
+ | | DGS-Plugins || HVS32Client, SOAP Server | ||
+ | |} | ||
+ | <!-- ------------------------------------------------------------------------------- ENDE Voraussetzungen ------------------------------------------------------------------------------- --> | ||
+ | <!-- ------------------------------------------------------------------------------- Funktionsbeschreibung ------------------------------------------------------------------------------- --> | ||
+ | = Funktionsbeschreibung = | ||
+ | Bei der SOAP-Schnittstelle stellt der DataGatewayServer (DGS) einen SOAP Server mit folgenden [[#Übersicht der Funktionen|Funktionen]] zur Verfügung. | ||
+ | Dieser ist in der Standardkonfiguration unter '''http://<Servername>:<Port>/hvs32soap''' erreichbar. Dabei wird der Port 8080 verwendet, welcher bei Bedarf geändert werden kann. | ||
+ | |||
+ | Die WSDL / XSD finden Sie hier: [[SOAP_WSDL_XSD|SOAP WSDL / XSD]] | ||
+ | <!-- ------------------------------------------------------------------------------- Funktionsbeschreibung ------------------------------------------------------------------------------- --> | ||
<!-- ------------------------------------------------------------------------------- DATENTYPEN ------------------------------------------------------------------------------- --> | <!-- ------------------------------------------------------------------------------- DATENTYPEN ------------------------------------------------------------------------------- --> | ||
= Datentypen = | = Datentypen = | ||
Zeile 10: | Zeile 25: | ||
'''Map''' - Key/Value Map<br> | '''Map''' - Key/Value Map<br> | ||
<!-- ------------------------------------------------------------------------------- ENDE DATENTYPEN ------------------------------------------------------------------------------- --> | <!-- ------------------------------------------------------------------------------- ENDE DATENTYPEN ------------------------------------------------------------------------------- --> | ||
− | <!-- ------------------------------------------------------------------------------- | + | <!-- ------------------------------------------------------------------------------- Übersicht Zusätzliche Datentypen ------------------------------------------------------------------------------- --> |
− | = | + | = Zusätzliche Datentypen = |
− | + | Zusätzliche Datentypen, welche in der Beschreibung vorkommen, stehen in einer 1:n Relation zu den Packstücken. | |
− | <!-- ------------------------------------------------------------------------------- | + | <!-- ------------------------------------------------------------------------------- artikelDaten ------------------------------------------------------------------------------- --> |
− | + | == artikelDaten == | |
− | == | ||
− | |||
− | |||
− | |||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
− | ! Feldname !! Typ !! Max Länge !! | + | ! 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 |
|} | |} | ||
− | + | <!-- ------------------------------------------------------------------------------- ENDE artikelDaten ------------------------------------------------------------------------------- --> | |
− | <!-- ------------------------------------------------------------------------------- ENDE | + | <!-- ------------------------------------------------------------------------------- gefahrgut ------------------------------------------------------------------------------- --> |
− | <!-- ------------------------------------------------------------------------------- | + | == gefahrgut == |
− | == | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung | ! 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]] || 100 || - || 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 | ||
+ | |- | ||
+ | | 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 |
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
− | + | | 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 |
|} | |} | ||
− | + | <!-- ------------------------------------------------------------------------------- ENDE gefahrgut ------------------------------------------------------------------------------- --> | |
− | <!-- ------------------------------------------------------------------------------- ENDE | + | <!-- ------------------------------------------------------------------------------- edistatus ------------------------------------------------------------------------------- --> |
− | <!-- ------------------------------------------------------------------------------- | + | == edistatus == |
− | |||
− | == | ||
− | |||
− | |||
− | |||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung | ! 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ührertyo (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) |
|} | |} | ||
− | < | + | <!-- ------------------------------------------------------------------------------- ENDE edistatus ------------------------------------------------------------------------------- --> |
− | + | <!-- ------------------------------------------------------------------------------- packstueckDaten ------------------------------------------------------------------------------- --> | |
− | + | == packstueckDaten == | |
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung | ! 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) | | 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 |
|} | |} | ||
− | ;<big><big>'''[[SOAP_Beispiel|XML Beispiele]]'''</big></big> | + | <!-- ------------------------------------------------------------------------------- ENDE packstueckDaten ------------------------------------------------------------------------------- --> |
− | <!-- ------------------------------------------------------------------------------- ENDE | + | <!--.--------------------------------------------------------------------------------ENDE Übersicht Zusätzliche Datentypen ---------------------------------------------------------.--> |
− | <!-- ------------------------------------------------------------------------------- | + | <!-- ------------------------------------------------------------------------------- ÜBERSICHT DER FUNTKIONEN ------------------------------------------------------------------------------- --> |
− | + | = Übersicht der Funktionen = | |
− | == | + | <!-- ------------------------------------------------------------------------------- echo ------------------------------------------------------------------------------- --> |
− | HVS32- | + | == Schnittstelle testen (echo) == |
− | + | Zum Testen der SOAP-Schnittstelle. Liefert die übergebene Nachricht unverändert zurück.<br><br> | |
− | + | ;<big><big>'''[[SOAP_Beispiel#Schnittstelle_testen_.28echo.29|XML Beispiele]]'''</big></big> | |
+ | <!-- ------------------------------------------------------------------------------- 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> | ||
+ | <br> | ||
+ | <big>'''Übergabe Parameter'''</big> | ||
+ | <br> | ||
+ | <small>'''Fett''' dargestellte Felder müssen IMMER belegt sein</small> | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
Zeile 154: | Zeile 260: | ||
|- | |- | ||
| ansprechpartner || [[#Datentypen|String]] || 20 || - || Empfänger Ansprechpartner | | 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) | | assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert) | ||
Zeile 160: | Zeile 270: | ||
|- | |- | ||
| '''auftraggeberID''' || [[#Datentypen|String]] || 10 || - || Mandantenkennung aus dem HVS32 | | '''auftraggeberID''' || [[#Datentypen|String]] || 10 || - || Mandantenkennung aus dem HVS32 | ||
− | |||
− | |||
|- | |- | ||
| avisHinweis1 || [[#Datentypen|String]] || 30 || - || - | | avisHinweis1 || [[#Datentypen|String]] || 30 || - || - | ||
Zeile 171: | Zeile 279: | ||
| avisZusatz2 || [[#Datentypen|String]] || 20 || - || Zusatz zu Fest-AVIS-Schlüssel 2 | | avisZusatz2 || [[#Datentypen|String]] || 20 || - || Zusatz zu Fest-AVIS-Schlüssel 2 | ||
|- | |- | ||
− | | bestellNr || [[#Datentypen|String]] || 20 || - || - | + | | 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 || - || | + | | 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 | | empfMobilfunkNr || [[#Datentypen|String]] || 20 || - || Mobilfunknummer des Empfängers | ||
Zeile 179: | Zeile 295: | ||
| faxNr || [[#Datentypen|String]] || 20 || - || Faxnummer des Empfängers | | faxNr || [[#Datentypen|String]] || 20 || - || Faxnummer des Empfängers | ||
|- | |- | ||
− | | | + | | flexZustellungEmailadresse || [[#Datentypen|String]] || 80 || - || Flex-Zustellung Emailadresse |
|- | |- | ||
− | | frachtBrief || [[#Datentypen|String]] || 20 || - || Frachtbrief Nummer | + | | frachtBrief || [[#Datentypen|String]] || 20 || - || Frachtbrief Nummer falls Frachtbrief durch Vorsystem gedruckt werden soll |
|- | |- | ||
− | | frachtfuehrerKdNr || [[#Datentypen|String]] || 10 || - || Kundennummer des Frachtzahlers beim Frachtführer | + | | frachtfuehrerKdNr || [[#Datentypen|String]] || 10 || - || Kundennummer des Frachtzahlers beim Frachtführer |
|- | |- | ||
| frankaturKennung || [[#Datentypen|String]] || 10 || - || - | | 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) | | 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 || - || - | | kostenstelle || [[#Datentypen|String]] || 30 || - || - | ||
Zeile 193: | Zeile 335: | ||
| kundenNr || [[#Datentypen|String]] || 20 || - || Kundennummer des Empfängers beim Versender | | 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 | | neutBIC || [[#Datentypen|String]] || 11 || - || Nur bei Neutral-Absendern belegt | ||
Zeile 221: | Zeile 369: | ||
| neutabsenderStrasse || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt | | neutabsenderStrasse || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt | ||
|- | |- | ||
− | | '''packStkGes | + | | 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. | | 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) | | paperlessInvoice || [[#Datentypen|String]] || 1 || - || Nur im UPS PaperlessInvoice Fall (T=PaperlessInvoice / F=nicht PaperlessInvoice) | ||
Zeile 248: | Zeile 410: | ||
|- | |- | ||
| rechnungsNr || [[#Datentypen|String]] || 20 || - || Rechnungsnummer | | rechnungsNr || [[#Datentypen|String]] || 20 || - || Rechnungsnummer | ||
− | |||
− | |||
|- | |- | ||
| sendungsinhalt || [[#Datentypen|String]] || 30 || - || - | | sendungsinhalt || [[#Datentypen|String]] || 30 || - || - | ||
Zeile 263: | Zeile 423: | ||
| terminDatum || [[#Datentypen|String]] || 10 || - || TT.MM.JJJJ | | terminDatum || [[#Datentypen|String]] || 10 || - || TT.MM.JJJJ | ||
|- | |- | ||
− | | terminZeit || [[#Datentypen| | + | | terminZeit || [[#Datentypen|Calendar]] || 5 || - || HH:MM |
|- | |- | ||
| ustIDNr || [[#Datentypen|String]] || 20 || - || UmsatzsteuerNr des Empfängers | | ustIDNr || [[#Datentypen|String]] || 20 || - || UmsatzsteuerNr des Empfängers | ||
+ | |- | ||
+ | | verpackungsart || [[#Datentypen|String]] || 6 || - || - | ||
|- | |- | ||
| '''versandartID''' || [[#Datentypen|String]] || 10 || - || Versandartkennung aus dem HVS32 | | '''versandartID''' || [[#Datentypen|String]] || 10 || - || Versandartkennung aus dem HVS32 | ||
|- | |- | ||
− | | | + | | versicherungswert || [[#Datentypen|Decimal]] || 18 || 2 || Höhe Versicherungswert |
|- | |- | ||
| vorpackdatum || [[#Datentypen|String]] || 10 || - || TT.MM.JJJJ | | vorpackdatum || [[#Datentypen|String]] || 10 || - || TT.MM.JJJJ | ||
|- | |- | ||
− | | wechselbruecke || [[#Datentypen|String]] || 20 || - || Wechselbrücke, die diesem Packstück zugewiesen | + | | 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 | | zahlungsbedingung || [[#Datentypen|String]] || 10 || - || 'S' = Sender, 'R' = Empfänger | ||
Zeile 300: | Zeile 468: | ||
|} | |} | ||
<br> | <br> | ||
− | ; | + | <br><big>'''Rückgabe Parameter'''</big><br> |
− | + | {| 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, wann das Etikett an den Frachtführer übermittelt worden ist (TT.MM.JJJJ) | ||
+ | |- | ||
+ | | ausgangDateTimeString || [[#Datentypen|String]] || 10 || - || Datum, wann das Etikett an den Frachtführer übermittelt worden ist (TT.MM.JJJJ) | ||
+ | |- | ||
+ | | druckDateTime || [[#Datentypen|Calendar]] || 19 || - || Datum, wann das Etikett im HVS32 gedruckt worden ist (TT.MM.JJJJ HH:mm:SS) | ||
+ | |- | ||
+ | | 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 | ||
+ | |} | ||
+ | ;<big><big>'''[[SOAP_Beispiel#Packst.C3.BCck-Verarbeitung_.28versanddatenAnfrage.29|XML Beispiele]]'''</big></big> | ||
+ | <!-- ------------------------------------------------------------------------------- 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> | ||
+ | <br> | ||
+ | <big>'''Übergabe Parameter'''</big> | ||
+ | <br> | ||
+ | <small>'''Fett''' dargestellte Felder müssen IMMER belegt sein</small> | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung | ! 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 |
|} | |} | ||
− | + | <br> | |
− | + | <br><big>'''Rückgabe Parameter'''</big><br> | |
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
Zeile 352: | Zeile 588: | ||
|- | |- | ||
| trackingURL || [[#Datentypen|String]] || 255 || - || URL des Trackinglinks zur Sendungsverfolgung | | 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 | | zusatzEtikettenDaten || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Name und Binärdaten der Zusatzetiketten als Key/Value Map | ||
Zeile 375: | Zeile 613: | ||
| zusatzfeld10 || [[#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 | ||
|} | |} | ||
− | ;<big><big>'''[[SOAP_Beispiel|XML Beispiele]]'''</big></big> | + | ;<big><big>'''[[SOAP_Beispiel#Etikett_nachdrucken_.28versanddatenNachdruckAnfrage.29|XML Beispiele]]'''</big></big> |
− | <!-- ------------------------------------------------------------------------------- ENDE | + | <!-- ------------------------------------------------------------------------------- ENDE versanddatenNachdruckAnfrage ------------------------------------------------------------------------------- --> |
− | <!-- ------------------------------------------------------------------------------- | + | <!-- ------------------------------------------------------------------------------- stornoVersanddaten ------------------------------------------------------------------------------- --> |
− | == | + | == Packstück stornieren (stornoVersanddaten) == |
− | HVS32- | + | 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> | |
− | + | <br> | |
+ | <big>'''Übergabe Parameter'''</big> | ||
+ | <br> | ||
+ | <small>'''Fett''' dargestellte Felder müssen IMMER belegt sein</small> | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
Zeile 388: | Zeile 629: | ||
| packplatz|| [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Auftrag verarbeiten soll. | | packplatz|| [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Auftrag verarbeiten soll. | ||
|- | |- | ||
− | | packstueckID|| [[#Datentypen|String]] || | + | | '''packstueckID'''|| [[#Datentypen|String]] || 30 || - || '''Eindeutige''' Nummer für das Paket im Vorsystem. |
+ | |- | ||
+ | | trackingNr|| [[#Datentypen|String]] || 35 || - || Paketnummer | ||
|} | |} | ||
<br> | <br> | ||
− | + | <br><big>'''Rückgabe Parameter'''</big><br> | |
− | |||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
Zeile 403: | Zeile 645: | ||
| fehlertext2 || [[#Datentypen|String]] || 200 || - || - | | fehlertext2 || [[#Datentypen|String]] || 200 || - || - | ||
|} | |} | ||
− | ;<big><big>'''[[SOAP_Beispiel|XML Beispiele]]'''</big></big> | + | ;<big><big>'''[[SOAP_Beispiel#Packst.C3.BCck_stornieren_.28stornoVersanddaten.29|XML Beispiele]]'''</big></big> |
− | <!-- ------------------------------------------------------------------------------- ENDE | + | <!-- ------------------------------------------------------------------------------- ENDE stornoversanddaten ------------------------------------------------------------------------------- --> |
− | <!-- ------------------------------------------------------------------------------- | + | <!-- ------------------------------------------------------------------------------- verladeVersandaten ------------------------------------------------------------------------------- --> |
− | == | + | == Packstück verladen (verladeVersanddaten) == |
− | HVS32- | + | 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> |
− | + | <br> | |
+ | <big>'''Übergabe Parameter'''</big> | ||
+ | <br> | ||
+ | <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. | ||
+ | |} | ||
+ | <br> | ||
+ | <br><big>'''Rückgabe Parameter'''</big><br> | ||
+ | {| class="wikitable sortable" | ||
+ | |- | ||
+ | ! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung | ||
+ | |- | ||
+ | | fehlercode || [[#Datentypen|Integer]] || - || - || 0 = Erfolgreich | ||
+ | |- | ||
+ | | fehlertext1 || [[#Datentypen|String]] || 200 || - || - | ||
+ | |- | ||
+ | | fehlertext1 || [[#Datentypen|String]] || 200 || - || - | ||
+ | |} | ||
+ | ;<big><big>'''[[SOAP_Beispiel#Packst.C3.BCck_verladen_.28verladeVersanddaten.29|XML Beispiele]]'''</big></big> | ||
+ | <!-- ------------------------------------------------------------------------------- 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> | ||
+ | <br> | ||
+ | <big>'''Übergabe Parameter'''</big> | ||
+ | <br> | ||
+ | <small>'''Fett''' dargestellte Felder müssen IMMER belegt sein</small> | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
Zeile 416: | Zeile 696: | ||
| packplatz|| [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Auftrag verarbeiten soll. | | 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> | <br> | ||
− | + | <br><big>'''Rückgabe Parameter'''</big><br> | |
− | |||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
Zeile 433: | Zeile 710: | ||
| fehlertext2 || [[#Datentypen|String]] || 200 || - || - | | fehlertext2 || [[#Datentypen|String]] || 200 || - || - | ||
|} | |} | ||
− | ;<big><big>'''[[SOAP_Beispiel|XML Beispiele]]'''</big></big> | + | ;<big><big>'''[[SOAP_Beispiel#Packst.C3.BCck_sperren_.28sperreVersanddaten.29|XML Beispiele]]'''</big></big> |
− | <!-- ------------------------------------------------------------------------------- ENDE | + | <!-- ------------------------------------------------------------------------------- ENDE sperreversanddaten ------------------------------------------------------------------------------- --> |
<!-- ------------------------------------------------------------------------------- tagesabschluss ------------------------------------------------------------------------------- --> | <!-- ------------------------------------------------------------------------------- tagesabschluss ------------------------------------------------------------------------------- --> | ||
− | == 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> | |
− | + | <br> | |
+ | <big>'''Übergabe Parameter'''</big> | ||
+ | <br> | ||
+ | <small>'''Fett''' dargestellte Felder müssen IMMER belegt sein</small> | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
Zeile 463: | Zeile 743: | ||
|} | |} | ||
<br> | <br> | ||
− | + | <br><big>'''Rückgabe Parameter'''</big><br> | |
− | |||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
Zeile 471: | Zeile 750: | ||
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert) | | assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert) | ||
|- | |- | ||
− | | [[#edistatus|edistatus]] || [[#Datentypen|Sequence]] [[#edistatus|<EDIStatus>]] || - || - || - | + | | [[#edistatus|edistatus]] || [[#Datentypen|Sequence]] '''[[#edistatus|<EDIStatus>]]''' || - || - || - |
|- | |- | ||
| fehlercode || [[#Datentypen|Integer]] || - || - || 0 = Erfolgreich | | fehlercode || [[#Datentypen|Integer]] || - || - || 0 = Erfolgreich | ||
Zeile 481: | Zeile 760: | ||
| listenDaten || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Name und Binärdaten der Listen als Key/Value Map. | | listenDaten || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Name und Binärdaten der Listen als Key/Value Map. | ||
|} | |} | ||
− | ;<big><big>'''[[SOAP_Beispiel|XML Beispiele]]'''</big></big> | + | ;<big><big>'''[[SOAP_Beispiel#Tagesabschluss_.28tagesabschluss.29|XML Beispiele]]'''</big></big> |
<!-- ------------------------------------------------------------------------------- ENDE tagesabschluss ------------------------------------------------------------------------------- --> | <!-- ------------------------------------------------------------------------------- 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> | ||
+ | <br> | ||
+ | <big>'''Übergabe Parameter'''</big> | ||
<br> | <br> | ||
− | + | <small>'''Fett''' dargestellte Felder müssen IMMER belegt sein</small> | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung | ! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung | ||
|- | |- | ||
− | | | + | | auftraggeberID || [[#Datentypen|Sequence<String>]] || 255 || - || Liste der Auftraggeber für die der Tagesabschluss durchgeführt wird.<br> |
+ | Wenn leer, werden alle Auftraggeber abgeschlossen, welche am betreffenden Packplatz freigegeben sind.<br> | ||
+ | Bei Nutzung muss zusätzlich der HVS32-Schalter 'MultiAGTagesabschluss' in der Sektion 'AutomatikPolling' auf 'ON' gesetzt sein. | ||
+ | |- | ||
+ | | 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 || - || Liste mit Name des Frachtführertyps. Z.B.: "DPD", "GLS", etc. oder "ALLE". | ||
+ | Wenn leer, werden alle Frachtführer abgeschlossen.<br> | ||
+ | Bei Nutzung muss zusätzlich der HVS32-Schalter 'MultiFFTagesabschluss' in der Sektion 'AutomatikPolling' auf 'ON' gesetzt sein. | ||
|- | |- | ||
− | | packplatz || [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den | + | | packplatz || [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Listenabschluss ausführen soll. |
|- | |- | ||
− | | | + | | versandartID || [[#Datentypen|Sequence<String>]] || 255 || - || Liste der Versandarten für die ein Tagesabschluss durchgeführt wird. |
− | + | Bei Nutzung muss zusätzlich der HVS32-Schalter 'MultiVATagesabschluss' in der Sektion 'AutomatikPolling' auf 'ON' gesetzt sein. | |
|- | |- | ||
− | | wechselbruecke || [[#Datentypen|String]] || | + | | wechselbruecke|| [[#Datentypen|String]] || 10 || - || Kennzeichen der abzuschließenden Wechselbrücke. Hiermit können nur bestimmte Sendungen abgeschlossen werden. |
|} | |} | ||
<br> | <br> | ||
− | + | <br><big>'''Rückgabe Parameter'''</big><br> | |
− | |||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung | ! 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 | | fehlercode || [[#Datentypen|Integer]] || - || - || 0 = Erfolgreich | ||
|- | |- | ||
| fehlertext1 || [[#Datentypen|String]] || 200 || - || - | | 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. | ||
+ | |} | ||
+ | ;<big><big>'''[[SOAP_Beispiel#Ausgangsliste_erzeugen_.28ListenabschlussAnfrage.29|XML Beispiele]]'''</big></big> | ||
+ | <!-- ------------------------------------------------------------------------------- ENDE Listenabschluss ------------------------------------------------------------------------------- --> | ||
+ | <!-- ------------------------------------------------------------------------------- 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> | ||
+ | <br> | ||
+ | <big>'''Übergabe Parameter'''</big> | ||
+ | <br> | ||
+ | <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 || - || Liste der Auftraggeber für die der Tagesabschluss durchgeführt wird.<br> | ||
+ | Wenn leer, werden alle Auftraggeber abgeschlossen, welche am betreffenden Packplatz freigegeben sind.<br> | ||
+ | Bei Nutzung muss zusätzlich der HVS32-Schalter 'MultiAGTagesabschluss' in der Sektion 'AutomatikPolling' auf 'ON' gesetzt 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 || - || Liste mit Name des Frachtführertyps. Z.B.: "DPD", "GLS", etc. oder "ALLE".<br> | ||
+ | Wenn leer, werden alle Frachtführer abgeschlossen.<br> | ||
+ | Bei Nutzung muss zusätzlich der HVS32-Schalter 'MultiFFTagesabschluss' in der Sektion 'AutomatikPolling' auf 'ON' gesetzt sein. | ||
+ | |- | ||
+ | | packplatz || [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Tagesabschluss ausführen soll. | ||
+ | |- | ||
+ | | versandartID || [[#Datentypen|Sequence]] [[#Datentypen|<String>]] || 255 || - || Liste der Versandarten für die ein Tagesabschluss durchgeführt wird.<br> | ||
+ | Bei Nutzung muss zusätzlich der HVS32-Schalter 'MultiVATagesabschluss' in der Sektion 'AutomatikPolling' auf 'ON' gesetzt sein. | ||
+ | |- | ||
+ | | wechselbruecke|| [[#Datentypen|String]] || 10 || - || Kennzeichen der abzuschließenden Wechselbrücke. Hiermit können nur bestimmte Sendungen abgeschlossen werden. | ||
+ | |} | ||
+ | <br> | ||
+ | <br><big>'''Rückgabe Parameter'''</big><br> | ||
+ | {| 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 || - || - | | 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. | ||
|} | |} | ||
− | ;<big><big>'''[[SOAP_Beispiel|XML Beispiele]]'''</big></big> | + | ;<big><big>'''[[SOAP_Beispiel#Frachtf.C3.BChrer_DF.C3.9C_erzeugen_.28ediabschlussAnfrage.29|XML Beispiele]]'''</big></big> |
− | <!-- ------------------------------------------------------------------------------- ENDE | + | <!-- ------------------------------------------------------------------------------- ENDE ediabschlussAnfrage ------------------------------------------------------------------------------- --> |
− | <!-- ------------------------------------------------------------------------------- | + | <!-- ------------------------------------------------------------------------------- versanddatenPruefAnfrage ------------------------------------------------------------------------------- --> |
− | == | + | == Packstückdaten aktualisieren (versanddatenPruefAnfrage) == |
− | HVS32 | + | 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> | |
− | + | <br> | |
+ | <big>'''Übergabe Parameter'''</big> | ||
+ | <br> | ||
+ | <small>'''Fett''' dargestellte Felder müssen IMMER belegt sein</small> | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
Zeile 538: | Zeile 873: | ||
| ansprechpartner || [[#Datentypen|String]] || 20 || - || Empfänger Ansprechpartner | | 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) | |
− | |||
− | | [[#artikelDaten|artikelDaten]] || [[#Datentypen|Sequence]] [[#artikelDaten|<ArtikelDaten>]] || - || - || - | ||
|- | |- | ||
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert) | | assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert) | ||
Zeile 555: | Zeile 888: | ||
|- | |- | ||
| avisZusatz2 || [[#Datentypen|String]] || 20 || - || Zusatz zu Fest-AVIS-Schlüssel 2 | | avisZusatz2 || [[#Datentypen|String]] || 20 || - || Zusatz zu Fest-AVIS-Schlüssel 2 | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| bestellNr || [[#Datentypen|String]] || 20 || - || Metro-Bestellnr (Metro-Versand) | | bestellNr || [[#Datentypen|String]] || 20 || - || Metro-Bestellnr (Metro-Versand) | ||
Zeile 567: | Zeile 894: | ||
|- | |- | ||
| email || [[#Datentypen|String]] || 100 || - || E-Mail Adresse des Empfängers (z.B.: für die Automatische E-Mail Avisierung) | | 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 | | faxNr || [[#Datentypen|String]] || 20 || - || Faxnummer des Empfängers | ||
Zeile 580: | Zeile 905: | ||
| frankaturKennung || [[#Datentypen|String]] || 10 || - || - | | frankaturKennung || [[#Datentypen|String]] || 10 || - || - | ||
|- | |- | ||
− | | [[#gefahrgut|gefahrgut]] || [[#Datentypen|Sequence]] [[#gefahrgut|<Gefahrgut>]] || - || - || | + | | [[#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 | | gewicht || [[#Datentypen|Decimal]] || 8 || 3 || Bruttogewicht in KG | ||
− | |||
− | |||
|- | |- | ||
| ilnNr || [[#Datentypen|String]] || 20 || - || ILN des Empfängers (Pflicht bei Metro-Versand) | | ilnNr || [[#Datentypen|String]] || 20 || - || ILN des Empfängers (Pflicht bei Metro-Versand) | ||
Zeile 612: | Zeile 935: | ||
| kundenNr || [[#Datentypen|String]] || 20 || - || Kundennummer des Empfängers beim Versender | | 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 || - | | nachnahme || [[#Datentypen|Decimal]] || 18 || 2 || - | ||
|- | |- | ||
| nettoGewicht || [[#Datentypen|Decimal]] || 8 || 3 || Nettogewicht in KG | | nettoGewicht || [[#Datentypen|Decimal]] || 8 || 3 || Nettogewicht in KG | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| neutabsenderLKZ || [[#Datentypen|String]] || 3 || - || Nur bei Neutral-Absendern belegt | | neutabsenderLKZ || [[#Datentypen|String]] || 3 || - || Nur bei Neutral-Absendern belegt | ||
Zeile 687: | Zeile 996: | ||
|- | |- | ||
| rechnungsNr || [[#Datentypen|String]] || 20 || - || Rechnungsnummer | | rechnungsNr || [[#Datentypen|String]] || 20 || - || Rechnungsnummer | ||
− | |||
− | |||
|- | |- | ||
| sonderdienste || [[#Datentypen|String]] || 30 || - || Versandart-spezifisch belegt | | sonderdienste || [[#Datentypen|String]] || 30 || - || Versandart-spezifisch belegt | ||
− | |||
− | |||
|- | |- | ||
| telefonNr || [[#Datentypen|String]] || 20 || - || Telefonnummer des Empfängers | | telefonNr || [[#Datentypen|String]] || 20 || - || Telefonnummer des Empfängers | ||
Zeile 709: | Zeile 1.014: | ||
|- | |- | ||
| versicherungswert || [[#Datentypen|Decimal]] || 18 || 2 || Höhe Versicherungswert | | versicherungswert || [[#Datentypen|Decimal]] || 18 || 2 || Höhe Versicherungswert | ||
− | |||
− | |||
|- | |- | ||
| vwWaehrung || [[#Datentypen|String]] || 3 || - || Versicherungswert - ISO-Währungscode | | vwWaehrung || [[#Datentypen|String]] || 3 || - || Versicherungswert - ISO-Währungscode | ||
|- | |- | ||
| warenwert || [[#Datentypen|Decimal]] || 18 || 2 || - | | warenwert || [[#Datentypen|Decimal]] || 18 || 2 || - | ||
− | |||
− | |||
|- | |- | ||
| wwWaehrung || [[#Datentypen|String]] || 3 || - || Warenwert - ISO-Währungscode | | wwWaehrung || [[#Datentypen|String]] || 3 || - || Warenwert - ISO-Währungscode | ||
Zeile 745: | Zeile 1.046: | ||
|} | |} | ||
<br> | <br> | ||
− | + | <br><big>'''Rückgabe Parameter'''</big><br> | |
− | |||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
− | ! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung| | + | ! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung|- |
+ | |- | ||
+ | | druckDateTime || [[#Datentypen|Calendar]] || 19 || - || Datum, wann das Etikett im HVS32 gedruckt worden ist (TT.MM.JJJJ HH:mm:SS) | ||
+ | |- | ||
+ | | 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 || - || - | ||
+ | |||
+ | |} | ||
+ | ;<big><big>'''[[SOAP_Beispiel#Packst.C3.BCckdaten_aktualisieren_.28versanddatenPruefAnfrage.29|XML Beispiele]]'''</big></big> | ||
+ | <!-- ------------------------------------------------------------------------------- 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. 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. 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> | ||
+ | <br> | ||
+ | <big>'''Übergabe Parameter'''</big> | ||
+ | <br> | ||
+ | <small>'''Fett''' dargestellte Felder müssen IMMER belegt sein</small> | ||
+ | {| class="wikitable sortable" | ||
+ | |- | ||
+ | ! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung | ||
+ | |- | ||
+ | | '''packstueckID''' || [[#Datentypen|String]] || 20 || - || Eindeutige Nummer für das Paket im Vorsystem. Wird als eindeutige Paketreferenz benötigt um den Datensatz zu identifizieren. | ||
+ | |- | ||
+ | | packplatz || [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Auftrag verarbeten soll. | ||
+ | |- | ||
+ | | ansprechpartner || [[#Datentypen|String]] || 20 || - || Empfänger Ansprechpartner | ||
|- | |- | ||
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert) | | assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert) | ||
|- | |- | ||
− | | | + | | avisHinweis1 || [[#Datentypen|String]] || 30 || - || - |
+ | |- | ||
+ | | avisHinweis2 || [[#Datentypen|String]] || 30 || - || - | ||
+ | |- | ||
+ | | avisZusatz1 || [[#Datentypen|String]] || 20 || - || Zusatz zu Fest-AVIS-Schlüssel 1 | ||
+ | |- | ||
+ | | avisZusatz2 || [[#Datentypen|String]] || 20 || - || Zusatz zu Fest-AVIS-Schlüssel 2 | ||
+ | |- | ||
+ | | bestellNr || [[#Datentypen|String]] || 20 || - || Metro-Bestellnr (Metro-Versand) | ||
+ | |- | ||
+ | | 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 | ||
+ | |- | ||
+ | | gewicht || [[#Datentypen|Decimal]] || 8 || 3 || Bruttogewicht in KG | ||
+ | |- | ||
+ | | nettoGewicht || [[#Datentypen|Decimal]] || 8 || 3 || Nettogewicht in KG | ||
+ | |- | ||
+ | | ilnNr || [[#Datentypen|String]] || 20 || - || ILN des Empfängers (Pflicht bei Metro-Versand) | ||
+ | |- | ||
+ | | kostenstelle || [[#Datentypen|String]] || 30 || - || - | ||
+ | |- | ||
+ | | lieferantenID || [[#Datentypen|Integer]] || - || - || - | ||
+ | |- | ||
+ | | nachnahme || [[#Datentypen|Decimal]] || 18 || 2 || - | ||
|- | |- | ||
− | | | + | | nnVermerk || [[#Datentypen|String]] || 1 || - || B': Bar / 'V': Verrechnungsscheck |
|- | |- | ||
− | | | + | | nnVerwendung || [[#Datentypen|String]] || 30 || - || Nachnahme Verwendungszweck |
|- | |- | ||
− | | | + | | nnWaehrung || [[#Datentypen|String]] || 3 || - || Nachnahme - ISO-Währungscode |
|- | |- | ||
− | | | + | | packstueckBreite || [[#Datentypen|Integer]] || - || - || Breite in cm |
|- | |- | ||
− | | | + | | packstueckHoehe || [[#Datentypen|Integer]] || - || - || Höhe in cm |
|- | |- | ||
− | | | + | | packstueckLaenge || [[#Datentypen|Integer]] || - || - || Länge in cm |
|- | |- | ||
− | | | + | | 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 || - || - |
|- | |- | ||
− | | | + | | telefonNr || [[#Datentypen|String]] || 20 || - || Telefonnummer des Empfängers |
|- | |- | ||
− | | | + | | vorpackdatum || [[#Datentypen|String]] || 10 || - || TT.MM.JJJJ |
|- | |- | ||
− | | | + | | versicherungswert || [[#Datentypen|Decimal]] || 18 || 2 || Höhe Versicherungswert |
|- | |- | ||
− | | | + | | vwWaehrung || [[#Datentypen|String]] || 3 || - || Versicherungswert - ISO-Währungscode |
|- | |- | ||
− | | | + | | wechselbruecke || [[#Datentypen|String]] || 20 || - || Wechselbrücke, die diesem Packstück zugewiesen wird |
|- | |- | ||
− | | | + | | warenwert || [[#Datentypen|Decimal]] || 18 || 2 || - |
|- | |- | ||
− | | | + | | wwWaehrung || [[#Datentypen|String]] || 3 || - || Warenwert - ISO-Währungscode |
+ | |} | ||
+ | <br> | ||
+ | <br><big>'''Rückgabe Parameter'''</big><br> | ||
+ | {| class="wikitable sortable" | ||
|- | |- | ||
− | | | + | ! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung| |
|- | |- | ||
− | | | + | | fehlercode || [[#Datentypen|Integer]] || - || - || 0 wenn Erfolgreich |
|- | |- | ||
− | | | + | | fehlertext1 || [[#Datentypen|String]] || 200 || - || Wird im Fehlerfall befüllt |
|- | |- | ||
− | | | + | | fehlertext2 || [[#Datentypen|String]] || 200 || - || Wird im Fehlerfall befüllt |
|} | |} | ||
− | ;<big><big>'''[[SOAP_Beispiel|XML Beispiele]]'''</big></big> | + | ;<big><big>'''[[SOAP_Beispiel#Packst.C3.BCckdaten_aktualisieren_.28updateVersanddaten.29|XML Beispiele]]'''</big></big> |
− | <!-- ------------------------------------------------------------------------------- ENDE | + | <!-- ------------------------------------------------------------------------------- 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> | |
− | + | <br> | |
− | + | <big>'''Übergabe Parameter'''</big> | |
+ | <br> | ||
+ | <small>'''Fett''' dargestellte Felder müssen IMMER belegt sein</small> | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
− | ! Feldname !! Typ !! Max Länge !! | + | ! 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. | + | | 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 | + | | trackingNr || [[#Datentypen|String]] || 35 || - || Paketnummer |
|} | |} | ||
<br> | <br> | ||
− | ;[[# | + | <br><big>'''Rückgabe Parameter'''</big><br> |
+ | {| 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 | ||
+ | |} | ||
+ | ;<big><big>'''[[SOAP_Beispiel#Packst.C3.BCckdaten_anonymisieren_.28anonymisiereVersandDaten.29|XML Beispiele]]'''</big></big> | ||
+ | <!-- ------------------------------------------------------------------------------- ENDE anonymisiereVersandDaten ------------------------------------------------------------------------------- --> | ||
+ | <!-- ------------------------------------------------------------------------------- sendungsdatenAnfrage ------------------------------------------------------------------------------- --> | ||
− | + | == Sendungs-Verarbeitung (sendungsdatenAnfrage) == | |
− | < | + | HVS32-Sendungsdaten Anfrage – 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> | |
− | + | <br> | |
− | + | <big>'''Übergabe Parameter'''</big> | |
− | + | <br> | |
− | + | <small>'''Fett''' dargestellte Felder müssen IMMER belegt sein</small> | |
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
Zeile 842: | Zeile 1.219: | ||
|- | |- | ||
| ansprechpartner || [[#Datentypen|String]] || 20 || - || Empfänger Ansprechpartner | | ansprechpartner || [[#Datentypen|String]] || 20 || - || Empfänger Ansprechpartner | ||
− | |||
− | |||
|- | |- | ||
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert) | | assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert) | ||
Zeile 850: | Zeile 1.225: | ||
|- | |- | ||
| '''auftraggeberID''' || [[#Datentypen|String]] || 10 || - || Mandantenkennung aus dem HVS32 | | '''auftraggeberID''' || [[#Datentypen|String]] || 10 || - || Mandantenkennung aus dem HVS32 | ||
+ | |- | ||
+ | | ausschlussFrachtfuehrer || [[#Datentypen|String]] || 20 || - || Ausschluss-Frachtführer für SPM Anfrage | ||
|- | |- | ||
| avisHinweis1 || [[#Datentypen|String]] || 30 || - || - | | avisHinweis1 || [[#Datentypen|String]] || 30 || - || - | ||
Zeile 859: | Zeile 1.236: | ||
| avisZusatz2 || [[#Datentypen|String]] || 20 || - || Zusatz zu Fest-AVIS-Schlüssel 2 | | avisZusatz2 || [[#Datentypen|String]] || 20 || - || Zusatz zu Fest-AVIS-Schlüssel 2 | ||
|- | |- | ||
− | | bestellNr || [[#Datentypen|String]] || 20 || - || | + | | 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 | | 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 | + | | frachtBrief || [[#Datentypen|String]] || 20 || - || Frachtbrief Nummer, falls Frachtbrief durch Vorsystem gedruckt wird. |
|- | |- | ||
− | | frachtfuehrerKdNr || [[#Datentypen|String]] || 10 || - || Kundennummer des Frachtzahlers beim Frachtführer | + | | frachtfuehrerKdNr || [[#Datentypen|String]] || 10 || - || Kundennummer des Frachtzahlers beim Frachtführer. |
|- | |- | ||
| frankaturKennung || [[#Datentypen|String]] || 10 || - || - | | frankaturKennung || [[#Datentypen|String]] || 10 || - || - | ||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| ilnNr || [[#Datentypen|String]] || 20 || - || ILN des Empfängers (Pflicht bei Metro-Versand) | | 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 | | neutabsenderLKZ || [[#Datentypen|String]] || 3 || - || Nur bei Neutral-Absendern belegt | ||
Zeile 925: | Zeile 1.286: | ||
| neutabsenderStrasse || [[#Datentypen|String]] || 50 || - || 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. | | 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) | | paperlessInvoice || [[#Datentypen|String]] || 1 || - || Nur im UPS PaperlessInvoice Fall (T=PaperlessInvoice / F=nicht PaperlessInvoice) | ||
Zeile 966: | Zeile 1.313: | ||
|- | |- | ||
| rechnungsNr || [[#Datentypen|String]] || 20 || - || Rechnungsnummer | | 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 | | 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 | | telefonNr || [[#Datentypen|String]] || 20 || - || Telefonnummer des Empfängers | ||
Zeile 975: | Zeile 1.328: | ||
| terminDatum || [[#Datentypen|String]] || 10 || - || TT.MM.JJJJ | | terminDatum || [[#Datentypen|String]] || 10 || - || TT.MM.JJJJ | ||
|- | |- | ||
− | | terminZeit || [[#Datentypen| | + | | terminZeit || [[#Datentypen|String]] || 5 || - || HH:MM |
|- | |- | ||
| ustIDNr || [[#Datentypen|String]] || 20 || - || UmsatzsteuerNr des Empfängers | | ustIDNr || [[#Datentypen|String]] || 20 || - || UmsatzsteuerNr des Empfängers | ||
− | |||
− | |||
|- | |- | ||
| '''versandartID''' || [[#Datentypen|String]] || 10 || - || Versandartkennung aus dem HVS32 | | '''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 | | zahlungsbedingung || [[#Datentypen|String]] || 10 || - || 'S' = Sender, 'R' = Empfänger | ||
Zeile 1.016: | Zeile 1.365: | ||
|} | |} | ||
<br> | <br> | ||
− | ; | + | <br><big>'''Rückgabe Parameter'''</big><br> |
− | + | ;Sendungsdaten | |
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
− | ! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung | + | ! 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" | {| class="wikitable sortable" | ||
|- | |- | ||
− | ! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung | + | ! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung| |
− | | | ||
− | |||
− | |||
− | |||
|- | |- | ||
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert) | | assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert) | ||
|- | |- | ||
− | | | + | | ausgangDateTime || [[#Datentypen|Calendar]] || 10 || - || Datum, wann das Etikett an den Frachtführer übermittelt worden ist (TT.MM.JJJJ) |
|- | |- | ||
− | | | + | | ausgangDateTimeString || [[#Datentypen|String]] || 10 || - || Datum, wann das Etikett an den Frachtführer übermittelt worden ist (TT.MM.JJJJ) |
|- | |- | ||
− | | | + | | druckDateTime || [[#Datentypen|Calendar]] || 19 || - || Datum, wann das Etikett im HVS32 gedruckt worden ist (TT.MM.JJJJ HH:mm:SS) |
|- | |- | ||
− | | | + | | 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 |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|} | |} | ||
− | < | + | ;<big><big>'''[[SOAP_Beispiel#Sendungs-Verarbeitung_.28sendungsdatenAnfrage.29|XML Beispiele]]'''</big></big> |
− | < | + | <!-- ------------------------------------------------------------------------------- ENDE sendungsdatenAnfrage ------------------------------------------------------------------------------- --> |
− | + | <!-- ------------------------------------------------------------------------------- ENDE ÜBERSICHT DER FUNTKIONEN ------------------------------------------------------------------------------- --> | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | <!-- ------------------------------------------------------------------------------- ENDE | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | <!-- ------------------------------------------------------------------------------- ENDE |
Version vom 27. April 2020, 14:32 Uhr
Voraussetzungen
DGS-Version | 3.6.0.XXX oder höher |
DGS-Plugins | HVS32Client, SOAP Server |
Funktionsbeschreibung
Bei der SOAP-Schnittstelle stellt der DataGatewayServer (DGS) einen SOAP Server mit folgenden Funktionen zur Verfügung. Dieser ist in der Standardkonfiguration unter http://<Servername>:<Port>/hvs32soap erreichbar. Dabei wird der Port 8080 verwendet, welcher bei Bedarf geändert werden kann.
Die WSDL / XSD finden Sie hier: SOAP WSDL / XSD
Datentypen
Integer - Zahl mit ausschließlich numerischen Zeichen (0-9).
Decimal - Zahl mit Nachkommastellen
Calendar - Datum. Monat ist dabei 0-basierend (0 = Januar, 11 = Dezember)
String - Beliebige Zeichen aus dem Zeichensatz ISO-8859-1. Maximale Länge darf nicht überschritten werden.
Binary - Base64 kodierte Binärdaten
Sequence - Eine Liste von Elementen
Map - Key/Value Map
Zusätzliche Datentypen
Zusätzliche Datentypen, welche in der Beschreibung vorkommen, stehen in einer 1:n Relation zu den Packstücken.
artikelDaten
Feldname | Typ | Max Länge | Dezimalstellen | Belegung |
---|---|---|---|---|
anzahlBuegel | Integer | - | - | Nur für Hängeversand: Anzahl der Bügel auf welche die Artikelgruppe aufgeteilt ist |
anzahlPosEtiketten | Integer | - | - | Anzahl Artikeletiketten, welche gedruckt werden sollen |
artikelBTNNr | String | 25 | - | BTN Nummer / Zolltarifnummer |
artikelEAN | String | 20 | - | EAN Nummer |
artikelEinheit | String | 10 | - | Einheit der Artikelmenge |
artikelGewicht | Decimal | 9 | 3 | Gewicht des Arikels |
artikelGruppe | String | 50 | - | Artikelgruppe |
artikelMenge | Decimal | 9 | 3 | Menge des Artikels |
artikelServices | String | 100 | - | Pipe getrennte Services für diesen Artikel |
artikelSollMenge | Decimal | 9 | 3 | - |
artikelText1 | String | 100 | - | Artikelbezeichnung |
artikelText2 | String | 100 | - | Artikelbezeichnung |
artikelText3 | String | 100 | - | Artikelbezeichnung |
artikelText4 | String | 100 | - | Artikelbezeichnung |
artikelVolumen | Decimal | 9 | 3 | Volumen des Artikels |
artikelWaehrung | String | 3 | - | Währung in welcher der Wert des Artikels angegeben wird |
artikelWert | Decimal | 18 | 2 | Wert des Artikels |
chargeFlag | String | 1 | - | |
kundenArtikelNr | String | 50 | - | Artikelnummer |
kundenBestellNr | String | 50 | - | Bestellnummer |
posAuftragNr | String | 50 | - | Auftragsnummer |
posLieferNr | String | 40 | - | Lieferscheinnummer |
positionNr | String | 50 | - | Laufende Nummer innerhalb des Packstücks |
serienNr | String | 30 | - | Seriennummer |
ursprungLand | String | 2 | - | Ursprungsland des Artikels |
gefahrgut
Feldname | Typ | Max Länge | Dezimalstellen | Belegung |
---|---|---|---|---|
gefahrgutBefoerdKat | Integer | 1 | - | Beförderungskategorie, Pflicht (siehe ADR-Tabelle Spalte (15)), kann 0-4 sein. Achtung! Muss unbedingt korrekt sein. |
gefahrgutBegrenzteMenge | String | 1 | - | T wenn der Stoff mit Status LQ / Begrenzte Menge nach ADR 3.4 verschickt wird, ansonsten F, Pflicht |
gefahrgutBezeichnung | String | 100 | - | Pflicht (siehe ADR-Tabelle Spalte (2)) |
gefahrgutBuchst640 | String | 1 | - | Buchstabe für Sondervorschrift 640, bedingte Pflicht bei Stoffen, bei denen die Sondervorschrift 640 gilt (siehe ADR-Tabelle Spalte (6)) |
gefahrgutFFCode | String | |||
gefahrgutFaktor | 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 | String | 1 | - | T wenn der Stoff mit Status EQ / Excepted Quantities nach ADR 3.5 verschickt wird, ansonsten F, Pflicht |
gefahrgutKCode | String | 10 | - | Klassifizierungscode, Pflicht (siehe ADR-Tabelle Spalte (3b)) |
gefahrgutKlasse | String | 100 | - | Pflicht (siehe ADR-Tabelle Spalte (3a)) |
gefahrgutMenge | 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 | String | 2 | - | Mengeneinheit zur Stoff-Menge. ‚1‘ oder ‚l‘: Liter ; ‚0‘ oder ‚kg‘ oder leer: kg |
gefahrgutNebenGefahr | 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 | Decimal | 8 | 3 | Netto-Explosivmasse in kg, nur bei Gefahrgütern der Klasse 1 |
gefahrgutTunnelBCode | String | 10 | - | Tunnelbeschränkungscode, Pflicht (siehe ADR-Tabelle Spalte (15)) |
gefahrgutUNNR | String | 10 | - | Pflicht (siehe ADR-Tabelle Spalte (1)) |
gefahrgutUmweltGef | String | 1 | - | T wenn Stoff umweltgefährdend ist , ansonsten F, Pflicht bei umweltgefährdenden Stoffen |
gefahrgutVPG | 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 | Integer | 4 | - | Anzahl der Einheiten, in denen das Gefahrgut verpackt ist (in Zusammenhang mit dem nächsten Feld GefahrgutVerpackungsart) |
gefahrgutVerpackungsart | String | 5 | - | ADR-Code der Verpackungsart, z.B. 4G für Kiste (Pappe), Pflicht, siehe separate Doc f. Verpackungscodes |
edistatus
Feldname | Typ | Max Länge | Dezimalstellen | Belegung |
---|---|---|---|---|
fehlercode | Integer | - | - | 0 = Erfolgreich |
statuscode | String | 2 | - |
01 = FFDatei wurde erzeugt. Es ist zu beachten, dass nicht jede FFDatei verschickt wird, dies hängt ab von der HVS32 Konfiguration. |
statustext | String | 200 | - | Klartext des Statuscodes |
fftyp | String | 50 | - | Frachtführertyo (z.B. UPS, GLS, DPD) |
dateityp | String | 50 | - | FFDateityp (z.B.: Standard, Express, etc.) |
auftraggeber | String | 10 | - | Auftraggebernummer (ACHTUNG! Nicht die AuftraggeberID) |
ffdateinr | String | 10 | - | Nummer der FF-Datei (ggf. im Fehlerfall nicht gefüllt) |
packstueckDaten
Feldname | Typ | Max Länge | Dezimalstellen | Belegung |
---|---|---|---|---|
anzahlArtikel | Integer | 6 | - | Anzahl Artikel (Druck auf Etikett) |
artikelDaten | Sequence <ArtikelDaten> | - | - | Eine Liste der Packstück-Artikel vom Typ ArtikelDaten (1:n) |
assoc | Map (String, String) | - | - | Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert) |
barcodeID | String | - | - | Zusatzfeld für evtl. Erweiterungen |
barcodeText | String | - | - | Zusatzfeld für evtl. Erweiterungen |
barcodeTyp | String | - | - | Zusatzfeld für evtl. Erweiterungen |
druckername | String | 30 | - | Name eines Ausgabekanals (Drucker) im HVS32 über den das Etikett gedruckt wird. (Benötigt Druckerspooler Erweiterungsmodul) |
gefahrgut | Sequence <Gefahrgut> | - | - | Eine Liste der Gefahrgüter vom Typ Gefahrgut (1:n) |
gewicht | Decimal | 8 | 3 | Bruttogewicht in KG |
hostTrackingNr | String | 35 | - | Falls die Paketnummer aus dem Vorsystem verwendet werden soll. |
infotext1 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext2 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext3 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext4 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext5 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext6 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext7 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext8 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext9 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext10 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
letztesPackstueck | String | 1 | - | T/F: T=letztes Packstück der Sendung (wird bei Hängeversand zum Drucken der Sendungs-Hängekarte benötigt) |
nachnahme | String | 3 | - | Warenwert - ISO-Währungscode |
nettoGewicht | Decimal | 8 | 3 | Nettogewicht in KG |
nnVermerk | String | 3 | - | Nachnahme - ISO-Währungscode |
nnVerwendung | String | 1 | - | 'B' = Bar, 'V' = Verrechnungsscheck |
nnWaehrung | String | 3 | - | Nachnahme - ISO-Währungscode |
packStkNr | Integer | - | - | Laufende Nummer pro Sendung |
packstueckBreite | Integer | - | - | Breite in cm |
packstueckHoehe | Integer | - | - | Höhe in cm |
packstueckID | 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 | Integer | - | - | Länge in cm |
verpackungsart | String | 6 | - | - |
versicherungswert | Decimal | 18 | 2 | Höhe-Versicherungswert |
vwWaehrung | String | 3 | - | Versicherungswert - ISO-Währungscode |
warenwert | Decimal | 18 | 2 | - |
wwWaehrung | String | 3 | - | Warenwert - ISO-Währungscode |
Übersicht der Funktionen
Schnittstelle testen (echo)
Zum Testen der SOAP-Schnittstelle. Liefert die übergebene Nachricht unverändert zurück.
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..
Übergabe Parameter
Fett dargestellte Felder müssen IMMER belegt sein
Feldname | Typ | Max Länge | Dezimalstellen | Belegung |
---|---|---|---|---|
ansprechpartner | String | 20 | - | Empfänger Ansprechpartner |
anzahlArtikel | Integer | 6 | - | Anzahl Artikel (Druck auf Etikett) |
artikelDaten | Sequence <ArtikelDaten> | - | - | Eine Liste der Packstück-Artikel vom Typ ArtikelDaten (1:n) |
assoc | Map (String, String) | - | - | Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert) |
auftragNr | String | 20 | - | - |
auftraggeberID | String | 10 | - | Mandantenkennung aus dem HVS32 |
avisHinweis1 | String | 30 | - | - |
avisHinweis2 | String | 30 | - | - |
avisZusatz1 | String | 20 | - | Zusatz zu Fest-AVIS-Schlüssel 1 |
avisZusatz2 | String | 20 | - | Zusatz zu Fest-AVIS-Schlüssel 2 |
barcodeID | String | - | - | Zusatzfeld für evtl. Erweiterungen |
barcodeText | String | - | - | Zusatzfeld für evtl. Erweiterungen |
barcodeTyp | String | - | - | Zusatzfeld für evtl. Erweiterungen |
bestellNr | String | 20 | - | Metro-Bestellnr (Metro-Versand) |
druckername | String | 30 | - | Name eines Ausgabekanals (Drucker) im HVS32 über den das Etikett gedruckt wird. (Benötigt Druckerspooler Erweiterungsmodul) |
String | 100 | - | E-Mail Adresse des Empfängers (z.B.: für die Automatische E-Mail Avisierung) | |
empfMobilfunkNr | String | 20 | - | Mobilfunknummer des Empfängers |
faxNr | String | 20 | - | Faxnummer des Empfängers |
flexZustellungEmailadresse | String | 80 | - | Flex-Zustellung Emailadresse |
frachtBrief | String | 20 | - | Frachtbrief Nummer falls Frachtbrief durch Vorsystem gedruckt werden soll |
frachtfuehrerKdNr | String | 10 | - | Kundennummer des Frachtzahlers beim Frachtführer |
frankaturKennung | String | 10 | - | - |
gefahrgut | Sequence <Gefahrgut> | - | - | Eine Liste der Gefahrgüter vom Typ Gefahrgut (1:n) |
gewicht | Decimal | 8 | 3 | Bruttogewicht in KG |
hostTrackingNr | String | 35 | - | Paketnummer aus dem Hostsystem |
ilnNr | String | 20 | - | ILN des Empfängers (Pflicht bei Metro-Versand) |
infotext1 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext2 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext3 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext4 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext5 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext6 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext7 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext8 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext9 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext10 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
kostenstelle | String | 30 | - | - |
kundenNr | String | 20 | - | Kundennummer des Empfängers beim Versender |
lagerkennzeichen | Integer | - | - | - |
letztesPackstueck | String | 1 | - | T/F: T=letztes Packstüeck der Sendung (wird bei Hängeversand zum Drucken der Sendungs-Hängekarte benötigt) |
lieferantenID | Integer | - | - | - |
lieferscheinNr | String | 40 | - | Wird im HVS32 als Such-Nummer verwendet |
nachnahme | Decimal | 18 | 2 | - |
nettoGewicht | Decimal | 8 | 3 | Nettogewicht in KG |
neutBIC | String | 11 | - | Nur bei Neutral-Absendern belegt |
neutBankBezeichnung | String | 40 | - | Nur bei Neutral-Absendern belegt |
neutIBAN | String | 31 | - | Nur bei Neutral-Absendern belegt |
neutKontoInhaber | String | 40 | - | Nur bei Neutral-Absendern belegt |
neutabsenderLKZ | String | 3 | - | Nur bei Neutral-Absendern belegt |
neutabsenderName1 | String | 50 | - | Nur bei Neutral-Absendern belegt |
neutabsenderName2 | String | 50 | - | Nur bei Neutral-Absendern belegt |
neutabsenderName3 | String | 50 | - | Nur bei Neutral-Absendern belegt |
neutabsenderOrt | String | 50 | - | Nur bei Neutral-Absendern belegt |
neutabsenderPLZ | String | 10 | - | Nur bei Neutral-Absendern belegt |
neutabsenderStrasse | String | 50 | - | Nur bei Neutral-Absendern belegt |
nnVermerk | String | 1 | - | B': Bar / 'V': Verrechnungsscheck |
nnVerwendung | String | 30 | - | Nachnahme Verwendungszweck |
nnWaehrung | String | 3 | - | Nachnahme - ISO-Währungscode |
packStkGes | Integer | - | - | Gesamt-Anzahl Colli der Sendung |
packStkNr | Integer | - | - | Laufende Nr pro Sendung |
packplatz | String | 10 | - | HVS32-Packplatz-Client, der den Auftrag verarbeten soll. |
packstueckBreite | Integer | - | - | Breite in cm |
packstueckHoehe | Integer | - | - | Höhe in cm |
packstueckID | 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 | Integer | - | - | Länge in cm |
paperlessInvoice | String | 1 | - | Nur im UPS PaperlessInvoice Fall (T=PaperlessInvoice / F=nicht PaperlessInvoice) |
postLeitcode | String | 15 | - | - |
postZielFrachtzent | String | 5 | - | - |
rechnungsEmpfLKZ | String | 5 | - | Rechnungsadresse |
rechnungsEmpfName1 | String | 50 | - | Rechnungsempfänger |
rechnungsEmpfName2 | String | 50 | - | Rechnungsempfänger |
rechnungsEmpfName3 | String | 50 | - | Rechnungsempfänger |
rechnungsEmpfOrt | String | 50 | - | Rechnungsadresse |
rechnungsEmpfPLZ | String | 10 | - | Rechnungsadresse |
rechnungsEmpfStrasse | String | 50 | - | Rechnungsadresse |
rechnungsNr | String | 20 | - | Rechnungsnummer |
sendungsinhalt | String | 30 | - | - |
sonderdienste | String | 30 | - | Versandart-spezifisch belegt |
sperrFlag | String | 1 | - | T/F: T=Sperren, sonst nicht sperren |
telefonNr | String | 20 | - | Telefonnummer des Empfängers |
terminArt | String | 1 | - | 'A'b / 'B'is / 'F'ix |
terminDatum | String | 10 | - | TT.MM.JJJJ |
terminZeit | Calendar | 5 | - | HH:MM |
ustIDNr | String | 20 | - | UmsatzsteuerNr des Empfängers |
verpackungsart | String | 6 | - | - |
versandartID | String | 10 | - | Versandartkennung aus dem HVS32 |
versicherungswert | Decimal | 18 | 2 | Höhe Versicherungswert |
vorpackdatum | String | 10 | - | TT.MM.JJJJ |
vwWaehrung | String | 3 | - | Versicherungswert - ISO-Währungscode |
warenwert | Decimal | 18 | 2 | - |
wechselbruecke | String | 20 | - | Wechselbrücke, die diesem Packstück zugewiesen wird |
wwWaehrung | String | 3 | - | Warenwert - ISO-Währungscode |
zahlungsbedingung | String | 10 | - | 'S' = Sender, 'R' = Empfänger |
zbZoll | String | 1 | - | Zahlungsbedingung für Zoll Steuern 'S' = Sender, 'R' = Empfänger |
zielAdrBahnhof | String | 30 | - | PLZ und Ort |
zielAdrLKZ | String | 5 | - | Lieferadresse |
zielAdrName1 | String | 50 | - | Lieferadresse |
zielAdrName2 | String | 50 | - | Lieferadresse |
zielAdrName3 | String | 50 | - | Lieferadresse |
zielAdrName4 | String | 50 | - | Lieferadresse |
zielAdrOrt | String | 50 | - | Lieferadresse |
zielAdrPLZ | String | 10 | - | Lieferadresse |
zielAdrRegion | String | 20 | - | Staat/Provinz (z.B.: für Sendungen in die USA wichtig) |
zielAdrStrasse | String | 50 | - | Lieferadresse |
Rückgabe Parameter
Feldname | Typ | Max Länge | Dezimalstellen | |
---|---|---|---|---|
assoc | Map (String, String) | - | - | Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert) |
ausgangDateTime | Calendar | 10 | - | Datum, wann das Etikett an den Frachtführer übermittelt worden ist (TT.MM.JJJJ) |
ausgangDateTimeString | String | 10 | - | Datum, wann das Etikett an den Frachtführer übermittelt worden ist (TT.MM.JJJJ) |
druckDateTime | Calendar | 19 | - | Datum, wann das Etikett im HVS32 gedruckt worden ist (TT.MM.JJJJ HH:mm:SS) |
druckDateTimeString | String | 19 | - | Datum, wann das Etikett im HVS32 gedruckt worden ist (TT.MM.JJJJ HH:mm:SS) |
etikettDaten | String | - | - | Binärdaten des Etiketts |
etikettName | String | - | - | Vorlagenname des Etiketts |
fehlercode | Integer | - | - | 0 wenn Erfolgreich |
fehlertext1 | String | 200 | - | Wird im Fehlerfall befüllt |
fehlertext2 | String | 200 | - | Wird im Fehlerfall befüllt |
gebuehr | Decimal | 18 | 2 | Frachtkosten |
gebuehrWaehrung | String | 3 | - | Frachkosten ISO-Währungscode |
packstueckID | String | 20 | - | PackstueckID aus der Anfrage |
retourTrackingNr | String | 50 | - | Paketnummer für die Retoure |
trackingNr | String | 35 | - | Paketnummer |
trackingURL | String | 255 | - | URL des Trackinglinks zur Sendungsverfolgung |
versandSendungsNr | String | - | - | - |
zusatzEtikettenDaten | Map (String, String) | - | - | Name und Binärdaten der Zusatzetiketten als Key/Value Map |
zusatzfeld1 | String | 200 | - | Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden |
zusatzfeld2 | String | 200 | - | Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden |
zusatzfeld3 | String | 200 | - | Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden |
zusatzfeld4 | String | 200 | - | Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden |
zusatzfeld5 | String | 200 | - | Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden |
zusatzfeld6 | String | 200 | - | Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden |
zusatzfeld7 | String | 200 | - | Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden |
zusatzfeld8 | String | 200 | - | Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden |
zusatzfeld9 | String | 200 | - | Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden |
zusatzfeld10 | String | 200 | - | Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden |
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.
Übergabe Parameter
Fett dargestellte Felder müssen IMMER belegt sein
Feldname | Typ | Max Länge | Dezimalstellen | Belegung |
---|---|---|---|---|
druckername | String | 30 | - | Name eines Ausgabekanals (Drucker) im HVS32 über den das Etikett gedruckt wird. |
packplatz | String | 10 | - | HVS32-Packplatz-Client, der den Auftrag verarbeiten soll. |
packstueckID | String | 30 | - | Eindeutige Nummer für das Paket im Vorsystem. |
trackingNr | String | 35 | - | Paketnummer |
Rückgabe Parameter
Feldname | Typ | Max Länge | Dezimalstellen | |
---|---|---|---|---|
assoc | Map (String, String) | - | - | Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert) |
ausgangDateTime | Calendar | 10 | - | Datum, wann das Etikett an den Frachtführer übermittelt worden ist (TT.MM.JJJJ) |
ausgangDateTimeString | String | 10 | - | Datum, wann das Etikett an den Frachtführer übermittelt worden ist (TT.MM.JJJJ) |
druckDateTime | Calendar | 19 | - | Datum, wann das Etikett im HVS32 gedruckt worden ist (TT.MM.JJJJ HH:mm:SS) |
druckDateTimeString | String | 19 | - | Datum, wann das Etikett im HVS32 gedruckt worden ist (TT.MM.JJJJ HH:mm:SS) |
etikettDaten | String | - | - | Binärdaten des Etiketts |
etikettName | String | - | - | Vorlagenname des Etiketts |
fehlercode | Integer | - | - | 0 wenn Erfolgreich |
fehlertext1 | String | 200 | - | Wird im Fehlerfall befüllt |
fehlertext2 | String | 200 | - | Wird im Fehlerfall befüllt |
gebuehr | Decimal | 18 | 2 | Frachtkosten |
gebuehrWaehrung | String | 3 | - | Frachkosten ISO-Währungscode |
packstueckID | String | 20 | - | PackstueckID aus der Anfrage |
retourTrackingNr | String | 50 | - | Paketnummer für die Retoure |
trackingNr | String | 35 | - | Paketnummer |
trackingURL | String | 255 | - | URL des Trackinglinks zur Sendungsverfolgung |
versandSendungsNr | String | - | - | - |
zusatzEtikettenDaten | Map (String, String) | - | - | Name und Binärdaten der Zusatzetiketten als Key/Value Map |
zusatzfeld1 | String | 200 | - | Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden |
zusatzfeld2 | String | 200 | - | Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden |
zusatzfeld3 | String | 200 | - | Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden |
zusatzfeld4 | String | 200 | - | Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden |
zusatzfeld5 | String | 200 | - | Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden |
zusatzfeld6 | String | 200 | - | Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden |
zusatzfeld7 | String | 200 | - | Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden |
zusatzfeld8 | String | 200 | - | Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden |
zusatzfeld9 | String | 200 | - | Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden |
zusatzfeld10 | String | 200 | - | Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden |
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.
Übergabe Parameter
Fett dargestellte Felder müssen IMMER belegt sein
Feldname | Typ | Max Länge | Dezimalstellen | Belegung |
---|---|---|---|---|
packplatz | String | 10 | - | HVS32-Packplatz-Client, der den Auftrag verarbeiten soll. |
packstueckID | String | 30 | - | Eindeutige Nummer für das Paket im Vorsystem. |
trackingNr | String | 35 | - | Paketnummer |
Rückgabe Parameter
Feldname | Typ | Max Länge | Dezimalstellen | Belegung |
---|---|---|---|---|
fehlercode | Integer | - | - | 0 = Erfolgreich |
fehlertext1 | String | 200 | - | - |
fehlertext2 | String | 200 | - | - |
Packstück verladen (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.
Übergabe Parameter
Fett dargestellte Felder müssen IMMER belegt sein
Feldname | Typ | Max Länge | Dezimalstellen | Belegung |
---|---|---|---|---|
hostFreigabeNr | String | 20 | - | Hostseitige Freigabenummer die für dieses Packstück gesetzt wird. |
packplatz | String | 10 | - | HVS32-Packplatz-Client, der den Auftrag verarbeiten soll. |
packstueckID | String | 20 | - | Eindeutige Nummer für das Paket im Vorsystem. Beim Etikettendruck zuvor muss die gleiche ID übergeben worden sein, damit das HVS32 das zu verladene Packstück eindeutig identifizieren kann. |
wechselbruecke | String | 20 | - | Wechselbrücke, die diesem Packstück zugewiesen wird. |
Rückgabe Parameter
Feldname | Typ | Max Länge | Dezimalstellen | Belegung |
---|---|---|---|---|
fehlercode | Integer | - | - | 0 = Erfolgreich |
fehlertext1 | String | 200 | - | - |
fehlertext1 | String | 200 | - | - |
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.
Übergabe Parameter
Fett dargestellte Felder müssen IMMER belegt sein
Feldname | Typ | Max Länge | Dezimalstellen | Belegung |
---|---|---|---|---|
packplatz | String | 10 | - | HVS32-Packplatz-Client, der den Auftrag verarbeiten soll. |
packstueckID | String | 20 | - | Eindeutige Nummer für das Paket im Vorsystem. |
Rückgabe Parameter
Feldname | Typ | Max Länge | Dezimalstellen | Belegung |
---|---|---|---|---|
fehlercode | Integer | - | - | 0 = Erfolgreich |
fehlertext1 | String | 200 | - | - |
fehlertext2 | String | 200 | - | - |
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.
Übergabe Parameter
Fett dargestellte Felder müssen IMMER belegt sein
Feldname | Typ | Max Länge | Dezimalstellen | Belegung |
---|---|---|---|---|
auftraggeberID | Sequence<String> | 255 | - | Liste der Auftraggeber für die der Tagesabschluss durchgeführt wird. Wenn leer, werden alle Auftraggeber abgeschlossen, welche am betreffenden Packplatz freigegeben sind. |
druckername | String | 30 | - | Name eines Ausgabekanals (Drucker) im HVS32 über den die Listen gedruckt werden sollen.
(Benötigt Druckerspooler Erweiterungsmodul) |
frachtfuehrerTyp | Sequence<String> | 255 | - | Liste mit Name des Frachtführertyps. Z.B.: "DPD", "GLS", etc. oder "ALLE".
Wenn leer, werden alle Frachtführer abgeschlossen. |
packplatz | String | 10 | - | HVS32-Packplatz-Client, der den Listenabschluss ausführen soll. |
versandartID | Sequence<String> | 255 | - | Liste der Versandarten für die ein Tagesabschluss durchgeführt wird.
Bei Nutzung muss zusätzlich der HVS32-Schalter 'MultiVATagesabschluss' in der Sektion 'AutomatikPolling' auf 'ON' gesetzt sein. |
wechselbruecke | String | 10 | - | Kennzeichen der abzuschließenden Wechselbrücke. Hiermit können nur bestimmte Sendungen abgeschlossen werden. |
Rückgabe Parameter
Feldname | Typ | Max Länge | Dezimalstellen | Belegung |
---|---|---|---|---|
assoc | Map (String, String) | - | - | Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert) |
edistatus | Sequence <EDIStatus> | - | - | - |
fehlercode | Integer | - | - | 0 = Erfolgreich |
fehlertext1 | String | 200 | - | - |
fehlertext2 | String | 200 | - | - |
listenDaten | Map (String, String) | - | - | Name und Binärdaten der Listen als Key/Value Map. |
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.
Übergabe Parameter
Fett dargestellte Felder müssen IMMER belegt sein
Feldname | Typ | Max Länge | Dezimalstellen | Belegung |
---|---|---|---|---|
auftraggeberID | Sequence<String> | 255 | - | Liste der Auftraggeber für die der Tagesabschluss durchgeführt wird. Wenn leer, werden alle Auftraggeber abgeschlossen, welche am betreffenden Packplatz freigegeben sind. |
druckername | String | 30 | - | Name eines Ausgabekanals (Drucker) im HVS32 über den die Listen gedruckt werden sollen.
(Benötigt Druckerspooler Erweiterungsmodul) |
frachtfuehrerTyp | Sequence<String> | 255 | - | Liste mit Name des Frachtführertyps. Z.B.: "DPD", "GLS", etc. oder "ALLE".
Wenn leer, werden alle Frachtführer abgeschlossen. |
packplatz | String | 10 | - | HVS32-Packplatz-Client, der den Listenabschluss ausführen soll. |
versandartID | Sequence<String> | 255 | - | Liste der Versandarten für die ein Tagesabschluss durchgeführt wird.
Bei Nutzung muss zusätzlich der HVS32-Schalter 'MultiVATagesabschluss' in der Sektion 'AutomatikPolling' auf 'ON' gesetzt sein. |
wechselbruecke | String | 10 | - | Kennzeichen der abzuschließenden Wechselbrücke. Hiermit können nur bestimmte Sendungen abgeschlossen werden. |
Rückgabe Parameter
Feldname | Typ | Max Länge | Dezimalstellen | Belegung |
---|---|---|---|---|
assoc | Map (String, String) | - | - | Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert) |
fehlercode | Integer | - | - | 0 = Erfolgreich |
fehlertext1 | String | 200 | - | - |
fehlertext2 | String | 200 | - | - |
listenDaten | Map (String, String) | - | - | Name und Binärdaten der Listen als Key/Value Map. |
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.
Übergabe Parameter
Fett dargestellte Felder müssen IMMER belegt sein
Feldname | Typ | Max Länge | Dezimalstellen | Belegung |
---|---|---|---|---|
auftraggeberID | Sequence <String> | 255 | - | Liste der Auftraggeber für die der Tagesabschluss durchgeführt wird. Wenn leer, werden alle Auftraggeber abgeschlossen, welche am betreffenden Packplatz freigegeben sind. |
druckername | String | 30 | - | Name eines Ausgabekanals (Drucker) im HVS32 über den z.B. die UPS Summary gedruckt wird. (Benötigt Druckerspooler Erweiterungsmodul) |
frachtfuehrerTyp | Sequence <String> | 255 | - | Liste mit Name des Frachtführertyps. Z.B.: "DPD", "GLS", etc. oder "ALLE". Wenn leer, werden alle Frachtführer abgeschlossen. |
packplatz | String | 10 | - | HVS32-Packplatz-Client, der den Tagesabschluss ausführen soll. |
versandartID | Sequence <String> | 255 | - | Liste der Versandarten für die ein Tagesabschluss durchgeführt wird. Bei Nutzung muss zusätzlich der HVS32-Schalter 'MultiVATagesabschluss' in der Sektion 'AutomatikPolling' auf 'ON' gesetzt sein. |
wechselbruecke | String | 10 | - | Kennzeichen der abzuschließenden Wechselbrücke. Hiermit können nur bestimmte Sendungen abgeschlossen werden. |
Rückgabe Parameter
Feldname | Typ | Max Länge | Dezimalstellen | Belegung |
---|---|---|---|---|
assoc | Map (String, String) | - | - | Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert) |
edistatus | Sequence <EDIStatus> | - | - | Liste mit Statusinformationen für EDIs. |
fehlercode | Integer | - | - | 0 = Erfolgreich |
fehlertext1 | String | 200 | - | - |
listenDaten | Map (String, String) | - | - | Name und Binärdaten der EDI-Listen (z.B. UPS Summary) als Key/Value Map. |
Packstückdaten aktualisieren (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.
Übergabe Parameter
Fett dargestellte Felder müssen IMMER belegt sein
Feldname | Typ | Max Länge | Dezimalstellen | Belegung |
---|---|---|---|---|
ansprechpartner | String | 20 | - | Empfänger Ansprechpartner |
artikelDaten | Sequence <ArtikelDaten> | - | - | Eine Liste der Packstück-Artikel vom Typ ArtikelDaten (1:n) |
assoc | Map (String, String) | - | - | Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert) |
auftragNr | String | 20 | - | - |
auftraggeberID | String | 10 | - | Mandantenkennung aus dem HVS32 |
avisHinweis1 | String | 30 | - | - |
avisHinweis2 | String | 30 | - | - |
avisZusatz1 | String | 20 | - | Zusatz zu Fest-AVIS-Schlüssel 1 |
avisZusatz2 | String | 20 | - | Zusatz zu Fest-AVIS-Schlüssel 2 |
bestellNr | String | 20 | - | Metro-Bestellnr (Metro-Versand) |
druckername | String | 30 | - | Name eines Ausgabekanals (Drucker) im HVS32 über den das Etikett gedruckt wird. (Benötigt Druckerspooler Erweiterungsmodul) |
String | 100 | - | E-Mail Adresse des Empfängers (z.B.: für die Automatische E-Mail Avisierung) | |
faxNr | String | 20 | - | Faxnummer des Empfängers |
flexZustellungEmailadresse | String | 80 | - | Flex-Zustellung Emailadresse |
frachtBrief | String | 20 | - | Frachtbrief Nummer falls Frachtbrief durch Vorsystem gedruckt werden soll |
frachtfuehrerKdNr | String | 10 | - | Kundennummer des Frachtzahlers beim Frachtführer |
frankaturKennung | String | 10 | - | - |
gefahrgut | Sequence <Gefahrgut> | - | - | Eine Liste der Gefahrgüter vom Typ Gefahrgut (1:n) |
gewicht | Decimal | 8 | 3 | Bruttogewicht in KG |
ilnNr | String | 20 | - | ILN des Empfängers (Pflicht bei Metro-Versand) |
infotext1 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext2 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext3 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext4 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext5 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext6 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext7 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext8 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext9 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext10 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
kostenstelle | String | 30 | - | - |
kundenNr | String | 20 | - | Kundennummer des Empfängers beim Versender |
lieferscheinNr | String | 40 | - | Wird im HVS32 als Such-Nummer verwendet |
nachnahme | Decimal | 18 | 2 | - |
nettoGewicht | Decimal | 8 | 3 | Nettogewicht in KG |
neutabsenderLKZ | String | 3 | - | Nur bei Neutral-Absendern belegt |
neutabsenderName1 | String | 50 | - | Nur bei Neutral-Absendern belegt |
neutabsenderName2 | String | 50 | - | Nur bei Neutral-Absendern belegt |
neutabsenderName3 | String | 50 | - | Nur bei Neutral-Absendern belegt |
neutabsenderOrt | String | 50 | - | Nur bei Neutral-Absendern belegt |
neutabsenderPLZ | String | 10 | - | Nur bei Neutral-Absendern belegt |
neutabsenderStrasse | String | 50 | - | Nur bei Neutral-Absendern belegt |
nnVermerk | String | 1 | - | B': Bar / 'V': Verrechnungsscheck |
nnVerwendung | String | 30 | - | Nachnahme Verwendungszweck |
nnWaehrung | String | 3 | - | Nachnahme - ISO-Währungscode |
packStkGes | Integer | - | - | Gesamt-Anzahl Colli der Sendung |
packStkNr | Integer | - | - | Laufende Nr pro Sendung |
packplatz | String | 10 | - | HVS32-Packplatz-Client, der den Auftrag verarbeten soll. |
packstueckBreite | Integer | - | - | Breite in cm |
packstueckHoehe | Integer | - | - | Höhe in cm |
packstueckID | 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 | Integer | - | - | Länge in cm |
paperlessInvoice | String | 1 | - | Nur im UPS PaperlessInvoice Fall (T=PaperlessInvoice / F=nicht PaperlessInvoice) |
postLeitcode | String | 15 | - | - |
postZielFrachtzent | String | 5 | - | - |
rechnungsEmpfLKZ | String | 5 | - | Rechnungsadresse |
rechnungsEmpfName1 | String | 50 | - | Rechnungsempfänger |
rechnungsEmpfName2 | String | 50 | - | Rechnungsempfänger |
rechnungsEmpfName3 | String | 50 | - | Rechnungsempfänger |
rechnungsEmpfOrt | String | 50 | - | Rechnungsadresse |
rechnungsEmpfPLZ | String | 10 | - | Rechnungsadresse |
rechnungsEmpfStrasse | String | 50 | - | Rechnungsadresse |
rechnungsNr | String | 20 | - | Rechnungsnummer |
sonderdienste | String | 30 | - | Versandart-spezifisch belegt |
telefonNr | String | 20 | - | Telefonnummer des Empfängers |
terminArt | String | 1 | - | 'A'b / 'B'is / 'F'ix |
terminDatum | String | 10 | - | TT.MM.JJJJ |
terminZeit | Calendar | 5 | - | HH:MM |
ustIDNr | String | 20 | - | UmsatzsteuerNr des Empfängers |
verpackungsart | String | 6 | - | - |
versandartID | String | 10 | - | Versandartkennung aus dem HVS32 |
versicherungswert | Decimal | 18 | 2 | Höhe Versicherungswert |
vwWaehrung | String | 3 | - | Versicherungswert - ISO-Währungscode |
warenwert | Decimal | 18 | 2 | - |
wwWaehrung | String | 3 | - | Warenwert - ISO-Währungscode |
zahlungsbedingung | String | 10 | - | 'S' = Sender, 'R' = Empfänger |
zbZoll | String | 1 | - | Zahlungsbedingung für Zoll Steuern 'S' = Sender, 'R' = Empfänger |
zielAdrBahnhof | String | 30 | - | PLZ und Ort |
zielAdrLKZ | String | 5 | - | Lieferadresse |
zielAdrName1 | String | 50 | - | Lieferadresse |
zielAdrName2 | String | 50 | - | Lieferadresse |
zielAdrName3 | String | 50 | - | Lieferadresse |
zielAdrName4 | String | 50 | - | Lieferadresse |
zielAdrOrt | String | 50 | - | Lieferadresse |
zielAdrPLZ | String | 10 | - | Lieferadresse |
zielAdrRegion | String | 20 | - | Staat/Provinz (z.B.: für Sendungen in die USA wichtig) |
zielAdrStrasse | String | 50 | - | Lieferadresse |
Rückgabe Parameter
Feldname | Typ | Max Länge | Dezimalstellen | - |
---|---|---|---|---|
druckDateTime | Calendar | 19 | - | Datum, wann das Etikett im HVS32 gedruckt worden ist (TT.MM.JJJJ HH:mm:SS) |
druckDateTimeString | String | 19 | - | Datum, wann das Etikett im HVS32 gedruckt worden ist (TT.MM.JJJJ HH:mm:SS) |
fehlertext1 | String | 200 | - | - |
fehlertext2 | String | 200 | - | - |
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. 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. 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.
Übergabe Parameter
Fett dargestellte Felder müssen IMMER belegt sein
Feldname | Typ | Max Länge | Dezimalstellen | Belegung |
---|---|---|---|---|
packstueckID | String | 20 | - | Eindeutige Nummer für das Paket im Vorsystem. Wird als eindeutige Paketreferenz benötigt um den Datensatz zu identifizieren. |
packplatz | String | 10 | - | HVS32-Packplatz-Client, der den Auftrag verarbeten soll. |
ansprechpartner | String | 20 | - | Empfänger Ansprechpartner |
assoc | Map (String, String) | - | - | Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert) |
avisHinweis1 | String | 30 | - | - |
avisHinweis2 | String | 30 | - | - |
avisZusatz1 | String | 20 | - | Zusatz zu Fest-AVIS-Schlüssel 1 |
avisZusatz2 | String | 20 | - | Zusatz zu Fest-AVIS-Schlüssel 2 |
bestellNr | String | 20 | - | Metro-Bestellnr (Metro-Versand) |
String | 100 | - | E-Mail Adresse des Empfängers (z.B.: für die Automatische E-Mail Avisierung) | |
empfMobilfunkNr | String | 20 | - | Mobilfunknummer des Empfängers |
faxNr | String | 20 | - | Faxnummer des Empfängers |
flexZustellungEmailadresse | String | 80 | - | Flex-Zustellung Emailadresse |
gewicht | Decimal | 8 | 3 | Bruttogewicht in KG |
nettoGewicht | Decimal | 8 | 3 | Nettogewicht in KG |
ilnNr | String | 20 | - | ILN des Empfängers (Pflicht bei Metro-Versand) |
kostenstelle | String | 30 | - | - |
lieferantenID | Integer | - | - | - |
nachnahme | Decimal | 18 | 2 | - |
nnVermerk | String | 1 | - | B': Bar / 'V': Verrechnungsscheck |
nnVerwendung | String | 30 | - | Nachnahme Verwendungszweck |
nnWaehrung | String | 3 | - | Nachnahme - ISO-Währungscode |
packstueckBreite | Integer | - | - | Breite in cm |
packstueckHoehe | Integer | - | - | Höhe in cm |
packstueckLaenge | Integer | - | - | Länge in cm |
rechnungsEmpfLKZ | String | 5 | - | Rechnungsadresse |
rechnungsEmpfName1 | String | 50 | - | Rechnungsempfänger |
rechnungsEmpfName2 | String | 50 | - | Rechnungsempfänger |
rechnungsEmpfName3 | String | 50 | - | Rechnungsempfänger |
rechnungsEmpfOrt | String | 50 | - | Rechnungsadresse |
rechnungsEmpfPLZ | String | 10 | - | Rechnungsadresse |
rechnungsEmpfStrasse | String | 50 | - | Rechnungsadresse |
rechnungsNr | String | 20 | - | Rechnungsnummer |
sendungsinhalt | String | 30 | - | - |
telefonNr | String | 20 | - | Telefonnummer des Empfängers |
vorpackdatum | String | 10 | - | TT.MM.JJJJ |
versicherungswert | Decimal | 18 | 2 | Höhe Versicherungswert |
vwWaehrung | String | 3 | - | Versicherungswert - ISO-Währungscode |
wechselbruecke | String | 20 | - | Wechselbrücke, die diesem Packstück zugewiesen wird |
warenwert | Decimal | 18 | 2 | - |
wwWaehrung | String | 3 | - | Warenwert - ISO-Währungscode |
Rückgabe Parameter
Feldname | Typ | Max Länge | Dezimalstellen | |
---|---|---|---|---|
fehlercode | Integer | - | - | 0 wenn Erfolgreich |
fehlertext1 | String | 200 | - | Wird im Fehlerfall befüllt |
fehlertext2 | String | 200 | - | Wird im Fehlerfall befüllt |
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.
Übergabe Parameter
Fett dargestellte Felder müssen IMMER belegt sein
Feldname | Typ | Max Länge | Nachkommastellen | Belegung |
---|---|---|---|---|
auftragsNr | String | 20 | - | - |
lieferscheinNr | String | 40 | - | Wird im HVS32 als Such-Nummer verwendet. |
packplatz | String | 10 | - | HVS32-Packplatz-Client, der den Auftrag verarbeiten soll. |
packstueckID | String | 20 | - | Eindeutige Nummer für das Paket im Vorsystem. |
trackingNr | String | 35 | - | Paketnummer |
Rückgabe Parameter
Feldname | Typ | Max Länge | Nachkommastellen | Belegung |
---|---|---|---|---|
fehlertext1 | String | 200 | - | Wird im Fehlerfall befüllt |
fehlertext2 | String | 200 | - | Wird im Fehlerfall befüllt |
Sendungs-Verarbeitung (sendungsdatenAnfrage)
HVS32-Sendungsdaten Anfrage – wird zur Laufzeit in einzelne versandDatenAnfragen unterteilt. Muss bei einer Anfrage für das SPM genutzt werden (requestSPM=TRUE).
Übergabe Parameter
Fett dargestellte Felder müssen IMMER belegt sein
Feldname | Typ | Max Länge | Dezimalstellen | Belegung |
---|---|---|---|---|
ansprechpartner | String | 20 | - | Empfänger Ansprechpartner |
assoc | Map (String, String) | - | - | Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert) |
auftragNr | String | 20 | - | - |
auftraggeberID | String | 10 | - | Mandantenkennung aus dem HVS32 |
ausschlussFrachtfuehrer | String | 20 | - | Ausschluss-Frachtführer für SPM Anfrage |
avisHinweis1 | String | 30 | - | - |
avisHinweis2 | String | 30 | - | - |
avisZusatz1 | String | 20 | - | Zusatz zu Fest-AVIS-Schlüssel 1 |
avisZusatz2 | String | 20 | - | Zusatz zu Fest-AVIS-Schlüssel 2 |
bestellNr | String | 20 | - | - |
String | 100 | - | Für automatische Mailavisierung | |
empfMobilfunkNr | String | 20 | - | Mobilfunknummer des Empfängers |
faxNr | String | 20 | - | Faxnummer des Empfängers |
flexZustellungEmailadResponsese | String | 80 | - | Flex-Zustellung Email-Adresse |
frachtBrief | String | 20 | - | Frachtbrief Nummer, falls Frachtbrief durch Vorsystem gedruckt wird. |
frachtfuehrerKdNr | String | 10 | - | Kundennummer des Frachtzahlers beim Frachtführer. |
frankaturKennung | String | 10 | - | - |
ilnNr | String | 20 | - | ILN des Empfängers (Pflicht bei Metro-Versand) |
kostenstelle | String | 30 | - | - |
kundenNr | String | 20 | - | Kundennummer des Empfängers beim Versender |
Lagerkennzeichen | String | |||
LieferantenID | String | |||
lieferscheinNr | String | 40 | - | Wird im HVS32 als Such-Nummer verwendet. |
neutBIC | String | 11 | - | Nur bei Neutral-Absendern belegt |
neutBankBezeichnung | String | 40 | - | Nur bei Neutral-Absendern belegt |
neutIBAN | String | 31 | - | Nur bei Neutral-Absendern belegt |
neutKontoInhaber | String | 40 | - | Nur bei Neutral-Absendern belegt |
neutabsenderLKZ | String | 3 | - | Nur bei Neutral-Absendern belegt |
neutabsenderName1 | String | 50 | - | Nur bei Neutral-Absendern belegt |
neutabsenderName2 | String | 50 | - | Nur bei Neutral-Absendern belegt |
neutabsenderName3 | String | 50 | - | Nur bei Neutral-Absendern belegt |
neutabsenderOrt | String | 50 | - | Nur bei Neutral-Absendern belegt |
neutabsenderPLZ | String | 10 | - | Nur bei Neutral-Absendern belegt |
neutabsenderStrasse | String | 50 | - | Nur bei Neutral-Absendern belegt |
packStkGes | Integer | - | - | Gesamt-Anzahl Colli der Sendung |
packstueckDaten | Sequence <PackStueckDaten> | - | - | - |
packplatz | String | 10 | - | HVS32-Packplatz-Client, der den Auftrag verarbeten soll. |
paperlessInvoice | String | 1 | - | Nur im UPS PaperlessInvoice Fall (T=PaperlessInvoice / F=nicht PaperlessInvoice) |
postLeitcode | String | 15 | - | - |
postZielFrachtzent | String | 5 | - | - |
rechnungsEmpfLKZ | String | 5 | - | Rechnungsadresse |
rechnungsEmpfName1 | String | 50 | - | Rechnungsempfänger |
rechnungsEmpfName2 | String | 50 | - | Rechnungsempfänger |
rechnungsEmpfName3 | String | 50 | - | Rechnungsempfänger |
rechnungsEmpfOrt | String | 50 | - | Rechnungsadresse |
rechnungsEmpfPLZ | String | 10 | - | Rechnungsadresse |
rechnungsEmpfStrasse | String | 50 | - | Rechnungsadresse |
rechnungsNr | String | 20 | - | Rechnungsnummer |
requestSPM | String | 5 | - | T/TRUE wenn die Entscheidungsmatrix angesprochen werden soll, sonst leer |
sendungsinhalt | String | 30 | - | - |
sonderdienste | String | 30 | - | Versandart-spezifisch belegt |
sperrFlag | String | 1 | - | T/F: T=Sperren, sonst nicht sperren |
telefonNr | String | 20 | - | Telefonnummer des Empfängers |
terminArt | String | 1 | - | 'A'b / 'B'is / 'F'ix |
terminDatum | String | 10 | - | TT.MM.JJJJ |
terminZeit | String | 5 | - | HH:MM |
ustIDNr | String | 20 | - | UmsatzsteuerNr des Empfängers |
versandartID | String | 10 | - | Versandartkennung aus dem HVS32 |
vorgabeFrachtfuehrer | String | 20 | - | Vorgabe-Frachtführer für SPM Anfrage |
vorpackdatum | String | 10 | - | TT.MM.JJJJ |
wechselbruecke | String | 20 | - | Wechselbrücke, die diesem Packstück zugewiesen werden soll |
zahlungsbedingung | String | 10 | - | 'S' = Sender, 'R' = Empfänger |
zbZoll | String | 1 | - | Zahlungsbedingung für Zoll Steuern 'S' = Sender, 'R' = Empfänger |
zielAdrBahnhof | String | 30 | - | PLZ und Ort |
zielAdrLKZ | String | 5 | - | Lieferadresse |
zielAdrName1 | String | 50 | - | Lieferadresse |
zielAdrName2 | String | 50 | - | Lieferadresse |
zielAdrName3 | String | 50 | - | Lieferadresse |
zielAdrName4 | String | 50 | - | Lieferadresse |
zielAdrOrt | String | 50 | - | Lieferadresse |
zielAdrPLZ | String | 10 | - | Lieferadresse |
zielAdrRegion | String | 20 | - | Staat/Provinz (z.B.: für Sendungen in die USA wichtig) |
zielAdrStrasse | String | 50 | - | Lieferadresse |
Rückgabe Parameter
- Sendungsdaten
Feldname | Typ | Max Länge | Dezimalstellen | Belegung |
---|---|---|---|---|
fehler | String | - | - | Wird im Fehlerfall befüllt |
sendungsGebuehr | Decimal | 18 | 2 | Frachkosten |
sendungsGebuehrWaehrung | String | 3 | - | Frachkosten ISO-Währungscode |
versandSendungsNr | String | 20 | - | Sendungsnummer |
- Packstückdaten
Feldname | Typ | Max Länge | Dezimalstellen | |
---|---|---|---|---|
assoc | Map (String, String) | - | - | Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert) |
ausgangDateTime | Calendar | 10 | - | Datum, wann das Etikett an den Frachtführer übermittelt worden ist (TT.MM.JJJJ) |
ausgangDateTimeString | String | 10 | - | Datum, wann das Etikett an den Frachtführer übermittelt worden ist (TT.MM.JJJJ) |
druckDateTime | Calendar | 19 | - | Datum, wann das Etikett im HVS32 gedruckt worden ist (TT.MM.JJJJ HH:mm:SS) |
druckDateTimeString | String | 19 | - | Datum, wann das Etikett im HVS32 gedruckt worden ist (TT.MM.JJJJ HH:mm:SS) |
etikettDaten | String | - | - | Binärdaten des Etiketts |
etikettName | String | - | - | Vorlagenname des Etiketts |
fehlercode | Integer | - | - | 0 wenn Erfolgreich |
fehlertext1 | String | 200 | - | Wird im Fehlerfall befüllt |
fehlertext2 | String | 200 | - | Wird im Fehlerfall befüllt |
gebuehr | Decimal | 18 | 2 | Frachtkosten |
gebuehrWaehrung | String | 3 | - | Frachkosten ISO-Währungscode |
packstueckID | String | 20 | - | PackstueckID aus der Anfrage |
retourTrackingNr | String | 50 | - | Paketnummer für die Retoure |
trackingNr | String | 35 | - | Paketnummer |
trackingURL | String | 255 | - | URL des Trackinglinks zur Sendungsverfolgung |
zusatzEtikettenDaten | Map (String, String) | - | - | Name und Binärdaten der Zusatzetiketten als Key/Value Map |
zusatzfeld1 | String | 200 | - | Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden |
zusatzfeld2 | String | 200 | - | Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden |
zusatzfeld3 | String | 200 | - | Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden |
zusatzfeld4 | String | 200 | - | Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden |
zusatzfeld5 | String | 200 | - | Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden |
zusatzfeld6 | String | 200 | - | Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden |
zusatzfeld7 | String | 200 | - | Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden |
zusatzfeld8 | String | 200 | - | Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden |
zusatzfeld9 | String | 200 | - | Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden |
zusatzfeld10 | String | 200 | - | Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden |