HVS32 Functions Interactive
You can find a list of all fields here: Verfügbare Felder
Please note that not all fields are available for each function. You can find these in the respective function description.
Data request notification (VersandDatenAnfrage)
The function VersandDatenAnfrage (ShippingDataRequest) is executed as soon as a search term (e.g. the LieferscheinNr (delivery note number)) is entered in the Lieferschein-Verarbeitung. This is transmitted by the DataGatewayServer to the host system, whereby the dispatch data for this search term can be determined and transmitted back to the HVS32.
- The search term is provided by the HVS32 as variable sReferenzNr.
- Using the option GatewayLieferungVerarbeitetPruefung (GatewayDeliveryProcessedExam) ('ON / OFF) the check for already processed delivery bills can be activated additionally. If the delivery bill has already been processed, the konfigurierte Aktion is applied.
Only the sReferenzNr field and Packplatz (packing location) are available for the VersandDatenAnfrage (Shipping data request).
The upstream system may provide the following fields in response to this request:
Shipment-related data such as client or recipient
| Field name | Type | Max Length | Decimals | Assignment |
|---|---|---|---|---|
| Ansprechpartner | String | 20 | - | Recipient contact person |
| AuftragNr | String | 20 | - | - |
| AuftraggeberID | String | 10 | - | Client identification from the HVS32 |
| AVISHinweis1 | String | 100 | - | - |
| AVISHinweis2 | String | 100 | - | - |
| AVISZusatz1 | String | 20 | - | Addition to fixed AVIS key 1 |
| AVISZusatz2 | String | 20 | - | Addition to fixed AVIS key 2 |
| BestellNr | String | 20 | - | Metro order no. (Metro shipping) |
| FaxNr | String | 20 | - | Fax number of the recipient |
| FrachtBrief | String | 20 | - | Waybill number if waybill is to be printed by pre-system |
| FrachtfuehrerKDNr | String | 10 | - | Customer number of the freight payer with the carrier |
| FrankaturKennung | String | 10 | - | - |
| ILNNr | String | 20 | - | ILN of the recipient (mandatory for Metro shipping) |
| KundenNr | String | 20 | - | Customer number of the recipient with the sender |
| LieferscheinNr | String | 40 | - | Used in HVS32 as search number |
| NeutabsenderLKZ | String | 3 | - | Only occupied for neutral senders |
| NeutabsenderName1 | String | 50 | - | Only occupied for neutral senders |
| NeutabsenderName2 | String | 50 | - | Only occupied for neutral senders |
| NeutabsenderName3 | String | 50 | - | Only occupied for neutral senders |
| NeutabsenderOrt | String | 50 | - | Only occupied for neutral senders |
| NeutabsenderPLZ | String | 10 | - | Only occupied for neutral senders |
| NeutabsenderStrasse | String | 50 | - | Only occupied for neutral senders |
| Nachnahme | Decimal | 18 | 2 | - |
| NNVermerk | String | 1 | - | B': Cash / 'V': Crossed check |
| NNVerwendung | String | 30 | - | Cash on delivery Intended use |
| NNWaehrung | String | 3 | - | Cash on delivery - ISO currency code |
| PostLeitcode | String | 15 | - | - |
| PostZielFrachtzent | String | 5 | - | - |
| RechnungsEmpfLKZ | String | 5 | - | Billing address |
| RechnungsEmpfName1 | String | 50 | - | Invoice recipient |
| RechnungsEmpfName2 | String | 50 | - | Invoice recipient |
| RechnungsEmpfName3 | String | 50 | - | Invoice recipient |
| RechnungsEmpfOrt | String | 50 | - | Billing address |
| RechnungsEmpfPLZ | String | 10 | - | Billing address |
| RechnungsEmpfStr | String | 50 | - | Billing address |
| RechnungsNr | String | 20 | - | Invoice number |
| SendungsInhalt | String | 30 | - | - |
| Sonderdienste | String | 30 | - | Shipping type specific occupancy |
| TelefonNr | String | 20 | - | Recipient phone number |
| TerminArt | String | 1 | - | 'A'from / 'B'until / 'F'fix |
| TerminDatum | String | 10 | - | DD.MM.YYYY |
| TerminZeit | String | 5 | - | HH:MM |
| UstIDNr | String | 20 | - | Sales tax number of the recipient |
| VersandartID | String | 10 | - | Dispatch type identifier from the HVS32 |
| Versicherungswert | Decimal | 18 | 2 | Amount of the insured value |
| VWWaehrung | String | 3 | - | Insured value - ISO currency code |
| Warenwert | Decimal | 18 | 2 | - |
| WWWaehrung | String | 3 | - | Value of goods - ISO currency code |
| Zahlungsbedinung | String | 10 | - | 'S' = Sender, 'R' = Recipient |
| ZBZoll | String | 1 | - | Payment term for customs taxes 'S' = Sender, 'R' = Recipient |
| ZielAdrName1 | String | 50 | - | Delivery address |
| ZielAdrName2 | String | 50 | - | Delivery address |
| ZielAdrName3 | String | 50 | - | Delivery address |
| ZielAdrLKZ | String | 5 | - | Delivery address |
| ZielAdrPLZ | String | 10 | - | Delivery address |
| ZielAdrOrt | String | 50 | - | Delivery address |
| ZielAdrStrasse | String | 50 | - | Delivery address |
| ZielAdrBahnhof | String | 30 | - | Zip code and city |
| ZielAdrRegion | String | 20 | - | State/province (e.g.: important for shipments to the USA) |
| EmpfEmailadresse | String | 100 | - | for automatic mail notification (extension module) |
| FreiAvis1 | String | 60 | - | - |
| FreiAvis2 | String | 60 | - | - |
| SendungsGewicht | Decimal | 8 | 3 | Weight of the entire shipment. The specified weight is distributed evenly among all recorded packages. |
| Field name | Type | Max length | Decimals | Assignment |
|---|---|---|---|---|
| LieferscheinNr | String | 40 | - | Foreign key to the consignment data record. Via this relation 0 ... n positions can be assigned to a delivery bill. |
| AnzahlPosEtiketten | Integer | - | - | Number of article labels to be printed |
| ArtikelBTNNr | String | 25 | - | BTN Number / Customs tariff number |
| ArtikelEAN | String | 20 | - | EAN Nummer |
| ArtikelEinheit | String | 10 | - | Article quantity unit |
| ArtikelGewicht | Decimal | 9 | 3 | Aricle weight |
| Article group | String | 50 | - | Article group |
| ArtikelMenge | Decimal | 9 | 3 | Article quantity |
| ArtikelServices | String | 100 | - | Pipe separate services for this Article |
| ArtikelSollMenge | Decimal | 9 | 3 | - |
| ArtikelText1 | String | 100 | - | Article description |
| ArtikelText2 | String | 100 | - | Article description |
| ArtikelText3 | String | 100 | - | Article description |
| ArtikelText4 | String | 100 | - | Article description |
| ArtikelVolumen | Decimal | 9 | 3 | Volumen des Artikels |
| ArtikelWaehrung | String | 3 | - | Currency in which the value of the Article is specified |
| ArtikelWert | Decimal | 18 | 2 | Article value |
| ChargeFlag | String | 1 | - | |
| KundenArtikelNr | String | 50 | - | Article number |
| KundenBestellNr | String | 50 | - | Customer order number |
| PosAuftragNr | String | 50 | - | Order number |
| PosLieferNr | String | 40 | - | Delivery note number |
| PositionNr | String | 50 | - | Sequence number within the package |
| SerienNr | String | 30 | - | Serial number |
| UrsprungLand | String | 2 | - | Country of origin of the Article |
| Field name | Type | Max length | Decimals | Assignment |
|---|---|---|---|---|
| LieferscheinNr | String | 40 | - | Foreign key to the consignment data record. Via this relation 0 ... n positions can be assigned to a delivery bill. |
| GefahrgutBefoerdKat | Integer | 1 | - | Transport category, mandatory (see ADR table column (15)), can be 0-4. Attention! Must be absolutely correct. |
| GefahrgutBegrenzteMenge | String | 1 | - | T if the substance is shipped with status LQ / Limited quantity according to ADR 3.4, otherwise F, mandatory |
| GefahrgutBezeichnung | String | 100 | - | Mandatory (see ADR table column (2)) |
| GefahrgutBuchst640 | String | 1 | - | Letter for special provision 640, conditional obligation for substances where special provision 640 applies (see ADR table column (6)). |
| GefahrgutFFCode | String | 20 | - | Handover code to carrier (e.g. for GLS) (optional) |
| GefahrgutFaktor | Integer | 3 | - | Evaluation factor for point summation on the transport document, (can be 0, 1, 3, 50 or 999), actually obligatory, but can be clearly concluded from the transport category, therefore it does not necessarily have to be documented |
| GefahrgutFreigestMenge | String | 1 | - | T if the substance is shipped with status EQ / Excepted Quantities according to ADR 3.5, otherwise F, mandatory |
| GefahrgutKCode | String | 10 | - | Classification code, mandatory (see ADR table column (3b)) |
| GefahrgutKlasse | String | 100 | - | Mandatory (see ADR table column (3a)) |
| GefahrgutMenge | Decimal | 8 | 3 | Substance quantity of dangerous goods to be declared ADR ( in liters for liquids and compressed gases, otherwise in kg, for LQ dangerous goods always kg ). |
| GefahrgutMengenEinheit | String | 2 | - | Unit of measure for the substance quantity. '1' or 'l': liter ; '0' or 'kg' or empty: kg |
| GefahrgutNebenGefahr | String | 10 | - | conditional obligation for substances with subsidiary risk label numbers in addition to the main hazard class/label number (see ADR table column (5), if e.g. 3+6.1+8 is entered there, 6.1 and 8 are the subsidiary risk label numbers and are to be transmitted as (6.1)(8) in the subsidiary risk field ) |
| GefahrgutNettoExplMasse | Decimal | 8 | 3 | Net explosive mass in kg, only for dangerous goods of class 1 |
| GefahrgutTechBenennung | String | 150 | 3 | conditional duty for N.A.G. dangerous goods(i.e. if the designation ends with N.A.G.) , then the dangerous goods trigger must be |
| GefahrgutTunnelBCode | String | 10 | - | Tunnel restriction code, mandatory (see ADR table column (15)) |
| GefahrgutUNNR | String | 10 | - | Mandatory (see ADR table column (1)) |
| GefahrgutUmweltGef | String | 1 | - | T if the substance is hazardous to the environment, otherwise F, mandatory for substances hazardous to the environment. |
| GefahrgutVPG | String | 3 | - | Packing group, conditionally obligatory for the substances for which this is documented in the ADR table, can be I,II or III or not documented at all (the latter e.g. for class 2)) (see ADR table column (4)). |
| GefahrgutVerpAnzahl | Integer | 4 | - | Number of units in which the dangerous goods are packed (in connection with the next field Dangerous goods packaging type). |
| GefahrgutVerpackungsart | String | 5 | - | ADR code of packaging type, e.g. 4G for box (cardboard), mandatory, see separate doc f. Packing codes |
| Field name | Type | Max length | Decimals | Assignment |
|---|---|---|---|---|
| VersandeinheitID | Integer | - | - | Foreign key to the Packstückdatensatz. This relationship can be used to assign 0 ... n positions to a package. |
| GefahrgutID | String | 20 | - | Unique search number for dangerous goods master data |
| GefahrgutMenge | Decimal | 8 | 3 | - |
| GefahrgutVerpAnzahl | Integer | - | - | - |
| GefahrgutMengenEinheit | String | 2 | - | '0' or blank: kilogram; '1': liter |
| GefahrgutNettoExplMasse | Decimal | 8 | 3 | Only for class 1, but then mandatory |
Customer data request (KundenDatenAnfrage)
The function KundenDatenAnfrage is executed as soon as a search term (e.g. customer name or customerNo) is entered in the Kundenstamm-Verarbeitung. This is transmitted by the DataGatewayServer to the host system, whereby the dispatch data for this search term can be determined and transmitted back to the HVS32.
- The search term is provided by the HVS32 as variable sReferenzNr.
Only the sReferenceNo field is available for the customer data request.
The upstream system may provide the following fields in response to this request:
Shipment-related data such as client or recipient
| Field name | Type | Max length | Decimals | Assignment |
|---|---|---|---|---|
| Ansprechpartner | String | 20 | - | Recipient contact person |
| AuftragNr | String | 20 | - | - |
| AuftraggeberID | String | 10 | - | Client identification from the HVS32 |
| AVISHinweis1 | String | 100 | - | - |
| AVISHinweis2 | String | 100 | - | - |
| AVISZusatz1 | String | 20 | - | Addition to fixed AVIS key 1 |
| AVISZusatz2 | String | 20 | - | Addition to fixed AVIS key 2 |
| BestellNr | String | 20 | - | Metro order no. (Metro shipping) |
| FaxNr | String | 20 | - | Fax number of the recipient |
| FrachtBrief | String | 20 | - | Waybill number if waybill is to be printed by pre-system |
| FrachtfuehrerKDNr | String | 10 | - | Customer number of the freight payer with the carrier |
| FrankaturKennung | String | 10 | - | - |
| ILNNr | String | 20 | - | ILN des Empfängers (mandatory for Metro shipping) |
| KundenNr | String | 20 | - | Customer number of the recipient with the sender |
| LieferscheinNr | String | 40 | - | Used in HVS32 as search number |
| NeutabsenderLKZ | String | 3 | - | Only occupied for neutral senders |
| NeutabsenderName1 | String | 50 | - | Only occupied for neutral senders |
| NeutabsenderName2 | String | 50 | - | Only occupied for neutral senders |
| NeutabsenderName3 | String | 50 | - | Only occupied for neutral senders |
| NeutabsenderOrt | String | 50 | - | Only occupied for neutral senders |
| NeutabsenderPLZ | String | 10 | - | Only occupied for neutral senders |
| NeutabsenderStrasse | String | 50 | - | Only occupied for neutral senders |
| Nachnahme | Decimal | 18 | 2 | - |
| NNVermerk | String | 1 | - | B': Cash / 'V': Crossed check |
| NNVerwendung | String | 30 | - | Cash on delivery Intended use |
| NNWaehrung | String | 3 | - | Cash on delivery - ISO currency code |
| PostLeitcode | String | 15 | - | - |
| PostZielFrachtzent | String | 5 | - | - |
| RechnungsEmpfLKZ | String | 5 | - | Billing address |
| RechnungsEmpfName1 | String | 50 | - | Invoice recipient |
| RechnungsEmpfName2 | String | 50 | - | Invoice recipient |
| RechnungsEmpfName3 | String | 50 | - | Invoice recipient |
| RechnungsEmpfOrt | String | 50 | - | Billing address |
| RechnungsEmpfPLZ | String | 10 | - | Billing address |
| RechnungsEmpfStr | String | 50 | - | Billing address |
| RechnungsNr | String | 20 | - | Invoice number |
| SendungsInhalt | String | 30 | - | - |
| Sonderdienste | String | 30 | - | Shipping type specific occupancy |
| TelefonNr | String | 20 | - | Recipient phone number |
| TerminArt | String | 1 | - | 'A'b / 'B'is / 'F'ix |
| TerminDatum | String | 10 | - | TT.MM.JJJJ |
| TerminZeit | String | 5 | - | HH:MM |
| UstIDNr | String | 20 | - | Sales tax number of the recipient |
| VersandartID | String | 10 | - | Dispatch type identifier from the HVS32 |
| Versicherungswert | Decimal | 18 | 2 | Amount of the insured value |
| VWWaehrung | String | 3 | - | Insured value - ISO currency code |
| Warenwert | Decimal | 18 | 2 | - |
| WWWaehrung | String | 3 | - | Value of goods - ISO currency code |
| Zahlungsbedinung | String | 10 | - | 'S' = Sender, 'R' = Empfänger |
| ZBZoll | String | 1 | - | Payment term for customs taxes 'S' = Sender, 'R' = Empfänger |
| ZielAdrName1 | String | 50 | - | Delivery address |
| ZielAdrName2 | String | 50 | - | Delivery address |
| ZielAdrName3 | String | 50 | - | Delivery address |
| ZielAdrLKZ | String | 5 | - | Delivery address |
| ZielAdrPLZ | String | 10 | - | Delivery address |
| ZielAdrOrt | String | 50 | - | Delivery address |
| ZielAdrStrasse | String | 50 | - | Delivery address |
| ZielAdrBahnhof | String | 30 | - | Zip code and city |
| ZielAdrRegion | String | 20 | - | State/province (e.g.: important for shipments to the USA) |
| EmpfEmailadresse | String | 100 | - | for automatic mail notification (extension module) |
| FreiAvis1 | String | 62 | - | - |
| FreiAvis2 | String | 62 | - | - |
| SendungsGewicht | Decimal | 8 | 3 | Weight of the entire shipment. The specified weight is distributed evenly among all recorded packages. |
Response of the package note data (PaketscheinDruckMeldung)
The PaketscheinDruckMeldung is used to return data about a single package. This message is used in different areas, which are listed below.
The following fields are available for the parcel label print message:
Interactive processing
Response of packet data directly after Lieferschein-Verarbeitung oder Kundenstamm-Verarbeitung eines Packstücks.
Single package
A separate PaketscheinDruckMeldung(parcel label print message) is reported for each parcel directly after it has been processed and printed.
Shipment
Special Response of package data in interactive Lieferschein-Modus after the whole processing procedure of a delivery bill.
.
A separate PaketscheinDruckMeldung (ParcelNotePrintMessage) is sent to the DataGatewayServer after processing for each generated parcel.
Delivery bills
Response per delivery bill, accompanying package delivery bill and package after a Lieferscheinverarbeitung. The number of records is: Delivery bills * Packages.
Package Delivery bills
Response of package and delivery note data for the main and each by-pack delivery bill after processing a created package.
For each delivery bill assigned to the package, a data record is transmitted to the DataGatewayServer in a PaketscheinDruckMeldung (package note print message).
.
The following fields are additionally available::
- AnzahlLNrPackStk = Number of delivery bills (Main and bypack)
- LFDLNrPackStk = Sequence number of the delivery bill within the package (starting with 1)
- HauptLieferscheinNr = LieferscheinNr (Delivery bill no.) of the main delivery bill
- VersandartID = VersandartID (Dispatch type ID) that was used for processing. (This can be different from the delivery bill header data).
Automatic-Polling
If the Automatic-Polling is configured in the HVS32 via the Vormerktabelle, a package slip print message is also executed per package in this case.
Return of the delivery note data (LieferscheinRueckMeldung)
The LieferscheinRueckMeldung is used for the return of delivery note data. This message is used in different areas, which are listed below.
The following fields are available for the delivery note return message:
Additionally the field HauptLieferscheinNr (MainDeliveryNoteNo) is transmitted.
Interactive processing
Feedback of delivery bill data directly after Lieferschein-Verarbeitung or Kundenstamm-Verarbeitung of a main delivery bill.
Single package
Return of delivery note data per main delivery bill and for each supplementary delivery bill after a Delivery Note Processing.
- If the option SAMMEL_DGCLRS' (ON) is active, a collected DeliveryNoteReturnMessage is sent. Otherwise for each LieferscheinNr a separate message.
Customer processing
Return of accompanying package delivery bills after processing from the Kundenstamm-Verarbeitung.
Automatic-Polling
If the Automatic-Polling is configured in HVS32 via the Vormerktabelle, then in this case a LieferscheinRueckMeldung (delivery bill return message) is also executed per main delivery bill and for each supplementary packing delivery bill.
Return message of the shipment data (SendungsRueckMeldung)
With the SendungsRueckMeldung summarized data of a shipment is reported back after a Lieferschein-Verarbeitung.
The following fields are summed up:
- Cash on delivery
- Fee
- Insurance value
- Total weight
The following fields are available for the SendungsRueckMeldung (ShipmentReturn) message:
Cancel packages Info (PaketscheinLoeschMeldung)
The PaketscheinLoeschMeldung is executed after a package is cancelled via the Auskunft.
- If records have not been processed through the DataGatewayServer, the DefaultStornoGatewayID option with the value "ODBC" is required.
The following fields are available for the PaketscheinLoeschMeldung:
Reprint replacement label Info (UpdateTrackingNr)
When reprinting a replacement label via the Auskunft, the UpdateTrackingNr is executed.
- If records have not been processed via the DataGatewayServer, the DefaultUpdateGatewayID option with the value "ODBC" is required.
- TrackingNrErsetzt = Old TrackingNr
- TrackingNr = New TrackingNr
Return of the consignment fees (SendungsGebuehrRueckmeldung)
When printing the outgoing list, the function SendungsGebuehrRueckmeldung can be activated, whereby the shipment fee can be reported back. Shipment related rates are not determined until the loading shipment is created and can be transmitted via this feedback to the upstream system when printing an HVS32 outbound list.
- Per Shipment the fields TrackingNr, VerarbeitungsNr, Gebuehr, PackStkNr are transferred.
- The fee is reported only for carriers that have the SendungsGebuehrRueckmeldung option set to "ON".
Return of the output lists (AusgangslistenRueckMeldung)
The AusgangslistenRueckMeldung(Outgoing list return message) is triggered during list generation and daily closing. Thus all packages, which are contained in the generated outgoing list, can be reported back. A separate AusgangslistenRueckMeldung(OutputListReturnMessage) is sent for each generated list.
- With the option AusgangslistenRueckMeldungTrackingURL(OutboundListReturnMessageTrackingURL) ('ON) the tracking link for the return message data can be generated additionally. This is then available in the TrackingURL field.
- If the confirmation of the PackstückID (package ID) is sufficient, the option AusgangslistenRueckMeldungNurPackstueckID(OutputListReturnMessageOnlyPackageID) ('ON) the performance can be improved.
- With the option LimitAusgangsListenSaetze(LimitOutputListSets) ('"500") (or any other value) the number of records per output list can be limited. This means that instead of one AusgangsListenRückmeldung (outbound list response) "n" AusgangsListenRückmeldungen (outbound list responses) will be triggered. e.g. 2,000 records, LimitAusgangsListenSaetze="500" (LimitOutboundListSets)-> 4 outbound list responses
- By-pack delivery bills can be reported only to the main delivery bill comma separated in the field BeipackLieferscheinNr.
The following fields are available for the output list return message:
Main, by-pack delivery note receipt (LieferscheinQuittungsMeldung)
LieferscheinQuittungsMeldung (DeliveryNoteReceiptMessage) is used to report back the shipping order data per main delivery bill and for each supplementary packing slip after Lieferschein-Verarbeitung of all packages.
- The field BeipackHauptLieferscheinNr is additionally available.
The following fields are available for the LieferscheinQuittungsMeldung (delivery note receipt message):
WaWi response information (AuskunftWaWiRueckMeldung)
The function AuskunftWaWiRueckMeldung is used to subsequently transfer data to the previous system by a manual trigger. The triggering is done via the button WaWi-Rück in the [Shipmenten:_Auskunft_/_Verwaltung|Auskunft]]. All selected packages are reported back.
For the AuskunftWaWiRueckMeldung the following fields are available
Feedback of the position data (Article) (ArtikelRueckMeldung)
The ArtikelRueckMeldung(ArticleReturnMessage) can be used to report back updated Article data of the shipping units of a processing. The feedback takes place at the end of a (Lieferschein-Verarbeitung or Kundenstamm-Verarbeitung).
- By-pack delivery bills are not taken into account!
The following fields are available for the ArtikelRueckMeldung (ArticleReturn message):
Update of the shipment fees (SendungsGebuehrUpdateMeldung)
Updates in the shipment fee are reported via the function SendungsGebuehrUpdateMeldung(ShipmentFeeUpdateMessage). The notification is sent after another package has been processed for shipment or cancelled in Auskunft.
- The updated freight charges are in the Gebuehr (Fee) field.
The following fields are available for the SendungsGebuehrUpdateMeldung (shipment fee update message):
Package release via the information desk (AuskunftFreigabe)
Release message reported back when a package is released via Auskunft freigegeben.
- If records have not been processed through the DataGatewayServer, the DefaultStornoGatewayID option with the value "ODBC" is required.
The following fields are available for the AuskunftFreigabe (information release):