Difference between revisions of "HVS32 automatic polling functions"

From Wiki - Heidler Strichcode GmbH
Jump to navigation Jump to search
m
 
(13 intermediate revisions by one other user not shown)
Line 9: Line 9:
 
<!-- ------------------------------------------------------------------------------- ENDE ÜBERSICHT UNTERFUNKTIONEN ------------------------------------------------------------------------------- -->
 
<!-- ------------------------------------------------------------------------------- ENDE ÜBERSICHT UNTERFUNKTIONEN ------------------------------------------------------------------------------- -->
 
<!-- ------------------------------------------------------------------------------- artikelDaten ------------------------------------------------------------------------------- -->
 
<!-- ------------------------------------------------------------------------------- artikelDaten ------------------------------------------------------------------------------- -->
== article data ==
+
== Article data ==
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
Line 143: Line 143:
 
|}
 
|}
 
<!-- ------------------------------------------------------------------------------- ENDE gefahrgut ------------------------------------------------------------------------------- -->
 
<!-- ------------------------------------------------------------------------------- ENDE gefahrgut ------------------------------------------------------------------------------- -->
 +
 +
<!-- ------------------------------------------------------------------------------- VersandDatenAnfrage ------------------------------------------------------------------------------- -->
 +
= Package processing (VersandDatenAnfrage) =
 +
The gateway function VersandDatenAnfrage is sent from the data gateway server in automatic polling mode to the HVS32 in order to generate and post a label for a package.
 +
A label is identified for all further functions such as cancellation, loading release, etc. by means of the host-side package ID. This is transferred in the Package ID field and must therefore be unique within the shipping system.
 +
 +
 +
By means of an additional configuration in the HVS32, the VersandDatenAnfrage can also be used to initiate a reprint. In this case, the same PackstueckID must be used for the new request.<br>
 +
<br>
 +
<big>'''Parameters'''</big>
 +
<br>
 +
<small>'''Bold''' fields must ALWAYS be filled</small>
 +
{| class="wikitable sortable"
 +
|-
 +
! Field name !! Type !! Max Length !! Decimal places !! Assignment
 +
|-
 +
| ANSPRECHPARTNER || [[#Data types|String]] || 50 || - || Recipient Contact person
 +
|-
 +
| ANZAHLARTIKEL || [[#Data types|Integer]] || 6 || - || Number of articles (print on label)
 +
|-
 +
| [[#Article data|ARTIKELDATEN]] || [[#Data types|Sequence]] '''[[#Article data|<ArtikelDaten>]]''' || - || - || A list of the [[#Article data|package articles]] of the type  '''[[#Article data|ArtikelDaten]]''' (1:n)
 +
|-
 +
| AUFTRAGNR || [[#Data types|String]] || 20 || - || -
 +
|-
 +
| '''AUFTRAGGEBERID''' || [[#Data types|String]] || 10 || - || Mandantenkennung aus dem HVS32
 +
|-
 +
| AVISHINWEIS1 || [[#Data types|String]] || 100 || - || -
 +
|-
 +
| AVISHINWEIS2 || [[#Data types|String]] || 100 || - || -
 +
|-
 +
| AVISZUSATZ1 || [[#Data types|String]] || 20 || - || Addition to fixed AVIS key 1
 +
|-
 +
| AVISZUSATZ2 || [[#Data types|String]] || 20 || - || Addition to fixed AVIS key 2
 +
|-
 +
| BARCODEID || [[#Data types|String]] || - || - || Additional field for possible extensions
 +
|-
 +
| BARCODETEXT || [[#Data types|String]] || - || - || Additional field for possible extensions
 +
|-
 +
| BARCODETYP || [[#Data types|String]] || - || - || Additional field for possible extensions
 +
|-
 +
| BESTELLNR || [[#Data types|String]] || 20 || - || Metro order no. (Metro shipping)
 +
|-
 +
| DRUCKERNAME || [[#Data types|String]] || 30 || - || Name of an output channel (printer) in the HVS32 via which the label is printed. (Requires printer spooler extension module)
 +
|-
 +
| EMAIL || [[#Data types|String]] || 100 || - || E-mail address of the recipient (e.g.: for automatic e-mail notification)
 +
|-
 +
| EMPFMOBILFUNKNR || [[#Data types|String]] || 20 || - || Mobile phone number of the recipient
 +
|-
 +
| FAXNR || [[#Data types|String]] || 20 || - || Fax number of the recipient
 +
|-
 +
| FLEXZUSTELLUNGEMAILADRESSE || [[#Data types|String]] || 80 || - || Flex delivery email address
 +
|-
 +
| FRACHTBRIEF || [[#Data types|String]] || 20 || - || Consignment note number if the consignment note is to be printed by the pre-system
 +
|-
 +
| FRACHTFUEHRERKDNR || [[#Data types|String]] || 10 || - || Customer number of the freight payer with the carrier
 +
|-
 +
| FRANKATURKENNUNG || [[#Data types|String]] || 10 || - || -
 +
|-
 +
| [[#Dangerous goods|GEFAHRGUT]] || [[#Data types|Sequence]] '''[[#Dangerous goods|<Gefahrgut>]]''' || - || - || A list of [[#Dangerous goods|Dangerous goods]] of type '''[[#Dangerous goods|Gefahrgut]]''' (1:n)
 +
|-
 +
| GEWICHT || [[#Data types|Decimal]] || 8 || 3 || Gross weight in KG
 +
|-
 +
| HOSTTRACKINGNR || [[#Data types|String]] || 35 || - || Package number from the host system
 +
|-
 +
| ILNNR || [[#Data types|String]] || 20 || - || ILN of the recipient (mandatory for Metro shipping)
 +
|-
 +
| KOSTENSTELLE || [[#Data types|String]] || 30 || - || -
 +
|-
 +
| KUNDENNR || [[#Data types|String]] || 20 || - || Customer number of the recipient with the sender
 +
|-
 +
| LAGERKENNZEICHEN || [[#Data types|Integer]] || - || - || -
 +
|-
 +
| LETZTESPACKSTUECK || [[#Data types|String]] || 1 || - || T/F: T=last packing piece of the consignment (required for printing the consignment hanging card in the case of hanging consignments).
 +
|-
 +
| LIEFERANTENID || [[#Data types|Integer]] || - || - || -
 +
|-
 +
| '''LIEFERSCHEINNR''' || [[#Data types|String]] || 40 || - || Used in the HVS32 as a search number
 +
|-
 +
| NACHNAHME || [[#Data types|Decimal]] || 18 || 2 || -
 +
|-
 +
| NETTOGEWICHT || [[#Data types|Decimal]] || 8 || 3 || Net weight in KG
 +
|-
 +
| NEUTBIC || [[#Data types|String]] || 11 || - || Only used with neutral senders
 +
|-
 +
| NEUTBANKBEZEICHNUNG || [[#Data types|String]] || 40 || - || Only used with neutral senders
 +
|-
 +
| NEUTIBAN || [[#Data types|String]] || 31 || - || Only used with neutral senders
 +
|-
 +
| NEUTKONTOINHABER || [[#Data types|String]] || 40 || - || Only used with neutral senders
 +
|-
 +
| NEUTABSENDERLKZ || [[#Data types|String]] || 3 || - || Only used with neutral senders
 +
|-
 +
| NEUTABSENDERNAME1 || [[#Data types|String]] || 50 || - || Only used with neutral senders
 +
|-
 +
| NEUTABSENDERNAME2 || [[#Data types|String]] || 50 || - || Only used with neutral senders
 +
|-
 +
| NEUTABSENDERNAME3 || [[#Data types|String]] || 50 || - || Only used with neutral senders
 +
|-
 +
| NEUTABSENDERORT || [[#Data types|String]] || 50 || - || Only used with neutral senders
 +
|-
 +
| NEUTABSENDERPLZ || [[#Data types|String]] || 10 || - || Only used with neutral senders
 +
|-
 +
| NEUTABSENDERSTRASSE || [[#Data types|String]] || 50 || - || Only used with neutral senders
 +
|-
 +
| NNVERMERK || [[#Data types|String]] || 1 || - || 'B': Cash / 'V': Crossed cheque
 +
|-
 +
| NNVERWENDUNG || [[#Data types|String]] || 30 || - || Cash on delivery - Intended use
 +
|-
 +
| NNWAEHRUNG || [[#Data types|String]] || 3 || - || Cash on delivery - ISO currency code
 +
|-
 +
| '''PACKSTKGES''' || [[#Data types|Integer]] || - || - || Total number of colli of the consignment
 +
|-
 +
| '''PACKSTKNR''' || [[#Data types|Integer]] || - || - || Sequence number per consignment
 +
|-
 +
| PACKPLATZ || [[#Data types|String]] || 10 || - || HVS32 packing station that will process the job.
 +
|-
 +
| PACKSTUECKBREITE || [[#Data types|Integer]] || - || - || Width in cm
 +
|-
 +
| PACKSTUECKHOEHE || [[#Data types|Integer]] || - || - || Height in cm
 +
|-
 +
| '''PACKSTUECKID''' || [[#Data types|String]] || 20 || - || Unique number for the parcel in the pre-system. Needed as a unique parcel reference to cancel or load the label later.
 +
|-
 +
| PACKSTUECKLAENGE || [[#Data types|Integer]] || - || - || Length in cm
 +
|-
 +
| PAPERLESSINVOICE || [[#Data types|String]] || 1 || - || Only in UPS PaperlessInvoice case (T=PaperlessInvoice / F=not PaperlessInvoice)
 +
|-
 +
| POSTLEITCODE || [[#Data types|String]] || 15 || - || -
 +
|-
 +
| POSTZIELFRACHTZENT || [[#Data types|String]] || 5 || - || -
 +
|-
 +
| RECHNUNGSEMPFLKZ || [[#Data types|String]] || 5 || - || Invoice address
 +
|-
 +
| RECHNUNGSEMPFNAME1 || [[#Data types|String]] || 50 || - || Invoice recipient
 +
|-
 +
| RECHNUNGSEMPFNAME2 || [[#Data types|String]] || 50 || - || Invoice recipient
 +
|-
 +
| RECHNUNGSEMPFNAME3 || [[#Data types|String]] || 50 || - || Invoice recipient
 +
|-
 +
| RECHNUNGSEMPFORT || [[#Data types|String]] || 50 || - || Invoice address
 +
|-
 +
| RECHNUNGSEMPFPLZ || [[#Data types|String]] || 10 || - || Invoice address
 +
|-
 +
| RECHNUNGSEMPFSTRASSE || [[#Data types|String]] || 50 || - || Invoice address
 +
|-
 +
| RECHNUNGSNR || [[#Data types|String]] || 20 || - || Invoice number
 +
|-
 +
| SENDUNGSINHALT || [[#Data types|String]] || 30 || - || -
 +
|-
 +
| SONDERDIENSTE || [[#Data types|String]] || 30 || - || SPECIAL SERVICES - depending on the shipping method used
 +
|-
 +
| SPERRFLAG || [[#Data types|String]] || 1 || - || T/F: T=lock, otherwise do not lock
 +
|-
 +
| TELEFONNR || [[#Data types|String]] || 20 || - || Recipient's phone number
 +
|-
 +
| TERMINART || [[#Data types|String]] || 1 || - || 'A' = deliver from this day on
 +
'B' = deliver until this day
 +
 +
'F' = deliver on this day
 +
|-
 +
| TERMINDATUM || [[#Data types|String]] || 10 || - || DD.MM.YYYY
 +
|-
 +
| TERMINZEIT || [[#Data types|Calendar]] || 5 || - || HH:MM
 +
|-
 +
| USTIDNR || [[#Data types|String]] || 20 || - || VAT number of the recipient
 +
|-
 +
| VERPACKUNGSART || [[#Data types|String]] || 6 || - || -
 +
|-
 +
| '''VERSANDARTID''' || [[#Data types|String]] || 10 || - || Dispatch type identifier from the HVS32
 +
|-
 +
| VERSICHERUNGSWERT || [[#Data types|Decimal]] || 18 || 2 || Amount of insured value
 +
|-
 +
| VORPACKDATUM || [[#Data types|String]] || 10 || - || DD.MM.YYYY
 +
|-
 +
| VWWAEHRUNG || [[#Data types|String]] || 3 || - || Insured value - ISO currency code
 +
|-
 +
| WARENWERT || [[#Data types|Decimal]] || 18 || 2 || Value of goods
 +
|-
 +
| WECHSELBRUECKE || [[#Data types|String]] || 20 || - || Swap body assigned to this package
 +
|-
 +
| WWWAEHRUNG || [[#Data types|String]] || 3 || - || Value of goods - ISO currency code
 +
|-
 +
| ZAHLUNGSBEDINGUNG || [[#Data types|String]] || 10 || - || 'S' = sender, 'R' = receiver
 +
|-
 +
| ZBZOLL || [[#Data types|String]] || 1 || - || Payment condition for customs taxes 'S' = Sender, 'R' = Receiver
 +
|-
 +
| ZIELADRBAHNHOF || [[#Data types|String]] || 30 || - || Postcode and city
 +
|-
 +
| '''ZIELADRLKZ''' || [[#Data types|String]] || 5 || - || Delivery address
 +
|-
 +
| '''ZIELADRNAME1''' || [[#Data types|String]] || 50 || - || Delivery address
 +
|-
 +
| ZIELADRNAME2 || [[#Data types|String]] || 50 || - || Delivery address
 +
|-
 +
| ZIELADRNAME3 || [[#Data types|String]] || 50 || - || Delivery address
 +
|-
 +
| ZIELADRNAME4 || [[#Data types|String]] || 50 || - || Delivery address
 +
|-
 +
| '''ZIELADRORT''' || [[#Data types|String]] || 50 || - || Delivery address
 +
|-
 +
| '''ZIELADRPLZ''' || [[#Data types|String]] || 10 || - || Delivery address
 +
|-
 +
| ZIELADRREGION || [[#Data types|String]] || 20 || - || State/province (e.g.: important for shipments to the USA)
 +
|-
 +
| '''ZIELADRSTRASSE''' || [[#Data types|String]] || 50 || - || Delivery address
 +
|}
 +
 +
<br><big>'''Return parameters'''</big><br>
 +
{| class="wikitable sortable"
 +
|-
 +
! Field name !! Type !! Max Length !! Decimal places !! Assignment|
 +
|-
 +
| AUSGANGDATETIME || [[#Data types|String]] || 10 || - || Date when the label was transmitted to the carrier (DD.MM.YYYY)
 +
|-
 +
| DRUCKDATETIME || [[#Data types|String]] || 19 || - || Date when the label was printed in the HVS32 (DD.MM.YYYY HH:mm:SS)
 +
|-
 +
| FEHLER || [[#Data types|Integer]] || - || - || 0 if successful
 +
|-
 +
| FEHLERTEXT1 || [[#Data types|String]] || 200 || - || Is filled in the event of an error
 +
|-
 +
| FEHLERTEXT2 || [[#Data types|String]] || 200 || - || Is filled in the event of an error
 +
|-
 +
| GEBUEHR || [[#Data types|Decimal]] || 18 || 2 || Freight costs
 +
|-
 +
| GEBUEHRWAEHRUNG || [[#Data types|String]] || 3 || - || Freight costs - ISO currency code
 +
|-
 +
| PACKSTUECKID || [[#Data types|String]] || 20 || - || PackstueckID from the request
 +
|-
 +
| RETOURTRACKINGNR || [[#Data types|String]] || 50 || - || Package number for the return
 +
|-
 +
| TRACKINGNR || [[#Data types|String]] || 35 || - || Package number
 +
|-
 +
| TRACKINGURL || [[#Data types|String]] || 255 || - || URL of the tracking link
 +
|-
 +
| VERSANDSENDUNGSNR || [[#Data types|String]] || - || - || -
 +
|}
 +
<!-- ------------------------------------------------------------------------------- ENDE VersandDatenAnfrage ------------------------------------------------------------------------------- -->
 +
 +
<!-- ------------------------------------------------------------------------------- VersandDatenWdhDruck ------------------------------------------------------------------------------- -->
 +
= Reprint label (VersandDatenWdhDruck) =
 +
The gateway function VersandDatenWdhDruck is sent from the data gateway server in automatic polling mode to the HVS32 to reprint a label for a package.
 +
A label is reprinted using the host-side package ID. This is transferred in the PackstueckID field.
 +
Some carriers (e.g. DPD) assign new tracking numbers when reprinting. This means that the old tracking number is no longer valid and the old shipping label must be destroyed.
 +
The new tracking number can be reported back in the response.
 +
<br><br><big>'''Parameters '''</big><br>
 +
<small>'''Bold''' fields must ALWAYS be filled</small>
 +
{| class="wikitable sortable"
 +
|-
 +
! Field name !! Type !! Max Length !! Decimal places !! Assignment
 +
|-
 +
| '''PACKSTUECKID''' || [[#Data types|String]] || 20 || - || '''Unique''' number for the parcel in the pre-system.
 +
|-
 +
| PACKPLATZ || [[#Data types|String]] || 10 || - || HVS32 packing station that will process the job.
 +
|-
 +
| DRUCKERNAME || [[#Data types|String]] || 30 || - || Name of an output channel (printer) in the HVS32 via which the label is printed. (Requires printer spooler extension module)
 +
|}
 +
<br><big>'''Return parameters'''</big><br>
 +
{| class="wikitable sortable"
 +
|-
 +
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
 +
|-
 +
| FEHLER || [[#Data types|Integer]] || - || - || 0 = Successful, 1 = Error
 +
|-
 +
| FEHLERTEXT1 || [[#Data types|String]] || 200 || - || Is filled in the event of an error
 +
|-
 +
| FEHLERTEXT2 || [[#Data types|String]] || 200 || - || Is filled in the event of an error
 +
|-
 +
| TRACKINGNR || [[#Data types|String]] || 35 || - || (New) tracking number of the package
 +
|}
 +
<!-- ------------------------------------------------------------------------------- ENDE VersandDatenWdhDruck ------------------------------------------------------------------------------- -->
 +
 +
<!-- ------------------------------------------------------------------------------- StornoVersandDaten ------------------------------------------------------------------------------- -->
 +
= Cancel package (StornoVersandDaten) =
 +
The gateway function StornoVersandDaten is sent from the data gateway server (DGS) in automatic polling mode to the HVS32 to cancel existing packages there that are not yet on an outgoing list.
 +
As a rule, a package is cancelled on the basis of the package ID on the host side. This is transferred in the PackstueckID field.
 +
In addition to the host-side package ID, the tracking number can also contribute to the identification of the package, in case the host-side package ID cannot guarantee uniqueness.
 +
No package/shipment data is available for the feedback. After a successful cancellation, only the field Error with value 0 is reported back - or in case of an error, Error with value 1 and the error Fehlertext1 are reported back.
 +
<br><br><big>'''Parameters'''</big><br>
 +
<small>'''Bold''' fields must ALWAYS be filled</small>
 +
{| class="wikitable sortable"
 +
|-
 +
! Field name !! Type !! Max Length !! Decimal places !! Assignment
 +
|-
 +
| '''PACKSTUECKID''' || [[#Data types|String]] || 20 || - || '''Unique''' number for the parcel in the pre-system.
 +
|-
 +
| PACKPLATZ || [[#Data types|String]] || 10 || - || HVS32 packing station that will process the job.
 +
|}
 +
<br><big>'''Return parameters'''</big><br>
 +
{| class="wikitable sortable"
 +
|-
 +
! Field name !! Type !! Max Length !! Decimal places !! Assignment
 +
|-
 +
| FEHLER || [[#Data types|Integer]] || - || - || 0 = Successful, 1 = Error
 +
|-
 +
| FEHLERTEXT1 || [[#Data types|String]] || 200 || - || Is filled in the event of an error
 +
|-
 +
| FEHLERTEXT2 || [[#Data types|String]] || 200 || - || Is filled in the event of an error
 +
|}
 +
<!-- ------------------------------------------------------------------------------- ENDE StornoVersandDaten ------------------------------------------------------------------------------- -->
 +
 +
<!-- ------------------------------------------------------------------------------- VerladeVersandDaten ------------------------------------------------------------------------------- -->
 +
= Load/release package (VerladeVersandDaten) =
 +
The gateway function VerladeVersandDaten is sent from the data gateway server in automatic polling mode to the HVS32 in order to release packages for outgoing.
 +
Only packages that have been released for exit are taken into account for the daily closing.
 +
No package/shipment data is available for the feedback. After successful release, only the field Fehler with value 0 is reported back - or in case of an error, Fehler with value 1 and the error Fehlertext1 are reported back.
 +
<br><br><big>'''Parameters'''</big><br>
 +
<small>'''Bold''' fields must ALWAYS be filled</small>
 +
{| class="wikitable sortable"
 +
|-
 +
! Field name !! Type !! Max Length !! Decimal places !! Assignment
 +
|-
 +
| '''PACKSTUECKID''' || [[#Datentypen|String]] || 20 || - || '''Unique''' number for the parcel in the pre-system.
 +
|-
 +
| PACKPLATZ || [[#Datentypen|String]] || 10 || - || HVS32 packing station that will process the job.
 +
|-
 +
| SPERRKENNZEICHEN || [[#Datentypen|String]] || 1 || - || "J" if the package is to be blocked
 +
|-
 +
| WECHSELBRUECKE || [[#Datentypen|String]] || 20 || - || Swap body on which the package is to be booked
 +
|-
 +
| SAMMELFREIGABE || [[#Datentypen|String]] || 1 || - || "T" for a collective release (release all packages with identical VE-ReferenzNr)
 +
|-
 +
| VEREFERENZNR || [[#Datentypen|String]] || 20 || - || must be filled for a collective release
 +
|}
 +
<br><big>'''Return parameters'''</big><br>
 +
{| class="wikitable sortable"
 +
|-
 +
! Field name !! Type !! Max Length !! Decimal places !! Assignment
 +
|-
 +
| FEHLER || [[#Datentypen|Integer]] || - || - || 0 = Successful, 1 = Error
 +
|-
 +
| FEHLERTEXT1 || [[#Datentypen|String]] || 200 || - || Is filled in the event of an error
 +
|-
 +
| FEHLERTEXT2 || [[#Datentypen|String]] || 200 || - || Is filled in the event of an error
 +
|}
 +
<!-- ------------------------------------------------------------------------------- ENDE VerladeVersandDaten ------------------------------------------------------------------------------- -->
 +
 +
<!-- ------------------------------------------------------------------------------- Tagesabschluss ------------------------------------------------------------------------------- -->
 +
= Daily closing (Tagesabschluss) =
 +
The gateway sends the daily closing request to the automatic polling of the HVS32. A daily closing is thus triggered in the HVS32 on the basis of the additionally transferred parameters.
 +
The daily closing consists of the points generate outgoing list and Generate EDI file.
 +
Only packages that have been released for exit are taken into account for the daily closing. By default, all packages are released unless they have been blocked by the output scanning extension module.
 +
The feedback in the HVS32 takes place after the daily closing has been executed.
 +
No package/shipment data is available for the feedback. After successful day-end closing, only the field Fehler is reported with the value 0 - or in the case of an error, Fehler is reported with the value 1 and the Fehlertext1 .
 +
<br><br><big>'''Parameters'''</big><br>
 +
<small>'''Bold''' fields must ALWAYS be filled</small>
 +
{| class="wikitable sortable"
 +
|-
 +
! Field name !! Type !! Max Length !! Decimal places !! Assignment
 +
|-
 +
| PACKPLATZ || [[#Data types|String]] || 10 || - || HVS32 packing station client that is to execute the daily closing.
 +
|-
 +
| FRACHTFUEHRERTYPLIST || [[#Data types|String]] || 250 || - || A semicolon separated list with the carriers to be concluded can be entered here. N carriers can be concluded.
 +
(Option MultiFFTagesabschluss must be active in HVS32)
 +
|-
 +
| AUFTRAGGEBERIDLIST || [[#Data types|String]] || 250 || - || A semicolon separated list with the clients to be completed can be entered here. N clients can be concluded.
 +
(Option MultiAGTagesabschluss must be active in HVS32)
 +
|-
 +
| VERSANDARTIDLIST || [[#Data types|String]] || 250 || - || A semicolon separated list with the dispatch types to be completed can be entered here. N shipping types can be completed.
 +
(Option MultiVATagesabschluss must be active in HVS32)
 +
|-
 +
| WECHSELBRUECKE || [[#Data types|String]] || 20 || - || Indicator of the swap body to be closed. Only certain consignments can be closed with this.
 +
|-
 +
| DRUCKERNAME || [[#Data types|String]] || 30 || - || Name of the output channel on which the list is to be printed.
 +
|}
 +
<br><big>'''Return parameters'''</big><br>
 +
{| class="wikitable sortable"
 +
|-
 +
! Field name !! Type !! Max Length !! Decimal places !! Assignment
 +
|-
 +
| FEHLER || [[#Data types|Integer]] || - || - || 0 = Successful, 1 = Error
 +
|-
 +
| FEHLERTEXT1 || [[#Data types|String]] || 200 || - || Is filled in the event of an error
 +
|-
 +
| FEHLERTEXT2 || [[#Data types|String]] || 200 || - || Is filled in the event of an error
 +
|}
 +
<!-- ------------------------------------------------------------------------------- ENDE Tagesabschluss ------------------------------------------------------------------------------- -->
 +
 +
<!-- ------------------------------------------------------------------------------- Listenabschluss ------------------------------------------------------------------------------- -->
 +
= Generate output list (Listenabschluss) =
 +
The gateway sends the generate-output-list request to the automatic polling of the HVS32. An outgoing list is thus generated in the HVS32 on the basis of the additionally transferred parameters.
 +
Only packages that have been released for exit are taken into account for the list closure. By default, all packages are released unless they have been blocked by the output scanning extension module.
 +
The feedback in the HVS32 takes place after the output list has been generated.
 +
No package/shipment data is available for feedback. After successful completion of the list, only the field Error with value 0 is reported back - or in the case of an error, Error with value 1 and the error text1 are reported back.
 +
<br><br><big>'''Parameters'''</big><br>
 +
<small>'''Bold''' fields must ALWAYS be filled</small>
 +
{| class="wikitable sortable"
 +
|-
 +
! Field name !! Type !! Max Length !! Decimal places !! Assignment
 +
|-
 +
| PACKPLATZ || [[#Data types|String]] || 10 || - || HVS32 packing station client that is to execute the daily closing.
 +
|-
 +
| FRACHTFUEHRERTYPLIST || [[#Data types|String]] || 250 || - || A semicolon separated list with the carriers to be concluded can be entered here. N carriers can be concluded.
 +
(Option MultiFFTagesabschluss must be active in HVS32)
 +
|-
 +
| AUFTRAGGEBERIDLIST || [[#Data types|String]] || 250 || - || A semicolon separated list with the clients to be completed can be entered here. N clients can be concluded.
 +
(Option MultiAGTagesabschluss must be active in HVS32)
 +
|-
 +
| VERSANDARTIDLIST || [[#Data types|String]] || 250 || - || A semicolon separated list with the dispatch types to be completed can be entered here. N shipping types can be completed.
 +
(Option MultiVATagesabschluss must be active in HVS32)
 +
|-
 +
| WECHSELBRUECKE || [[#Data types|String]] || 20 || - || Indicator of the swap body to be closed. Only certain consignments can be closed with this.
 +
|-
 +
| DRUCKERNAME || [[#Data types|String]] || 30 || - || Name of the output channel on which the list is to be printed.
 +
|}
 +
<br><big>'''Return parameters'''</big><br>
 +
{| class="wikitable sortable"
 +
|-
 +
! Field name !! Type !! Max Length !! Decimal places !! Assignment
 +
|-
 +
| FEHLER || [[#Data types|Integer]] || - || - || 0 = Successful, 1 = Error
 +
|-
 +
| FEHLERTEXT1 || [[#Data types|String]] || 200 || - || Is filled in the event of an error
 +
|-
 +
| FEHLERTEXT2 || [[#Data types|String]] || 200 || - || Is filled in the event of an error
 +
|}
 +
<!-- ------------------------------------------------------------------------------- ENDE Listenabschluss ------------------------------------------------------------------------------- -->
 +
 +
<!-- ------------------------------------------------------------------------------- EDIAbschluss ------------------------------------------------------------------------------- -->
 +
= Create carrier EDI (EDIAbschluss) =
 +
The gateway sends the create-carrier-EDI request to the automatic polling of the HVS32. A carrier EDI is thus generated in the HVS32 on the basis of the additionally transferred parameters and (if configured) transmitted to the carrier.
 +
Only packages for which an outgoing list was previously generated are taken into account for a carrier EDI.
 +
The confirmation in the HVS32 takes place after the carrier EDI has been generated.
 +
No package/shipment data is available for the confirmation. After successful completion of the EDI, only the field Error with value 0 is reported - or in case of an error, Error with value 1 and the error text1 are reported.
 +
<br><br><big>'''Parameters'''</big><br>
 +
<small>'''Bold''' fields must ALWAYS be filled</small>
 +
{| class="wikitable sortable"
 +
|-
 +
! Field name !! Type !! Max Length !! Decimal places !! Assignment
 +
|-
 +
| PACKPLATZ || [[#Data types|String]] || 10 || - || HVS32 packing station client that is to execute the daily closing.
 +
|-
 +
| FRACHTFUEHRERTYPLIST || [[#Data types|String]] || 250 || - || A semicolon separated list with the carriers to be concluded can be entered here. N carriers can be concluded.
 +
(Option MultiFFTagesabschluss must be active in HVS32)
 +
|-
 +
| AUFTRAGGEBERIDLIST || [[#Data types|String]] || 250 || - || A semicolon separated list with the clients to be completed can be entered here. N clients can be concluded.
 +
(Option MultiAGTagesabschluss must be active in HVS32)
 +
|-
 +
| VERSANDARTIDLIST || [[#Data types|String]] || 250 || - || A semicolon separated list with the dispatch types to be completed can be entered here. N shipping types can be completed.
 +
(Option MultiVATagesabschluss must be active in HVS32)
 +
|-
 +
| WECHSELBRUECKE || [[#Data types|String]] || 20 || - || Indicator of the swap body to be closed. Only certain consignments can be closed with this.
 +
|}
 +
<br><big>'''Return parameters'''</big><br>
 +
{| class="wikitable sortable"
 +
|-
 +
! Field name !! Type !! Max Length !! Decimal places !! Assignment
 +
|-
 +
| FEHLER || [[#Data types|Integer]] || - || - || 0 = Successful, 1 = Error
 +
|-
 +
| FEHLERTEXT1 || [[#Data types|String]] || 200 || - || Is filled in the event of an error
 +
|-
 +
| FEHLERTEXT2 || [[#Data types|String]] || 200 || - || Is filled in the event of an error
 +
|}
 +
<!-- ------------------------------------------------------------------------------- ENDE EDIAbschluss ------------------------------------------------------------------------------- -->
 +
 +
<!-- ------------------------------------------------------------------------------- VersandDatenPruefAnfrage ------------------------------------------------------------------------------- -->
 +
= Verify package data (VersandDatenPruefAnfrage) =
 +
The gateway sends the VersandDatenPruefAnfrage to the automatic polling of the HVS32. A shipping data request is thus simulated in the HVS32.
 +
No labels are printed and the package or label is not booked, but all other processes are identical to the shipping data request (route determination, tracking number determination, address check, etc.).
 +
This function is used to validate all shipping data in advance.
 +
<br><br><big>'''Parameters'''</big><br>
 +
<small>'''Bold''' fields must ALWAYS be filled</small>
 +
{| class="wikitable sortable"
 +
|-
 +
! Field name !! Type !! Max Length !! Decimal places !! Assignment
 +
|-
 +
| ANSPRECHPARTNER || [[#Data types|String]] || 50 || - || Recipient Contact person
 +
|-
 +
| ANZAHLARTIKEL || [[#Data types|Integer]] || 6 || - || Number of articles (print on label)
 +
|-
 +
| [[#Article data|ARTIKELDATEN]] || [[#Data types|Sequence]] '''[[#Article data|<ArtikelDaten>]]''' || - || - || Eine Liste der [[#Article data|Package article]] vom Typ '''[[#Article data|ArtikelDaten]]''' (1:n)
 +
|-
 +
| AUFTRAGNR || [[#Data types|String]] || 20 || - || -
 +
|-
 +
| '''AUFTRAGGEBERID''' || [[#Data types|String]] || 10 || - || Client identifier from HVS32
 +
|-
 +
| AVISHINWEIS1 || [[#Data types|String]] || 100 || - || -
 +
|-
 +
| AVISHINWEIS2 || [[#Data types|String]] || 100 || - || -
 +
|-
 +
| AVISZUSATZ1 || [[#Data types|String]] || 20 || - || Addition to fixed AVIS key 1
 +
|-
 +
| AVISZUSATZ2 || [[#Data types|String]] || 20 || - || Addition to fixed AVIS key 2
 +
|-
 +
| BARCODEID || [[#Data types|String]] || - || - || Additional field for possible extensions
 +
|-
 +
| BARCODETEXT || [[#Data types|String]] || - || - || Additional field for possible extensions
 +
|-
 +
| BARCODETYP || [[#Data types|String]] || - || - || Additional field for possible extensions
 +
|-
 +
| BESTELLNR || [[#Data types|String]] || 20 || - || Metro order number (Metro shipping)
 +
|-
 +
| DRUCKERNAME || [[#Data types|String]] || 30 || - || Name of an output channel (printer) in the HVS32 via which the label is printed. (Requires printer spooler extension module)
 +
|-
 +
| EMAIL || [[#Data types|String]] || 100 || - || Recipient's e-mail address (e.g.: for automatic e-mail notification)
 +
|-
 +
| EMPFMOBILFUNKNR || [[#Data types|String]] || 20 || - || Mobile phone number of the recipient
 +
|-
 +
| FAXNR || [[#Data types|String]] || 20 || - || Fax number of the recipient
 +
|-
 +
| FLEXZUSTELLUNGEMAILADRESSE || [[#Data types|String]] || 80 || - || Flex delivery email address
 +
|-
 +
| FRACHTBRIEF || [[#Data types|String]] || 20 || - || Consignment note number if consignment note is to be printed by pre-system
 +
|-
 +
| FRACHTFUEHRERKDNR || [[#Data types|String]] || 10 || - || Customer number of the freight payer with the carrier
 +
|-
 +
| FRANKATURKENNUNG || [[#Data types|String]] || 10 || - || -
 +
|-
 +
| [[#Dangerous goods|GEFAHRGUT]] || [[#Data types|Sequence]] '''[[#Dangerous goods|<Gefahrgut>]]''' || - || - || A list of [[#Dangerous goods|Dangerous goods]] of type '''[[#Dangerous goods|Gefahrgut]]''' (1:n)
 +
|-
 +
| GEWICHT || [[#Data types|Decimal]] || 8 || 3 || Gross weight in KG
 +
|-
 +
| HOSTTRACKINGNR || [[#Data types|String]] || 35 || - || Package number from the host system
 +
|-
 +
| ILNNR || [[#Data types|String]] || 20 || - || ILN of the recipient (mandatory for Metro shipping)
 +
|-
 +
| KOSTENSTELLE || [[#Data types|String]] || 30 || - || -
 +
|-
 +
| KUNDENNR || [[#Data types|String]] || 20 || - || Customer number of the recipient with the sender
 +
|-
 +
| LAGERKENNZEICHEN || [[#Data types|Integer]] || - || - || -
 +
|-
 +
| LETZTESPACKSTUECK || [[#Data types|String]] || 1 || - || T/F: T=last package of the consignment (required for printing the consignment hanging card for hanging consignments)
 +
|-
 +
| LIEFERANTENID || [[#Data types|Integer]] || - || - || -
 +
|-
 +
| '''LIEFERSCHEINNR''' || [[#Data types|String]] || 40 || - || Used in the HVS32 as a search number
 +
|-
 +
| NACHNAHME || [[#Data types|Decimal]] || 18 || 2 || -
 +
|-
 +
| NETTOGEWICHT || [[#Data types|Decimal]] || 8 || 3 || Net weight in KG
 +
|-
 +
| NEUTBIC || [[#Data types|String]] || 11 || - || Only used with neutral senders
 +
|-
 +
| NEUTBANKBEZEICHNUNG || [[#Data types|String]] || 40 || - || Only used with neutral senders
 +
|-
 +
| NEUTIBAN || [[#Data types|String]] || 31 || - || Only used with neutral senders
 +
|-
 +
| NEUTKONTOINHABER || [[#Data types|String]] || 40 || - || Only used with neutral senders
 +
|-
 +
| NEUTABSENDERLKZ || [[#Data types|String]] || 3 || - || Only used with neutral senders
 +
|-
 +
| NEUTABSENDERNAME1 || [[#Data types|String]] || 50 || - || Only used with neutral senders
 +
|-
 +
| NEUTABSENDERNAME2 || [[#Data types|String]] || 50 || - || Only used with neutral senders
 +
|-
 +
| NEUTABSENDERNAME3 || [[#Data types|String]] || 50 || - || Only used with neutral senders
 +
|-
 +
| NEUTABSENDERORT || [[#Data types|String]] || 50 || - || Only used with neutral senders
 +
|-
 +
| NEUTABSENDERPLZ || [[#Data types|String]] || 10 || - || Only used with neutral senders
 +
|-
 +
| NEUTABSENDERSTRASSE || [[#Data types|String]] || 50 || - || Only used with neutral senders
 +
|-
 +
| NNVERMERK || [[#Data types|String]] || 1 || - || 'B': Cash / 'V': Crossed cheque
 +
|-
 +
| NNVERWENDUNG || [[#Data types|String]] || 30 || - || Cash on delivery - Intended use
 +
|-
 +
| NNWAEHRUNG || [[#Data types|String]] || 3 || - || Cash on delivery - ISO currency code
 +
|-
 +
| '''PACKSTKGES''' || [[#Data types|Integer]] || - || - || Total number of colli of the consignment
 +
|-
 +
| '''PACKSTKNR''' || [[#Data types|Integer]] || - || - || Sequence number per consignment
 +
|-
 +
| PACKPLATZ || [[#Data types|String]] || 10 || - || HVS32 packing station that will process the job.
 +
|-
 +
| PACKSTUECKBREITE || [[#Data types|Integer]] || - || - || Width in cm
 +
|-
 +
| PACKSTUECKHOEHE || [[#Data types|Integer]] || - || - || Height in cm
 +
|-
 +
| PACKSTUECKID || [[#Data types|String]] || 20 || - || Unique number for the parcel in the pre-system. Needed as a unique parcel reference to cancel or load the label later.
 +
|-
 +
| PACKSTUECKLAENGE || [[#Data types|Integer]] || - || - || Length in cm
 +
|-
 +
| PAPERLESSINVOICE || [[#Data types|String]] || 1 || - || Only in UPS PaperlessInvoice case (T=PaperlessInvoice / F=not PaperlessInvoice)
 +
|-
 +
| POSTLEITCODE || [[#Data types|String]] || 15 || - || -
 +
|-
 +
| POSTZIELFRACHTZENT || [[#Data types|String]] || 5 || - || -
 +
|-
 +
| RECHNUNGSEMPFLKZ || [[#Data types|String]] || 5 || - || Invoice address
 +
|-
 +
| RECHNUNGSEMPFNAME1 || [[#Data types|String]] || 50 || - || Invoice recipient
 +
|-
 +
| RECHNUNGSEMPFNAME2 || [[#Data types|String]] || 50 || - || Invoice recipient
 +
|-
 +
| RECHNUNGSEMPFNAME3 || [[#Data types|String]] || 50 || - || Invoice recipient
 +
|-
 +
| RECHNUNGSEMPFORT || [[#Data types|String]] || 50 || - || Invoice address
 +
|-
 +
| RECHNUNGSEMPFPLZ || [[#Data types|String]] || 10 || - || Invoice address
 +
|-
 +
| RECHNUNGSEMPFSTRASSE || [[#Data types|String]] || 50 || - || Invoice address
 +
|-
 +
| RECHNUNGSNR || [[#Data types|String]] || 20 || - || Invoice number
 +
|-
 +
| SENDUNGSINHALT || [[#Data types|String]] || 30 || - || -
 +
|-
 +
| SONDERDIENSTE || [[#Data types|String]] || 30 || - || SPECIAL SERVICES - depending on the shipping method used
 +
|-
 +
| SPERRFLAG || [[#Data types|String]] || 1 || - || T/F: T=lock, otherwise do not lock
 +
|-
 +
| TELEFONNR || [[#Data types|String]] || 20 || - || Recipient's phone number
 +
|-
 +
| TERMINART || [[#Data types|String]] || 1 || - || 'A' = deliver from this day on
 +
 +
'B' = deliver until this day
 +
 +
'F' = deliver on this day
 +
 +
|-
 +
| TERMINDATUM || [[#Data types|String]] || 10 || - || DD.MM.YYYY
 +
|-
 +
| TERMINZEIT || [[#Data types|Calendar]] || 5 || - || HH:MM
 +
|-
 +
| USTIDNR || [[#Data types|String]] || 20 || - || VAT number of the recipient
 +
|-
 +
| VERPACKUNGSART || [[#Data types|String]] || 6 || - || -
 +
|-
 +
| '''VERSANDARTID''' || [[#Data types|String]] || 10 || - || Dispatch type identifier from the HVS32
 +
|-
 +
| VERSICHERUNGSWERT || [[#Data types|Decimal]] || 18 || 2 || Amount of insured value
 +
|-
 +
| VORPACKDATUM || [[#Data types|String]] || 10 || - || DD.MM.YYYY
 +
|-
 +
| VWWAEHRUNG || [[#Data types|String]] || 3 || - || Insured value - ISO currency code
 +
|-
 +
| WARENWERT || [[#Data types|Decimal]] || 18 || 2 || Value of goods
 +
|-
 +
| WECHSELBRUECKE || [[#Data types|String]] || 20 || - || Swap body assigned to this package
 +
|-
 +
| WWWAEHRUNG || [[#Data types|String]] || 3 || - || Value of goods - ISO currency code
 +
|-
 +
| ZAHLUNGSBEDINGUNG || [[#Data types|String]] || 10 || - || 'S' = sender, 'R' = receiver
 +
|-
 +
| ZBZOLL || [[#Data types|String]] || 1 || - || Payment condition for customs taxes 'S' = Sender, 'R' = Receiver
 +
|-
 +
| ZIELADRBAHNHOF || [[#Data types|String]] || 30 || - || Postcode and city
 +
|-
 +
| '''ZIELADRLKZ''' || [[#Data types|String]] || 5 || - || Delivery address
 +
|-
 +
| '''ZIELADRNAME1''' || [[#Data types|String]] || 50 || - || Delivery address
 +
|-
 +
| ZIELADRNAME2 || [[#Data types|String]] || 50 || - || Delivery address
 +
|-
 +
| ZIELADRNAME3 || [[#Data types|String]] || 50 || - || Delivery address
 +
|-
 +
| ZIELADRNAME4 || [[#Data types|String]] || 50 || - || Delivery address
 +
|-
 +
| '''ZIELADRORT''' || [[#Data types|String]] || 50 || - || Delivery address
 +
|-
 +
| '''ZIELADRPLZ''' || [[#Data types|String]] || 10 || - || Delivery address
 +
|-
 +
| ZIELADRREGION || [[#Data types|String]] || 20 || - || State/province (e.g.: important for shipments to the USA)
 +
|-
 +
| '''ZIELADRSTRASSE''' || [[#Data types|String]] || 50 || - || Delivery address
 +
|}
 +
 +
<br><big>'''Return parameters'''</big><br>
 +
{| class="wikitable sortable"
 +
|-
 +
! Field name !! Type !! Max Length !! Decimal places !! Assignment|
 +
|-
 +
| FEHLER || [[#Data types|Integer]] || - || - || 0 if successful
 +
|-
 +
| FEHLERTEXT1 || [[#Data types|String]] || 200 || - || Is filled in the event of an error
 +
|-
 +
| FEHLERTEXT2 || [[#Data types|String]] || 200 || - || Is filled in the event of an error
 +
|-
 +
| GEBUEHR || [[#Data types|Decimal]] || 18 || 2 || Freight costs
 +
|-
 +
| GEBUEHRWAEHRUNG || [[#Data types|String]] || 3 || - || Freight costs ISO currency code
 +
|-
 +
| PACKSTUECKID || [[#Data types|String]] || 20 || - || PackstueckID from the request
 +
|}
 +
<!-- ------------------------------------------------------------------------------- ENDE VersandDatenPruefAnfrage ------------------------------------------------------------------------------- -->
 +
 +
<!-- ------------------------------------------------------------------------------- UpdateVersandDaten ------------------------------------------------------------------------------- -->
 +
= Update package data (UpdateVersandDaten) =
 +
The gateway function UpdateVersandDaten is sent from the data gateway server in automatic polling mode to the HVS32 in order to change the data of existing packages.
 +
This request is sent, for example, if the value of goods for a package is only known at a later time.
 +
Data can be updated within the tables Versandeinheit, Abrechnungseinheit and Lieferung. The search is always carried out via the field PackstueckID and, if occupied, also via the field TrackingNr.
 +
However, the fields and contents to be updated are no longer checked according to the carrier's guidelines (e.g. weight limits, etc.).
 +
The pre-system must therefore ensure that the values to be updated comply with the carrier's guidelines. If this is not possible, this function cannot be used and the label must be cancelled and processed again.
 +
In addition, fields that have already been printed on a label or determined by the HVS32 shipping system in a carrier processing (e.g. address, route, tracking number, special services, etc.) cannot be manipulated.
 +
No package/shipment data is available for the confirmation. After a successful update, only the field Error with value 0 is reported back - or in case of an error, Error with value 1 and the error text1 are reported back.
 +
<br><br><big>'''Parameters'''</big><br>
 +
<small>'''Bold''' fields must ALWAYS be filled</small>
 +
{| class="wikitable sortable"
 +
|-
 +
! Field name !! Type !! Max Length !! Decimal places !! Assignment
 +
|-
 +
| '''PACKSTUECKID''' || [[#Data types|String]] || 20 || - || Unique number for the package in the pre-system. Required as a unique package reference to identify the record.
 +
|-
 +
| PACKPLATZ || [[#Data types|String]] || 10 || - || HVS32 packing station that will process the job.
 +
|-
 +
| ANSPRECHPARTNER || [[#Data types|String]] || 50 || - || Recipient Contact person
 +
|-
 +
| AVISHINWEIS1 || [[#Data types|String]] || 100 || - || -
 +
|-
 +
| AVISHINWEIS2 || [[#Data types|String]] || 100 || - || -
 +
|-
 +
| AVISZUSATZ1 || [[#Data types|String]] || 20 || - || Addition to fixed AVIS key 1
 +
|-
 +
| AVISZUSATZ2 || [[#Data types|String]] || 20 || - || Addition to fixed AVIS key 2
 +
|-
 +
| BESTELLNR || [[#Data types|String]] || 20 || - || Metro order number (Metro shipping)
 +
|-
 +
| EMAIL || [[#Data types|String]] || 100 || - || Recipient's e-mail address (e.g.: for automatic e-mail notification)
 +
|-
 +
| EMPFMOBILFUNKNR || [[#Data types|String]] || 20 || - || Mobile phone number of the recipient
 +
|-
 +
| FAXNR || [[#Data types|String]] || 20 || - || Fax number of the recipient
 +
|-
 +
| FLEXZUSTELLUNGEMAILADRESSE || [[#Data types|String]] || 80 || - || Flex delivery email address
 +
|-
 +
| GEWICHT || [[#Data types|Decimal]] || 8 || 3 || Gross weight in KG
 +
|-
 +
| NETTOGEWICHT || [[#Data types|Decimal]] || 8 || 3 || Net weight in KG
 +
|-
 +
| ILNNR || [[#Data types|String]] || 20 || - || ILN of the recipient (mandatory for Metro shipping)
 +
|-
 +
| KOSTENSTELLE || [[#Data types|String]] || 30 || - || -
 +
|-
 +
| LIEFERANTENID || [[#Data types|Integer]] || - || - || -
 +
|-
 +
| NACHNAHME || [[#Data types|Decimal]] || 18 || 2 || -
 +
|-
 +
| NNVERMERK || [[#Data types|String]] || 1 || - || 'B': Cash / 'V': Crossed cheque
 +
|-
 +
| NNVERWENDUNG || [[#Data types|String]] || 30 || - || Cash on delivery - Intended use
 +
|-
 +
| NNWAEHRUNG || [[#Data types|String]] || 3 || - || Cash on delivery - ISO currency code
 +
|-
 +
| PACKSTUECKBREITE || [[#Data types|Integer]] || - || - || Width in cm
 +
|-
 +
| PACKSTUECKHOEHE || [[#Data types|Integer]] || - || - || Height in cm
 +
|-
 +
| PACKSTUECKLAENGE || [[#Data types|Integer]] || - || - || Length in cm
 +
|-
 +
| RECHNUNGSEMPFLKZ || [[#Data types|String]] || 5 || - || Invoice address
 +
|-
 +
| RECHNUNGSEMPFNAME1 || [[#Data types|String]] || 50 || - || Invoice recipient
 +
|-
 +
| RECHNUNGSEMPFNAME2 || [[#Data types|String]] || 50 || - || Invoice recipient
 +
|-
 +
| RECHNUNGSEMPFNAME3 || [[#Data types|String]] || 50 || - || Invoice recipient
 +
|-
 +
| RECHNUNGSEMPFORT || [[#Data types|String]] || 50 || - || Invoice address
 +
|-
 +
| RECHNUNGSEMPFPLZ || [[#Data types|String]] || 10 || - || Invoice address
 +
|-
 +
| RECHNUNGSEMPFSTRASSE || [[#Data types|String]] || 50 || - || Invoice address
 +
|-
 +
| RECHNUNGSNR || [[#Data types|String]] || 20 || - || Invoice number
 +
|-
 +
| SENDUNGSINHALT || [[#Data types|String]] || 30 || - || -
 +
|-
 +
| TELEFONNR || [[#Data types|String]] || 20 || - || Recipient's telephone number
 +
|-
 +
| VORPACKDATUM || [[#Data types|String]] || 10 || - || DD.MM.YYYY
 +
|-
 +
| VERSICHERUNGSWERT || [[#Data types|Decimal]] || 18 || 2 || Amount of insured value
 +
|-
 +
| VWWAEHRUNG || [[#Data types|String]] || 3 || - || Insured value - ISO currency code
 +
|-
 +
| WECHSELBRUECKE || [[#Data types|String]] || 20 || - || Swap body assigned to this package
 +
|-
 +
| WARENWERT || [[#Data types|Decimal]] || 18 || 2 || Value of goods
 +
|-
 +
| WWWAEHRUNG || [[#Data types|String]] || 3 || - || Value of goods - ISO currency code
 +
|}
 +
 +
<br><big>'''Return parameters'''</big><br>
 +
{| class="wikitable sortable"
 +
|-
 +
! Field name !! Type !! Max Length !! Decimal places !! Assignment
 +
|-
 +
| FEHLER || [[#Data types|Integer]] || - || - || 0 = Successful, 1 = Error
 +
|-
 +
| FEHLERTEXT1 || [[#Data types|String]] || 200 || - || Is filled in the event of an error
 +
|-
 +
| FEHLERTEXT2 || [[#Data types|String]] || 200 || - || Is filled in the event of an error
 +
|}
 +
<!-- ------------------------------------------------------------------------------- ENDE UpdateVersandDaten ------------------------------------------------------------------------------- -->
 +
 +
<!-- ------------------------------------------------------------------------------- AnonymisiereVersandDaten ------------------------------------------------------------------------------- -->
 +
= Anonymise package data (AnonymisiereVersandDaten) =
 +
The gateway sends the AnonymisiereVersandDaten request to the automatic polling of the HVS32. In the HVS32, customer-related data is thus anonymised for the corresponding data record in accordance with the DSGVO.
 +
This anonymisation is irrevocably and finally carried out at the database level of the dispatch system. A recovery of the original data is therefore no longer possible.
 +
Log files, confirmation files, already transmitted carrier data transmission etc. are not affected by this. Only packages and consignments that have already been completed for the day can be anonymised.
 +
<br><br><big>'''Parameters'''</big><br>
 +
<small>'''Bold''' fields must ALWAYS be filled</small>
 +
{| class="wikitable sortable"
 +
|-
 +
! Field name !! Type !! Max Length !! Decimal places !! Assignment
 +
|-
 +
| PACKSTUECKID || [[#Data types|String]] || 20 || - || Package ID of the package to be anonymised.
 +
|-
 +
| TRACKINGNR || [[#Data types|String]] || 35 || - || Tracking number of the package to be anonymised.
 +
|-
 +
| LIEFERSCHEINNR || [[#Data types|String]] || 40 || - || Delivery note number of the consignment to be anonymised.
 +
|-
 +
| AUFTRAGSNR || [[#Data types|String]] || 50 || - || Order number of the item to be anonymised.
 +
|-
 +
| PACKPLATZ || [[#Data types|String]] || 10 || - || HVS32 Packing Station that is to process the anonymisation.
 +
|}
 +
<br><big>'''Return parameters'''</big><br>
 +
{| class="wikitable sortable"
 +
|-
 +
! Field name !! Type !! Max Length !! Decimal places !! Assignment
 +
|-
 +
| FEHLER || [[#Data types|Integer]] || - || - || 0 = Successful, 1 = Error
 +
|-
 +
| FEHLERTEXT1 || [[#Data types|String]] || 200 || - || Is filled in the event of an error
 +
|-
 +
| FEHLERTEXT2 || [[#Data types|String]] || 200 || - || Is filled in the event of an error
 +
|}
 +
<!-- ------------------------------------------------------------------------------- ENDE AnonymisiereVersandDaten ------------------------------------------------------------------------------- -->

Latest revision as of 11:30, 18 May 2022

Data types

Integer - Number with only numeric characters (0-9).
Decimal - Number with decimal places
String - Any character from the ISO-8859-1 character set. Maximum length not to be exceeded.

Additional data types

Additional data types, which occur in the description, are in a 1:n relation to the packages. Please refer to the respective interface documentation of the corresponding plug-in (file, JDBC, SAP, etc.) to find out how this relation must be realised.

Article data

Field name Type Max Length Decimal places Assignment
Satz-Kennung String 3 - Only required for file processing

"Satzkennung" in the polling file: "ART"

--- ARTICLE DATA SECTION ---
ANZAHLBUEGEL Integer - - Only for hanging shipment: Number of hangers on which the article group is divided up
ANZAHLPOSETIKETTEN Integer - - Number of article labels to be printed
ARTIKELBTNNR String 25 - BTN number / customs tariff number
ARTIKELEAN String 20 - EAN number
ARTIKELEINHEIT String 10 - Unit of the article quantity
ARTIKELGEWICHT Decimal 9 3 Article weight
ARTIKELGRUPPE String 50 - Article group
ARTIKELMENGE Decimal 9 3 Article quantity
ARTIKELSERVICES String 100 - Pipe separate services for this article
ARTIKELSOLLMENGE Decimal 9 3 Article target quantity
ARTIKELTEXT1 String 100 - Article description
ARTIKELTEXT2 String 100 - Article description
ARTIKELTEXT3 String 100 - Article description
ARTIKELTEXT4 String 100 - Article description
ARTIKELVOLUMEN Decimal 9 3 Article volume
ARTIKELWAEHRUNG String 3 - Currency in which the value of the article is indicated
ARTIKELWERT Decimal 18 2 Value of the article
CHARGEFLAG String 1 -
KUNDENARTIKELNR String 50 - Article number
KUNDENBESTELLNR String 50 - Purchase 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

Dangerous goods

Field name Type Max Length Decimal places Assignment
Satz-Kennung String 3 - Only required for file processing

"Satzkennung" in the polling file: "GEF"

--- DANGEROUS GOODS DATA SECTION ---
GEFAHRGUTBEFOERDKAT Integer 1 - Transport category, mandatory (see ADR table column (15)), can be 0-4. Attention! Must be 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 110 - Mandatory (see ADR table column (2))
GEFAHRGUTBUCHST640 String 1 - Letter for special provision 640, conditionally mandatory for substances to which special provision 640 applies (see ADR table column (6)).
GEFAHRGUTFFCODE String
GEFAHRGUTFAKTOR Integer 3 - Assessment factor for point summation on the transport document, (can be 0, 1, 3, 50 or 999), technically mandatory, 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
GEFAHRGUTID String 20 - Unique search number for dangerous goods master data
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 according to ADR (in litres for liquids and compressed gases, otherwise in kg, for LQ dangerous goods always kg).
GEFAHRGUTMENGENEINHEIT String 2 - Unit of measurement for the substance quantity. 1' or 'l': litre ; '0' or 'kg' or empty: kg
GEFAHRGUTNEBENGEFAHR String 10 - Conditionally mandatory for substances where subsidiary risk label numbers exist 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
GEFAHRGUTPOSITIONNR Integer - -
GEFAHRGUTTECHBENENNUNG String 150 - Conditionally mandatory for N.A.G. dangerous goods (i.e. if the designation ends with N.A.G.)
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 substance is environmentally hazardous, otherwise F, mandatory for environmentally hazardous substances.
GEFAHRGUTVPG String 3 - Packing group, conditionally mandatory for those substances for which it is assigned in the ADR table, may be I,II or III or not assigned 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 GefahrgutVerpackungsart)
GEFAHRGUTVERPACKUNGSART String 5 - ADR code of the type of packaging, e.g. 4G for box (cardboard), mandatory, see separate documentation for packaging codes.

Package processing (VersandDatenAnfrage)

The gateway function VersandDatenAnfrage is sent from the data gateway server in automatic polling mode to the HVS32 in order to generate and post a label for a package. A label is identified for all further functions such as cancellation, loading release, etc. by means of the host-side package ID. This is transferred in the Package ID field and must therefore be unique within the shipping system.


By means of an additional configuration in the HVS32, the VersandDatenAnfrage can also be used to initiate a reprint. In this case, the same PackstueckID must be used for the new request.

Parameters
Bold fields must ALWAYS be filled

Field name Type Max Length Decimal places Assignment
ANSPRECHPARTNER String 50 - Recipient Contact person
ANZAHLARTIKEL Integer 6 - Number of articles (print on label)
ARTIKELDATEN Sequence <ArtikelDaten> - - A list of the package articles of the type ArtikelDaten (1:n)
AUFTRAGNR String 20 - -
AUFTRAGGEBERID String 10 - Mandantenkennung aus dem 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
BARCODEID String - - Additional field for possible extensions
BARCODETEXT String - - Additional field for possible extensions
BARCODETYP String - - Additional field for possible extensions
BESTELLNR String 20 - Metro order no. (Metro shipping)
DRUCKERNAME String 30 - Name of an output channel (printer) in the HVS32 via which the label is printed. (Requires printer spooler extension module)
EMAIL String 100 - E-mail address of the recipient (e.g.: for automatic e-mail notification)
EMPFMOBILFUNKNR String 20 - Mobile phone number of the recipient
FAXNR String 20 - Fax number of the recipient
FLEXZUSTELLUNGEMAILADRESSE String 80 - Flex delivery email address
FRACHTBRIEF String 20 - Consignment note number if the consignment note is to be printed by the pre-system
FRACHTFUEHRERKDNR String 10 - Customer number of the freight payer with the carrier
FRANKATURKENNUNG String 10 - -
GEFAHRGUT Sequence <Gefahrgut> - - A list of Dangerous goods of type Gefahrgut (1:n)
GEWICHT Decimal 8 3 Gross weight in KG
HOSTTRACKINGNR String 35 - Package number from the host system
ILNNR String 20 - ILN of the recipient (mandatory for Metro shipping)
KOSTENSTELLE String 30 - -
KUNDENNR String 20 - Customer number of the recipient with the sender
LAGERKENNZEICHEN Integer - - -
LETZTESPACKSTUECK String 1 - T/F: T=last packing piece of the consignment (required for printing the consignment hanging card in the case of hanging consignments).
LIEFERANTENID Integer - - -
LIEFERSCHEINNR String 40 - Used in the HVS32 as a search number
NACHNAHME Decimal 18 2 -
NETTOGEWICHT Decimal 8 3 Net weight in KG
NEUTBIC String 11 - Only used with neutral senders
NEUTBANKBEZEICHNUNG String 40 - Only used with neutral senders
NEUTIBAN String 31 - Only used with neutral senders
NEUTKONTOINHABER String 40 - Only used with neutral senders
NEUTABSENDERLKZ String 3 - Only used with neutral senders
NEUTABSENDERNAME1 String 50 - Only used with neutral senders
NEUTABSENDERNAME2 String 50 - Only used with neutral senders
NEUTABSENDERNAME3 String 50 - Only used with neutral senders
NEUTABSENDERORT String 50 - Only used with neutral senders
NEUTABSENDERPLZ String 10 - Only used with neutral senders
NEUTABSENDERSTRASSE String 50 - Only used with neutral senders
NNVERMERK String 1 - 'B': Cash / 'V': Crossed cheque
NNVERWENDUNG String 30 - Cash on delivery - Intended use
NNWAEHRUNG String 3 - Cash on delivery - ISO currency code
PACKSTKGES Integer - - Total number of colli of the consignment
PACKSTKNR Integer - - Sequence number per consignment
PACKPLATZ String 10 - HVS32 packing station that will process the job.
PACKSTUECKBREITE Integer - - Width in cm
PACKSTUECKHOEHE Integer - - Height in cm
PACKSTUECKID String 20 - Unique number for the parcel in the pre-system. Needed as a unique parcel reference to cancel or load the label later.
PACKSTUECKLAENGE Integer - - Length in cm
PAPERLESSINVOICE String 1 - Only in UPS PaperlessInvoice case (T=PaperlessInvoice / F=not PaperlessInvoice)
POSTLEITCODE String 15 - -
POSTZIELFRACHTZENT String 5 - -
RECHNUNGSEMPFLKZ String 5 - Invoice address
RECHNUNGSEMPFNAME1 String 50 - Invoice recipient
RECHNUNGSEMPFNAME2 String 50 - Invoice recipient
RECHNUNGSEMPFNAME3 String 50 - Invoice recipient
RECHNUNGSEMPFORT String 50 - Invoice address
RECHNUNGSEMPFPLZ String 10 - Invoice address
RECHNUNGSEMPFSTRASSE String 50 - Invoice address
RECHNUNGSNR String 20 - Invoice number
SENDUNGSINHALT String 30 - -
SONDERDIENSTE String 30 - SPECIAL SERVICES - depending on the shipping method used
SPERRFLAG String 1 - T/F: T=lock, otherwise do not lock
TELEFONNR String 20 - Recipient's phone number
TERMINART String 1 - 'A' = deliver from this day on

'B' = deliver until this day

'F' = deliver on this day

TERMINDATUM String 10 - DD.MM.YYYY
TERMINZEIT Calendar 5 - HH:MM
USTIDNR String 20 - VAT number of the recipient
VERPACKUNGSART String 6 - -
VERSANDARTID String 10 - Dispatch type identifier from the HVS32
VERSICHERUNGSWERT Decimal 18 2 Amount of insured value
VORPACKDATUM String 10 - DD.MM.YYYY
VWWAEHRUNG String 3 - Insured value - ISO currency code
WARENWERT Decimal 18 2 Value of goods
WECHSELBRUECKE String 20 - Swap body assigned to this package
WWWAEHRUNG String 3 - Value of goods - ISO currency code
ZAHLUNGSBEDINGUNG String 10 - 'S' = sender, 'R' = receiver
ZBZOLL String 1 - Payment condition for customs taxes 'S' = Sender, 'R' = Receiver
ZIELADRBAHNHOF String 30 - Postcode and city
ZIELADRLKZ String 5 - Delivery address
ZIELADRNAME1 String 50 - Delivery address
ZIELADRNAME2 String 50 - Delivery address
ZIELADRNAME3 String 50 - Delivery address
ZIELADRNAME4 String 50 - Delivery address
ZIELADRORT String 50 - Delivery address
ZIELADRPLZ String 10 - Delivery address
ZIELADRREGION String 20 - State/province (e.g.: important for shipments to the USA)
ZIELADRSTRASSE String 50 - Delivery address


Return parameters

Field name Type Max Length Decimal places
AUSGANGDATETIME String 10 - Date when the label was transmitted to the carrier (DD.MM.YYYY)
DRUCKDATETIME String 19 - Date when the label was printed in the HVS32 (DD.MM.YYYY HH:mm:SS)
FEHLER Integer - - 0 if successful
FEHLERTEXT1 String 200 - Is filled in the event of an error
FEHLERTEXT2 String 200 - Is filled in the event of an error
GEBUEHR Decimal 18 2 Freight costs
GEBUEHRWAEHRUNG String 3 - Freight costs - ISO currency code
PACKSTUECKID String 20 - PackstueckID from the request
RETOURTRACKINGNR String 50 - Package number for the return
TRACKINGNR String 35 - Package number
TRACKINGURL String 255 - URL of the tracking link
VERSANDSENDUNGSNR String - - -

Reprint label (VersandDatenWdhDruck)

The gateway function VersandDatenWdhDruck is sent from the data gateway server in automatic polling mode to the HVS32 to reprint a label for a package. A label is reprinted using the host-side package ID. This is transferred in the PackstueckID field. Some carriers (e.g. DPD) assign new tracking numbers when reprinting. This means that the old tracking number is no longer valid and the old shipping label must be destroyed. The new tracking number can be reported back in the response.

Parameters
Bold fields must ALWAYS be filled

Field name Type Max Length Decimal places Assignment
PACKSTUECKID String 20 - Unique number for the parcel in the pre-system.
PACKPLATZ String 10 - HVS32 packing station that will process the job.
DRUCKERNAME String 30 - Name of an output channel (printer) in the HVS32 via which the label is printed. (Requires printer spooler extension module)


Return parameters

Feldname Typ Max Länge Dezimalstellen Belegung
FEHLER Integer - - 0 = Successful, 1 = Error
FEHLERTEXT1 String 200 - Is filled in the event of an error
FEHLERTEXT2 String 200 - Is filled in the event of an error
TRACKINGNR String 35 - (New) tracking number of the package

Cancel package (StornoVersandDaten)

The gateway function StornoVersandDaten is sent from the data gateway server (DGS) in automatic polling mode to the HVS32 to cancel existing packages there that are not yet on an outgoing list. As a rule, a package is cancelled on the basis of the package ID on the host side. This is transferred in the PackstueckID field. In addition to the host-side package ID, the tracking number can also contribute to the identification of the package, in case the host-side package ID cannot guarantee uniqueness. No package/shipment data is available for the feedback. After a successful cancellation, only the field Error with value 0 is reported back - or in case of an error, Error with value 1 and the error Fehlertext1 are reported back.

Parameters
Bold fields must ALWAYS be filled

Field name Type Max Length Decimal places Assignment
PACKSTUECKID String 20 - Unique number for the parcel in the pre-system.
PACKPLATZ String 10 - HVS32 packing station that will process the job.


Return parameters

Field name Type Max Length Decimal places Assignment
FEHLER Integer - - 0 = Successful, 1 = Error
FEHLERTEXT1 String 200 - Is filled in the event of an error
FEHLERTEXT2 String 200 - Is filled in the event of an error

Load/release package (VerladeVersandDaten)

The gateway function VerladeVersandDaten is sent from the data gateway server in automatic polling mode to the HVS32 in order to release packages for outgoing. Only packages that have been released for exit are taken into account for the daily closing. No package/shipment data is available for the feedback. After successful release, only the field Fehler with value 0 is reported back - or in case of an error, Fehler with value 1 and the error Fehlertext1 are reported back.

Parameters
Bold fields must ALWAYS be filled

Field name Type Max Length Decimal places Assignment
PACKSTUECKID String 20 - Unique number for the parcel in the pre-system.
PACKPLATZ String 10 - HVS32 packing station that will process the job.
SPERRKENNZEICHEN String 1 - "J" if the package is to be blocked
WECHSELBRUECKE String 20 - Swap body on which the package is to be booked
SAMMELFREIGABE String 1 - "T" for a collective release (release all packages with identical VE-ReferenzNr)
VEREFERENZNR String 20 - must be filled for a collective release


Return parameters

Field name Type Max Length Decimal places Assignment
FEHLER Integer - - 0 = Successful, 1 = Error
FEHLERTEXT1 String 200 - Is filled in the event of an error
FEHLERTEXT2 String 200 - Is filled in the event of an error

Daily closing (Tagesabschluss)

The gateway sends the daily closing request to the automatic polling of the HVS32. A daily closing is thus triggered in the HVS32 on the basis of the additionally transferred parameters. The daily closing consists of the points generate outgoing list and Generate EDI file. Only packages that have been released for exit are taken into account for the daily closing. By default, all packages are released unless they have been blocked by the output scanning extension module. The feedback in the HVS32 takes place after the daily closing has been executed. No package/shipment data is available for the feedback. After successful day-end closing, only the field Fehler is reported with the value 0 - or in the case of an error, Fehler is reported with the value 1 and the Fehlertext1 .

Parameters
Bold fields must ALWAYS be filled

Field name Type Max Length Decimal places Assignment
PACKPLATZ String 10 - HVS32 packing station client that is to execute the daily closing.
FRACHTFUEHRERTYPLIST String 250 - A semicolon separated list with the carriers to be concluded can be entered here. N carriers can be concluded.

(Option MultiFFTagesabschluss must be active in HVS32)

AUFTRAGGEBERIDLIST String 250 - A semicolon separated list with the clients to be completed can be entered here. N clients can be concluded.

(Option MultiAGTagesabschluss must be active in HVS32)

VERSANDARTIDLIST String 250 - A semicolon separated list with the dispatch types to be completed can be entered here. N shipping types can be completed.

(Option MultiVATagesabschluss must be active in HVS32)

WECHSELBRUECKE String 20 - Indicator of the swap body to be closed. Only certain consignments can be closed with this.
DRUCKERNAME String 30 - Name of the output channel on which the list is to be printed.


Return parameters

Field name Type Max Length Decimal places Assignment
FEHLER Integer - - 0 = Successful, 1 = Error
FEHLERTEXT1 String 200 - Is filled in the event of an error
FEHLERTEXT2 String 200 - Is filled in the event of an error

Generate output list (Listenabschluss)

The gateway sends the generate-output-list request to the automatic polling of the HVS32. An outgoing list is thus generated in the HVS32 on the basis of the additionally transferred parameters. Only packages that have been released for exit are taken into account for the list closure. By default, all packages are released unless they have been blocked by the output scanning extension module. The feedback in the HVS32 takes place after the output list has been generated. No package/shipment data is available for feedback. After successful completion of the list, only the field Error with value 0 is reported back - or in the case of an error, Error with value 1 and the error text1 are reported back.

Parameters
Bold fields must ALWAYS be filled

Field name Type Max Length Decimal places Assignment
PACKPLATZ String 10 - HVS32 packing station client that is to execute the daily closing.
FRACHTFUEHRERTYPLIST String 250 - A semicolon separated list with the carriers to be concluded can be entered here. N carriers can be concluded.

(Option MultiFFTagesabschluss must be active in HVS32)

AUFTRAGGEBERIDLIST String 250 - A semicolon separated list with the clients to be completed can be entered here. N clients can be concluded.

(Option MultiAGTagesabschluss must be active in HVS32)

VERSANDARTIDLIST String 250 - A semicolon separated list with the dispatch types to be completed can be entered here. N shipping types can be completed.

(Option MultiVATagesabschluss must be active in HVS32)

WECHSELBRUECKE String 20 - Indicator of the swap body to be closed. Only certain consignments can be closed with this.
DRUCKERNAME String 30 - Name of the output channel on which the list is to be printed.


Return parameters

Field name Type Max Length Decimal places Assignment
FEHLER Integer - - 0 = Successful, 1 = Error
FEHLERTEXT1 String 200 - Is filled in the event of an error
FEHLERTEXT2 String 200 - Is filled in the event of an error

Create carrier EDI (EDIAbschluss)

The gateway sends the create-carrier-EDI request to the automatic polling of the HVS32. A carrier EDI is thus generated in the HVS32 on the basis of the additionally transferred parameters and (if configured) transmitted to the carrier. Only packages for which an outgoing list was previously generated are taken into account for a carrier EDI. The confirmation in the HVS32 takes place after the carrier EDI has been generated. No package/shipment data is available for the confirmation. After successful completion of the EDI, only the field Error with value 0 is reported - or in case of an error, Error with value 1 and the error text1 are reported.

Parameters
Bold fields must ALWAYS be filled

Field name Type Max Length Decimal places Assignment
PACKPLATZ String 10 - HVS32 packing station client that is to execute the daily closing.
FRACHTFUEHRERTYPLIST String 250 - A semicolon separated list with the carriers to be concluded can be entered here. N carriers can be concluded.

(Option MultiFFTagesabschluss must be active in HVS32)

AUFTRAGGEBERIDLIST String 250 - A semicolon separated list with the clients to be completed can be entered here. N clients can be concluded.

(Option MultiAGTagesabschluss must be active in HVS32)

VERSANDARTIDLIST String 250 - A semicolon separated list with the dispatch types to be completed can be entered here. N shipping types can be completed.

(Option MultiVATagesabschluss must be active in HVS32)

WECHSELBRUECKE String 20 - Indicator of the swap body to be closed. Only certain consignments can be closed with this.


Return parameters

Field name Type Max Length Decimal places Assignment
FEHLER Integer - - 0 = Successful, 1 = Error
FEHLERTEXT1 String 200 - Is filled in the event of an error
FEHLERTEXT2 String 200 - Is filled in the event of an error

Verify package data (VersandDatenPruefAnfrage)

The gateway sends the VersandDatenPruefAnfrage to the automatic polling of the HVS32. A shipping data request is thus simulated in the HVS32. No labels are printed and the package or label is not booked, but all other processes are identical to the shipping data request (route determination, tracking number determination, address check, etc.). This function is used to validate all shipping data in advance.

Parameters
Bold fields must ALWAYS be filled

Field name Type Max Length Decimal places Assignment
ANSPRECHPARTNER String 50 - Recipient Contact person
ANZAHLARTIKEL Integer 6 - Number of articles (print on label)
ARTIKELDATEN Sequence <ArtikelDaten> - - Eine Liste der Package article vom Typ ArtikelDaten (1:n)
AUFTRAGNR String 20 - -
AUFTRAGGEBERID String 10 - Client identifier from 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
BARCODEID String - - Additional field for possible extensions
BARCODETEXT String - - Additional field for possible extensions
BARCODETYP String - - Additional field for possible extensions
BESTELLNR String 20 - Metro order number (Metro shipping)
DRUCKERNAME String 30 - Name of an output channel (printer) in the HVS32 via which the label is printed. (Requires printer spooler extension module)
EMAIL String 100 - Recipient's e-mail address (e.g.: for automatic e-mail notification)
EMPFMOBILFUNKNR String 20 - Mobile phone number of the recipient
FAXNR String 20 - Fax number of the recipient
FLEXZUSTELLUNGEMAILADRESSE String 80 - Flex delivery email address
FRACHTBRIEF String 20 - Consignment note number if consignment note is to be printed by pre-system
FRACHTFUEHRERKDNR String 10 - Customer number of the freight payer with the carrier
FRANKATURKENNUNG String 10 - -
GEFAHRGUT Sequence <Gefahrgut> - - A list of Dangerous goods of type Gefahrgut (1:n)
GEWICHT Decimal 8 3 Gross weight in KG
HOSTTRACKINGNR String 35 - Package number from the host system
ILNNR String 20 - ILN of the recipient (mandatory for Metro shipping)
KOSTENSTELLE String 30 - -
KUNDENNR String 20 - Customer number of the recipient with the sender
LAGERKENNZEICHEN Integer - - -
LETZTESPACKSTUECK String 1 - T/F: T=last package of the consignment (required for printing the consignment hanging card for hanging consignments)
LIEFERANTENID Integer - - -
LIEFERSCHEINNR String 40 - Used in the HVS32 as a search number
NACHNAHME Decimal 18 2 -
NETTOGEWICHT Decimal 8 3 Net weight in KG
NEUTBIC String 11 - Only used with neutral senders
NEUTBANKBEZEICHNUNG String 40 - Only used with neutral senders
NEUTIBAN String 31 - Only used with neutral senders
NEUTKONTOINHABER String 40 - Only used with neutral senders
NEUTABSENDERLKZ String 3 - Only used with neutral senders
NEUTABSENDERNAME1 String 50 - Only used with neutral senders
NEUTABSENDERNAME2 String 50 - Only used with neutral senders
NEUTABSENDERNAME3 String 50 - Only used with neutral senders
NEUTABSENDERORT String 50 - Only used with neutral senders
NEUTABSENDERPLZ String 10 - Only used with neutral senders
NEUTABSENDERSTRASSE String 50 - Only used with neutral senders
NNVERMERK String 1 - 'B': Cash / 'V': Crossed cheque
NNVERWENDUNG String 30 - Cash on delivery - Intended use
NNWAEHRUNG String 3 - Cash on delivery - ISO currency code
PACKSTKGES Integer - - Total number of colli of the consignment
PACKSTKNR Integer - - Sequence number per consignment
PACKPLATZ String 10 - HVS32 packing station that will process the job.
PACKSTUECKBREITE Integer - - Width in cm
PACKSTUECKHOEHE Integer - - Height in cm
PACKSTUECKID String 20 - Unique number for the parcel in the pre-system. Needed as a unique parcel reference to cancel or load the label later.
PACKSTUECKLAENGE Integer - - Length in cm
PAPERLESSINVOICE String 1 - Only in UPS PaperlessInvoice case (T=PaperlessInvoice / F=not PaperlessInvoice)
POSTLEITCODE String 15 - -
POSTZIELFRACHTZENT String 5 - -
RECHNUNGSEMPFLKZ String 5 - Invoice address
RECHNUNGSEMPFNAME1 String 50 - Invoice recipient
RECHNUNGSEMPFNAME2 String 50 - Invoice recipient
RECHNUNGSEMPFNAME3 String 50 - Invoice recipient
RECHNUNGSEMPFORT String 50 - Invoice address
RECHNUNGSEMPFPLZ String 10 - Invoice address
RECHNUNGSEMPFSTRASSE String 50 - Invoice address
RECHNUNGSNR String 20 - Invoice number
SENDUNGSINHALT String 30 - -
SONDERDIENSTE String 30 - SPECIAL SERVICES - depending on the shipping method used
SPERRFLAG String 1 - T/F: T=lock, otherwise do not lock
TELEFONNR String 20 - Recipient's phone number
TERMINART String 1 - 'A' = deliver from this day on

'B' = deliver until this day

'F' = deliver on this day

TERMINDATUM String 10 - DD.MM.YYYY
TERMINZEIT Calendar 5 - HH:MM
USTIDNR String 20 - VAT number of the recipient
VERPACKUNGSART String 6 - -
VERSANDARTID String 10 - Dispatch type identifier from the HVS32
VERSICHERUNGSWERT Decimal 18 2 Amount of insured value
VORPACKDATUM String 10 - DD.MM.YYYY
VWWAEHRUNG String 3 - Insured value - ISO currency code
WARENWERT Decimal 18 2 Value of goods
WECHSELBRUECKE String 20 - Swap body assigned to this package
WWWAEHRUNG String 3 - Value of goods - ISO currency code
ZAHLUNGSBEDINGUNG String 10 - 'S' = sender, 'R' = receiver
ZBZOLL String 1 - Payment condition for customs taxes 'S' = Sender, 'R' = Receiver
ZIELADRBAHNHOF String 30 - Postcode and city
ZIELADRLKZ String 5 - Delivery address
ZIELADRNAME1 String 50 - Delivery address
ZIELADRNAME2 String 50 - Delivery address
ZIELADRNAME3 String 50 - Delivery address
ZIELADRNAME4 String 50 - Delivery address
ZIELADRORT String 50 - Delivery address
ZIELADRPLZ String 10 - Delivery address
ZIELADRREGION String 20 - State/province (e.g.: important for shipments to the USA)
ZIELADRSTRASSE String 50 - Delivery address


Return parameters

Field name Type Max Length Decimal places
FEHLER Integer - - 0 if successful
FEHLERTEXT1 String 200 - Is filled in the event of an error
FEHLERTEXT2 String 200 - Is filled in the event of an error
GEBUEHR Decimal 18 2 Freight costs
GEBUEHRWAEHRUNG String 3 - Freight costs ISO currency code
PACKSTUECKID String 20 - PackstueckID from the request

Update package data (UpdateVersandDaten)

The gateway function UpdateVersandDaten is sent from the data gateway server in automatic polling mode to the HVS32 in order to change the data of existing packages. This request is sent, for example, if the value of goods for a package is only known at a later time. Data can be updated within the tables Versandeinheit, Abrechnungseinheit and Lieferung. The search is always carried out via the field PackstueckID and, if occupied, also via the field TrackingNr. However, the fields and contents to be updated are no longer checked according to the carrier's guidelines (e.g. weight limits, etc.). The pre-system must therefore ensure that the values to be updated comply with the carrier's guidelines. If this is not possible, this function cannot be used and the label must be cancelled and processed again. In addition, fields that have already been printed on a label or determined by the HVS32 shipping system in a carrier processing (e.g. address, route, tracking number, special services, etc.) cannot be manipulated. No package/shipment data is available for the confirmation. After a successful update, only the field Error with value 0 is reported back - or in case of an error, Error with value 1 and the error text1 are reported back.

Parameters
Bold fields must ALWAYS be filled

Field name Type Max Length Decimal places Assignment
PACKSTUECKID String 20 - Unique number for the package in the pre-system. Required as a unique package reference to identify the record.
PACKPLATZ String 10 - HVS32 packing station that will process the job.
ANSPRECHPARTNER String 50 - Recipient Contact person
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 number (Metro shipping)
EMAIL String 100 - Recipient's e-mail address (e.g.: for automatic e-mail notification)
EMPFMOBILFUNKNR String 20 - Mobile phone number of the recipient
FAXNR String 20 - Fax number of the recipient
FLEXZUSTELLUNGEMAILADRESSE String 80 - Flex delivery email address
GEWICHT Decimal 8 3 Gross weight in KG
NETTOGEWICHT Decimal 8 3 Net weight in KG
ILNNR String 20 - ILN of the recipient (mandatory for Metro shipping)
KOSTENSTELLE String 30 - -
LIEFERANTENID Integer - - -
NACHNAHME Decimal 18 2 -
NNVERMERK String 1 - 'B': Cash / 'V': Crossed cheque
NNVERWENDUNG String 30 - Cash on delivery - Intended use
NNWAEHRUNG String 3 - Cash on delivery - ISO currency code
PACKSTUECKBREITE Integer - - Width in cm
PACKSTUECKHOEHE Integer - - Height in cm
PACKSTUECKLAENGE Integer - - Length in cm
RECHNUNGSEMPFLKZ String 5 - Invoice address
RECHNUNGSEMPFNAME1 String 50 - Invoice recipient
RECHNUNGSEMPFNAME2 String 50 - Invoice recipient
RECHNUNGSEMPFNAME3 String 50 - Invoice recipient
RECHNUNGSEMPFORT String 50 - Invoice address
RECHNUNGSEMPFPLZ String 10 - Invoice address
RECHNUNGSEMPFSTRASSE String 50 - Invoice address
RECHNUNGSNR String 20 - Invoice number
SENDUNGSINHALT String 30 - -
TELEFONNR String 20 - Recipient's telephone number
VORPACKDATUM String 10 - DD.MM.YYYY
VERSICHERUNGSWERT Decimal 18 2 Amount of insured value
VWWAEHRUNG String 3 - Insured value - ISO currency code
WECHSELBRUECKE String 20 - Swap body assigned to this package
WARENWERT Decimal 18 2 Value of goods
WWWAEHRUNG String 3 - Value of goods - ISO currency code


Return parameters

Field name Type Max Length Decimal places Assignment
FEHLER Integer - - 0 = Successful, 1 = Error
FEHLERTEXT1 String 200 - Is filled in the event of an error
FEHLERTEXT2 String 200 - Is filled in the event of an error

Anonymise package data (AnonymisiereVersandDaten)

The gateway sends the AnonymisiereVersandDaten request to the automatic polling of the HVS32. In the HVS32, customer-related data is thus anonymised for the corresponding data record in accordance with the DSGVO. This anonymisation is irrevocably and finally carried out at the database level of the dispatch system. A recovery of the original data is therefore no longer possible. Log files, confirmation files, already transmitted carrier data transmission etc. are not affected by this. Only packages and consignments that have already been completed for the day can be anonymised.

Parameters
Bold fields must ALWAYS be filled

Field name Type Max Length Decimal places Assignment
PACKSTUECKID String 20 - Package ID of the package to be anonymised.
TRACKINGNR String 35 - Tracking number of the package to be anonymised.
LIEFERSCHEINNR String 40 - Delivery note number of the consignment to be anonymised.
AUFTRAGSNR String 50 - Order number of the item to be anonymised.
PACKPLATZ String 10 - HVS32 Packing Station that is to process the anonymisation.


Return parameters

Field name Type Max Length Decimal places Assignment
FEHLER Integer - - 0 = Successful, 1 = Error
FEHLERTEXT1 String 200 - Is filled in the event of an error
FEHLERTEXT2 String 200 - Is filled in the event of an error