HVS32 REST Interface (Polling)

Prerequisite

DGS-Version	3.6.0.595 or higher
DGS-Plugins	HVS32Client, REST Server

Function description

For the REST interface, the DataGatewayServer (DGS) provides a REST server with the following Funktionen. This is accessible in the default configuration at http://<server name>:<port>/hvs32rest. Port 8081 is used, which can be changed if necessary.

Data types

Integer - Number with numeric characters only (0-9).
Decimal - Number with decimal places
Calendar - Date. Month is 0-based (0 = January, 11 = December)
String - Any character from the ISO-8859-1 character set. Maximum length must not be exceeded.
Binary - Base64 encoded binary data
Sequence - A list of elements
Map - Key/Value Map

Additional data types

A special data type can be used within the request/feedback of a Funktion.

articleData

article-data

Field name	Type	Max length	Decimal places	Assignment
anzahlBuegel	Integer	-	-	Only for hanging shipment: number of hangers on which the article group is split up
anzahlPosEtiketten	Integer	-	-	number of article labels which should be printed
artikelBTNNr	String	25	-	BTN number / customs tariff number
artikelEAN	String	20	-	EAN number
artikelEinheit	String	10	-	Unit of article quantity
artikelGewicht	Decimal	9	3	Weight of the article
artikelGruppe	String	50	-	articlegroup
artikelMenge	Decimal	9	3	quantity of the article
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	volume of the article
artikelWaehrung	String	3	-	Currency in which the value of the article is specified
artikelWert	Decimal	18	2	value of the article
chargeFlag	String	1	-
kundenArtikelNr	String	50	-	article number
kundenBestellNr	String	50	-	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 item

dangerous goods

Dangerous materials data

Field name	Type	Max length	Decimal places	Assignment
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, conditional obligation for substances where special provision 640 applies (see ADR table column (6))
gefahrgutFFCode	String
gefahrgutFaktor	Integer	3	-	Evaluation factor for point summation on the transport document, (can be 0, 1, 3, 50 or 999), actually mandatory, but can be clearly concluded from the transport category, therefore it does not necessarily have to be assigned
gefahrgutFreigestMenge	String	1	-	T if the substance is shipped with status EQ / Excepted Quantities according to ADR 3.5, otherwise F, mandatory
gefahrgutID	String	8	-	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 ADR-technically ( in liters for liquids and compressed gases, otherwise in kg, for LQ dangerous goods always kg )
gefahrgutMengenEinheit	String	2	-	Unit of quantity for substance quantity. '1' or 'l': liter ; '0' or 'kg' or empty: kg
gefahrgutNebenGefahr	String	10	-	conditional obligation for substances where subsidiary hazard tick numbers exist in addition to the main hazard class/tick number (see ADR table column (5), if e.g. 3+6.1+8 is entered there, 6.1 and 8 are the subsidiary hazard tick numbers and to be transmitted as (6.1)(8) in the subsidiary hazard field )
gefahrgutNettoExplMasse	Decimal	8	3	Net explosive mass in kg, only for dangerous goods of class 1
gefahrgutPositionNr	Integer	-	-	Net explosive mass in kg, only for class 1 dangerous goods
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 obligatory for substances for which this is assigned in the ADR table, can 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 Dangerous goods packaging type)
gefahrgutVerpackungsart	String	5	-	ADR code of packing type, e.g. 4G for box (cardboard), mandatory, see separate doc f. Packaging codes

edistatus

EDIStatus

Field name	Type	Max length	Decimal places	Assignment
fehlercode	Integer	-	-	0 = Successful
statuscode	String	2	-	01 = Carrier file was created. 02 = Carrier file was written. 03 = Carrier file was sent. 11 = Carrier file could not be created. 12 = Carrier file could not be written! 13 = Carrier file could not be sent! It is to be noted that not every carrier file is sent, this depends on the HVS32 configuration. I.e. as long as no status "1x" is contained, was proceeded with the carrier file according to the HVS32 configuration.
statustext	String	200	-	Plain text of the status code
fftyp	String	50	-	Carrier type (e.g. UPS, GLS, DPD)
dateityp	String	50	-	Carrier Datatype (e.g.: Standard, Express, etc.)
auftraggeber	String	10	-	Client number (ATTENTION! Not the ClientID)
ffdateinr	String	10	-	number of the carrier file (may not be filled in case of error)

packstueckDaten

Package Data

Field name	Type	Max Length	decimals	occupancy
anzahlArtikel	Integer	6	-	Number of items (print on label)
artikelDaten	Sequence <ArtikelDaten>	-	-	A list of the Packstück-Artikel of type ArtikelDaten (1:n)
assoc	Map (String, String)	-	-	Additional field for extra extensions (Key=Fieldname / Value=Value)
barcodeID	String	-	-	Additional field for extra extensions
barcodeText	String	-	-	Additional field for extra extensions
barcodeTyp	String	-	-	Additional field for extra extensions
druckername	String	30	-	Name of an output channel (printer) in the HVS32 via which the label is printed. (Requires printer spooler extension module)
gefahrgut	Sequence <Gefahrgut>	-	-	A list of Gefahrgüter of type Gefahrgut (1:n)
gewicht	Decimal	8	3	Gross Mass in kg
hostTrackingNr	String	35	-	If the package number from the previous system is to be used.
infotext1	String	150	-	Additional field for extra extensions
infotext2	String	150	-	Additional field for extra extensions
infotext3	String	150	-	Additional field for extra extensions
infotext4	String	150	-	Additional field for extra extensions
infotext5	String	150	-	Additional field for extra extensions
infotext6	String	150	-	Additional field for extra extensions
infotext7	String	150	-	Additional field for extra extensions
infotext8	String	150	-	Additional field for extra extensions
infotext9	String	150	-	Additional field for extra extensions
infotext10	String	150	-	Additional field for extra extensions
letztesPackstueck	String	1	-	T/F: T=last package in the shipment (is required for hanging shipments to print the shipment hanging card )
cash on delivery	String	3	-	Value of goods - ISO currency code
Net weight	Decimal	8	3	Net weight in KG
nnVermerk	String	3	-	cash on delivery - ISO currency code
nnVerwendung	String	1	-	'B' = Bar, 'V' = personal cheque
nnWaehrung	String	3	-	cash on delivery - ISO currency code
packStkNr	Integer	-	-	Consecutive number per shipment
packstueckBreite	Integer	-	-	Width in cm
packstueckHoehe	Integer	-	-	Height in cm
packstueckID	String	20	-	Unique Number for the package in the source system. Is required as a unique package reference to later cancel or load the label.
packstueckLaenge	Integer	-	-	Length in cm
verpackungsart	String	6	-	-
insurance value	Decimal	18	2	amount-insured value
vwWaehrung	String	3	-	insurance value - ISO currency code
Value of goods	Decimal	18	2	-
wwWaehrung	String	3	-	Value of goods - ISO currency code

Overview of the functions

test interface (echo)

For testing the REST interface. Returns the passed message unchanged.

Function (method: GET): /hvs32rest/echo/<Message>

<Message> will be returned.

package processing (versanddatenAnfrage)

The gateway function versanddatenAnfrage is sent from the data gateway server to the HVS32 in automatic polling mode in order to generate and book a label for a package there. A label is identified for all other functions such as cancellation, loading release, etc. using the package ID on the host side. This is transferred in the PackstueckID field and must therefore be unique within the shipping system.

Function (method: POST)	/hvs32rest/versanddatenAnfrage
MediaType	text/plain
Charset	UTF-8

request parameters

Bold highlighted fields need to be filled at all times!

Field name	Type	Max Length	Decimals	Occupancy
absenderAdresseID	String	10	-	-
ansprechpartner	String	20	-	Recipient contact person
anzahlArtikel	Integer	6	-	Number of articles (print on label)
artikelDaten	Sequence <ArtikelDaten>	-	-	A list of Packstück-Artikel of type ArtikelDaten (1:n)
assoc	Map (String, String)	-	-	Additional field for extra extensions (Key=Field name / Value=Wert)
auftragNr	String	20	-	-
auftraggeberID	String	10	-	Client ID 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
barcodeID	String	-	-	Additional field for extra extensions
barcodeText	String	-	-	Additional field for extra extensions
barcodeTyp	String	-	-	Additional field for extra 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	-	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	-	Recipient's fax number
flexZustellungEmailadresse	String	80	-	Flex delivery email address
frachtBrief	String	20	-	Bill of lading number if bill of lading is to be printed by the upstream system
frachtfuehrerKdNr	String	10	-	Customer number of the freight payer at the carrier
freiAvis1	String	-	-	-
freiAvis2	String	-	-	-
frankaturKennung	String	10	-	-
gefahrgut	Sequence <Gefahrgut>	-	-	A list of Gefahrgüter of type Gefahrgut (1:n)
gewicht	Decimal	8	3	Gross weight in KG
hostTrackingNr	String	35	-	Packet number from the host system
ilnNr	String	20	-	Recipient's ILN (required for Metro shipping)
infotext1	String	150	-	Additional field for extra extensions
infotext2	String	150	-	Additional field for extra extensions
infotext3	String	150	-	Additional field for extra extensions
infotext4	String	150	-	Additional field for extra extensions
infotext5	String	150	-	Additional field for extra extensions
infotext6	String	150	-	Additional field for extra extensions
infotext7	String	150	-	Additional field for extra extensions
infotext8	String	150	-	Additional field for extra extensions
infotext9	String	150	-	Additional field for extra extensions
infotext10	String	150	-	Additional field for extra extensions
kostenstelle	String	30	-	-
kundenNr	String	20	-	Customer number of the recipient at the sender
lagerkennzeichen	Integer	-	-	-
letztesPackstueck	String	1	-	T/F: T=last package of the shipment (required for hanging shipment to print the shipment hanging card)
lieferantenID	Integer	-	-	-
lieferscheinNr	String	40	-	Is used in the HVS32 as a search number
cash on delivery	Decimal	18	2	-
Net weight	Decimal	8	3	Net weight in KG
neutBIC	String	11	-	Only assigned to neutral senders
neutBankBezeichnung	String	40	-	Only assigned to neutral senders
neutIBAN	String	31	-	Only assigned to neutral senders
neutKontoInhaber	String	40	-	Only assigned to neutral senders
neutabsenderLKZ	String	3	-	Only assigned to neutral senders
neutabsenderName1	String	50	-	Only assigned to neutral senders
neutabsenderName2	String	50	-	Only assigned to neutral senders
neutabsenderName3	String	50	-	Only assigned to neutral senders
neutabsenderOrt	String	50	-	Only assigned to neutral senders
neutabsenderPLZ	String	10	-	Only assigned to neutral senders
neutabsenderStrasse	String	50	-	Only assigned to neutral senders
nnVermerk	String	1	-	B': Bar / 'V': personal cheque
nnVerwendung	String	30	-	cash on delivery usage
nnWaehrung	String	3	-	cash on delivery - ISO currency code
packStkGes	Integer	-	-	Total number of packages in the shipment
packStkNr	Integer	-	-	Consecutive number per shipment
packplatz	String	10	-	HVS32 packing station client that is to process the order.
packstueckBreite	Integer	-	-	Width in cm
packstueckHoehe	Integer	-	-	Height in cm
packstueckID	String	20	-	Unique number for the package in the source system. Is required as a unique package reference to later cancel or load the label.
packstueckLaenge	Integer	-	-	Length in cm
paperlessInvoice	String	1	-	Only in the UPS PaperlessInvoice case (T=PaperlessInvoice / F=not PaperlessInvoice)
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
rechnungsEmpfStrasse	String	50	-	Billing address
rechnungsNr	String	20	-	bill number
sendungsinhalt	String	30	-	-
sonderdienste	String	30	-	Shipping type-specific
sperrFlag	String	1	-	T/F: T=lock, otherwise don't lock
telefonNr	String	20	-	Recipient's phone number
terminArt	String	1	-	'A' = deliver from this day 'B' = deliver by this date 'F' = an diesem Tag liefern
terminDatum	String	10	-	TT.MM.JJJJ
terminZeit	Calendar	5	-	HH:MM
ustIDNr	String	20	-	VAT number of the recipient
verpackungsart	String	6	-	-
versandartID	String	10	-	Shipping type identifier from the HVS32
insurance value	Decimal	18	2	Amount of insurance value
vorpackdatum	String	10	-	TT.MM.JJJJ
vwWaehrung	String	3	-	insurance value - ISO currency code
Value of goods	Decimal	18	2	-
wechselbruecke	String	20	-	Swap body assigned to this package
wwWaehrung	String	3	-	Value of goods - ISO currency code
zahlungsbedingung	String	10	-	'S' = Sender, 'R' = recipient
zbZoll	String	1	-	Terms of payment for customs taxes 'S' = Sender, 'R' = recipient
zielAdrBahnhof	String	30	-	Postal code 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

response parameters

Field name	Type	Max Length	Decimals
assoc	Map (String, String)	-	-	Additional field for extra extensions (Key=Field name / Value=Wert)
ausgangDateTime	Calendar	10	-	Date when the label was sent to the carrier (DD.MM.YYYY)
ausgangDateTimeString	String	10	-	Date when the label was sent to the carrier (DD.MM.YYYY)
druckDateTime	Calendar	19	-	Date when the label was printed in HVS32 (DD.MM.YYYY HH:mm:SS)
druckDateTimeString	String	19	-	Date when the label was printed in HVS32 (DD.MM.YYYY HH:mm:SS)
etikettDaten	String	-	-	Label binary data
etikettName	String	-	-	Label template name
fehlercode	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 charges
gebuehrWaehrung	String	3	-	Freight costs ISO currency code
packstueckID	String	20	-	PackstueckID from the request
retourTrackingNr	String	50	-	Parcel number for the return
trackingNr	String	35	-	package number
trackingURL	String	255	-	URL of the tracking link for shipment tracking
versandSendungsNr	String	-	-	-
zusatzEtikettenDaten	Map (String, String)	-	-	Name and binary data of the additional labels as key/value map
zusatzfeld1	String	200	-	Additional field - can optionally be mapped in the HVS32 to report back additional information
zusatzfeld2	String	200	-	Additional field - can optionally be mapped in the HVS32 to report back additional information
zusatzfeld3	String	200	-	Additional field - can optionally be mapped in the HVS32 to report back additional information
zusatzfeld4	String	200	-	Additional field - can optionally be mapped in the HVS32 to report back additional information
zusatzfeld5	String	200	-	Additional field - can optionally be mapped in the HVS32 to report back additional information
zusatzfeld6	String	200	-	Additional field - can optionally be mapped in the HVS32 to report back additional information
zusatzfeld7	String	200	-	Additional field - can optionally be mapped in the HVS32 to report back additional information
zusatzfeld8	String	200	-	Additional field - can optionally be mapped in the HVS32 to report back additional information
zusatzfeld9	String	200	-	Additional field - can optionally be mapped in the HVS32 to report back additional information
zusatzfeld10	String	200	-	Additional field - can optionally be mapped in the HVS32 to report back additional information

Examples

Request

{
	"absenderAdresseID": "",
	"ansprechpartner": "",
	"assoc": {
		"":""
	},
	"artikelDaten": [
		{
			"anzahlBuegel": 0,
			"anzahlPosEtiketten": 0,
			"artikelBTNNr": "",
			"artikelEAN": "",
			"artikelEinheit": "",
			"artikelGewicht": 0,
			"artikelGruppe": "",
			"artikelMenge": 0,
			"artikelServices": "",
			"artikelSollMenge": 0,
			"artikelText1": "",
			"artikelText2": "",
			"artikelText3": "",
			"artikelText4": "",
			"artikelVolumen": 0,
			"artikelWaehrung": "",
			"artikelWert": 0,
			"chargeFlag": "",
			"kundenArtikelNr": "",
			"kundenBestellNr": "",
			"posAuftragNr": "",
			"posLieferNr": "",
			"positionNr": "",
			"serienNr": "",
			"ursprungLand": ""
		}
	],
	"auftragNr": "",
	"auftraggeberID": "",
	"avisHinweis1": "",
	"avisHinweis2": "",
	"avisZusatz1": "",
	"avisZusatz2": "",
	"bestellNr": "",
	"druckername": "",
	"email": "",
	"faxNr": "",
	"frachtBrief": "",
	"frachtfuehrerKdNr": "",
	"freiAvis1": "",
	"freiAvis2": "",
	"frankaturKennung": "",
	"gefahrgut": [
		{
			"gefahrgutBefoerdKat": 0,
			"gefahrgutBegrenzteMenge": "",
			"gefahrgutBezeichnung": "",
			"gefahrgutBuchst640": "",
			"gefahrgutFFCode": "",
			"gefahrgutFaktor": 0,
			"gefahrgutFreigestMenge": "",
			"gefahrgutKCode": "",
			"gefahrgutKlasse": "",
			"gefahrgutMenge": 0,
			"gefahrgutMengenEinheit": "",
			"gefahrgutNebenGefahr": "",
			"gefahrgutNettoExplMasse": 0,
			"gefahrgutTunnelBCode": "",
			"gefahrgutUNNR": "",
			"gefahrgutUmweltGef": "",
			"gefahrgutVPG": "",
			"gefahrgutVerpAnzahl": 0,
			"gefahrgutVerpackungsart": ""
		}
	],
	"gewicht": 0,
	"ilnNr": "",
	"infotext1": "",
	"infotext2": "",
	"infotext3": "",
	"infotext4": "",
	"infotext5": "",
	"infotext6": "",
	"infotext7": "",
	"infotext8": "",
	"infotext9": "",
	"infotext10": "",
	"kostenstelle": "",
	"kundenNr": "",
	"lieferscheinNr": "",
	"cash on delivery ": 0,
	"Net weight": 0,
	"neutabsenderLKZ": "",
	"neutabsenderName1": "",
	"neutabsenderName2": "",
	"neutabsenderName3": "",
	"neutabsenderOrt": "",
	"neutabsenderPLZ": "",
	"neutabsenderStrasse": "",
	"nnVermerk": "",
	"nnVerwendung": "",
	"nnWaehrung": "",
	"packStkGes": 0,
	"packStkNr": 0,
	"packplatz": "",
	"packstueckBreite": 0,
	"packstueckHoehe": 0,
	"packstueckID": "",
	"packstueckLaenge": 0,
	"paperlessInvoice": "",
	"postLeitcode": "",
	"postZielFrachtzent": "",
	"rechnungsEmpfLKZ": "",
	"rechnungsEmpfName1": "",
	"rechnungsEmpfName2": "",
	"rechnungsEmpfName3": "",
	"rechnungsEmpfOrt": "",
	"rechnungsEmpfPLZ": "",
	"rechnungsEmpfStrasse": "",
	"sendungsinhalt": "",
	"sonderdienste": "",
	"telefonNr": "",
	"terminArt": "",
	"terminDatum": "",
	"terminZeit": "",
	"ustIDNr": "",
	"verpackungsart": "",
	"versandartID": "",
	"insurance value": 0,
	"vwWaehrung": "",
	"Value of goods ": 0,
	"wwWaehrung": "",
	"zahlungsbedingung": "",
	"zbZoll": "",
	"zielAdrBahnhof": "",
	"zielAdrLKZ": "",
	"zielAdrName1": "",
	"zielAdrName2": "",
	"zielAdrName3": "",
	"zielAdrOrt": "",
	"zielAdrPLZ": "",
	"zielAdrRegion": "",
	"zielAdrStrasse": ""
}

Response

{
	"assoc": {
		"":""
	},
	"packstueckID": "",
	"trackingNr": "",
	"retourTrackingNr": "",
	"versandSendungsNr": "",
	"druckDateTime": "",
	"ausgangDateTime": "",
	"gebuehr": 0,
	"gebuehrWaehrung": "",
	"fehlertext1": "",
	"fehlertext2": "",
	"etikettName": "",
	"etikettDaten": "",
	"zusatzEtikettenDaten": {
		"": ""
	},
	"trackingURL": "",
	"zusatzfeld1": "",
	"zusatzfeld2": "",
	"zusatzfeld3": "",
	"zusatzfeld4": "",
	"zusatzfeld5": "",
	"zusatzfeld6": "",
	"zusatzfeld7": "",
	"zusatzfeld8": "",
	"zusatzfeld9": "",
	"zusatzfeld10": ""
}

reprint label (versanddatenNachdruckAnfrage)

The gateway function versanddatenReprintRequest is sent by the data gateway server in automatic polling mode to the HVS32 in order to reprint a label for a package there. 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. The old tracking number is therefore no longer valid and the old shipping label must be destroyed. The new tracking number can be reported back in the feedback.

Function (method: POST)	/hvs32rest/versanddatenNachdruckAnfrage
MediaType	text/plain
Charset	UTF-8

request parameters

bold fields must always be occupied

Field name	Type	Max Length	Decimals	Occupancy
druckername	String	30	-	Name of an output channel (printer) in the HVS32 via which the label is printed.
packplatz	String	10	-	Name of an output channel (printer) in the HVS32 via which the label is
packstueckID	String	30	-	Unique number for the package in the source system.
trackingNr	String	35	-	package number

response parameters

Field name	Type	Max Length	Decimals
assoc	Map (String, String)	-	-	Additional field for extra extensions (Key=Field name / Value=Wert)
ausgangDateTime	Calendar	10	-	Date when the label was sent to the carrier (DD.MM.YYYY)
ausgangDateTimeString	String	10	-	Date when the label was sent to the carrier (DD.MM.YYYY)
druckDateTime	Calendar	19	-	Date when the label was printed in HVS32 (DD.MM.YYYY HH:mm:SS)
druckDateTimeString	String	19	-	Date when the label was printed in HVS32 (DD.MM.YYYY HH:mm:SS)
etikettDaten	String	-	-	Label binary data
etikettName	String	-	-	Label template name
fehlercode	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 charges
gebuehrWaehrung	String	3	-	Freight costs ISO currency code
packstueckID	String	20	-	PackstueckID from the request
retourTrackingNr	String	50	-	Parcel number for the return
trackingNr	String	35	-	package number
trackingURL	String	255	-	URL of the tracking link for shipment tracking
versandSendungsNr	String	-	-	-
zusatzEtikettenDaten	Map (String, String)	-	-	Name and binary data of the additional labels as key/value map
zusatzfeld1	String	200	-	Additional field - can optionally be mapped in the HVS32 to report back additional information
zusatzfeld2	String	200	-	Additional field - can optionally be mapped in the HVS32 to report back additional information
zusatzfeld3	String	200	-	Additional field - can optionally be mapped in the HVS32 to report back additional information
zusatzfeld4	String	200	-	Additional field - can optionally be mapped in the HVS32 to report back additional information
zusatzfeld5	String	200	-	Additional field - can optionally be mapped in the HVS32 to report back additional information
zusatzfeld6	String	200	-	Additional field - can optionally be mapped in the HVS32 to report back additional information
zusatzfeld7	String	200	-	Additional field - can optionally be mapped in the HVS32 to report back additional information
zusatzfeld8	String	200	-	Additional field - can optionally be mapped in the HVS32 to report back additional information
zusatzfeld9	String	200	-	Additional field - can optionally be mapped in the HVS32 to report back additional information
zusatzfeld10	String	200	-	Additional field - can optionally be mapped in the HVS32 to report back additional information

Examples

Request

{
	"druckername": "",
	"packplatz": "",
	"packstueckID": "",
	"trackingNr": ""
}

Response

{
	"assoc": {
		"":""
	},
	"packstueckID": "",
	"trackingNr": "",
	"retourTrackingNr": "",
	"versandSendungsNr": "",
	"druckDateTime": "",
	"ausgangDateTime": "",
	"gebuehr": 0,
	"gebuehrWaehrung": "",
	"fehlertext1": "",
	"fehlertext2": "",
	"etikettName": "",
	"etikettDaten": "",
	"zusatzEtikettenDaten": {
		"": ""
	},
	"trackingURL": "",
	"zusatzfeld1": "",
	"zusatzfeld2": "",
	"zusatzfeld3": "",
	"zusatzfeld4": "",
	"zusatzfeld5": "",
	"zusatzfeld6": "",
	"zusatzfeld7": "",
	"zusatzfeld8": "",
	"zusatzfeld9": "",
	"zusatzfeld10": ""
}

cancel package(stornoVersanddaten)

The gateway function stornoVersanddaten is sent from the data gateway server to the HVS32 in automatic polling mode in order to cancel existing packages that are not yet on an outgoing list. As a rule, a package is canceled using the package ID on the host side. This is transferred in the PackstueckID field. In addition to the host-side package ID, the TrackingNr can also contribute to the identification of the package in the event that the host-side package ID cannot guarantee uniqueness. There are no package/shipment data available for confirmation. After a successful reversal, only the error field is returned with the value 0 - or in the event of an error, the error is returned with the value 1 and Fehlertext1.

Function (method: POST)	/hvs32rest/stornoVersanddaten
MediaType	text/plain
Charset	UTF-8

request parameters

Bold fields must ALWAYS be filled

Field name	Type	Max Length	Decimals	Occupancy
packplatz	String	10	-	Name of an output channel (printer) in the HVS32 via which the label is
packstueckID	String	30	-	Unique number for the package in the source system.
trackingNr	String	35	-	package number

response parameters

Field name	Type	Max Length	Decimals	Occupancy
fehlercode	Integer	-	-	0 = Successful
fehlertext1	String	200	-	-
fehlertext2	String	200	-	-

Examples

Request

{
	"packplatz": "",
	"packstueckID": "",
	"trackingNr": ""
}

Response

{
	"fehlercode": 0,
	"fehlertext1": "",
	"fehlertext2": ""
}

Load / release package(verladeVersanddaten)

The gateway function verladeVersanddaten is sent by the data gateway server in automatic polling mode to the HVS32 in order to release packages there for exit. Only packages that have been released for exit are taken into account for the daily closing. There are no package/shipment data available for confirmation. After successful release, only the error field is returned with the value 0 - or in the event of an error, the error is returned with the value 1 and Fehlertext1.

Function (method: POST)	/hvs32rest/verladeVersanddaten
MediaType	text/plain
Charset	UTF-8

request parameters

Bold fields must ALWAYS be filled

Field name	Type	Max Length	Decimals	Occupancy
hostFreigabeNr	String	20	-	Host-side release number that is set for this package.
packplatz	String	10	-	Name of an output channel (printer) in the HVS32 via which the label is
packstueckID	String	20	-	Unique number for the package in the source system. When printing the label, the same ID must have been transferred beforehand so that the HVS32 can clearly identify the package to be loaded.
wechselbruecke	String	20	-	Swap body assigned to this package.

response parameters

Field name	Type	Max Length	Decimals	Occupancy
fehlercode	Integer	-	-	0 = Successful
fehlertext1	String	200	-	-
fehlertext1	String	200	-	-

Examples

Request

{
	"hostFreigabeNr": "",
	"packplatz": "",
	"packstueckID": "",
	"wechselbruecke": ""
}

Response

{
	"fehlercode": 0,
	"fehlertext1": "",
	"fehlertext2": ""
}

lock package (sperreVersanddaten)

The gateway function sperreVersanddaten is sent by the data gateway server in automatic polling mode to the HVS32 in order to block packages for exit there. Blocked packages are not taken into account for the daily closing. There are no package/shipment data available for confirmation. After successful blocking, only the error field is returned with the value 0 - or in the event of an error, the error is returned with the value 1 and Fehlertext1.

Function (method: POST)	/hvs32rest/sperreVersanddaten
MediaType	text/plain
Charset	UTF-8

request parameters

Bold fields must ALWAYS be filled

Field name	Type	Max Length	Decimals	Occupancy
packplatz	String	10	-	Name of an output channel (printer) in the HVS32 via which the label is
packstueckID	String	20	-	Unique number for the package in the source system.

response parameters

Field name	Type	Max Length	Decimals	Occupancy
fehlercode	Integer	-	-	0 = Successful
fehlertext1	String	200	-	-
fehlertext2	String	200	-	-

Examples

Request

{
	"packplatz": "",
	"packstueckID": ""
}

Response

{
	"fehlercode": 0,
	"fehlertext1": "",
	"fehlertext2": ""
}

End of day (tagesabschluss)

The gateway sends the tagesabschluss request to the automatic polling of the HVS32. In the HVS32, a daily closing is thus triggered using the additionally transferred parameters. The daily closing consists of the items Generate outbound list and Generate EDI carrier. 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 Outgoing Scan extension module. The feedback in the HVS32 takes place after the daily closing has been carried out. There are no package/shipment data available for confirmation. After a successful end of day, only the error field is returned with the value 0 - or in the event of an error, the error is returned with the value 1 and Fehlertext1.

Function (method: POST)	/hvs32rest/tagesabschluss
MediaType	text/plain
Charset	UTF-8

request parameters

Bold fields must ALWAYS be filled

Field name	Type	Max Length	Decimals	Occupancy
auftraggeberID	Sequence<String>	255	-	A semicolon-separated list with the clients to be closed can be given here. n clients can be concluded. (Option MultiAGTagesabschluss muss im HVS32 aktiv sein)
druckername	String	30	-	Name of an output channel (printer) in the HVS32 via which the lists are to be printed. (Requires printer spooler extension module)
frachtfuehrerTyp	Sequence<String>	255	-	A semicolon-separated list with the freight forwarders to be concluded can be given here. n carriers can be contracted. (MultiFFTagesabschluss option must be active in HVS32)
packplatz	String	10	-	HVS32 packing station client that is to carry out the list closure.
versandartID	Sequence<String>	255	-	A semicolon-separated list with the shipping methods to be completed can be given here. n types of shipping can be contracted. (MultiVATagesabschluss option must be active in HVS32)
wechselbruecke	String	10	-	Identification of the swap body to be locked. Only certain shipments can be completed with this.

response parameters

Field name	Type	Max Length	Decimals	Occupancy
assoc	Map (String, String)	-	-	Additional field for extra extensions (Key=Field name / Value=Wert)
edistatus	Sequence <EDIStatus>	-	-	-
fehlercode	Integer	-	-	0 = Successful
fehlertext1	String	200	-	-
fehlertext2	String	200	-	-
listenDaten	Map (String, String)	-	-	Name and binary data of the lists as a key/value map.
etikettenDaten	Map (String, String)	-	-	Label name and binary data as key/value map.
ausgangsListeNr	Sequence<String>	-	-	Output list number(s) of the generated output list(s).

Examples

Request

{
	"auftraggeberID": [
		""
	],
	"druckername": "",
	"frachtfuehrerTyp": [
		""
	],
	"packplatz": "",
	"versandartID": [
		""
	],
	"wechselbruecke": ""
}

Response

{
	"assoc": {
		"":""
	},
	"fehlercode": 0,
	"fehlertext1": "",
	"edistatus": [
		{
			"fehlercode": 0,
			"statuscode": "",
			"statustext": "",
			"fftyp": "",
			"dateityp": "",
			"auftraggeber": "",
			"ffdateinr": ""
		}
	],
	"listenDaten": {},
	"ausgangsListeNr": [
		"75"
	]
}

Generate output list (listenabschlussAnfrage)

The gateway sends the listenabschlussAnfrage request to the automatic polling of the HVS32. An output list is thus generated in the HVS32 using the additionally transferred parameters. Only packages that have been released for exit are considered for the end of the list. By default, all packages are released unless they have been blocked by the Outgoing Scan extension module. The feedback in the HVS32 takes place after the output list has been generated. There are no package/shipment data available for confirmation. After successful completion of the list, only the Error field is returned with the value 0 - or in the event of an error, the Error is returned with the value 1 and Error text1.

Function (method: POST)	/hvs32rest/listenabschlussAnfrage
MediaType	text/plain
Charset	UTF-8

request parameters

Bold fields must ALWAYS be filled

Field name	Type	Max Length	Decimals	Occupancy
auftraggeberID	String	255	-	A semicolon-separated list with the clients to be closed can be given here. n clients can be concluded. (Option MultiAGTagesabschluss muss im HVS32 aktiv sein)
druckername	String	30	-	Name of an output channel (printer) in the HVS32 via which the lists are to be printed. (Requires printer spooler extension module)
frachtfuehrerTyp	String	255	-	A semicolon-separated list with the freight forwarders to be concluded can be given here. n carriers can be contracted. (MultiFFTagesabschluss option must be active in HVS32)
packplatz	String	10	-	HVS32 packing station client that is to carry out the list closure.
versandartID	String	255	-	A semicolon-separated list with the shipping methods to be completed can be given here. n types of shipping can be contracted. (MultiVATagesabschluss option must be active in HVS32)
wechselbruecke	String	10	-	Identification of the swap body to be locked. Only certain shipments can be completed with this.

response parameters

Field name	Type	Max Length	Decimals	Occupancy
assoc	Map (String, String)	-	-	Additional field for extra extensions (Key=Field name / Value=Wert)
fehlercode	Integer	-	-	0 = Successful
fehlertext1	String	200	-	-
fehlertext2	String	200	-	-
listenDaten	Map (String, String)	-	-	Name and binary data of the lists as a key/value map.
etikettenDaten	Map (String, String)	-	-	Label name and binary data as key/value map.
ausgangsListeNr	Sequence<String>	-	-	Output list number(s) of the generated output list(s).

Examples

Request

{
	"auftraggeberID": [
		""
	],
	"druckername": "",
	"frachtfuehrerTyp": [
		""
	],
	"packplatz": "",
	"versandartID": [
		""
	],
	"wechselbruecke": ""
}

Response

{
	"assoc": {
		"":""
	},
	"fehlercode": 0,
	"fehlertext1": "",
	"listenDaten": {
		"": ""
	},
	"ausgangsListeNr": [
		"75"
	]
}

reprint outgoing list (listenNachdruckAnfrage)

The gateway sends the listenNachdruckAnfrage request to the automatic polling of the HVS32. In the HVS32, an output list that has already been created is then reprinted using the output list number that was transferred. A list can only be reprinted if it has already been generated using the functions daily closing, list closing request or manually using the HVS32 mask. There are no package/shipment data available for confirmation. After successful completion of the list, only the Error field is returned with the value 0 - or in the event of an error, the Error is returned with the value 1 and Fehlertext1.

Function (method: POST)	/hvs32rest/listenNachdruckAnfrage
MediaType	text/plain
Charset	UTF-8

request parameters

Bold fields must ALWAYS be filled

Field name	Type	Max Length	Decimals	Occupancy
ausgangsListeNr	Sequence<String>	-	-	List of output list no. of the lists to be reprinted.
druckername	String	30	-	Name of an output channel (printer) in the HVS32 via which the lists are to be printed. (Requires printer spooler extension module)
auftraggeberID	Sequence<String>	-	-	List of client IDs for which the lists are to be reprinted.
frachtFuehrerTyp	Sequence<String>	-	-	List of carrier types for which the lists are to be reprinted.
erstellDatum	String	10	-	Creation date of the outgoing lists to be reprinted. In the format "dd.mm.yyyy", e.g. 01.01.2001
druckDatum	String	10	-	Print date of the outgoing lists to be reprinted. In the format "dd.mm.yyyy", e.g. 01.01.2001 or zero if only lists that have not yet been printed are to be reprinted

response parameters

Field name	Type	Max Length	Decimals	Occupancy
ausgangsListeNr	Sequence<String>	-	-	List of output list no. of the lists that have been reprinted.
assoc	Map (String, String)	-	-	Additional field for extra extensions (Key=Field name / Value=Wert)
fehlercode	Integer	-	-	0 = Successful
fehlertext1	String	200	-	-
fehlertext2	String	200	-	-
listenDaten	Map (String, String)	-	-	Name and binary data of the lists as a key/value map.
etikettenDaten	Map (String, String)	-	-	Label name and binary data as key/value map.

Examples

Request

{
	"ausgangsListeNr": [
		"77"
	],
	"druckername": "",
	"auftraggeberID": [], 
	"frachtFuehrerTyp": [], 
	"erstellDatum": "", 
	"druckDatum": ""
}

Response

{
	"ausgangsListeNr": [
		"77"
	]
	"assoc": {
		"":""
	},
	"fehlercode": 0,
	"fehlertext1": "",
	"listenDaten": {
		"": ""
	}
}

Generate carrier EDI (ediabschlussAnfrage)

The gateway sends the ediabschlussAnfrage request to the automatic polling of the HVS32. In the HVS32, a carrier EDI is generated based on 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 feedback in the HVS32 takes place after the carrier EDI has been generated. There are no package/shipment data available for confirmation. After successful EDI completion, only the error field is reported with the value 0 - or in the event of an error, the error is reported with the value 1 Fehlertext1.

Function (method: POST)	/hvs32rest/ediabschlussAnfrage
MediaType	text/plain
Charset	UTF-8

request parameters

Bold fields must ALWAYS be filled

Field name	Type	Max Length	Decimals	Occupancy
auftraggeberID	Sequence <String>	255	-	A semicolon-separated list with the clients to be closed can be given here. n clients can be concluded. (Option MultiAGTagesabschluss muss im HVS32 aktiv sein)
druckername	String	30	-	Name of an output channel (printer) in the HVS32 via which, for example, the UPS summary is printed. (Requires printer spooler extension module)
frachtfuehrerTyp	Sequence <String>	255	-	A semicolon-separated list with the freight forwarders to be concluded can be given here. n carriers can be contracted. (MultiFFTagesabschluss option must be active in HVS32)
packplatz	String	10	-	HVS32 packing station client that is to carry out the daily closing.
versandartID	Sequence <String>	255	-	A semicolon-separated list with the shipping methods to be completed can be given here. n types of shipping can be contracted. (MultiVATagesabschluss option must be active in HVS32)
wechselbruecke	String	10	-	Identification of the swap body to be locked. Only certain shipments can be completed with this.

response parameters

Field name	Type	Max Length	Decimals	Occupancy
assoc	Map (String, String)	-	-	Additional field for extra extensions (Key=Field name / Value=Wert)
edistatus	Sequence <EDIStatus>	-	-	List of status information for EDIs.
fehlercode	Integer	-	-	0 = Successful
fehlertext1	String	200	-	-
listenDaten	Map (String, String)	-	-	Name and binary data of the EDI lists (e.g. UPS Summary) as key/value map.

Examples

Request

{
	"auftraggeberID": [
		""
	],
	"druckername": "",
	"frachtfuehrerTyp": [
		""
	],
	"packplatz": "",
	"versandartID": [
		""
	],
	"wechselbruecke": ""
}

Response

{
	"assoc": {
		"":""
	},
	"fehlercode": 0,
	"fehlertext1": "",
	"edistatus": [
		{
			"fehlercode": 0,
			"statuscode": "",
			"statustext": "",
			"fftyp": "",
			"dateityp": "",
			"auftraggeber": "",
			"ffdateinr": ""
		}
	],
	"listenDaten": {}
}

Check package data (versanddatenPruefAnfrage)

The gateway sends the versanddatenPruefAnfrage to the automatic polling of the HVS32. A versanddatenAnfrage 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 verification, etc.). This function is used to validate all shipping data in advance.

Function (method: POST)	/hvs32rest/versanddatenPruefAnfrage
MediaType	text/plain
Charset	UTF-8

request parameters

Bold fields must ALWAYS be filled

Field name	Type	Max Length	Decimals	Occupancy
ansprechpartner	String	20	-	Recipient contact person
artikelDaten	Sequence <ArtikelDaten>	-	-	A list of Packstück-Artikel of type ArtikelDaten (1:n)
assoc	Map (String, String)	-	-	Additional field for extra extensions (Key=Field name / Value=Wert)
auftragNr	String	20	-	-
auftraggeberID	String	10	-	Client ID 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 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	-	E-mail address of the recipient (e.g. for automatic e-mail notification)
faxNr	String	20	-	Recipient's fax number
flexZustellungEmailadresse	String	80	-	Flex delivery email address
frachtBrief	String	20	-	Bill of lading number if bill of lading is to be printed by the upstream system
frachtfuehrerKdNr	String	10	-	Customer number of the freight payer at the carrier
frankaturKennung	String	10	-	-
gefahrgut	Sequence <Gefahrgut>	-	-	A list of Gefahrgüter of type Gefahrgut (1:n)
gewicht	Decimal	8	3	Gross weight in KG
ilnNr	String	20	-	Recipient's ILN (required for Metro shipping)
infotext1	String	150	-	Additional field for extra extensions
infotext2	String	150	-	Additional field for extra extensions
infotext3	String	150	-	Additional field for extra extensions
infotext4	String	150	-	Additional field for extra extensions
infotext5	String	150	-	Additional field for extra extensions
infotext6	String	150	-	Additional field for extra extensions
infotext7	String	150	-	Additional field for extra extensions
infotext8	String	150	-	Additional field for extra extensions
infotext9	String	150	-	Additional field for extra extensions
infotext10	String	150	-	Additional field for extra extensions
kostenstelle	String	30	-	-
kundenNr	String	20	-	Customer number of the recipient at the sender
lieferscheinNr	String	40	-	Is used in the HVS32 as a search number
cash on delivery	Decimal	18	2	-
Net weight	Decimal	8	3	Net weight in KG
neutabsenderLKZ	String	3	-	Only assigned to neutral senders
neutabsenderName1	String	50	-	Only assigned to neutral senders
neutabsenderName2	String	50	-	Only assigned to neutral senders
neutabsenderName3	String	50	-	Only assigned to neutral senders
neutabsenderOrt	String	50	-	Only assigned to neutral senders
neutabsenderPLZ	String	10	-	Only assigned to neutral senders
neutabsenderStrasse	String	50	-	Only assigned to neutral senders
nnVermerk	String	1	-	B': Bar / 'V': personal cheque
nnVerwendung	String	30	-	cash on delivery usage
nnWaehrung	String	3	-	cash on delivery - ISO currency code
packStkGes	Integer	-	-	Total number of packages in the shipment
packStkNr	Integer	-	-	Consecutive number per shipment
packplatz	String	10	-	HVS32 packing station client that is to process the order.
packstueckBreite	Integer	-	-	Width in cm
packstueckHoehe	Integer	-	-	Height in cm
packstueckID	String	20	-	Unique number for the package in the source system. Is required as a unique package reference to later cancel or load the label.
packstueckLaenge	Integer	-	-	Length in cm
paperlessInvoice	String	1	-	Only in the UPS PaperlessInvoice case (T=PaperlessInvoice / F=not PaperlessInvoice)
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
rechnungsEmpfStrasse	String	50	-	Billing address
rechnungsNr	String	20	-	bill number
sonderdienste	String	30	-	Shipping type-specific
telefonNr	String	20	-	Recipient's phone number
terminArt	String	1	-	'A'b / 'B'is / 'F'ix
terminDatum	String	10	-	TT.MM.JJJJ
terminZeit	Calendar	5	-	HH:MM
ustIDNr	String	20	-	VAT number of the recipient
verpackungsart	String	6	-	-
versandartID	String	10	-	Shipping type identifier from the HVS32
insurance value	Decimal	18	2	Amount of insurance value
vwWaehrung	String	3	-	insurance value - ISO currency code
Value of goods	Decimal	18	2	-
wwWaehrung	String	3	-	Value of goods - ISO currency code
zahlungsbedingung	String	10	-	'S' = Sender, 'R' = recipient
zbZoll	String	1	-	Terms of payment for customs taxes 'S' = Sender, 'R' = recipient
zielAdrBahnhof	String	30	-	Postal code 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

response parameters

Field name	Type	Max Length	Decimals	-
druckDateTime	Calendar	19	-	Date when the label was printed in HVS32 (DD.MM.YYYY HH:mm:SS)
druckDateTimeString	String	19	-	Date when the label was printed in HVS32 (DD.MM.YYYY HH:mm:SS)
fehlertext1	String	200	-	-
fehlertext2	String	200	-	-

Examples

Request

{
	"ansprechpartner": "",
	"artikelDaten": [
		{
			"anzahlBuegel": 0,
			"anzahlPosEtiketten": 0,
			"artikelBTNNr": "",
			"artikelEAN": "",
			"artikelEinheit": "",
			"artikelGewicht": 0,
			"artikelGruppe": "",
			"artikelMenge": 0,
			"artikelServices": "",
			"artikelSollMenge": 0,
			"artikelText1": "",
			"artikelText2": "",
			"artikelText3": "",
			"artikelText4": "",
			"artikelVolumen": 0,
			"artikelWaehrung": "",
			"artikelWert": 0,
			"chargeFlag": "",
			"kundenArtikelNr": "",
			"kundenBestellNr": "",
			"posAuftragNr": "",
			"posLieferNr": "",
			"positionNr": "",
			"serienNr": "",
			"ursprungLand": ""
		}
	],
	"auftragNr": "",
	"auftraggeberID": "",
	"avisHinweis1": "",
	"avisHinweis2": "",
	"avisZusatz1": "",
	"avisZusatz2": "",
	"bestellNr": "",
	"druckername": "",
	"email": "",
	"faxNr": "",
	"frachtBrief": "",
	"frachtfuehrerKdNr": "",
	"frankaturKennung": "",
	"gefahrgut": [
		{
			"gefahrgutBefoerdKat": 0,
			"gefahrgutBegrenzteMenge": "",
			"gefahrgutBezeichnung": "",
			"gefahrgutBuchst640": "",
			"gefahrgutFFCode": "",
			"gefahrgutFaktor": 0,
			"gefahrgutFreigestMenge": "",
			"gefahrgutKCode": "",
			"gefahrgutKlasse": "",
			"gefahrgutMenge": 0,
			"gefahrgutMengenEinheit": "",
			"gefahrgutNebenGefahr": "",
			"gefahrgutNettoExplMasse": 0,
			"gefahrgutTunnelBCode": "",
			"gefahrgutUNNR": "",
			"gefahrgutUmweltGef": "",
			"gefahrgutVPG": "",
			"gefahrgutVerpAnzahl": 0,
			"gefahrgutVerpackungsart": ""
		}
	],
	"gewicht": 0,
	"ilnNr": "",
	"infotext1": "",
	"infotext2": "",
	"infotext3": "",
	"infotext4": "",
	"infotext5": "",
	"infotext6": "",
	"infotext7": "",
	"infotext8": "",
	"infotext9": "",
	"infotext10": "",
	"kostenstelle": "",
	"kundenNr": "",
	"lieferscheinNr": "",
	"cash on delivery ": 0,
	"Net weight": 0,
	"neutabsenderLKZ": "",
	"neutabsenderName1": "",
	"neutabsenderName2": "",
	"neutabsenderName3": "",
	"neutabsenderOrt": "",
	"neutabsenderPLZ": "",
	"neutabsenderStrasse": "",
	"nnVermerk": "",
	"nnVerwendung": "",
	"nnWaehrung": "",
	"packStkGes": 0,
	"packStkNr": 0,
	"packplatz": "",
	"packstueckBreite": 0,
	"packstueckHoehe": 0,
	"packstueckID": "",
	"packstueckLaenge": 0,
	"paperlessInvoice": "",
	"postLeitcode": "",
	"postZielFrachtzent": "",
	"rechnungsEmpfLKZ": "",
	"rechnungsEmpfName1": "",
	"rechnungsEmpfName2": "",
	"rechnungsEmpfName3": "",
	"rechnungsEmpfOrt": "",
	"rechnungsEmpfPLZ": "",
	"rechnungsEmpfStrasse": "",
	"sendungsinhalt": "",
	"sonderdienste": "",
	"telefonNr": "",
	"terminArt": "",
	"terminDatum": "",
	"terminZeit": "",
	"ustIDNr": "",
	"verpackungsart": "",
	"versandartID": "",
	"insurance value": 0,
	"vwWaehrung": "",
	"Value of goods ": 0,
	"wwWaehrung": "",
	"zahlungsbedingung": "",
	"zbZoll": "",
	"zielAdrBahnhof": "",
	"zielAdrLKZ": "",
	"zielAdrName1": "",
	"zielAdrName2": "",
	"zielAdrName3": "",
	"zielAdrOrt": "",
	"zielAdrPLZ": "",
	"zielAdrRegion": "",
	"zielAdrStrasse": ""
}

Response

{
	"druckDateTime": "",
	"fehlertext1": "",
	"fehlertext2": ""
}

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 there. This request is sent, for example, if the value of goods for a package is only known at a later point in time. Data within the shipping unit, billing unit and delivery tables can be updated. The search is always made via the PackstueckID field and, if occupied, also via the TrackingNr field. With this request, however, the fields and content to be updated are no longer checked according to the guidelines of the carrier (e.g. weight limits, etc.). The upstream system must therefore ensure that the updated values ​​match the carrier's guidelines. If this is not possible, this function cannot be used and the label must be canceled and reprocessed. In addition, fields that have already been printed on a label or that have been determined by the HVS32 shipping system in a carrier transaction (e.g. address, route, tracking number, special services, etc.) cannot be manipulated. There are no package/shipment data available for confirmation. After a successful update, only the error field is returned with the value 0 - or in the event of an error, the error is returned with the value 1 and Fehlertext1.

Function (method: POST)	/hvs32rest/updateVersanddaten
MediaType	text/plain
Charset	UTF-8

request parameters

Bold fields must ALWAYS be filled

Field name	Type	Max Length	Decimals	Occupancy
ansprechpartner	String	20	-	Recipient contact person
anzahlArtikel	Integer	6	-	Number of articles (print on label)
artikelDaten	Sequence <ArtikelDaten>	-	-	A list of Packstück-Artikel of type ArtikelDaten (1:n)
assoc	Map (String, String)	-	-	Additional field for extra extensions (Key=Field name / Value=Wert)
auftragNr	String	20	-	-
auftraggeberID	String	10	-	Client ID 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
barcodeID	String	-	-	Additional field for extra extensions
barcodeText	String	-	-	Additional field for extra extensions
barcodeTyp	String	-	-	Additional field for extra 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	-	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	-	Recipient's fax number
flexZustellungEmailadresse	String	80	-	Flex delivery email address
frachtBrief	String	20	-	Bill of lading number if bill of lading is to be printed by the upstream system
frachtfuehrerKdNr	String	10	-	Customer number of the freight payer at the carrier
frankaturKennung	String	10	-	-
gefahrgut	Sequence <Gefahrgut>	-	-	A list of Gefahrgüter of type Gefahrgut (1:n)
gewicht	Decimal	8	3	Gross weight in KG
hostTrackingNr	String	35	-	Packet number from the host system
ilnNr	String	20	-	Recipient's ILN (required for Metro shipping)
infotext1	String	150	-	Additional field for extra extensions
infotext2	String	150	-	Additional field for extra extensions
infotext3	String	150	-	Additional field for extra extensions
infotext4	String	150	-	Additional field for extra extensions
infotext5	String	150	-	Additional field for extra extensions
infotext6	String	150	-	Additional field for extra extensions
infotext7	String	150	-	Additional field for extra extensions
infotext8	String	150	-	Additional field for extra extensions
infotext9	String	150	-	Additional field for extra extensions
infotext10	String	150	-	Additional field for extra extensions
kostenstelle	String	30	-	-
kundenNr	String	20	-	Customer number of the recipient at the sender
lagerkennzeichen	Integer	-	-	-
letztesPackstueck	String	1	-	T/F: T=last package of the shipment (required for hanging shipment to print the shipment hanging card)
lieferantenID	Integer	-	-	-
lieferscheinNr	String	40	-	Is used in the HVS32 as a search number
cash on delivery	Decimal	18	2	-
Net weight	Decimal	8	3	Net weight in KG
neutBIC	String	11	-	Only assigned to neutral senders
neutBankBezeichnung	String	40	-	Only assigned to neutral senders
neutIBAN	String	31	-	Only assigned to neutral senders
neutKontoInhaber	String	40	-	Only assigned to neutral senders
neutabsenderLKZ	String	3	-	Only assigned to neutral senders
neutabsenderName1	String	50	-	Only assigned to neutral senders
neutabsenderName2	String	50	-	Only assigned to neutral senders
neutabsenderName3	String	50	-	Only assigned to neutral senders
neutabsenderOrt	String	50	-	Only assigned to neutral senders
neutabsenderPLZ	String	10	-	Only assigned to neutral senders
neutabsenderStrasse	String	50	-	Only assigned to neutral senders
nnVermerk	String	1	-	B': Bar / 'V': personal cheque
nnVerwendung	String	30	-	cash on delivery usage
nnWaehrung	String	3	-	cash on delivery - ISO currency code
packStkGes	Integer	-	-	Total number of packages in the shipment
packStkNr	Integer	-	-	Consecutive number per shipment
packplatz	String	10	-	HVS32 packing station client that is to process the order.
packstueckBreite	Integer	-	-	Width in cm
packstueckHoehe	Integer	-	-	Height in cm
packstueckID	String	20	-	Unique number for the package in the source system. Is required as a unique package reference to later cancel or load the label.
packstueckLaenge	Integer	-	-	Length in cm
paperlessInvoice	String	1	-	Only in the UPS PaperlessInvoice case (T=PaperlessInvoice / F=not PaperlessInvoice)
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
rechnungsEmpfStrasse	String	50	-	Billing address
rechnungsNr	String	20	-	bill number
sendungsinhalt	String	30	-	-
sonderdienste	String	30	-	Shipping type-specific
sperrFlag	String	1	-	T/F: T=lock, otherwise don't lock
telefonNr	String	20	-	Recipient's phone number
terminArt	String	1	-	'A'b / 'B'is / 'F'ix
terminDatum	String	10	-	TT.MM.JJJJ
terminZeit	Calendar	5	-	HH:MM
ustIDNr	String	20	-	VAT number of the recipient
verpackungsart	String	6	-	-
versandartID	String	10	-	Shipping type identifier from the HVS32
insurance value	Decimal	18	2	Amount of insurance value
vorpackdatum	String	10	-	TT.MM.JJJJ
vwWaehrung	String	3	-	insurance value - ISO currency code
Value of goods	Decimal	18	2	-
wechselbruecke	String	20	-	Swap body assigned to this package
wwWaehrung	String	3	-	Value of goods - ISO currency code
zahlungsbedingung	String	10	-	'S' = Sender, 'R' = recipient
zbZoll	String	1	-	Terms of payment for customs taxes 'S' = Sender, 'R' = recipient
zielAdrBahnhof	String	30	-	Postal code 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

response parameters

Field name	Type	Max Length	Decimals
assoc	Map (String, String)	-	-	Additional field for extra extensions (Key=Field name / Value=Wert)
ausgangDateTime	Calendar	10	-	Date when the label was sent to the carrier (DD.MM.YYYY)
ausgangDateTimeString	String	10	-	Date when the label was sent to the carrier (DD.MM.YYYY)
druckDateTime	Calendar	19	-	Date when the label was printed in HVS32 (DD.MM.YYYY HH:mm:SS)
druckDateTimeString	String	19	-	Date when the label was printed in HVS32 (DD.MM.YYYY HH:mm:SS)
etikettDaten	String	-	-	Label binary data
etikettName	String	-	-	Label template name
fehlercode	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 charges
gebuehrWaehrung	String	3	-	Freight costs ISO currency code
packstueckID	String	20	-	PackstueckID from the request
retourTrackingNr	String	50	-	Parcel number for the return
trackingNr	String	35	-	package number
trackingURL	String	255	-	URL of the tracking link for shipment tracking
versandSendungsNr	String	-	-	-
zusatzEtikettenDaten	Map (String, String)	-	-	Name and binary data of the additional labels as key/value map
zusatzfeld1	String	200	-	Additional field - can optionally be mapped in the HVS32 to report back additional information
zusatzfeld2	String	200	-	Additional field - can optionally be mapped in the HVS32 to report back additional information
zusatzfeld3	String	200	-	Additional field - can optionally be mapped in the HVS32 to report back additional information
zusatzfeld4	String	200	-	Additional field - can optionally be mapped in the HVS32 to report back additional information
zusatzfeld5	String	200	-	Additional field - can optionally be mapped in the HVS32 to report back additional information
zusatzfeld6	String	200	-	Additional field - can optionally be mapped in the HVS32 to report back additional information
zusatzfeld7	String	200	-	Additional field - can optionally be mapped in the HVS32 to report back additional information
zusatzfeld8	String	200	-	Additional field - can optionally be mapped in the HVS32 to report back additional information
zusatzfeld9	String	200	-	Additional field - can optionally be mapped in the HVS32 to report back additional information
zusatzfeld10	String	200	-	Additional field - can optionally be mapped in the HVS32 to report back additional information

Examples

Request

{
	"ansprechpartner": "",
	"anzahlArtikel": 0,
	"artikelDaten": [
		{
			"anzahlBuegel": 0,
			"anzahlPosEtiketten": 0,
			"artikelBTNNr": "",
			"artikelEAN": "",
			"artikelEinheit": "",
			"artikelGewicht": 0,
			"artikelGruppe": "",
			"artikelMenge": 0,
			"artikelServices": "",
			"artikelSollMenge": 0,
			"artikelText1": "",
			"artikelText2": "",
			"artikelText3": "",
			"artikelText4": "",
			"artikelVolumen": 0,
			"artikelWaehrung": "",
			"artikelWert": 0,
			"chargeFlag": "",
			"kundenArtikelNr": "",
			"kundenBestellNr": "",
			"posAuftragNr": "",
			"posLieferNr": "",
			"positionNr": "",
			"serienNr": "",
			"ursprungLand": ""
		}
	],
	"auftragNr": "",
	"auftraggeberID": "",
	"avisHinweis1": "",
	"avisHinweis2": "",
	"avisZusatz1": "",
	"avisZusatz2": "",
	"barcodeID": "",
	"barcodeText": "",
	"barcodeTyp": "",
	"bestellNr": "",
	"druckername": "",
	"email": "",
	"empfMobilfunkNr": "",
	"faxNr": "",
	"flexZustellungEmailadResponsese": "",
	"frachtBrief": "",
	"frachtfuehrerKdNr": "",
	"frankaturKennung": "",
	"gefahrgut": [
		{
			"gefahrgutBefoerdKat": 0,
			"gefahrgutBegrenzteMenge": "",
			"gefahrgutBezeichnung": "",
			"gefahrgutBuchst640": "",
			"gefahrgutFFCode": "",
			"gefahrgutFaktor": 0,
			"gefahrgutFreigestMenge": "",
			"gefahrgutKCode": "",
			"gefahrgutKlasse": "",
			"gefahrgutMenge": 0,
			"gefahrgutMengenEinheit": "",
			"gefahrgutNebenGefahr": "",
			"gefahrgutNettoExplMasse": 0,
			"gefahrgutTunnelBCode": "",
			"gefahrgutUNNR": "",
			"gefahrgutUmweltGef": "",
			"gefahrgutVPG": "",
			"gefahrgutVerpAnzahl": 0,
			"gefahrgutVerpackungsart": ""
		}
	],
	"gewicht": 0,
	"hostTrackingNr": "",
	"ilnNr": "",
	"infotext1": "",
	"infotext2": "",
	"infotext3": "",
	"infotext4": "",
	"infotext5": "",
	"infotext6": "",
	"infotext7": "",
	"infotext8": "",
	"infotext9": "",
	"infotext10": "",
	"kostenstelle": "",
	"kundenNr": "",
	"lagerkennzeichen": 0,
	"letztesPackstueck": "",
	"lieferantenID": 0,
	"lieferscheinNr": "",
	"cash on delivery ": 0,
	"Net weight": 0,
	"neutBIC": "",
	"neutBankBezeichnung": "",
	"neutIBAN": "",
	"neutKontoInhaber": "",
	"neutabsenderLKZ": "",
	"neutabsenderName1": "",
	"neutabsenderName2": "",
	"neutabsenderName3": "",
	"neutabsenderOrt": "",
	"neutabsenderPLZ": "",
	"neutabsenderStrasse": "",
	"nnVermerk": "",
	"nnVerwendung": "",
	"nnWaehrung": "",
	"packStkGes": 0,
	"packStkNr": 0,
	"packplatz": "",
	"packstueckBreite": 0,
	"packstueckHoehe": 0,
	"packstueckID": "",
	"packstueckLaenge": 0,
	"paperlessInvoice": "",
	"postLeitcode": "",
	"postZielFrachtzent": "",
	"rechnungsEmpfLKZ": "",
	"rechnungsEmpfName1": "",
	"rechnungsEmpfName2": "",
	"rechnungsEmpfName3": "",
	"rechnungsEmpfOrt": "",
	"rechnungsEmpfPLZ": "",
	"rechnungsEmpfStrasse": "",
	"rechnungsNr": "",
	"sendungsinhalt": "",
	"sonderdienste": "",
	"sperrFlag": "",
	"telefonNr": "",
	"terminArt": "",
	"terminDatum": "",
	"terminZeit": "",
	"ustIDNr": "",
	"verpackungsart": "",
	"versandartID": "",
	"insurance value": 0,
	"vorpackdatum": "",
	"vwWaehrung": "",
	"Value of goods ": 0,
	"wechselbruecke": "",
	"wwWaehrung": "",
	"zahlungsbedingung": "",
	"zbZoll": "",
	"zielAdrBahnhof": "",
	"zielAdrLKZ": "",
	"zielAdrName1": "",
	"zielAdrName2": "",
	"zielAdrName3": "",
	"zielAdrName4": "",
	"zielAdrOrt": "",
	"zielAdrPLZ": "",
	"zielAdrRegion": "",
	"zielAdrStrasse": ""
}

Response

{
	"packstueckID": "",
	"trackingNr": "",
	"retourTrackingNr": "",
	"versandSendungsNr": "",
	"druckDateTime": "",
	"ausgangDateTime": "",
	"gebuehrWaehrung": "",
	"fehlercode": 0,
	"fehlertext1": "",
	"fehlertext2": "",
	"etikettName": "",
	"etikettDaten": "",
	"trackingURL": "",
	"zusatzfeld1": "",
	"zusatzfeld2": "",
	"zusatzfeld3": "",
	"zusatzfeld4": "",
	"zusatzfeld5": "",
	"zusatzfeld6": "",
	"zusatzfeld7": "",
	"zusatzfeld8": "",
	"zusatzfeld9": "",
	"zusatzfeld10": ""
}

Anonymize package data (anonymisiereVersandDaten)

The gateway sends the anonymisiereVersandDaten to the automatic polling of the HVS32. In the HVS32, customer-related data is thus anonymized for the corresponding data set in accordance with the GDPR. This anonymization is irrevocably and definitively carried out at the database level of the shipping system. It is therefore no longer possible to restore the original data. Log files, feedback files, carrier EDIs that have already been transferred, etc. are not affected. Only packages and shipments that have already been closed during the day can be anonymised.

Function (method: POST)	/hvs32rest/anonymisiereVersandDaten
MediaType	text/plain
Charset	UTF-8

request parameters

Bold fields must ALWAYS be filled

Field name	Type	Max length	Decimal places	occupancy
auftragsNr	String	20	-	-
lieferscheinNr	String	40	-	Is used in the HVS32 as a search number.
packplatz	String	10	-	Name of an output channel (printer) in the HVS32 via which the label is
packstueckID	String	20	-	Unique number for the package in the source system.
trackingNr	String	35	-	package number

response parameters

Field name	Type	Max length	Decimal places	occupancy
fehlertext1	String	200	-	Is filled in the event of an error
fehlertext2	String	200	-	Is filled in the event of an error

Examples

Request

{
	"auftragNr": "",
	"lieferscheinNr": "",
	"packplatz": "",
	"packstueckID": "",
	"trackingNr": ""
}

Response

{
	"fehlertext1": "",
	"fehlertext2": ""
}

shipment processing (sendungsdatenAnfrage)

sendungsdatenAnfrage – is divided into individual versandDatenAnfragen at runtime. Must be used with a request for the SPM (requestSPM=TRUE)

Function (method: POST)	/hvs32rest/sendungsdatenAnfrage
MediaType	text/plain
Charset	UTF-8

request parameters

Bold fields must ALWAYS be filled

Field name	Type	Max Length	Decimals	Occupancy
ansprechpartner	String	20	-	Recipient contact person
assoc	Map (String, String)	-	-	Additional field for extra extensions (Key=Field name / Value=Wert)
auftragNr	String	20	-	-
auftraggeberID	String	10	-	Client ID from the HVS32
ausschlussFrachtfuehrer	String	20	-	Exclusion carrier for SPM request
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	-	-
email	String	100	-	For automatic mail notification
empfMobilfunkNr	String	20	-	Mobile phone number of the recipient
faxNr	String	20	-	Recipient's fax number
flexZustellungEmailadResponsese	String	80	-	Flex delivery email address
frachtBrief	String	20	-	Bill of lading number if bill of lading is printed by the upstream system.
frachtfuehrerKdNr	String	10	-	Customer number of the freight payer at the carrier.
frankaturKennung	String	10	-	-
ilnNr	String	20	-	Recipient's ILN (required for Metro shipping)
kostenstelle	String	30	-	-
kundenNr	String	20	-	Customer number of the recipient at the sender
Lagerkennzeichen	String
LieferantenID	String
lieferscheinNr	String	40	-	Is used in the HVS32 as a search number.
neutBIC	String	11	-	Only assigned to neutral senders
neutBankBezeichnung	String	40	-	Only assigned to neutral senders
neutIBAN	String	31	-	Only assigned to neutral senders
neutKontoInhaber	String	40	-	Only assigned to neutral senders
neutabsenderLKZ	String	3	-	Only assigned to neutral senders
neutabsenderName1	String	50	-	Only assigned to neutral senders
neutabsenderName2	String	50	-	Only assigned to neutral senders
neutabsenderName3	String	50	-	Only assigned to neutral senders
neutabsenderOrt	String	50	-	Only assigned to neutral senders
neutabsenderPLZ	String	10	-	Only assigned to neutral senders
neutabsenderStrasse	String	50	-	Only assigned to neutral senders
packStkGes	Integer	-	-	Total number of packages in the shipment
packstueckDaten	Sequence <PackStueckDaten>	-	-	-
packplatz	String	10	-	HVS32 packing station client that is to process the order.
paperlessInvoice	String	1	-	Only in the UPS PaperlessInvoice case (T=PaperlessInvoice / F=not PaperlessInvoice)
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
rechnungsEmpfStrasse	String	50	-	Billing address
rechnungsNr	String	20	-	bill number
requestSPM	String	5	-	T/TRUE if the decision matrix is to be addressed, empty otherwise
sendungsinhalt	String	30	-	-
sonderdienste	String	30	-	Shipping type-specific
sperrFlag	String	1	-	T/F: T=lock, otherwise don't lock
telefonNr	String	20	-	Recipient's 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	-	VAT number of the recipient
versandartID	String	10	-	Shipping type identifier from the HVS32
vorgabeFrachtfuehrer	String	20	-	Default carrier for SPM request
vorpackdatum	String	10	-	TT.MM.JJJJ
wechselbruecke	String	20	-	Swap body that is to be assigned to this package
zahlungsbedingung	String	10	-	'S' = Sender, 'R' = recipient
zbZoll	String	1	-	Terms of payment for customs taxes 'S' = Sender, 'R' = recipient
zielAdrBahnhof	String	30	-	Postal code and city des Bahnhofs
zielAdrLKZ	String	5	-	Country code (LKZ)
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

response parameters

Field name	Type	Max Length	Decimals	Occupancy
fehler	String	-	-	Is filled in the event of an error
sendungsGebuehr	Decimal	18	2	freight charges
sendungsGebuehrWaehrung	String	3	-	Freight costs ISO currency code
versandSendungsNr	String	20	-	tracking number

Packstückdaten

Field name	Type	Max Length	Decimals
assoc	Map (String, String)	-	-	Additional field for extra extensions (Key=Field name / Value=Wert)
ausgangDateTime	Calendar	10	-	Date when the label was sent to the carrier (DD.MM.YYYY)
ausgangDateTimeString	String	10	-	Date when the label was sent to the carrier (DD.MM.YYYY)
druckDateTime	Calendar	19	-	Date when the label was printed in HVS32 (DD.MM.YYYY HH:mm:SS)
druckDateTimeString	String	19	-	Date when the label was printed in HVS32 (DD.MM.YYYY HH:mm:SS)
etikettDaten	String	-	-	Label binary data
etikettName	String	-	-	Label template name
fehlercode	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 charges
gebuehrWaehrung	String	3	-	Freight costs ISO currency code
packstueckID	String	20	-	PackstueckID from the request
retourTrackingNr	String	50	-	Parcel number for the return
trackingNr	String	35	-	package number
trackingURL	String	255	-	URL of the tracking link for shipment tracking
zusatzEtikettenDaten	Map (String, String)	-	-	Name and binary data of the additional labels as key/value map
zusatzfeld1	String	200	-	Additional field - can optionally be mapped in the HVS32 to report back additional information
zusatzfeld2	String	200	-	Additional field - can optionally be mapped in the HVS32 to report back additional information
zusatzfeld3	String	200	-	Additional field - can optionally be mapped in the HVS32 to report back additional information
zusatzfeld4	String	200	-	Additional field - can optionally be mapped in the HVS32 to report back additional information
zusatzfeld5	String	200	-	Additional field - can optionally be mapped in the HVS32 to report back additional information
zusatzfeld6	String	200	-	Additional field - can optionally be mapped in the HVS32 to report back additional information
zusatzfeld7	String	200	-	Additional field - can optionally be mapped in the HVS32 to report back additional information
zusatzfeld8	String	200	-	Additional field - can optionally be mapped in the HVS32 to report back additional information
zusatzfeld9	String	200	-	Additional field - can optionally be mapped in the HVS32 to report back additional information
zusatzfeld10	String	200	-	Additional field - can optionally be mapped in the HVS32 to report back additional information

Examples

Request

{
	"ansprechpartner": "",
	"assoc": {
		"":""
	},
	"auftragNr": "",
	"auftraggeberID": "",
	"ausschlussFrachtfuehrer": "",
	"avisHinweis1": "",
	"avisHinweis2": "",
	"avisZusatz1": "",
	"avisZusatz2": "",
	"bestellNr": "",
	"email": "",
	"empfMobilfunkNr": "",
	"faxNr": "",
	"flexZustellungEmailadResponsese": "",
	"frachtBrief": "",
	"frachtfuehrerKdNr": "",
	"frankaturKennung": "",
	"ilnNr": "",
	"kostenstelle": "",
	"kundenNr": "",
	"Lagerkennzeichen": 0,
	"LieferantenID": 0,
	"lieferscheinNr": "",
	"neutBIC": "",
	"neutBankBezeichnung": "",
	"neutIBAN": "",
	"neutKontoInhaber": "",
	"neutabsenderLKZ": "",
	"neutabsenderName1": "",
	"neutabsenderName2": "",
	"neutabsenderName3": "",
	"neutabsenderOrt": "",
	"neutabsenderPLZ": "",
	"neutabsenderStrasse": "",
	"packStkGes": 0,
	"packStueckDaten": [
		{
			"anzahlArtikel": 0,
			"assoc": {
				"":""
			},
			"artikelDaten": [
				{
					"anzahlBuegel": 0,
					"anzahlPosEtiketten": 0,
					"artikelBTNNr": "",
					"artikelEAN": "",
					"artikelEinheit": "",
					"artikelGewicht": 0,
					"artikelGruppe": "",
					"artikelMenge": 0,
					"artikelServices": "",
					"artikelSollMenge": 0,
					"artikelText1": "",
					"artikelText2": "",
					"artikelText3": "",
					"artikelText4": "",
					"artikelVolumen": 0,
					"artikelWaehrung": "",
					"artikelWert": 0,
					"chargeFlag": "",
					"kundenArtikelNr": "",
					"kundenBestellNr": "",
					"posAuftragNr": "",
					"posLieferNr": "",
					"positionNr": "",
					"serienNr": "",
					"ursprungLand": ""
				}
			],
			"barcodeID": "",
			"barcodeText": "",
			"barcodeTyp": "",
			"druckername": "",
			"gefahrgut": [
				{
					"gefahrgutBefoerdKat": 0,
					"gefahrgutBegrenzteMenge": "",
					"gefahrgutBezeichnung": "",
					"gefahrgutBuchst640": "",
					"gefahrgutFFCode": "",
					"gefahrgutFaktor": 0,
					"gefahrgutFreigestMenge": "",
					"gefahrgutKCode": "",
					"gefahrgutKlasse": "",
					"gefahrgutMenge": 0,
					"gefahrgutMengenEinheit": "",
					"gefahrgutNebenGefahr": "",
					"gefahrgutNettoExplMasse": 0,
					"gefahrgutTunnelBCode": "",
					"gefahrgutUNNR": "",
					"gefahrgutUmweltGef": "",
					"gefahrgutVPG": "",
					"gefahrgutVerpAnzahl": 0,
					"gefahrgutVerpackungsart": ""
				}
			],
			"gewicht": 0,
			"hostTrackingNr": "",
			"infotext1": "",
			"infotext10": "",
			"infotext2": "",
			"infotext3": "",
			"infotext4": "",
			"infotext5": "",
			"infotext6": "",
			"infotext7": "",
			"infotext8": "",
			"infotext9": "",
			"letztesPackstueck": "",
			"cash on delivery ": 0,
			"Net weight": 0,
			"nnVermerk": "",
			"nnVerwendung": "",
			"nnWaehrung": "",
			"packStkNr": 0,
			"packstueckBreite": 0,
			"packstueckHoehe": 0,
			"packstueckID": "",
			"packstueckLaenge": 0,
			"verpackungsart": "",
			"insurance value": 0,
			"vwWaehrung": "",
			"Value of goods ": 0,
			"wwWaehrung": ""
		}
	],
	"packplatz": "",
	"paperlessInvoice": "",
	"postLeitcode": "",
	"postZielFrachtzent": "",
	"rechnungsEmpfLKZ": "",
	"rechnungsEmpfName1": "",
	"rechnungsEmpfName2": "",
	"rechnungsEmpfName3": "",
	"rechnungsEmpfOrt": "",
	"rechnungsEmpfPLZ": "",
	"rechnungsEmpfStrasse": "",
	"rechnungsNr": "",
	"RequestuestSPM": "",
	"sendungsinhalt": "",
	"sonderdienste": "",
	"sperrFlag": "",
	"telefonNr": "",
	"terminArt": "",
	"terminDatum": "",
	"terminZeit": "",
	"ustIDNr": "",
	"versandartID": "",
	"vorgabeFrachtfuehrer": "",
	"vorpackdatum": "",
	"wechselbruecke": "",
	"zahlungsbedingung": "",
	"zbZoll": "",
	"zielAdrBahnhof": "",
	"zielAdrLKZ": "",
	"zielAdrName1": "",
	"zielAdrName2": "",
	"zielAdrName3": "",
	"zielAdrName4": "",
	"zielAdrOrt": "",
	"zielAdrPLZ": "",
	"zielAdrRegion": "",
	"zielAdrStrasse": ""
}

Response

{
	"versandSendungsNr": "",
	"sendungsGebuehrWaehrung": "",
	"fehler": "",
	"packStueckDaten": [
		{
			"assoc": {
				"":""
			},
			"packstueckID": "",
			"trackingNr": "",
			"retourTrackingNr": "",
			"druckDateTime": "",
			"gebuehrWaehrung": "",
			"fehlertext1": "",
			"fehlertext2": "",
			"etikettName": "",
			"etikettDaten": "",
			"zusatzEtikettenDaten": {
				"": ""
			},
			"trackingURL": "",
			"zusatzfeld1": "",
			"zusatzfeld2": "",
			"zusatzfeld3": "",
			"zusatzfeld4": "",
			"zusatzfeld5": "",
			"zusatzfeld6": "",
			"zusatzfeld7": "",
			"zusatzfeld8": "",
			"zusatzfeld9": "",
			"zusatzfeld10": "",
			"ausgangDateTime": ""
		}
	]
}

Examples

All JSON examples can also be found here: REST SERVER JSON Examples