HVS32 Standard Datei Schnittstelle
Funktionsbeschreibung
Text anpassen an Dateischnittstelle
Datentypen
Integer - Zahl mit ausschließlich numerischen Zeichen (0-9).
Decimal - Zahl mit Nachkommastellen
Calendar - Datum. Monat ist dabei 0-basierend (0 = Januar, 11 = Dezember)
String - Beliebige Zeichen aus dem Zeichensatz ISO-8859-1. Maximale Länge darf nicht überschritten werden.
Binary - Base64 kodierte Binärdaten
Sequence - Eine Liste von Elementen
Map - Key/Value Map
Zusätzliche Datentypen
Ein spezial Datentyp kann innerhalb der Anfrage / Rückmeldung einer Funktion genutzt werden.
artikelDaten
Nr | Feldname | Von | Bis | Typ | Länge | Dezimalstellen | Pflicht | HVS-Feld | Belegung | Feldname |
---|---|---|---|---|---|---|---|---|---|---|
1 | Satz-Kennung | 1 | 3 | A | 3 | M | Festeintrag "ART" | Satz-Kennung | ||
2 | Lieferschein-Nr | 4 | 13 | A | 10 | M | Lieferschein-Nr | |||
3 | Packstück-Nr | 14 | 16 | N | 3 | C | Pflicht bei AutomatikPolling | Packstück-Nr | ||
4 | Positions-Nr | 17 | 26 | N | 10 | 0 | M | Positions-Nr | ||
5 | Artikel-Nr | 27 | 76 | A | 50 | O | Artikel-Nr | |||
6 | Artikel-Bezeichnung1 | 77 | 176 | A | 100 | M | Artikel-Bezeichnung1 | |||
7 | Artikel-Bezeichnung2 | 177 | 276 | A | 100 | O | Artikel-Bezeichnung2 | |||
8 | Artikel-Netto-Gewicht (je Maßeinheit) | 277 | 285 | N | 9 | 3 | M | Artikel-Netto-Gewicht (je Maßeinheit) | ||
9 | BTN-Nummer | 286 | 310 | A | 25 | O | BTN-Nummer | |||
10 | Artikel-Anzahl (je Maßeinheit) | 311 | 319 | N | 9 | 0 | M | Artikel-Anzahl (je Maßeinheit) | ||
11 | Ursprungsland | 320 | 321 | A | 2 | O | Ursprungsland | |||
12 | Artikel-Wert (je Maßeinheit) | 322 | 330 | N | 9 | 2 | O | Artikel-Wert (je Maßeinheit) | ||
13 | Artikelwert-Währung | 331 | 333 | A | 3 | O | ISO-Währung z.B. 'EUR' | Artikelwert-Währung | ||
14 | Artikel-Maßeinheit | 334 | 343 | A | 10 | O | Artikel-Maßeinheit | |||
15 | Artikel-BestellNr | 344 | 393 | A | 50 | M | Artikel-BestellNr | |||
16 | Artikel-Volumen | 394 | 402 | N | 9 | 3 | M | Artikel-Volumen | ||
17 | Artikel-Services | 403 | 452 | A | 50 | O | Artikel-Services | |||
18 | Artikel-Gruppe | 453 | 502 | A | 50 | O | Artikel-Gruppe |
M = Muss eingetragen werden, O = Optimal einzutragen, C = Conditional abhängig von anderen Feldern
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 |
gefahrgutID | String | 8 | - | Eindeutige Suchnummer für Gefahrgut-Stammdaten |
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 |
gefahrgutPositionNr | Integer | - | - | Netto-Explosivmasse in kg, nur bei Gefahrgütern der Klasse 1 |
gefahrgutTechBenennung | String | 150 | - | bedingt Pflicht bei N.A.G. Gefahrgut (d.h. wenn die Bezeichnung mit N.A.G. endet) |
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 |
Übersicht der Funktionen
Packstück-Verarbeitung ()
Text anpassen
Fett dargestellte Felder müssen IMMER belegt sein
Feldname | Typ | Max Länge | Dezimalstellen | Belegung |
---|---|---|---|---|
ansprechpartner | String | 20 | - | Empfänger Ansprechpartner |
anzahlArtikel | Integer | 6 | - | Anzahl Artikel (Druck auf Etikett) |
artikelDaten | Sequence <ArtikelDaten> | - | - | Eine Liste der Packstück-Artikel vom Typ ArtikelDaten (1:n) |
assoc | Map (String, String) | - | - | Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert) |
auftragNr | String | 20 | - | - |
auftraggeberID | String | 10 | - | Mandantenkennung aus dem HVS32 |
avisHinweis1 | String | 30 | - | - |
avisHinweis2 | String | 30 | - | - |
avisZusatz1 | String | 20 | - | Zusatz zu Fest-AVIS-Schlüssel 1 |
avisZusatz2 | String | 20 | - | Zusatz zu Fest-AVIS-Schlüssel 2 |
barcodeID | String | - | - | Zusatzfeld für evtl. Erweiterungen |
barcodeText | String | - | - | Zusatzfeld für evtl. Erweiterungen |
barcodeTyp | String | - | - | Zusatzfeld für evtl. Erweiterungen |
bestellNr | String | 20 | - | Metro-Bestellnr (Metro-Versand) |
druckername | String | 30 | - | Name eines Ausgabekanals (Drucker) im HVS32 über den das Etikett gedruckt wird. (Benötigt Druckerspooler Erweiterungsmodul) |
String | 100 | - | E-Mail Adresse des Empfängers (z.B.: für die Automatische E-Mail Avisierung) | |
empfMobilfunkNr | String | 20 | - | Mobilfunknummer des Empfängers |
faxNr | String | 20 | - | Faxnummer des Empfängers |
flexZustellungEmailadresse | String | 80 | - | Flex-Zustellung Emailadresse |
frachtBrief | String | 20 | - | Frachtbrief Nummer falls Frachtbrief durch Vorsystem gedruckt werden soll |
frachtfuehrerKdNr | String | 10 | - | Kundennummer des Frachtzahlers beim Frachtführer |
frankaturKennung | String | 10 | - | - |
gefahrgut | Sequence <Gefahrgut> | - | - | Eine Liste der Gefahrgüter vom Typ Gefahrgut (1:n) |
gewicht | Decimal | 8 | 3 | Bruttogewicht in KG |
hostTrackingNr | String | 35 | - | Paketnummer aus dem Hostsystem |
ilnNr | String | 20 | - | ILN des Empfängers (Pflicht bei Metro-Versand) |
infotext1 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext2 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext3 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext4 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext5 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext6 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext7 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext8 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext9 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext10 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
kostenstelle | String | 30 | - | - |
kundenNr | String | 20 | - | Kundennummer des Empfängers beim Versender |
lagerkennzeichen | Integer | - | - | - |
letztesPackstueck | String | 1 | - | T/F: T=letztes Packstüeck der Sendung (wird bei Hängeversand zum Drucken der Sendungs-Hängekarte benötigt) |
lieferantenID | Integer | - | - | - |
lieferscheinNr | String | 40 | - | Wird im HVS32 als Such-Nummer verwendet |
nachnahme | Decimal | 18 | 2 | - |
nettoGewicht | Decimal | 8 | 3 | Nettogewicht in KG |
neutBIC | String | 11 | - | Nur bei Neutral-Absendern belegt |
neutBankBezeichnung | String | 40 | - | Nur bei Neutral-Absendern belegt |
neutIBAN | String | 31 | - | Nur bei Neutral-Absendern belegt |
neutKontoInhaber | String | 40 | - | Nur bei Neutral-Absendern belegt |
neutabsenderLKZ | String | 3 | - | Nur bei Neutral-Absendern belegt |
neutabsenderName1 | String | 50 | - | Nur bei Neutral-Absendern belegt |
neutabsenderName2 | String | 50 | - | Nur bei Neutral-Absendern belegt |
neutabsenderName3 | String | 50 | - | Nur bei Neutral-Absendern belegt |
neutabsenderOrt | String | 50 | - | Nur bei Neutral-Absendern belegt |
neutabsenderPLZ | String | 10 | - | Nur bei Neutral-Absendern belegt |
neutabsenderStrasse | String | 50 | - | Nur bei Neutral-Absendern belegt |
nnVermerk | String | 1 | - | B': Bar / 'V': Verrechnungsscheck |
nnVerwendung | String | 30 | - | Nachnahme Verwendungszweck |
nnWaehrung | String | 3 | - | Nachnahme - ISO-Währungscode |
packStkGes | Integer | - | - | Gesamt-Anzahl Colli der Sendung |
packStkNr | Integer | - | - | Laufende Nr pro Sendung |
packplatz | String | 10 | - | HVS32-Packplatz-Client, der den Auftrag verarbeten soll. |
packstueckBreite | Integer | - | - | Breite in cm |
packstueckHoehe | Integer | - | - | Höhe in cm |
packstueckID | String | 20 | - | Eindeutige Nummer für das Paket im Vorsystem. Wird als eindeutige Paketreferenz benötigt um das Etikett später zu stornieren oder zu Verladen. |
packstueckLaenge | Integer | - | - | Länge in cm |
paperlessInvoice | String | 1 | - | Nur im UPS PaperlessInvoice Fall (T=PaperlessInvoice / F=nicht PaperlessInvoice) |
postLeitcode | String | 15 | - | - |
postZielFrachtzent | String | 5 | - | - |
rechnungsEmpfLKZ | String | 5 | - | Rechnungsadresse |
rechnungsEmpfName1 | String | 50 | - | Rechnungsempfänger |
rechnungsEmpfName2 | String | 50 | - | Rechnungsempfänger |
rechnungsEmpfName3 | String | 50 | - | Rechnungsempfänger |
rechnungsEmpfOrt | String | 50 | - | Rechnungsadresse |
rechnungsEmpfPLZ | String | 10 | - | Rechnungsadresse |
rechnungsEmpfStrasse | String | 50 | - | Rechnungsadresse |
rechnungsNr | String | 20 | - | Rechnungsnummer |
sendungsinhalt | String | 30 | - | - |
sonderdienste | String | 30 | - | Versandart-spezifisch belegt |
sperrFlag | String | 1 | - | T/F: T=Sperren, sonst nicht sperren |
telefonNr | String | 20 | - | Telefonnummer des Empfängers |
terminArt | String | 1 | - | 'A'b / 'B'is / 'F'ix |
terminDatum | String | 10 | - | TT.MM.JJJJ |
terminZeit | Calendar | 5 | - | HH:MM |
ustIDNr | String | 20 | - | UmsatzsteuerNr des Empfängers |
verpackungsart | String | 6 | - | - |
versandartID | String | 10 | - | Versandartkennung aus dem HVS32 |
versicherungswert | Decimal | 18 | 2 | Höhe Versicherungswert |
vorpackdatum | String | 10 | - | TT.MM.JJJJ |
vwWaehrung | String | 3 | - | Versicherungswert - ISO-Währungscode |
warenwert | Decimal | 18 | 2 | - |
wechselbruecke | String | 20 | - | Wechselbrücke, die diesem Packstück zugewiesen wird |
wwWaehrung | String | 3 | - | Warenwert - ISO-Währungscode |
zahlungsbedingung | String | 10 | - | 'S' = Sender, 'R' = Empfänger |
zbZoll | String | 1 | - | Zahlungsbedingung für Zoll Steuern 'S' = Sender, 'R' = Empfänger |
zielAdrBahnhof | String | 30 | - | PLZ und Ort |
zielAdrLKZ | String | 5 | - | Lieferadresse |
zielAdrName1 | String | 50 | - | Lieferadresse |
zielAdrName2 | String | 50 | - | Lieferadresse |
zielAdrName3 | String | 50 | - | Lieferadresse |
zielAdrName4 | String | 50 | - | Lieferadresse |
zielAdrOrt | String | 50 | - | Lieferadresse |
zielAdrPLZ | String | 10 | - | Lieferadresse |
zielAdrRegion | String | 20 | - | Staat/Provinz (z.B.: für Sendungen in die USA wichtig) |
zielAdrStrasse | String | 50 | - | Lieferadresse |
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 |
- Request
{
"ansprechpartner": "",
"assoc": {
"":""
},
"artikelDaten": [
{
"anzahlBuegel": 0,
"anzahlPosEtiketten": 0,
"artikelBTNNr": "",
"artikelEAN": "",
"artikelEinheit": "",
"artikelGewicht": 0,
"artikelGruppe": "",
"artikelMenge": 0,
"artikelServices": "",
"artikelSollMenge": 0,
"artikelText1": "",
"artikelText2": "",
"artikelText3": "",
"artikelText4": "",
"artikelVolumen": 0,
"artikelWaehrung": "",
"artikelWert": 0,
"chargeFlag": "",
"kundenArtikelNr": "",
"kundenBestellNr": "",
"posAuftragNr": "",
"posLieferNr": "",
"positionNr": "",
"serienNr": "",
"ursprungLand": ""
}
],
"auftragNr": "",
"auftraggeberID": "",
"avisHinweis1": "",
"avisHinweis2": "",
"avisZusatz1": "",
"avisZusatz2": "",
"bestellNr": "",
"druckername": "",
"email": "",
"faxNr": "",
"frachtBrief": "",
"frachtfuehrerKdNr": "",
"frankaturKennung": "",
"gefahrgut": [
{
"gefahrgutBefoerdKat": 0,
"gefahrgutBegrenzteMenge": "",
"gefahrgutBezeichnung": "",
"gefahrgutBuchst640": "",
"gefahrgutFFCode": "",
"gefahrgutFaktor": 0,
"gefahrgutFreigestMenge": "",
"gefahrgutKCode": "",
"gefahrgutKlasse": "",
"gefahrgutMenge": 0,
"gefahrgutMengenEinheit": "",
"gefahrgutNebenGefahr": "",
"gefahrgutNettoExplMasse": 0,
"gefahrgutTunnelBCode": "",
"gefahrgutUNNR": "",
"gefahrgutUmweltGef": "",
"gefahrgutVPG": "",
"gefahrgutVerpAnzahl": 0,
"gefahrgutVerpackungsart": ""
}
],
"gewicht": 0,
"ilnNr": "",
"infotext1": "",
"infotext2": "",
"infotext3": "",
"infotext4": "",
"infotext5": "",
"infotext6": "",
"infotext7": "",
"infotext8": "",
"infotext9": "",
"infotext10": "",
"kostenstelle": "",
"kundenNr": "",
"lieferscheinNr": "",
"nachnahme": 0,
"nettoGewicht": 0,
"neutabsenderLKZ": "",
"neutabsenderName1": "",
"neutabsenderName2": "",
"neutabsenderName3": "",
"neutabsenderOrt": "",
"neutabsenderPLZ": "",
"neutabsenderStrasse": "",
"nnVermerk": "",
"nnVerwendung": "",
"nnWaehrung": "",
"packStkGes": 0,
"packStkNr": 0,
"packplatz": "",
"packstueckBreite": 0,
"packstueckHoehe": 0,
"packstueckID": "",
"packstueckLaenge": 0,
"paperlessInvoice": "",
"postLeitcode": "",
"postZielFrachtzent": "",
"rechnungsEmpfLKZ": "",
"rechnungsEmpfName1": "",
"rechnungsEmpfName2": "",
"rechnungsEmpfName3": "",
"rechnungsEmpfOrt": "",
"rechnungsEmpfPLZ": "",
"rechnungsEmpfStrasse": "",
"sendungsinhalt": "",
"sonderdienste": "",
"telefonNr": "",
"terminArt": "",
"terminDatum": "",
"terminZeit": "",
"ustIDNr": "",
"verpackungsart": "",
"versandartID": "",
"versicherungswert": 0,
"vwWaehrung": "",
"warenwert": 0,
"wwWaehrung": "",
"zahlungsbedingung": "",
"zbZoll": "",
"zielAdrBahnhof": "",
"zielAdrLKZ": "",
"zielAdrName1": "",
"zielAdrName2": "",
"zielAdrName3": "",
"zielAdrOrt": "",
"zielAdrPLZ": "",
"zielAdrRegion": "",
"zielAdrStrasse": ""
}
- Response
{
"assoc": {
"":""
},
"packstueckID": "",
"trackingNr": "",
"retourTrackingNr": "",
"versandSendungsNr": "",
"druckDateTime": "",
"ausgangDateTime": "",
"gebuehr": 0,
"gebuehrWaehrung": "",
"fehlertext1": "",
"fehlertext2": "",
"etikettName": "",
"etikettDaten": "",
"zusatzEtikettenDaten": {
"": ""
},
"trackingURL": "",
"zusatzfeld1": "",
"zusatzfeld2": "",
"zusatzfeld3": "",
"zusatzfeld4": "",
"zusatzfeld5": "",
"zusatzfeld6": "",
"zusatzfeld7": "",
"zusatzfeld8": "",
"zusatzfeld9": "",
"zusatzfeld10": ""
}
Etikett nachdrucken ()
Text anpassen
Fett dargestellte Felder müssen IMMER belegt sein
Feldname | Typ | Max Länge | Dezimalstellen | Belegung |
---|---|---|---|---|
druckername | String | 30 | - | Name eines Ausgabekanals (Drucker) im HVS32 über den das Etikett gedruckt wird. |
packplatz | String | 10 | - | HVS32-Packplatz-Client, der den Auftrag verarbeiten soll. |
packstueckID | String | 30 | - | Eindeutige Nummer für das Paket im Vorsystem. |
trackingNr | String | 35 | - | Paketnummer |
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 |
- Request
{
"druckername": "",
"packplatz": "",
"packstueckID": "",
"trackingNr": ""
}
- Response
{
"assoc": {
"":""
},
"packstueckID": "",
"trackingNr": "",
"retourTrackingNr": "",
"versandSendungsNr": "",
"druckDateTime": "",
"ausgangDateTime": "",
"gebuehr": 0,
"gebuehrWaehrung": "",
"fehlertext1": "",
"fehlertext2": "",
"etikettName": "",
"etikettDaten": "",
"zusatzEtikettenDaten": {
"": ""
},
"trackingURL": "",
"zusatzfeld1": "",
"zusatzfeld2": "",
"zusatzfeld3": "",
"zusatzfeld4": "",
"zusatzfeld5": "",
"zusatzfeld6": "",
"zusatzfeld7": "",
"zusatzfeld8": "",
"zusatzfeld9": "",
"zusatzfeld10": ""
}
Packstück stornieren ()
Text anpassen
- Request
{
"packplatz": "",
"packstueckID": "",
"trackingNr": ""
}
- Response
{
"fehlercode": 0,
"fehlertext1": "",
"fehlertext2": ""
}
Ausgangsliste erzeugen (listenabschlussAnfrage)
Text anpassen
Fett dargestellte Felder müssen IMMER belegt sein
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. |
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. |
etikettenDaten | Map (String, String) | - | - | Name und Binärdaten der Etiketten als Key/Value Map. |
- Request
{
"auftraggeberID": [
""
],
"druckername": "",
"frachtfuehrerTyp": [
""
],
"packplatz": "",
"versandartID": [
""
],
"wechselbruecke": ""
}
- Response
{
"assoc": {
"":""
},
"fehlercode": 0,
"fehlertext1": "",
"listenDaten": {
"": ""
}
}
Frachtführer DFÜ erzeugen (ediabschlussAnfrage)
Das Gateway sendet die ediabschlussAnfrage an das Automatik-Polling des HVS32. Im HVS32 wird somit eine Frachtführer DFÜ anhand der zusätzlich übergebenen Parameter erzeugt und (falls konfiguriert) an den Frachtführer übertragen. Nur Packstücke, für welche zuvor eine Ausgangsliste erzeugt wurde, werden für eine Frachtführer DFÜ berücksichtigt. Die Rückmeldung im HVS32 findet nach dem Erzeugen der Frachtführer DFÜ statt. Es stehen keine Packstück-/Sendungs-Daten für die Rückmeldung zur Verfügung. Nach erfolgreichem EDIAbschluss wird lediglich das Feld Fehler mit Wert 0 zurückgemeldet - bzw. im Fehlerfall wird Fehler mit dem Wert 1 sowie der Fehlertext1 zurückgemeldet.
Funktion (POST): /hvs32rest/ediabschlussAnfrage
MediaType: text/plain
Fett dargestellte Felder müssen IMMER belegt sein
Feldname | Typ | Max Länge | Dezimalstellen | Belegung |
---|---|---|---|---|
auftraggeberID | Sequence <String> | 255 | - | Liste der Auftraggeber für die der Tagesabschluss durchgeführt wird. Wenn leer, werden alle Auftraggeber abgeschlossen, welche am betreffenden Packplatz freigegeben sind. |
druckername | String | 30 | - | Name eines Ausgabekanals (Drucker) im HVS32 über den z.B. die UPS Summary gedruckt wird. (Benötigt Druckerspooler Erweiterungsmodul) |
frachtfuehrerTyp | Sequence <String> | 255 | - | Liste mit Name des Frachtführertyps. Z.B.: "DPD", "GLS", etc. oder "ALLE". Wenn leer, werden alle Frachtführer abgeschlossen. |
packplatz | String | 10 | - | HVS32-Packplatz-Client, der den Tagesabschluss ausführen soll. |
versandartID | Sequence <String> | 255 | - | Liste der Versandarten für die ein Tagesabschluss durchgeführt wird. Bei Nutzung muss zusätzlich der HVS32-Schalter 'MultiVATagesabschluss' in der Sektion 'AutomatikPolling' auf 'ON' gesetzt sein. |
wechselbruecke | String | 10 | - | Kennzeichen der abzuschließenden Wechselbrücke. Hiermit können nur bestimmte Sendungen abgeschlossen werden. |
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. |
- Request
{
"auftraggeberID": [
""
],
"druckername": "",
"frachtfuehrerTyp": [
""
],
"packplatz": "",
"versandartID": [
""
],
"wechselbruecke": ""
}
- Response
{
"assoc": {
"":""
},
"fehlercode": 0,
"fehlertext1": "",
"edistatus": [
{
"fehlercode": 0,
"statuscode": "",
"statustext": "",
"fftyp": "",
"dateityp": "",
"auftraggeber": "",
"ffdateinr": ""
}
],
"listenDaten": {}
}
Packstückdaten aktualisieren (versanddatenPruefAnfrage)
Das Gateway sendet die versanddatenPruefAnfrage an das Automatik-Polling des HVS32. Im HVS32 wird somit eine VersandDatenAnfrage simuliert. Dabei werden keine Etiketten gedruckt und das Packstück bzw. das Etikett wird nicht verbucht, jedoch sind alle weiteren Prozesse identisch zur VersandDatenAnfrage (Routenermittlung, Trackingnummer-Ermittlung, Adressprüfung, etc.) Diese Funktion dient dazu im Vorfeld alle Versand-Daten zu validieren.
Funktion (POST): /hvs32rest/versanddatenPruefAnfrage
MediaType: text/plain
Fett dargestellte Felder müssen IMMER belegt sein
Feldname | Typ | Max Länge | Dezimalstellen | Belegung |
---|---|---|---|---|
ansprechpartner | String | 20 | - | Empfänger Ansprechpartner |
artikelDaten | Sequence <ArtikelDaten> | - | - | Eine Liste der Packstück-Artikel vom Typ ArtikelDaten (1:n) |
assoc | Map (String, String) | - | - | Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert) |
auftragNr | String | 20 | - | - |
auftraggeberID | String | 10 | - | Mandantenkennung aus dem HVS32 |
avisHinweis1 | String | 30 | - | - |
avisHinweis2 | String | 30 | - | - |
avisZusatz1 | String | 20 | - | Zusatz zu Fest-AVIS-Schlüssel 1 |
avisZusatz2 | String | 20 | - | Zusatz zu Fest-AVIS-Schlüssel 2 |
bestellNr | String | 20 | - | Metro-Bestellnr (Metro-Versand) |
druckername | String | 30 | - | Name eines Ausgabekanals (Drucker) im HVS32 über den das Etikett gedruckt wird. (Benötigt Druckerspooler Erweiterungsmodul) |
String | 100 | - | E-Mail Adresse des Empfängers (z.B.: für die Automatische E-Mail Avisierung) | |
faxNr | String | 20 | - | Faxnummer des Empfängers |
flexZustellungEmailadresse | String | 80 | - | Flex-Zustellung Emailadresse |
frachtBrief | String | 20 | - | Frachtbrief Nummer falls Frachtbrief durch Vorsystem gedruckt werden soll |
frachtfuehrerKdNr | String | 10 | - | Kundennummer des Frachtzahlers beim Frachtführer |
frankaturKennung | String | 10 | - | - |
gefahrgut | Sequence <Gefahrgut> | - | - | Eine Liste der Gefahrgüter vom Typ Gefahrgut (1:n) |
gewicht | Decimal | 8 | 3 | Bruttogewicht in KG |
ilnNr | String | 20 | - | ILN des Empfängers (Pflicht bei Metro-Versand) |
infotext1 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext2 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext3 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext4 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext5 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext6 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext7 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext8 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext9 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext10 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
kostenstelle | String | 30 | - | - |
kundenNr | String | 20 | - | Kundennummer des Empfängers beim Versender |
lieferscheinNr | String | 40 | - | Wird im HVS32 als Such-Nummer verwendet |
nachnahme | Decimal | 18 | 2 | - |
nettoGewicht | Decimal | 8 | 3 | Nettogewicht in KG |
neutabsenderLKZ | String | 3 | - | Nur bei Neutral-Absendern belegt |
neutabsenderName1 | String | 50 | - | Nur bei Neutral-Absendern belegt |
neutabsenderName2 | String | 50 | - | Nur bei Neutral-Absendern belegt |
neutabsenderName3 | String | 50 | - | Nur bei Neutral-Absendern belegt |
neutabsenderOrt | String | 50 | - | Nur bei Neutral-Absendern belegt |
neutabsenderPLZ | String | 10 | - | Nur bei Neutral-Absendern belegt |
neutabsenderStrasse | String | 50 | - | Nur bei Neutral-Absendern belegt |
nnVermerk | String | 1 | - | B': Bar / 'V': Verrechnungsscheck |
nnVerwendung | String | 30 | - | Nachnahme Verwendungszweck |
nnWaehrung | String | 3 | - | Nachnahme - ISO-Währungscode |
packStkGes | Integer | - | - | Gesamt-Anzahl Colli der Sendung |
packStkNr | Integer | - | - | Laufende Nr pro Sendung |
packplatz | String | 10 | - | HVS32-Packplatz-Client, der den Auftrag verarbeten soll. |
packstueckBreite | Integer | - | - | Breite in cm |
packstueckHoehe | Integer | - | - | Höhe in cm |
packstueckID | String | 20 | - | Eindeutige Nummer für das Paket im Vorsystem. Wird als eindeutige Paketreferenz benötigt um das Etikett später zu stornieren oder zu Verladen. |
packstueckLaenge | Integer | - | - | Länge in cm |
paperlessInvoice | String | 1 | - | Nur im UPS PaperlessInvoice Fall (T=PaperlessInvoice / F=nicht PaperlessInvoice) |
postLeitcode | String | 15 | - | - |
postZielFrachtzent | String | 5 | - | - |
rechnungsEmpfLKZ | String | 5 | - | Rechnungsadresse |
rechnungsEmpfName1 | String | 50 | - | Rechnungsempfänger |
rechnungsEmpfName2 | String | 50 | - | Rechnungsempfänger |
rechnungsEmpfName3 | String | 50 | - | Rechnungsempfänger |
rechnungsEmpfOrt | String | 50 | - | Rechnungsadresse |
rechnungsEmpfPLZ | String | 10 | - | Rechnungsadresse |
rechnungsEmpfStrasse | String | 50 | - | Rechnungsadresse |
rechnungsNr | String | 20 | - | Rechnungsnummer |
sonderdienste | String | 30 | - | Versandart-spezifisch belegt |
telefonNr | String | 20 | - | Telefonnummer des Empfängers |
terminArt | String | 1 | - | 'A'b / 'B'is / 'F'ix |
terminDatum | String | 10 | - | TT.MM.JJJJ |
terminZeit | Calendar | 5 | - | HH:MM |
ustIDNr | String | 20 | - | UmsatzsteuerNr des Empfängers |
verpackungsart | String | 6 | - | - |
versandartID | String | 10 | - | Versandartkennung aus dem HVS32 |
versicherungswert | Decimal | 18 | 2 | Höhe Versicherungswert |
vwWaehrung | String | 3 | - | Versicherungswert - ISO-Währungscode |
warenwert | Decimal | 18 | 2 | - |
wwWaehrung | String | 3 | - | Warenwert - ISO-Währungscode |
zahlungsbedingung | String | 10 | - | 'S' = Sender, 'R' = Empfänger |
zbZoll | String | 1 | - | Zahlungsbedingung für Zoll Steuern 'S' = Sender, 'R' = Empfänger |
zielAdrBahnhof | String | 30 | - | PLZ und Ort |
zielAdrLKZ | String | 5 | - | Lieferadresse |
zielAdrName1 | String | 50 | - | Lieferadresse |
zielAdrName2 | String | 50 | - | Lieferadresse |
zielAdrName3 | String | 50 | - | Lieferadresse |
zielAdrName4 | String | 50 | - | Lieferadresse |
zielAdrOrt | String | 50 | - | Lieferadresse |
zielAdrPLZ | String | 10 | - | Lieferadresse |
zielAdrRegion | String | 20 | - | Staat/Provinz (z.B.: für Sendungen in die USA wichtig) |
zielAdrStrasse | String | 50 | - | Lieferadresse |
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 | - | - |
- Request
{
"ansprechpartner": "",
"artikelDaten": [
{
"anzahlBuegel": 0,
"anzahlPosEtiketten": 0,
"artikelBTNNr": "",
"artikelEAN": "",
"artikelEinheit": "",
"artikelGewicht": 0,
"artikelGruppe": "",
"artikelMenge": 0,
"artikelServices": "",
"artikelSollMenge": 0,
"artikelText1": "",
"artikelText2": "",
"artikelText3": "",
"artikelText4": "",
"artikelVolumen": 0,
"artikelWaehrung": "",
"artikelWert": 0,
"chargeFlag": "",
"kundenArtikelNr": "",
"kundenBestellNr": "",
"posAuftragNr": "",
"posLieferNr": "",
"positionNr": "",
"serienNr": "",
"ursprungLand": ""
}
],
"auftragNr": "",
"auftraggeberID": "",
"avisHinweis1": "",
"avisHinweis2": "",
"avisZusatz1": "",
"avisZusatz2": "",
"bestellNr": "",
"druckername": "",
"email": "",
"faxNr": "",
"frachtBrief": "",
"frachtfuehrerKdNr": "",
"frankaturKennung": "",
"gefahrgut": [
{
"gefahrgutBefoerdKat": 0,
"gefahrgutBegrenzteMenge": "",
"gefahrgutBezeichnung": "",
"gefahrgutBuchst640": "",
"gefahrgutFFCode": "",
"gefahrgutFaktor": 0,
"gefahrgutFreigestMenge": "",
"gefahrgutKCode": "",
"gefahrgutKlasse": "",
"gefahrgutMenge": 0,
"gefahrgutMengenEinheit": "",
"gefahrgutNebenGefahr": "",
"gefahrgutNettoExplMasse": 0,
"gefahrgutTunnelBCode": "",
"gefahrgutUNNR": "",
"gefahrgutUmweltGef": "",
"gefahrgutVPG": "",
"gefahrgutVerpAnzahl": 0,
"gefahrgutVerpackungsart": ""
}
],
"gewicht": 0,
"ilnNr": "",
"infotext1": "",
"infotext2": "",
"infotext3": "",
"infotext4": "",
"infotext5": "",
"infotext6": "",
"infotext7": "",
"infotext8": "",
"infotext9": "",
"infotext10": "",
"kostenstelle": "",
"kundenNr": "",
"lieferscheinNr": "",
"nachnahme": 0,
"nettoGewicht": 0,
"neutabsenderLKZ": "",
"neutabsenderName1": "",
"neutabsenderName2": "",
"neutabsenderName3": "",
"neutabsenderOrt": "",
"neutabsenderPLZ": "",
"neutabsenderStrasse": "",
"nnVermerk": "",
"nnVerwendung": "",
"nnWaehrung": "",
"packStkGes": 0,
"packStkNr": 0,
"packplatz": "",
"packstueckBreite": 0,
"packstueckHoehe": 0,
"packstueckID": "",
"packstueckLaenge": 0,
"paperlessInvoice": "",
"postLeitcode": "",
"postZielFrachtzent": "",
"rechnungsEmpfLKZ": "",
"rechnungsEmpfName1": "",
"rechnungsEmpfName2": "",
"rechnungsEmpfName3": "",
"rechnungsEmpfOrt": "",
"rechnungsEmpfPLZ": "",
"rechnungsEmpfStrasse": "",
"sendungsinhalt": "",
"sonderdienste": "",
"telefonNr": "",
"terminArt": "",
"terminDatum": "",
"terminZeit": "",
"ustIDNr": "",
"verpackungsart": "",
"versandartID": "",
"versicherungswert": 0,
"vwWaehrung": "",
"warenwert": 0,
"wwWaehrung": "",
"zahlungsbedingung": "",
"zbZoll": "",
"zielAdrBahnhof": "",
"zielAdrLKZ": "",
"zielAdrName1": "",
"zielAdrName2": "",
"zielAdrName3": "",
"zielAdrOrt": "",
"zielAdrPLZ": "",
"zielAdrRegion": "",
"zielAdrStrasse": ""
}
- Response
{
"druckDateTime": "",
"fehlertext1": "",
"fehlertext2": ""
}
Packstückdaten aktualisieren (updateVersanddaten)
Die Gatewayfunktion updateVersanddaten wird vom Data-Gateway-Server im Automatik-Polling Modus an das HVS32 gesendet, um dort die Daten von bestehende Packstücken zu verändern. Diese Anfrage wird zum Beispiel gesendet, wenn der Warenwert für ein Packstück erst zu einem späteren Zeitpunkt bekannt ist. Aktualisiert werden können Daten innerhalb der Tabellen Versandeinheit, Abrechnungseinheit und Lieferung. Dabei wird stets über das Feld PackstueckID und bei Belegung auch über das Feld TrackingNr gesucht. Bei dieser Anfrage werden allerdings die zu aktualisierenden Felder und Inhalte nicht mehr nach den Richtlinien des Frachtführers geprüft (z.B. Gewichtsgrenzen, etc.). Es muss somit vom Vorsystem sichergestellt werden, dass die aktualisierenden Werte mit den Richtlinien des Frachtführers übereinstimmen. Sollte dies nicht möglich sein, kann diese Funktion nicht genutzt werden, sondern das Etikett muss storniert und neu verarbeitet werden. Außerdem können Felder, welche bereits auf einem Etikett angedruckt oder vom Versandsystem HVS32 in einer Frachtführerabwicklung ermittelt wurden (z.B. Adresse, Route, TrackingNr, Sonderdienste, etc.) nicht manipuliert werden. Es stehen keine Packstück-/Sendungs-Daten für die Rückmeldung zur Verfügung. Nach erfolgreichem Update wird lediglich das Feld Fehler mit Wert 0 zurückgemeldet - bzw. im Fehlerfall wird Fehler mit dem Wert 1 sowie der Fehlertext1 zurückgemeldet.
Funktion (POST): /hvs32rest/updateVersanddaten
MediaType: text/plain
Fett dargestellte Felder müssen IMMER belegt sein
Feldname | Typ | Max Länge | Dezimalstellen | Belegung |
---|---|---|---|---|
ansprechpartner | String | 20 | - | Empfänger Ansprechpartner |
anzahlArtikel | Integer | 6 | - | Anzahl Artikel (Druck auf Etikett) |
artikelDaten | Sequence <ArtikelDaten> | - | - | Eine Liste der Packstück-Artikel vom Typ ArtikelDaten (1:n) |
assoc | Map (String, String) | - | - | Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert) |
auftragNr | String | 20 | - | - |
auftraggeberID | String | 10 | - | Mandantenkennung aus dem HVS32 |
avisHinweis1 | String | 30 | - | - |
avisHinweis2 | String | 30 | - | - |
avisZusatz1 | String | 20 | - | Zusatz zu Fest-AVIS-Schlüssel 1 |
avisZusatz2 | String | 20 | - | Zusatz zu Fest-AVIS-Schlüssel 2 |
barcodeID | String | - | - | Zusatzfeld für evtl. Erweiterungen |
barcodeText | String | - | - | Zusatzfeld für evtl. Erweiterungen |
barcodeTyp | String | - | - | Zusatzfeld für evtl. Erweiterungen |
bestellNr | String | 20 | - | Metro-Bestellnr (Metro-Versand) |
druckername | String | 30 | - | Name eines Ausgabekanals (Drucker) im HVS32 über den das Etikett gedruckt wird. (Benötigt Druckerspooler Erweiterungsmodul) |
String | 100 | - | E-Mail Adresse des Empfängers (z.B.: für die Automatische E-Mail Avisierung) | |
empfMobilfunkNr | String | 20 | - | Mobilfunknummer des Empfängers |
faxNr | String | 20 | - | Faxnummer des Empfängers |
flexZustellungEmailadresse | String | 80 | - | Flex-Zustellung Emailadresse |
frachtBrief | String | 20 | - | Frachtbrief Nummer falls Frachtbrief durch Vorsystem gedruckt werden soll |
frachtfuehrerKdNr | String | 10 | - | Kundennummer des Frachtzahlers beim Frachtführer |
frankaturKennung | String | 10 | - | - |
gefahrgut | Sequence <Gefahrgut> | - | - | Eine Liste der Gefahrgüter vom Typ Gefahrgut (1:n) |
gewicht | Decimal | 8 | 3 | Bruttogewicht in KG |
hostTrackingNr | String | 35 | - | Paketnummer aus dem Hostsystem |
ilnNr | String | 20 | - | ILN des Empfängers (Pflicht bei Metro-Versand) |
infotext1 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext2 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext3 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext4 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext5 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext6 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext7 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext8 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext9 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
infotext10 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
kostenstelle | String | 30 | - | - |
kundenNr | String | 20 | - | Kundennummer des Empfängers beim Versender |
lagerkennzeichen | Integer | - | - | - |
letztesPackstueck | String | 1 | - | T/F: T=letztes Packstüeck der Sendung (wird bei Hängeversand zum Drucken der Sendungs-Hängekarte benötigt) |
lieferantenID | Integer | - | - | - |
lieferscheinNr | String | 40 | - | Wird im HVS32 als Such-Nummer verwendet |
nachnahme | Decimal | 18 | 2 | - |
nettoGewicht | Decimal | 8 | 3 | Nettogewicht in KG |
neutBIC | String | 11 | - | Nur bei Neutral-Absendern belegt |
neutBankBezeichnung | String | 40 | - | Nur bei Neutral-Absendern belegt |
neutIBAN | String | 31 | - | Nur bei Neutral-Absendern belegt |
neutKontoInhaber | String | 40 | - | Nur bei Neutral-Absendern belegt |
neutabsenderLKZ | String | 3 | - | Nur bei Neutral-Absendern belegt |
neutabsenderName1 | String | 50 | - | Nur bei Neutral-Absendern belegt |
neutabsenderName2 | String | 50 | - | Nur bei Neutral-Absendern belegt |
neutabsenderName3 | String | 50 | - | Nur bei Neutral-Absendern belegt |
neutabsenderOrt | String | 50 | - | Nur bei Neutral-Absendern belegt |
neutabsenderPLZ | String | 10 | - | Nur bei Neutral-Absendern belegt |
neutabsenderStrasse | String | 50 | - | Nur bei Neutral-Absendern belegt |
nnVermerk | String | 1 | - | B': Bar / 'V': Verrechnungsscheck |
nnVerwendung | String | 30 | - | Nachnahme Verwendungszweck |
nnWaehrung | String | 3 | - | Nachnahme - ISO-Währungscode |
packStkGes | Integer | - | - | Gesamt-Anzahl Colli der Sendung |
packStkNr | Integer | - | - | Laufende Nr pro Sendung |
packplatz | String | 10 | - | HVS32-Packplatz-Client, der den Auftrag verarbeten soll. |
packstueckBreite | Integer | - | - | Breite in cm |
packstueckHoehe | Integer | - | - | Höhe in cm |
packstueckID | String | 20 | - | Eindeutige Nummer für das Paket im Vorsystem. Wird als eindeutige Paketreferenz benötigt um das Etikett später zu stornieren oder zu Verladen. |
packstueckLaenge | Integer | - | - | Länge in cm |
paperlessInvoice | String | 1 | - | Nur im UPS PaperlessInvoice Fall (T=PaperlessInvoice / F=nicht PaperlessInvoice) |
postLeitcode | String | 15 | - | - |
postZielFrachtzent | String | 5 | - | - |
rechnungsEmpfLKZ | String | 5 | - | Rechnungsadresse |
rechnungsEmpfName1 | String | 50 | - | Rechnungsempfänger |
rechnungsEmpfName2 | String | 50 | - | Rechnungsempfänger |
rechnungsEmpfName3 | String | 50 | - | Rechnungsempfänger |
rechnungsEmpfOrt | String | 50 | - | Rechnungsadresse |
rechnungsEmpfPLZ | String | 10 | - | Rechnungsadresse |
rechnungsEmpfStrasse | String | 50 | - | Rechnungsadresse |
rechnungsNr | String | 20 | - | Rechnungsnummer |
sendungsinhalt | String | 30 | - | - |
sonderdienste | String | 30 | - | Versandart-spezifisch belegt |
sperrFlag | String | 1 | - | T/F: T=Sperren, sonst nicht sperren |
telefonNr | String | 20 | - | Telefonnummer des Empfängers |
terminArt | String | 1 | - | 'A'b / 'B'is / 'F'ix |
terminDatum | String | 10 | - | TT.MM.JJJJ |
terminZeit | Calendar | 5 | - | HH:MM |
ustIDNr | String | 20 | - | UmsatzsteuerNr des Empfängers |
verpackungsart | String | 6 | - | - |
versandartID | String | 10 | - | Versandartkennung aus dem HVS32 |
versicherungswert | Decimal | 18 | 2 | Höhe Versicherungswert |
vorpackdatum | String | 10 | - | TT.MM.JJJJ |
vwWaehrung | String | 3 | - | Versicherungswert - ISO-Währungscode |
warenwert | Decimal | 18 | 2 | - |
wechselbruecke | String | 20 | - | Wechselbrücke, die diesem Packstück zugewiesen wird |
wwWaehrung | String | 3 | - | Warenwert - ISO-Währungscode |
zahlungsbedingung | String | 10 | - | 'S' = Sender, 'R' = Empfänger |
zbZoll | String | 1 | - | Zahlungsbedingung für Zoll Steuern 'S' = Sender, 'R' = Empfänger |
zielAdrBahnhof | String | 30 | - | PLZ und Ort |
zielAdrLKZ | String | 5 | - | Lieferadresse |
zielAdrName1 | String | 50 | - | Lieferadresse |
zielAdrName2 | String | 50 | - | Lieferadresse |
zielAdrName3 | String | 50 | - | Lieferadresse |
zielAdrName4 | String | 50 | - | Lieferadresse |
zielAdrOrt | String | 50 | - | Lieferadresse |
zielAdrPLZ | String | 10 | - | Lieferadresse |
zielAdrRegion | String | 20 | - | Staat/Provinz (z.B.: für Sendungen in die USA wichtig) |
zielAdrStrasse | String | 50 | - | Lieferadresse |
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 |
- Request
{
"ansprechpartner": "",
"anzahlArtikel": 0,
"artikelDaten": [
{
"anzahlBuegel": 0,
"anzahlPosEtiketten": 0,
"artikelBTNNr": "",
"artikelEAN": "",
"artikelEinheit": "",
"artikelGewicht": 0,
"artikelGruppe": "",
"artikelMenge": 0,
"artikelServices": "",
"artikelSollMenge": 0,
"artikelText1": "",
"artikelText2": "",
"artikelText3": "",
"artikelText4": "",
"artikelVolumen": 0,
"artikelWaehrung": "",
"artikelWert": 0,
"chargeFlag": "",
"kundenArtikelNr": "",
"kundenBestellNr": "",
"posAuftragNr": "",
"posLieferNr": "",
"positionNr": "",
"serienNr": "",
"ursprungLand": ""
}
],
"auftragNr": "",
"auftraggeberID": "",
"avisHinweis1": "",
"avisHinweis2": "",
"avisZusatz1": "",
"avisZusatz2": "",
"barcodeID": "",
"barcodeText": "",
"barcodeTyp": "",
"bestellNr": "",
"druckername": "",
"email": "",
"empfMobilfunkNr": "",
"faxNr": "",
"flexZustellungEmailadResponsese": "",
"frachtBrief": "",
"frachtfuehrerKdNr": "",
"frankaturKennung": "",
"gefahrgut": [
{
"gefahrgutBefoerdKat": 0,
"gefahrgutBegrenzteMenge": "",
"gefahrgutBezeichnung": "",
"gefahrgutBuchst640": "",
"gefahrgutFFCode": "",
"gefahrgutFaktor": 0,
"gefahrgutFreigestMenge": "",
"gefahrgutKCode": "",
"gefahrgutKlasse": "",
"gefahrgutMenge": 0,
"gefahrgutMengenEinheit": "",
"gefahrgutNebenGefahr": "",
"gefahrgutNettoExplMasse": 0,
"gefahrgutTunnelBCode": "",
"gefahrgutUNNR": "",
"gefahrgutUmweltGef": "",
"gefahrgutVPG": "",
"gefahrgutVerpAnzahl": 0,
"gefahrgutVerpackungsart": ""
}
],
"gewicht": 0,
"hostTrackingNr": "",
"ilnNr": "",
"infotext1": "",
"infotext2": "",
"infotext3": "",
"infotext4": "",
"infotext5": "",
"infotext6": "",
"infotext7": "",
"infotext8": "",
"infotext9": "",
"infotext10": "",
"kostenstelle": "",
"kundenNr": "",
"lagerkennzeichen": 0,
"letztesPackstueck": "",
"lieferantenID": 0,
"lieferscheinNr": "",
"nachnahme": 0,
"nettoGewicht": 0,
"neutBIC": "",
"neutBankBezeichnung": "",
"neutIBAN": "",
"neutKontoInhaber": "",
"neutabsenderLKZ": "",
"neutabsenderName1": "",
"neutabsenderName2": "",
"neutabsenderName3": "",
"neutabsenderOrt": "",
"neutabsenderPLZ": "",
"neutabsenderStrasse": "",
"nnVermerk": "",
"nnVerwendung": "",
"nnWaehrung": "",
"packStkGes": 0,
"packStkNr": 0,
"packplatz": "",
"packstueckBreite": 0,
"packstueckHoehe": 0,
"packstueckID": "",
"packstueckLaenge": 0,
"paperlessInvoice": "",
"postLeitcode": "",
"postZielFrachtzent": "",
"rechnungsEmpfLKZ": "",
"rechnungsEmpfName1": "",
"rechnungsEmpfName2": "",
"rechnungsEmpfName3": "",
"rechnungsEmpfOrt": "",
"rechnungsEmpfPLZ": "",
"rechnungsEmpfStrasse": "",
"rechnungsNr": "",
"sendungsinhalt": "",
"sonderdienste": "",
"sperrFlag": "",
"telefonNr": "",
"terminArt": "",
"terminDatum": "",
"terminZeit": "",
"ustIDNr": "",
"verpackungsart": "",
"versandartID": "",
"versicherungswert": 0,
"vorpackdatum": "",
"vwWaehrung": "",
"warenwert": 0,
"wechselbruecke": "",
"wwWaehrung": "",
"zahlungsbedingung": "",
"zbZoll": "",
"zielAdrBahnhof": "",
"zielAdrLKZ": "",
"zielAdrName1": "",
"zielAdrName2": "",
"zielAdrName3": "",
"zielAdrName4": "",
"zielAdrOrt": "",
"zielAdrPLZ": "",
"zielAdrRegion": "",
"zielAdrStrasse": ""
}
- Response
{
"packstueckID": "",
"trackingNr": "",
"retourTrackingNr": "",
"versandSendungsNr": "",
"druckDateTime": "",
"ausgangDateTime": "",
"gebuehrWaehrung": "",
"fehlercode": 0,
"fehlertext1": "",
"fehlertext2": "",
"etikettName": "",
"etikettDaten": "",
"trackingURL": "",
"zusatzfeld1": "",
"zusatzfeld2": "",
"zusatzfeld3": "",
"zusatzfeld4": "",
"zusatzfeld5": "",
"zusatzfeld6": "",
"zusatzfeld7": "",
"zusatzfeld8": "",
"zusatzfeld9": "",
"zusatzfeld10": ""
}
Packstückdaten anonymisieren (anonymisiereVersandDaten)
Das Gateway sendet die anonymisiereVersandDaten an das Automatik-Polling des HVS32. Im HVS32 werden somit Kunden bezogene Daten für den entsprechenden Datensatz gemäß DSGVO anonymisiert. Diese Anonymisierung wird unwiderruflich und endgültig auf der Datenbankebene des Versandsystems durchgeführt. Eine Wiederherstellung der ursprünglichen Daten ist somit nicht mehr möglich. Log-Dateien, Rückmelde-Dateien, bereits übertragene Frachtführer DFÜs etc. sind hiervon nicht betroffen. Es können ausschließlich Packstücke und Sendungen anonymisiert werden, welche bereits Tages abgeschlossen sind.
Funktion (POST): /hvs32rest/anonymisiereVersandDaten
MediaType: text/plain
Fett dargestellte Felder müssen IMMER belegt sein
Feldname | Typ | Max Länge | Nachkommastellen | Belegung |
---|---|---|---|---|
auftragsNr | String | 20 | - | - |
lieferscheinNr | String | 40 | - | Wird im HVS32 als Such-Nummer verwendet. |
packplatz | String | 10 | - | HVS32-Packplatz-Client, der den Auftrag verarbeiten soll. |
packstueckID | String | 20 | - | Eindeutige Nummer für das Paket im Vorsystem. |
trackingNr | String | 35 | - | Paketnummer |
- Request
{
"auftragNr": "",
"lieferscheinNr": "",
"packplatz": "",
"packstueckID": "",
"trackingNr": ""
}
- Response
{
"fehlertext1": "",
"fehlertext2": ""
}
Sendungs-Verarbeitung (sendungsdatenAnfrage)
sendungsdatenAnfrage – wird zur Laufzeit in einzelne versandDatenAnfragen unterteilt. Muss bei einer Anfrage für das SPM genutzt werden (requestSPM=TRUE)
Funktion (POST): /hvs32rest/sendungsdatenAnfrage
MediaType: text/plain
Fett dargestellte Felder müssen IMMER belegt sein
Feldname | Typ | Max Länge | Dezimalstellen | Belegung |
---|---|---|---|---|
ansprechpartner | String | 20 | - | Empfänger Ansprechpartner |
assoc | Map (String, String) | - | - | Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert) |
auftragNr | String | 20 | - | - |
auftraggeberID | String | 10 | - | Mandantenkennung aus dem HVS32 |
ausschlussFrachtfuehrer | String | 20 | - | Ausschluss-Frachtführer für SPM Anfrage |
avisHinweis1 | String | 30 | - | - |
avisHinweis2 | String | 30 | - | - |
avisZusatz1 | String | 20 | - | Zusatz zu Fest-AVIS-Schlüssel 1 |
avisZusatz2 | String | 20 | - | Zusatz zu Fest-AVIS-Schlüssel 2 |
bestellNr | String | 20 | - | - |
String | 100 | - | Für automatische Mailavisierung | |
empfMobilfunkNr | String | 20 | - | Mobilfunknummer des Empfängers |
faxNr | String | 20 | - | Faxnummer des Empfängers |
flexZustellungEmailadResponsese | String | 80 | - | Flex-Zustellung Email-Adresse |
frachtBrief | String | 20 | - | Frachtbrief Nummer, falls Frachtbrief durch Vorsystem gedruckt wird. |
frachtfuehrerKdNr | String | 10 | - | Kundennummer des Frachtzahlers beim Frachtführer. |
frankaturKennung | String | 10 | - | - |
ilnNr | String | 20 | - | ILN des Empfängers (Pflicht bei Metro-Versand) |
kostenstelle | String | 30 | - | - |
kundenNr | String | 20 | - | Kundennummer des Empfängers beim Versender |
Lagerkennzeichen | String | |||
LieferantenID | String | |||
lieferscheinNr | String | 40 | - | Wird im HVS32 als Such-Nummer verwendet. |
neutBIC | String | 11 | - | Nur bei Neutral-Absendern belegt |
neutBankBezeichnung | String | 40 | - | Nur bei Neutral-Absendern belegt |
neutIBAN | String | 31 | - | Nur bei Neutral-Absendern belegt |
neutKontoInhaber | String | 40 | - | Nur bei Neutral-Absendern belegt |
neutabsenderLKZ | String | 3 | - | Nur bei Neutral-Absendern belegt |
neutabsenderName1 | String | 50 | - | Nur bei Neutral-Absendern belegt |
neutabsenderName2 | String | 50 | - | Nur bei Neutral-Absendern belegt |
neutabsenderName3 | String | 50 | - | Nur bei Neutral-Absendern belegt |
neutabsenderOrt | String | 50 | - | Nur bei Neutral-Absendern belegt |
neutabsenderPLZ | String | 10 | - | Nur bei Neutral-Absendern belegt |
neutabsenderStrasse | String | 50 | - | Nur bei Neutral-Absendern belegt |
packStkGes | Integer | - | - | Gesamt-Anzahl Colli der Sendung |
packstueckDaten | Sequence <PackStueckDaten> | - | - | - |
packplatz | String | 10 | - | HVS32-Packplatz-Client, der den Auftrag verarbeten soll. |
paperlessInvoice | String | 1 | - | Nur im UPS PaperlessInvoice Fall (T=PaperlessInvoice / F=nicht PaperlessInvoice) |
postLeitcode | String | 15 | - | - |
postZielFrachtzent | String | 5 | - | - |
rechnungsEmpfLKZ | String | 5 | - | Rechnungsadresse |
rechnungsEmpfName1 | String | 50 | - | Rechnungsempfänger |
rechnungsEmpfName2 | String | 50 | - | Rechnungsempfänger |
rechnungsEmpfName3 | String | 50 | - | Rechnungsempfänger |
rechnungsEmpfOrt | String | 50 | - | Rechnungsadresse |
rechnungsEmpfPLZ | String | 10 | - | Rechnungsadresse |
rechnungsEmpfStrasse | String | 50 | - | Rechnungsadresse |
rechnungsNr | String | 20 | - | Rechnungsnummer |
requestSPM | String | 5 | - | T/TRUE wenn die Entscheidungsmatrix angesprochen werden soll, sonst leer |
sendungsinhalt | String | 30 | - | - |
sonderdienste | String | 30 | - | Versandart-spezifisch belegt |
sperrFlag | String | 1 | - | T/F: T=Sperren, sonst nicht sperren |
telefonNr | String | 20 | - | Telefonnummer des Empfängers |
terminArt | String | 1 | - | 'A'b / 'B'is / 'F'ix |
terminDatum | String | 10 | - | TT.MM.JJJJ |
terminZeit | String | 5 | - | HH:MM |
ustIDNr | String | 20 | - | UmsatzsteuerNr des Empfängers |
versandartID | String | 10 | - | Versandartkennung aus dem HVS32 |
vorgabeFrachtfuehrer | String | 20 | - | Vorgabe-Frachtführer für SPM Anfrage |
vorpackdatum | String | 10 | - | TT.MM.JJJJ |
wechselbruecke | String | 20 | - | Wechselbrücke, die diesem Packstück zugewiesen werden soll |
zahlungsbedingung | String | 10 | - | 'S' = Sender, 'R' = Empfänger |
zbZoll | String | 1 | - | Zahlungsbedingung für Zoll Steuern 'S' = Sender, 'R' = Empfänger |
zielAdrBahnhof | String | 30 | - | PLZ und Ort 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 |
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 |
- Request
{
"ansprechpartner": "",
"assoc": {
"":""
},
"auftragNr": "",
"auftraggeberID": "",
"ausschlussFrachtfuehrer": "",
"avisHinweis1": "",
"avisHinweis2": "",
"avisZusatz1": "",
"avisZusatz2": "",
"bestellNr": "",
"email": "",
"empfMobilfunkNr": "",
"faxNr": "",
"flexZustellungEmailadResponsese": "",
"frachtBrief": "",
"frachtfuehrerKdNr": "",
"frankaturKennung": "",
"ilnNr": "",
"kostenstelle": "",
"kundenNr": "",
"Lagerkennzeichen": 0,
"LieferantenID": 0,
"lieferscheinNr": "",
"neutBIC": "",
"neutBankBezeichnung": "",
"neutIBAN": "",
"neutKontoInhaber": "",
"neutabsenderLKZ": "",
"neutabsenderName1": "",
"neutabsenderName2": "",
"neutabsenderName3": "",
"neutabsenderOrt": "",
"neutabsenderPLZ": "",
"neutabsenderStrasse": "",
"packStkGes": 0,
"packStueckDaten": [
{
"anzahlArtikel": 0,
"assoc": {
"":""
},
"artikelDaten": [
{
"anzahlBuegel": 0,
"anzahlPosEtiketten": 0,
"artikelBTNNr": "",
"artikelEAN": "",
"artikelEinheit": "",
"artikelGewicht": 0,
"artikelGruppe": "",
"artikelMenge": 0,
"artikelServices": "",
"artikelSollMenge": 0,
"artikelText1": "",
"artikelText2": "",
"artikelText3": "",
"artikelText4": "",
"artikelVolumen": 0,
"artikelWaehrung": "",
"artikelWert": 0,
"chargeFlag": "",
"kundenArtikelNr": "",
"kundenBestellNr": "",
"posAuftragNr": "",
"posLieferNr": "",
"positionNr": "",
"serienNr": "",
"ursprungLand": ""
}
],
"barcodeID": "",
"barcodeText": "",
"barcodeTyp": "",
"druckername": "",
"gefahrgut": [
{
"gefahrgutBefoerdKat": 0,
"gefahrgutBegrenzteMenge": "",
"gefahrgutBezeichnung": "",
"gefahrgutBuchst640": "",
"gefahrgutFFCode": "",
"gefahrgutFaktor": 0,
"gefahrgutFreigestMenge": "",
"gefahrgutKCode": "",
"gefahrgutKlasse": "",
"gefahrgutMenge": 0,
"gefahrgutMengenEinheit": "",
"gefahrgutNebenGefahr": "",
"gefahrgutNettoExplMasse": 0,
"gefahrgutTunnelBCode": "",
"gefahrgutUNNR": "",
"gefahrgutUmweltGef": "",
"gefahrgutVPG": "",
"gefahrgutVerpAnzahl": 0,
"gefahrgutVerpackungsart": ""
}
],
"gewicht": 0,
"hostTrackingNr": "",
"infotext1": "",
"infotext10": "",
"infotext2": "",
"infotext3": "",
"infotext4": "",
"infotext5": "",
"infotext6": "",
"infotext7": "",
"infotext8": "",
"infotext9": "",
"letztesPackstueck": "",
"nachnahme": 0,
"nettoGewicht": 0,
"nnVermerk": "",
"nnVerwendung": "",
"nnWaehrung": "",
"packStkNr": 0,
"packstueckBreite": 0,
"packstueckHoehe": 0,
"packstueckID": "",
"packstueckLaenge": 0,
"verpackungsart": "",
"versicherungswert": 0,
"vwWaehrung": "",
"warenwert": 0,
"wwWaehrung": ""
}
],
"packplatz": "",
"paperlessInvoice": "",
"postLeitcode": "",
"postZielFrachtzent": "",
"rechnungsEmpfLKZ": "",
"rechnungsEmpfName1": "",
"rechnungsEmpfName2": "",
"rechnungsEmpfName3": "",
"rechnungsEmpfOrt": "",
"rechnungsEmpfPLZ": "",
"rechnungsEmpfStrasse": "",
"rechnungsNr": "",
"RequestuestSPM": "",
"sendungsinhalt": "",
"sonderdienste": "",
"sperrFlag": "",
"telefonNr": "",
"terminArt": "",
"terminDatum": "",
"terminZeit": "",
"ustIDNr": "",
"versandartID": "",
"vorgabeFrachtfuehrer": "",
"vorpackdatum": "",
"wechselbruecke": "",
"zahlungsbedingung": "",
"zbZoll": "",
"zielAdrBahnhof": "",
"zielAdrLKZ": "",
"zielAdrName1": "",
"zielAdrName2": "",
"zielAdrName3": "",
"zielAdrName4": "",
"zielAdrOrt": "",
"zielAdrPLZ": "",
"zielAdrRegion": "",
"zielAdrStrasse": ""
}
- Response
{
"versandSendungsNr": "",
"sendungsGebuehrWaehrung": "",
"fehler": "",
"packStueckDaten": [
{
"assoc": {
"":""
},
"packstueckID": "",
"trackingNr": "",
"retourTrackingNr": "",
"druckDateTime": "",
"gebuehrWaehrung": "",
"fehlertext1": "",
"fehlertext2": "",
"etikettName": "",
"etikettDaten": "",
"zusatzEtikettenDaten": {
"": ""
},
"trackingURL": "",
"zusatzfeld1": "",
"zusatzfeld2": "",
"zusatzfeld3": "",
"zusatzfeld4": "",
"zusatzfeld5": "",
"zusatzfeld6": "",
"zusatzfeld7": "",
"zusatzfeld8": "",
"zusatzfeld9": "",
"zusatzfeld10": "",
"ausgangDateTime": ""
}
]
}
Beispiele
Alle JSON Beispiele finden Sie auch hier: REST SERVER JSON Beispiele