HVS32 REST Schnittstelle (Automatik-Polling): Unterschied zwischen den Versionen
Zeile 14: | Zeile 14: | ||
'''Fett''' dargestellte Felder müssen IMMER belegt sein. | '''Fett''' dargestellte Felder müssen IMMER belegt sein. | ||
<!-- ------------------------------------------------------------------------------- ENDE ÜBERSICHT DER FUNTKIONEN ------------------------------------------------------------------------------- --> | <!-- ------------------------------------------------------------------------------- ENDE ÜBERSICHT DER FUNTKIONEN ------------------------------------------------------------------------------- --> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
<!-- ------------------------------------------------------------------------------- echo ------------------------------------------------------------------------------- --> | <!-- ------------------------------------------------------------------------------- echo ------------------------------------------------------------------------------- --> | ||
− | == echo == | + | == Schnittstelle testen (echo) == |
Zum Testen der REST-Schnittstelle. Liefert die übergebene Nachricht unverändert zurück.<br><br> | Zum Testen der REST-Schnittstelle. Liefert die übergebene Nachricht unverändert zurück.<br><br> | ||
'''Funktion (GET): /hvs32rest/echo/<Nachricht>'''<br> | '''Funktion (GET): /hvs32rest/echo/<Nachricht>'''<br> | ||
<Nachricht> wird zurück gegeben. | <Nachricht> wird zurück gegeben. | ||
<!-- ------------------------------------------------------------------------------- ENDE echo ------------------------------------------------------------------------------- --> | <!-- ------------------------------------------------------------------------------- ENDE echo ------------------------------------------------------------------------------- --> | ||
− | <!-- ------------------------------------------------------------------------------- | + | <!-- ------------------------------------------------------------------------------- versanddatenAnfrage ------------------------------------------------------------------------------- --> |
− | == | + | |
− | + | == Packstück-Verarbeitung (versanddatenAnfrage) == | |
− | '''Funktion (POST): /hvs32rest/ | + | HVS32-VersandDatenAnfrage zum Erzeugen von Versandeinheiten und anschließendem Druck der zugehörigen Etiketten.<br><br> |
− | ; | + | '''Funktion (POST): /hvs32rest/versanddatenAnfrage'''<br> |
− | :Anfrage vom Hostsystem zum | + | ;VersanddatenAnfrage. '''[[#Datentypen|Datentyp String]]'''<br> |
+ | :Anfrage vom Hostsystem zum Drucken eines Versandetiketts für ein Packstück. | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung | ! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung | ||
|- | |- | ||
− | | | + | | ansprechpartner || [[#Datentypen|String]] || 20 || - || Empfänger Ansprechpartner |
− | |||
− | |||
|- | |- | ||
− | | | + | | anzahlArtikel || [[#Datentypen|Integer]] || 6 || - || Anzahl Artikel (Druck auf Etikett) |
− | |||
|- | |- | ||
− | + | | [[#artikelDaten|artikelDaten]] || [[#Datentypen|Sequence]] '''[[#artikelDaten|<ArtikelDaten>]]''' || - || - || Eine Liste der [[#artikelDaten|Packstück-Artikel]] vom Typ '''[[#artikelDaten|ArtikelDaten]]''' (1:n) | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | : | ||
− | |||
− | |||
− | |||
|- | |- | ||
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert) | | assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert) | ||
|- | |- | ||
− | | | + | | auftragNr || [[#Datentypen|String]] || 20 || - || - |
|- | |- | ||
− | | | + | | '''auftraggeberID''' || [[#Datentypen|String]] || 10 || - || Mandantenkennung aus dem HVS32 |
|- | |- | ||
− | | | + | | avisHinweis1 || [[#Datentypen|String]] || 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 |
− | |||
− | |||
|- | |- | ||
− | | | + | | barcodeID || [[#Datentypen|String]] || - || - || Zusatzfeld für evtl. Erweiterungen |
− | |||
|- | |- | ||
− | | | + | | barcodeText || [[#Datentypen|String]] || - || - || Zusatzfeld für evtl. Erweiterungen |
− | |||
− | |||
|- | |- | ||
− | | | + | | barcodeTyp || [[#Datentypen|String]] || - || - || Zusatzfeld für evtl. Erweiterungen |
|- | |- | ||
− | | | + | | bestellNr || [[#Datentypen|String]] || 20 || - || Metro-Bestellnr (Metro-Versand) |
− | |||
|- | |- | ||
− | | | + | | druckername || [[#Datentypen|String]] || 30 || - || Name eines Ausgabekanals (Drucker) im HVS32 über den das Etikett gedruckt wird. (Benötigt Druckerspooler Erweiterungsmodul) |
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
− | + | | email || [[#Datentypen|String]] || 100 || - || E-Mail Adresse des Empfängers (z.B.: für die Automatische E-Mail Avisierung) | |
|- | |- | ||
− | | | + | | empfMobilfunkNr || [[#Datentypen|String]] || 20 || - || Mobilfunknummer des Empfängers |
|- | |- | ||
− | | | + | | faxNr || [[#Datentypen|String]] || 20 || - || Faxnummer des Empfängers |
|- | |- | ||
− | | | + | | flexZustellungEmailadresse || [[#Datentypen|String]] || 80 || - || Flex-Zustellung Emailadresse |
|- | |- | ||
− | | | + | | frachtBrief || [[#Datentypen|String]] || 20 || - || Frachtbrief Nummer falls Frachtbrief durch Vorsystem gedruckt werden soll |
|- | |- | ||
− | | | + | | frachtfuehrerKdNr || [[#Datentypen|String]] || 10 || - || Kundennummer des Frachtzahlers beim Frachtführer |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
− | + | | frankaturKennung || [[#Datentypen|String]] || 10 || - || - | |
|- | |- | ||
− | | | + | | [[#gefahrgut|gefahrgut]] || [[#Datentypen|Sequence]] '''[[#gefahrgut|<Gefahrgut>]]''' || - || - || Eine Liste der [[#gefahrgut|Gefahrgüter]] vom Typ '''[[#gefahrgut|Gefahrgut]]''' (1:n) |
|- | |- | ||
− | | | + | | gewicht || [[#Datentypen|Decimal]] || 8 || 3 || Bruttogewicht in KG |
|- | |- | ||
− | | | + | | hostTrackingNr || [[#Datentypen|String]] || 35 || - || Paketnummer aus dem Hostsystem |
|- | |- | ||
− | | | + | | ilnNr || [[#Datentypen|String]] || 20 || - || ILN des Empfängers (Pflicht bei Metro-Versand) |
|- | |- | ||
− | | | + | | infotext1 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen |
|- | |- | ||
− | | | + | | infotext2 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen |
|- | |- | ||
− | | | + | | infotext3 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen |
|- | |- | ||
− | | | + | | infotext4 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen |
|- | |- | ||
− | | | + | | infotext5 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen |
|- | |- | ||
− | | | + | | infotext6 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen |
|- | |- | ||
− | | | + | | infotext7 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen |
|- | |- | ||
− | | | + | | infotext8 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen |
|- | |- | ||
− | | | + | | infotext9 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen |
|- | |- | ||
− | | | + | | infotext10 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen |
|- | |- | ||
− | | | + | | kostenstelle || [[#Datentypen|String]] || 30 || - || - |
|- | |- | ||
− | | | + | | kundenNr || [[#Datentypen|String]] || 20 || - || Kundennummer des Empfängers beim Versender |
|- | |- | ||
− | | | + | | lagerkennzeichen || [[#Datentypen|Integer]] || - || - || - |
|- | |- | ||
− | | | + | | letztesPackstueck || [[#Datentypen|String]] || 1 || - || T/F: T=letztes Packstüeck der Sendung (wird bei Hängeversand zum Drucken der Sendungs-Hängekarte benötigt) |
|- | |- | ||
− | | | + | | lieferantenID || [[#Datentypen|Integer]] || - || - || - |
|- | |- | ||
− | | | + | | '''lieferscheinNr''' || [[#Datentypen|String]] || 40 || - || Wird im HVS32 als Such-Nummer verwendet |
|- | |- | ||
− | | | + | | nachnahme || [[#Datentypen|Decimal]] || 18 || 2 || - |
|- | |- | ||
− | | | + | | nettoGewicht || [[#Datentypen|Decimal]] || 8 || 3 || Nettogewicht in KG |
− | |||
− | |||
|- | |- | ||
| neutBIC || [[#Datentypen|String]] || 11 || - || Nur bei Neutral-Absendern belegt | | neutBIC || [[#Datentypen|String]] || 11 || - || Nur bei Neutral-Absendern belegt | ||
Zeile 227: | Zeile 141: | ||
| 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 254: | Zeile 182: | ||
|- | |- | ||
| rechnungsNr || [[#Datentypen|String]] || 20 || - || Rechnungsnummer | | rechnungsNr || [[#Datentypen|String]] || 20 || - || Rechnungsnummer | ||
− | |||
− | |||
|- | |- | ||
| sendungsinhalt || [[#Datentypen|String]] || 30 || - || - | | sendungsinhalt || [[#Datentypen|String]] || 30 || - || - | ||
Zeile 269: | Zeile 195: | ||
| 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 285: | Zeile 219: | ||
| zbZoll || [[#Datentypen|String]] || 1 || - || Zahlungsbedingung für Zoll Steuern 'S' = Sender, 'R' = Empfänger | | zbZoll || [[#Datentypen|String]] || 1 || - || Zahlungsbedingung für Zoll Steuern 'S' = Sender, 'R' = Empfänger | ||
|- | |- | ||
− | | zielAdrBahnhof || [[#Datentypen|String]] || 30 || - || PLZ und Ort | + | | zielAdrBahnhof || [[#Datentypen|String]] || 30 || - || PLZ und Ort |
|- | |- | ||
− | | '''zielAdrLKZ''' || [[#Datentypen|String]] || 5 || - || | + | | '''zielAdrLKZ''' || [[#Datentypen|String]] || 5 || - || Lieferadresse |
|- | |- | ||
| '''zielAdrName1''' || [[#Datentypen|String]] || 50 || - || Lieferadresse | | '''zielAdrName1''' || [[#Datentypen|String]] || 50 || - || Lieferadresse | ||
Zeile 306: | Zeile 240: | ||
|} | |} | ||
<br> | <br> | ||
− | ; | + | ;VersanddatenAntwort. '''[[#Datentypen|Datentyp String]]'''<br> |
− | :Rückmeldung vom HVS32 nach einer sendungsdatenAnfrage. | + | :Rückmeldung vom HVS32 nach einer sendungsdatenAnfrage. |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
Zeile 358: | Zeile 277: | ||
|- | |- | ||
| 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 382: | Zeile 303: | ||
|} | |} | ||
;<big><big>'''[[REST_Beispiel|JSON Beispiele]]'''</big></big> | ;<big><big>'''[[REST_Beispiel|JSON Beispiele]]'''</big></big> | ||
− | <!-- ------------------------------------------------------------------------------- ENDE | + | <!-- ------------------------------------------------------------------------------- ENDE versanddatenAnfrage ------------------------------------------------------------------------------- --> |
− | <!-- ------------------------------------------------------------------------------- | + | <!-- ------------------------------------------------------------------------------- versanddatenNachdruckAnfrage ------------------------------------------------------------------------------- --> |
+ | |||
+ | == Etikett nachdrucken (versanddatenNachdruckAnfrage) == | ||
+ | Dient dem Nachdruck von Versandetiketten (Schalter in Sektion AutomatikPolling: NachdruckBeiVersanddatenanfrage=“ON“ muss gesetzt sein)<br><br> | ||
+ | '''Funktion (POST): /hvs32rest/versanddatenNachdruckAnfrage'''<br> | ||
+ | ;VersanddatenNachdruckAnfrage. '''[[#Datentypen|Datentyp String]]'''<br> | ||
+ | :Anfrage vom Hostsystem zum Nachdruck eines zuvor erstellten Versandetiketts. Schalter NachdruckBeiVersanddatenanfrage=“ON“ in Sektion AutomatikPolling muss gesetzt sein. | ||
− | |||
− | |||
− | |||
− | |||
− | |||
{| 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. | | 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> | ||
− | ; | + | ;[[#versanddatenAnfrage|VersanddatenAntwort]]. '''[[#Datentypen|Datentyp String]]''' |
− | + | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
;<big><big>'''[[REST_Beispiel|JSON Beispiele]]'''</big></big> | ;<big><big>'''[[REST_Beispiel|JSON Beispiele]]'''</big></big> | ||
− | <!-- ------------------------------------------------------------------------------- ENDE | + | <!-- ------------------------------------------------------------------------------- ENDE versanddatenNachdruckAnfrage ------------------------------------------------------------------------------- --> |
<!-- ------------------------------------------------------------------------------- stornoVersanddaten ------------------------------------------------------------------------------- --> | <!-- ------------------------------------------------------------------------------- stornoVersanddaten ------------------------------------------------------------------------------- --> | ||
Zeile 445: | Zeile 361: | ||
;<big><big>'''[[REST_Beispiel|JSON Beispiele]]'''</big></big> | ;<big><big>'''[[REST_Beispiel|JSON Beispiele]]'''</big></big> | ||
<!-- ------------------------------------------------------------------------------- ENDE stornoversanddaten ------------------------------------------------------------------------------- --> | <!-- ------------------------------------------------------------------------------- ENDE stornoversanddaten ------------------------------------------------------------------------------- --> | ||
+ | <!-- ------------------------------------------------------------------------------- verladeVersandaten ------------------------------------------------------------------------------- --> | ||
+ | == Packstück verladen / freigeben (verladeVersanddaten) == | ||
+ | HVS32-VerladeVersandDaten zur Ausgangsfreigabe von erzeugten Versandeinheiten<br><br> | ||
+ | '''Funktion (POST): /hvs32rest/verladeVersanddaten'''<br> | ||
+ | ;VerladeAnfrage. '''[[#Datentypen|Datentyp String]]'''<br> | ||
+ | :Anfrage vom Hostsystem zur Ausgangsverladung eines zuvor etikettierten Packstücks. | ||
+ | {| 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> | ||
+ | ;VerladeAntwort. '''[[#Datentypen|Datentyp String]]'''<br> | ||
+ | :Rückmeldung vom HVS32 nach einer VerladeAnfrage | ||
+ | {| 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>'''[[REST_Beispiel|JSON Beispiele]]'''</big></big> | ||
+ | <!-- ------------------------------------------------------------------------------- ENDE verladeVersandaten ------------------------------------------------------------------------------- --> | ||
+ | <!-- ------------------------------------------------------------------------------- sperreVersanddaten ------------------------------------------------------------------------------- --> | ||
+ | |||
+ | == Packstück sperren (sperreVersanddaten) == | ||
+ | HVS32-Sperre-VersandDaten zum Sperren von bereits freigegebenen Versandeinheiten<br><br> | ||
+ | '''Funktion (POST): /hvs32rest/sperreVersanddaten'''<br> | ||
+ | ;SperrAnfrage. '''[[#Datentypen|Datentyp String]]'''<br> | ||
+ | :Anfrage vom Hostsystem zum Sperren von Packstücken im HVS32. | ||
+ | {| class="wikitable sortable" | ||
+ | |- | ||
+ | ! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung | ||
+ | |- | ||
+ | | packplatz|| [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Auftrag verarbeiten soll. | ||
+ | |- | ||
+ | | packstueckID|| [[#Datentypen|String]] || 20 || - || '''Eindeutige''' Nummer für das Paket im Vorsystem. | ||
+ | |} | ||
+ | <br> | ||
+ | ;SperrAntwort. '''[[#Datentypen|Datentyp String]]'''<br> | ||
+ | :Rückmeldung vom HVS32 nach einer sperreVersanddaten | ||
+ | {| class="wikitable sortable" | ||
+ | |- | ||
+ | ! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung | ||
+ | |- | ||
+ | | fehlercode || [[#Datentypen|Integer]] || - || - || 0 = Erfolgreich | ||
+ | |- | ||
+ | | fehlertext1 || [[#Datentypen|String]] || 200 || - || - | ||
+ | |- | ||
+ | | fehlertext2 || [[#Datentypen|String]] || 200 || - || - | ||
+ | |} | ||
+ | ;<big><big>'''[[REST_Beispiel|JSON Beispiele]]'''</big></big> | ||
+ | <!-- ------------------------------------------------------------------------------- ENDE sperreversanddaten ------------------------------------------------------------------------------- --> | ||
<!-- ------------------------------------------------------------------------------- tagesabschluss ------------------------------------------------------------------------------- --> | <!-- ------------------------------------------------------------------------------- tagesabschluss ------------------------------------------------------------------------------- --> | ||
− | == tagesabschluss == | + | == Tagesabschluss (tagesabschluss) == |
Generiert den HVS32 Tagesabschluss ([[#ListenabschlussAnfrage|Listenabschluss]] + [[#ediabschlussAnfrage|EDI Übertragung]])<br><br> | Generiert den HVS32 Tagesabschluss ([[#ListenabschlussAnfrage|Listenabschluss]] + [[#ediabschlussAnfrage|EDI Übertragung]])<br><br> | ||
'''Funktion (POST): /hvs32rest/tagesabschluss'''<br> | '''Funktion (POST): /hvs32rest/tagesabschluss'''<br> | ||
Zeile 495: | Zeile 475: | ||
;<big><big>'''[[REST_Beispiel|JSON Beispiele]]'''</big></big> | ;<big><big>'''[[REST_Beispiel|JSON Beispiele]]'''</big></big> | ||
<!-- ------------------------------------------------------------------------------- ENDE tagesabschluss ------------------------------------------------------------------------------- --> | <!-- ------------------------------------------------------------------------------- ENDE tagesabschluss ------------------------------------------------------------------------------- --> | ||
− | <!-- ------------------------------------------------------------------------------- | + | <!-- ------------------------------------------------------------------------------- ListenabschlussAnfrage ------------------------------------------------------------------------------- --> |
− | |||
− | |||
− | |||
− | |||
− | |||
+ | == Ausgangsliste erzeugen (ListenabschlussAnfrage) == | ||
+ | Zum Erzeugen einer AusgangsListe.<br><br> | ||
+ | '''Funktion (POST): /hvs32rest/ListenabschlussAnfrage'''<br> | ||
+ | ;ListenabschlussAnfrage. '''[[#Datentypen|Datentyp String]]'''<br> | ||
+ | :Anfrage vom Hostsystem zum Abschließen der Listen (muss vor dem [[#ediabschlussAnfrage|ediabschlussAnfrage]] erfolgen) | ||
+ | {| class="wikitable sortable" | ||
+ | |- | ||
+ | ! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung | ||
+ | |- | ||
+ | | auftraggeberID || [[#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 die Listen gedruckt werden sollen. | ||
+ | (Benötigt Druckerspooler Erweiterungsmodul) | ||
+ | |- | ||
+ | | frachtfuehrerTyp || [[#Datentypen|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 Listenabschluss ausführen soll. | ||
+ | |- | ||
+ | | versandartID || [[#Datentypen|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]] || 10 || - || Kennzeichen der abzuschließenden Wechselbrücke. Hiermit können nur bestimmte Sendungen abgeschlossen werden. | ||
+ | |} | ||
<br> | <br> | ||
− | ;[[# | + | ;ListenabschlussAntwort. '''[[#Datentypen|Datentyp String]]'''<br> |
− | + | :Rückmeldung vom HVS32 nach einer ListenabschlussAnfrage | |
+ | {| class="wikitable sortable" | ||
+ | |- | ||
+ | ! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung | ||
+ | |- | ||
+ | | assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert) | ||
+ | |- | ||
+ | | fehlercode || [[#Datentypen|Integer]] || - || - || 0 = Erfolgreich | ||
+ | |- | ||
+ | | fehlertext1 || [[#Datentypen|String]] || 200 || - || - | ||
+ | |- | ||
+ | | fehlertext2 || [[#Datentypen|String]] || 200 || - || - | ||
+ | |- | ||
+ | | listenDaten || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Name und Binärdaten der Listen als Key/Value Map. | ||
+ | |} | ||
;<big><big>'''[[REST_Beispiel|JSON Beispiele]]'''</big></big> | ;<big><big>'''[[REST_Beispiel|JSON Beispiele]]'''</big></big> | ||
− | <!-- ------------------------------------------------------------------------------- ENDE | + | <!-- ------------------------------------------------------------------------------- ENDE Listenabschluss ------------------------------------------------------------------------------- --> |
− | <!-- ------------------------------------------------------------------------------- | + | <!-- ------------------------------------------------------------------------------- ediabschlussAnfrage ------------------------------------------------------------------------------- --> |
− | == | + | == Frachtführer DFÜ erzeugen (ediabschlussAnfrage) == |
− | + | Zum Erzeugen der Frachtführer DFÜ ([[#ListenabschlussAnfrage|AusgangsListe]] muss zuvor erzeugt worden sein!)<br><br> | |
− | '''Funktion (POST): /hvs32rest/ | + | '''Funktion (POST): /hvs32rest/ediabschlussAnfrage'''<br> |
− | ; | + | ;EDIabschlussAnfrage. '''[[#Datentypen|Datentyp String]]'''<br> |
− | :Anfrage vom Hostsystem | + | :Anfrage vom Hostsystem zum Abschließen der EDI (muss nach der [[#ListenabschlussAnfrage|ListenabschlussAnfrage]] erfolgen) |
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung | ! 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 | + | | 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]] || | + | | wechselbruecke|| [[#Datentypen|String]] || 10 || - || Kennzeichen der abzuschließenden Wechselbrücke. Hiermit können nur bestimmte Sendungen abgeschlossen werden. |
|} | |} | ||
<br> | <br> | ||
− | ; | + | ;EDIabschlussAntwort. '''[[#Datentypen|Datentyp String]]'''<br> |
− | :Rückmeldung vom HVS32 nach einer | + | :Rückmeldung vom HVS32 nach einer EDIabschlussAnfrage |
{| 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) | ||
+ | |- | ||
+ | | [[#edistatus|edistatus]] || [[#Datentypen|Sequence]] [[#edistatus|<EDIStatus>]] || - || - || Liste mit Statusinformationen für EDIs. | ||
|- | |- | ||
| fehlercode || [[#Datentypen|Integer]] || - || - || 0 = Erfolgreich | | fehlercode || [[#Datentypen|Integer]] || - || - || 0 = Erfolgreich | ||
Zeile 537: | Zeile 566: | ||
| 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>'''[[REST_Beispiel|JSON Beispiele]]'''</big></big> | ;<big><big>'''[[REST_Beispiel|JSON Beispiele]]'''</big></big> | ||
− | <!-- ------------------------------------------------------------------------------- ENDE | + | <!-- ------------------------------------------------------------------------------- ENDE ediabschlussAnfrage ------------------------------------------------------------------------------- --> |
− | <!-- ------------------------------------------------------------------------------- | + | <!-- ------------------------------------------------------------------------------- versanddatenPruefAnfrage ------------------------------------------------------------------------------- --> |
− | == | + | == Packstückdaten prüfen (versanddatenPruefAnfrage) == |
− | HVS32-VersandDatenAnfrage zum | + | HVS32-VersandDatenAnfrage zum Prüfen der Versanddaten.<br><br> |
− | '''Funktion (POST): /hvs32rest/ | + | '''Funktion (POST): /hvs32rest/versanddatenPruefAnfrage'''<br> |
− | ; | + | ;VersanddatenPruefAnfrage. '''[[#Datentypen|Datentyp String]]'''<br> |
:Anfrage vom Hostsystem zum Drucken eines Versandetiketts für ein Packstück. | :Anfrage vom Hostsystem zum Drucken eines Versandetiketts für ein Packstück. | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
Zeile 554: | Zeile 583: | ||
| ansprechpartner || [[#Datentypen|String]] || 20 || - || Empfänger Ansprechpartner | | ansprechpartner || [[#Datentypen|String]] || 20 || - || Empfänger Ansprechpartner | ||
|- | |- | ||
− | + | | [[#artikelDaten|artikelDaten]] || [[#Datentypen|Sequence]] [[#artikelDaten|<ArtikelDaten>]] || - || - || - | |
− | |||
− | | [[#artikelDaten|artikelDaten]] || [[#Datentypen|Sequence]] | ||
|- | |- | ||
| 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 571: | Zeile 598: | ||
|- | |- | ||
| 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 583: | Zeile 604: | ||
|- | |- | ||
| 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 596: | Zeile 615: | ||
| frankaturKennung || [[#Datentypen|String]] || 10 || - || - | | frankaturKennung || [[#Datentypen|String]] || 10 || - || - | ||
|- | |- | ||
− | | [[#gefahrgut|gefahrgut]] || [[#Datentypen|Sequence]] | + | | [[#gefahrgut|gefahrgut]] || [[#Datentypen|Sequence]] [[#gefahrgut|<Gefahrgut>]] || - || - || - |
|- | |- | ||
| 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 628: | Zeile 645: | ||
| 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 703: | Zeile 706: | ||
|- | |- | ||
| 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 725: | Zeile 724: | ||
|- | |- | ||
| 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 761: | Zeile 756: | ||
|} | |} | ||
<br> | <br> | ||
− | ; | + | ;VersanddatenPruefAntwort. '''[[#Datentypen|Datentyp String]]'''<br> |
:Rückmeldung vom HVS32 nach einer sendungsdatenAnfrage. | :Rückmeldung vom HVS32 nach einer sendungsdatenAnfrage. | ||
{| 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) | | druckDateTime || [[#Datentypen|Calendar]] || 19 || - || Datum, wann das Etikett im HVS32 gedruckt worden ist (TT.MM.JJJJ HH:mm:SS) | ||
Zeile 777: | Zeile 766: | ||
| druckDateTimeString || [[#Datentypen|String]] || 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>'''[[REST_Beispiel|JSON Beispiele]]'''</big></big> | ||
+ | <!-- ------------------------------------------------------------------------------- ENDE versanddatenPruefAnfrage ------------------------------------------------------------------------------- --> | ||
+ | <!-- ------------------------------------------------------------------------------- updateVersanddaten ------------------------------------------------------------------------------- --> | ||
+ | |||
+ | == Packstückdaten aktualisieren (updateVersanddaten) == | ||
+ | HVS32-UpdateVersandDaten zur Aktualisierung von Feldinhalten bei einer bereits erzeugten Versandeinheit. Zur Identifizierung der Versandeinheit dient das Feld PackstueckID. Tatsächlich zu aktualisierende Felder müssen zusätzlich im HVS32 unter den Sektionen GW_UpdateFieldList_VE / AE / AssocMemo / Lieferung<br><br> | ||
+ | '''Funktion (POST): /hvs32rest/updateVersanddaten'''<br> | ||
+ | ;[[#versanddatenAnfrage|VersandDatenAnfrage]]. '''[[#Datentypen|Datentyp String]]'''<br> | ||
+ | |||
+ | <br> | ||
+ | ;[[#versanddatenAnfrage|VersanddatenAntwort]]. '''[[#Datentypen|Datentyp String]]''' | ||
+ | |||
+ | ;<big><big>'''[[REST_Beispiel|JSON Beispiele]]'''</big></big> | ||
+ | <!-- ------------------------------------------------------------------------------- ENDE updateVersanddaten ------------------------------------------------------------------------------- --> | ||
+ | <!-- ------------------------------------------------------------------------------- anonymisiereVersandDaten ------------------------------------------------------------------------------- --> | ||
+ | == Packstückdaten anonymisieren (anonymisiereVersandDaten) == | ||
+ | Anonymisiert personenbezogene Daten, wie zum Beispiel Anschrift, Telefonnr., usw.<br><br> | ||
+ | '''Funktion (POST): /hvs32rest/anonymisiereVersandDaten'''<br> | ||
+ | ;AnonymisiereVersandDatenRequest. '''[[#Datentypen|Datentyp String]]'''<br> | ||
+ | :Anfrage vom Hostsystem zur Anonymisierung personenbezogener Daten.<br> | ||
+ | {| class="wikitable sortable" | ||
|- | |- | ||
− | + | ! Feldname !! Typ !! Max Länge !! Nachkommastellen !! Belegung | |
|- | |- | ||
− | | | + | | auftragsNr || [[#Datentypen|String]] || 20 || - || - |
|- | |- | ||
− | | | + | | lieferscheinNr || [[#Datentypen|String]] || 40 || - || Wird im HVS32 als Such-Nummer verwendet. |
|- | |- | ||
− | | | + | | packplatz || [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Auftrag verarbeiten soll. |
|- | |- | ||
− | + | | packstueckID || [[#Datentypen|String]] || 20 || - || '''Eindeutige''' Nummer für das Paket im Vorsystem. | |
− | |||
− | | packstueckID || [[#Datentypen|String]] || 20 || - || | ||
− | |||
− | |||
|- | |- | ||
| trackingNr || [[#Datentypen|String]] || 35 || - || Paketnummer | | trackingNr || [[#Datentypen|String]] || 35 || - || Paketnummer | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|} | |} | ||
− | + | <br> | |
− | + | ;AnonymisiereVersandDatenResponse. '''[[#Datentypen|Datentyp String]]'''<br> | |
− | + | :Rückmeldung vom HVS32 nachdem der Datensatz anonymisiert worden ist. | |
− | |||
− | |||
− | |||
− | |||
− | ; | ||
− | : | ||
− | |||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
− | ! Feldname !! Typ !! Max Länge !! | + | ! 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>'''[[REST_Beispiel|JSON Beispiele]]'''</big></big> | ;<big><big>'''[[REST_Beispiel|JSON Beispiele]]'''</big></big> | ||
− | <!-- ------------------------------------------------------------------------------- ENDE | + | <!-- ------------------------------------------------------------------------------- ENDE anonymisiereVersandDaten ------------------------------------------------------------------------------- --> |
− | <!-- ------------------------------------------------------------------------------- | + | <!-- ------------------------------------------------------------------------------- sendungsdatenAnfrage ------------------------------------------------------------------------------- --> |
− | == | + | == Sendungs-Verarbeitung (sendungsdatenAnfrage) == |
− | HVS32- | + | 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> |
− | '''Funktion (POST): /hvs32rest/ | + | '''Funktion (POST): /hvs32rest/sendungsdatenAnfrage'''<br> |
− | ; | + | ;sendungsdatenAnfrage. '''[[#Datentypen|Datentyp String]]'''<br> |
− | :Anfrage vom Hostsystem zum Drucken | + | :Anfrage vom Hostsystem zum Drucken einer Sendung mit mehreren Packstücken. |
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
Zeile 862: | Zeile 830: | ||
|- | |- | ||
| 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 870: | Zeile 836: | ||
|- | |- | ||
| '''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 879: | Zeile 847: | ||
| 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 945: | Zeile 897: | ||
| 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 986: | Zeile 924: | ||
|- | |- | ||
| 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 995: | Zeile 939: | ||
| 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.015: | Zeile 955: | ||
| zbZoll || [[#Datentypen|String]] || 1 || - || Zahlungsbedingung für Zoll Steuern 'S' = Sender, 'R' = Empfänger | | zbZoll || [[#Datentypen|String]] || 1 || - || Zahlungsbedingung für Zoll Steuern 'S' = Sender, 'R' = Empfänger | ||
|- | |- | ||
− | | zielAdrBahnhof || [[#Datentypen|String]] || 30 || - || PLZ und Ort | + | | zielAdrBahnhof || [[#Datentypen|String]] || 30 || - || PLZ und Ort des Bahnhofs |
|- | |- | ||
− | | '''zielAdrLKZ''' || [[#Datentypen|String]] || 5 || - || | + | | '''zielAdrLKZ''' || [[#Datentypen|String]] || 5 || - || Länderkennzeichen (LKZ) |
|- | |- | ||
| '''zielAdrName1''' || [[#Datentypen|String]] || 50 || - || Lieferadresse | | '''zielAdrName1''' || [[#Datentypen|String]] || 50 || - || Lieferadresse | ||
Zeile 1.036: | Zeile 976: | ||
|} | |} | ||
<br> | <br> | ||
− | ; | + | ;SendungsdatenAntwort. '''[[#Datentypen|Datentyp String]]'''<br> |
− | :Rückmeldung vom HVS32 nach einer sendungsdatenAnfrage. | + | :Rückmeldung vom HVS32 nach einer sendungsdatenAnfrage.<br> |
+ | ;Sendungsdaten | ||
+ | {| class="wikitable sortable" | ||
+ | |- | ||
+ | ! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung | ||
+ | |- | ||
+ | | fehler || [[#Datentypen|String]] || - || - || Wird im Fehlerfall befüllt | ||
+ | |- | ||
+ | | sendungsGebuehr || [[#Datentypen|Decimal]] || 18 || 2 || Frachkosten | ||
+ | |- | ||
+ | | sendungsGebuehrWaehrung || [[#Datentypen|String]] || 3 || - || Frachkosten ISO-Währungscode | ||
+ | |- | ||
+ | | versandSendungsNr || [[#Datentypen|String]] || 20 || - || Sendungsnummer | ||
+ | |} | ||
+ | |||
+ | ;Packstückdaten | ||
{| class="wikitable sortable" | {| 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) | ||
+ | |- | ||
+ | | 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) | | druckDateTime || [[#Datentypen|Calendar]] || 19 || - || Datum, wann das Etikett im HVS32 gedruckt worden ist (TT.MM.JJJJ HH:mm:SS) | ||
Zeile 1.046: | Zeile 1.007: | ||
| druckDateTimeString || [[#Datentypen|String]] || 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 || - || - | + | | 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>'''[[REST_Beispiel|JSON Beispiele]]'''</big></big> | ;<big><big>'''[[REST_Beispiel|JSON Beispiele]]'''</big></big> | ||
− | <!-- ------------------------------------------------------------------------------- ENDE | + | <!-- ------------------------------------------------------------------------------- ENDE sendungsdatenAnfrage ------------------------------------------------------------------------------- --> |
<!-- ------------------------------------------------------------------------------- ÜBERSICHT UNTERFUNKTIONEN ------------------------------------------------------------------------------- --> | <!-- ------------------------------------------------------------------------------- ÜBERSICHT UNTERFUNKTIONEN ------------------------------------------------------------------------------- --> | ||
Version vom 24. April 2020, 10:52 Uhr
DataGatewayServer Versionsstand: DGS-3_6_0_586
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
Übersicht der Funktionen
Fett dargestellte Felder müssen IMMER belegt sein.
Schnittstelle testen (echo)
Zum Testen der REST-Schnittstelle. Liefert die übergebene Nachricht unverändert zurück.
Funktion (GET): /hvs32rest/echo/<Nachricht>
<Nachricht> wird zurück gegeben.
Packstück-Verarbeitung (versanddatenAnfrage)
HVS32-VersandDatenAnfrage zum Erzeugen von Versandeinheiten und anschließendem Druck der zugehörigen Etiketten.
Funktion (POST): /hvs32rest/versanddatenAnfrage
- VersanddatenAnfrage. Datentyp String
- Anfrage vom Hostsystem zum Drucken eines Versandetiketts für ein Packstück.
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 |
- VersanddatenAntwort. Datentyp String
- Rückmeldung vom HVS32 nach einer sendungsdatenAnfrage.
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)
Dient dem Nachdruck von Versandetiketten (Schalter in Sektion AutomatikPolling: NachdruckBeiVersanddatenanfrage=“ON“ muss gesetzt sein)
Funktion (POST): /hvs32rest/versanddatenNachdruckAnfrage
- VersanddatenNachdruckAnfrage. Datentyp String
- Anfrage vom Hostsystem zum Nachdruck eines zuvor erstellten Versandetiketts. Schalter NachdruckBeiVersanddatenanfrage=“ON“ in Sektion AutomatikPolling muss gesetzt 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 |
Packstück stornieren (stornoVersanddaten)
HVS32-StornoVersandDaten zum Stornieren von erzeugten Versandeinheiten
Funktion (POST): /hvs32rest/stornoVersanddaten
- StornoAnfrage. Datentyp String
- Anfrage vom Hostsystem zum Stornieren/Löschen eines zuvor etikettierten Packstücks.
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 |
- StornoAntwort. Datentyp String
- Rückmeldung vom HVS32 nach einer stornoVersanddaten
Feldname | Typ | Max Länge | Dezimalstellen | Belegung |
---|---|---|---|---|
fehlercode | Integer | - | - | 0 = Erfolgreich |
fehlertext1 | String | 200 | - | - |
fehlertext2 | String | 200 | - | - |
Packstück verladen / freigeben (verladeVersanddaten)
HVS32-VerladeVersandDaten zur Ausgangsfreigabe von erzeugten Versandeinheiten
Funktion (POST): /hvs32rest/verladeVersanddaten
- VerladeAnfrage. Datentyp String
- Anfrage vom Hostsystem zur Ausgangsverladung eines zuvor etikettierten Packstücks.
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. |
- VerladeAntwort. Datentyp String
- Rückmeldung vom HVS32 nach einer VerladeAnfrage
Feldname | Typ | Max Länge | Dezimalstellen | Belegung |
---|---|---|---|---|
fehlercode | Integer | - | - | 0 = Erfolgreich |
fehlertext1 | String | 200 | - | - |
fehlertext1 | String | 200 | - | - |
Packstück sperren (sperreVersanddaten)
HVS32-Sperre-VersandDaten zum Sperren von bereits freigegebenen Versandeinheiten
Funktion (POST): /hvs32rest/sperreVersanddaten
- SperrAnfrage. Datentyp String
- Anfrage vom Hostsystem zum Sperren von Packstücken im HVS32.
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. |
- SperrAntwort. Datentyp String
- Rückmeldung vom HVS32 nach einer sperreVersanddaten
Feldname | Typ | Max Länge | Dezimalstellen | Belegung |
---|---|---|---|---|
fehlercode | Integer | - | - | 0 = Erfolgreich |
fehlertext1 | String | 200 | - | - |
fehlertext2 | String | 200 | - | - |
Tagesabschluss (tagesabschluss)
Generiert den HVS32 Tagesabschluss (Listenabschluss + EDI Übertragung)
Funktion (POST): /hvs32rest/tagesabschluss
- TagesabschlussAnfrage. Datentyp String
- Anfrage vom Hostsystem zum Abschließen der Listen + EDI
Feldname | Typ | Max Länge | Dezimalstellen | Belegung |
---|---|---|---|---|
auftraggeberID | 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 | 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 | 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. |
- TagesabschlussAntwort. Datentyp String
- Rückmeldung vom HVS32 nach einer tagesabschluss
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)
Zum Erzeugen einer AusgangsListe.
Funktion (POST): /hvs32rest/ListenabschlussAnfrage
- ListenabschlussAnfrage. Datentyp String
- Anfrage vom Hostsystem zum Abschließen der Listen (muss vor dem ediabschlussAnfrage erfolgen)
Feldname | Typ | Max Länge | Dezimalstellen | Belegung |
---|---|---|---|---|
auftraggeberID | 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 | 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 | 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. |
- ListenabschlussAntwort. Datentyp String
- Rückmeldung vom HVS32 nach einer ListenabschlussAnfrage
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)
Zum Erzeugen der Frachtführer DFÜ (AusgangsListe muss zuvor erzeugt worden sein!)
Funktion (POST): /hvs32rest/ediabschlussAnfrage
- EDIabschlussAnfrage. Datentyp String
- Anfrage vom Hostsystem zum Abschließen der EDI (muss nach der ListenabschlussAnfrage erfolgen)
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. |
- EDIabschlussAntwort. Datentyp String
- Rückmeldung vom HVS32 nach einer EDIabschlussAnfrage
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 prüfen (versanddatenPruefAnfrage)
HVS32-VersandDatenAnfrage zum Prüfen der Versanddaten.
Funktion (POST): /hvs32rest/versanddatenPruefAnfrage
- VersanddatenPruefAnfrage. Datentyp String
- Anfrage vom Hostsystem zum Drucken eines Versandetiketts für ein Packstück.
Feldname | Typ | Max Länge | Dezimalstellen | Belegung |
---|---|---|---|---|
ansprechpartner | String | 20 | - | Empfänger Ansprechpartner |
artikelDaten | Sequence <ArtikelDaten> | - | - | - |
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> | - | - | - |
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 |
- VersanddatenPruefAntwort. Datentyp String
- Rückmeldung vom HVS32 nach einer sendungsdatenAnfrage.
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)
HVS32-UpdateVersandDaten zur Aktualisierung von Feldinhalten bei einer bereits erzeugten Versandeinheit. Zur Identifizierung der Versandeinheit dient das Feld PackstueckID. Tatsächlich zu aktualisierende Felder müssen zusätzlich im HVS32 unter den Sektionen GW_UpdateFieldList_VE / AE / AssocMemo / Lieferung
Funktion (POST): /hvs32rest/updateVersanddaten
Packstückdaten anonymisieren (anonymisiereVersandDaten)
Anonymisiert personenbezogene Daten, wie zum Beispiel Anschrift, Telefonnr., usw.
Funktion (POST): /hvs32rest/anonymisiereVersandDaten
- AnonymisiereVersandDatenRequest. Datentyp String
- Anfrage vom Hostsystem zur Anonymisierung personenbezogener Daten.
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 |
- AnonymisiereVersandDatenResponse. Datentyp String
- Rückmeldung vom HVS32 nachdem der Datensatz anonymisiert worden ist.
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).
Funktion (POST): /hvs32rest/sendungsdatenAnfrage
- sendungsdatenAnfrage. Datentyp String
- Anfrage vom Hostsystem zum Drucken einer Sendung mit mehreren Packstücken.
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 des Bahnhofs |
zielAdrLKZ | String | 5 | - | Länderkennzeichen (LKZ) |
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 |
- SendungsdatenAntwort. Datentyp String
- Rückmeldung vom HVS32 nach einer sendungsdatenAnfrage.
- 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 |
Übersicht der spezial Datentypen
Ein spezial Datentyp kann innerhalb der Anfrage / Rückmeldung einer Funktion genutzt werden.
packstueckDaten
Feldname | Typ | Max Länge | Dezimalstellen | Belegung |
---|---|---|---|---|
anzahlArtikel | Integer | 6 | - | Anzahl Artikel (Druck auf Etikett) |
artikelDaten | Sequence <ArtikelDaten> | - | - | - |
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> | - | - | - |
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 |
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ührertyp (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) |