Introduction

Welcome to the ParcelPakket Shipping REST API Developers Guide. This guide provides the information you need to begin using ParcelPakket Developer APIs.

ParcelPakket APIs offer a fast and convenient way to access ParcelPakket shipping services information using the REST API. With these Developer APIs, ParcelPakket lets you easily incorporate ParcelPakket technology in your own applications or your own website. Your users running your applications or visiting your website can have up-to-the-minute access to ParcelPakket shipping services.

Business Process and Rules

  • When registering for the Shipping API, a customer must either have an existing account or open a new account.
  • Customer address is printed for ShipFromAddress on the label. Address Line 1, 2 and 3 will be printed on the label for the ShipTo Address if provided in the request.

Required Steps to Integrating REST API

The required steps for integrating the ParcelPakket REST API are listed here for ParcelPakket Web Services.

Parcel Pakket Web Services

Details for accessing ParcelPakket Developer API Web Services are defined within Web Service Definition Language (WSDL) files that are part of the ParcelPakket Developer Kit (Under Development). Most modern development environments include support for automatically importing WSDL files and generating skeleton code to access the services. Although the specific details depend on the particular development environment, the general procedure is as follows.

  • Review the ParcelPakket Technology agreement. This agreement requires that you follow certain procedures and practices in using ParcelPakket Developer API Web Services.
  • Add your functionality specific to your application and/or website to the Skelton code.
  • Test your application and/or website using the designated ParcelPakket staging environment.
  • Review your application with ParcelPakket.
  • Deploy your application for your customer.

Planning Your Application For Web Services

Planning is a key part of any successful development activity, and ParcelPakket Web Service applications are no exception . This section helps that planning by describing the important activities of any ParcelPakket application project. It provides an overview of the steps required to develop application, and it describes key factors and choices necessary to deploy those applications.

Web Service Application

Many different types of applications can take advantage of Web Services. Those application types include dedicated desktop applications, databases, and web applications. The only essential requirement for all of These applications are that they must have access to the internet.

Developing Web Services Client

The ParcelPakket Developer API Web Service relies on standard Web Services technology that is supported by a wide variety of software development platforms. Those platforms may vary from pure open source environment such as Apache to commercial products from vendors such as Microsoft. Other development tools that support Web Services development include BEA WebLogic, Sun s NetBeans, and products from both major systems vendors including IBM and Hewlett-Packard and smaller, specialized vendors such as Altova, Cape, and Clear. Many non- traditional environments such as Microsoft Office and Adobe Acrobat also include support for Web Services.

Web Services development relies on a technology known as Web Services Definition Language (WSDL). This technology is a formal language based on the Extensible Markup Language (XML). WSDL precisely and completely describes Web Services, and standard Web Services documents themselves by publishing one or more WSDL files.

Parcel Pakket API Technologies For Web Services

Web Services are powerful technologies that let business applications in different enterprises communicate directly with each other. For example, a software application program that processes orders for a mail order retailer can use Web Services to communicate with software applications at ParcelPakket that automatically schedule the shipment for new orders.

Web Services are governed by standards bodies which include, but are not limited to, W3C and OASIS. They are not limited to particular vendors and are available to any software application. Applications created for one environment (such as Microsoft Windows) can seamlessly communicate with applications in a different environment (such as Linux) without worrying about incompatibility of the different environments.

Web Services are supported by a wide variety of software development environments, so virtually all software developers can easily add Web Services features to their applications.

In effect, Web Services create a World Wide Web, but for computer applications instead of people. With Web Services, communications between enterprises happens rapidly, efficiently, and reliably.

Understanding The Parcel Pakket Shipping API

This section provides an overview of the ParcelPakket Shipping Web Services. It describes the services available through the ParcelPakket Shipping API, and it explains at an overview level how the API operates.

What Parcel Pakket Shipping API Can Do

The ParcelPakket API makes ParcelPakket Shipping Web Services available to client applications that communicate with ParcelPakket using the Internet. With the ParcelPakket Shipping API, applications can prepare or schedule shipments, manage returns, or cancel previously scheduled shipments.

Shipments

Shipping Web Services give your applications many ways to manage the shipment of small packages to their destination. ParcelPakket offers a range of delivery time frames from same day to standard ground transportation. Shipments may be within the Europe or international, and they may range from letter documents to large packages.

ParcelPakket also supports many valued added services for shipments, including collect on delivery (COD), declared value, delivery confirmation, and automatic notification of delivery status and many more.

Development URL:
https://test.dpost.be/Api/post
Producton URL:
https://www.dpost.be/Api/post

Add Shipment

Shipment Operation

Type: Request-Response (Client sends a request to ParcelPakket and the ParcelPakket server replies with a response.

Parameter Required Type(Length) Description
username Yes String(20) Customer username provided by ParcelPakket
password Yes String(20) Customer password provided by Parcelpakket
weight Yes Float(5,3) Weight of package (in KG or G)
quantity Yes Int(4) No of parcel
shipto Yes String(100) Name of receiver
contact Optional String(100) Contact Person
street Yes String(100) Street of receiver
streetno Optional String(20) House number
address1 Optional String(100) Additional Address
address2 Optional String(100) Address 2(Street 2)
postalcode Yes String(8) Postal code Length is depend on ship to country
city Yes String(50) Ship to city name
countrycode Yes String(2) Ship to country code: NL => Netherlands, BE => Belgium
phone Optional String(20) Ship to phone number
email Optional String(100) Ship to email address
eori_no Optional String(100) EORI Number for Receiver
Validate Here
servicecode Yes Alphanumeric (4) A => Home Delivery B => Business Delivery Ex. A30 (A is Home Delivery and 30 is Additional Service) If you don t want any additional service then Servicecode is (A)
reference Optional String (17) Shipment reference number
cod_price Optional Float (10,2) Shipment COD Price
emailnotification Optional Int (1) Email Notification by default 1
SenderCode Optional String (5) Sender code in case you want another sender address on label
labeltype Optional String (3) Label type like PDF if wants Complete label data in base 64 Encoded.
weightstandard Optional String (3) Unit of Weight G- for Gram and KG or blank for kilogram
parcel_shop Optional String (250) This is shop details Encoded in Json format. Make sure this value you can get from Parcelshop finder under tag
Custom Declaration Available Parameters (Mandatory for outside EU)
goods_type Optional String (1) Default: C
Available Options:-
C: Commercial
G: Gift
D: Documents
Provide multiple value with pipe(|) seperated.
Example: D|G|C
goods_description Optional String (200) Default: Printed Matter
Provide multiple value with pipe(|) seperated.
Example: Legal Paper|T-shirts|Auto Parts
goods_sku Optional String (4) Provide multiple value with pipe(|) seperated.
Example: 11AC|22AS|36YT
price Optional Float (8,2) Default: 5
Provide multiple value with pipe(|) seperated.
Example: 100.50|250.25|360.75
currency Optional String (3) Currency code of CN-22,CN-23
goods_quantity Optional Int (4) Provide multiple value with pipe(|) seperated.
Example: 1234|5678|9012
goods_weight Optional Float (5,1) Provide multiple value with pipe(|) seperated.
Example: 159.5|854.3|58965.5
origin_cncode Optional String (2) Provide multiple value with pipe(|) seperated.
Example: NL|DE|IN
hs_code Optional String (30) Provide multiple value with pipe(|) seperated.
Example: 70123900|10029000|70023900
Lookup HS Code
Parcel Dimension
length Optional Integer (3) Parcel length should be in centimeter (cm)
width Optional Integer (3) Parcel width should be in centimeter (cm)
height Optional Integer (3) Parcel height should be in centimeter (cm)
EORI / BTW Number
sname Optional String (30) Sender Name
saddress1 Optional String (30) Sender Address 1
saddress2 Optional String (30) Sender Address 2
scity Optional String (30) Sender City
szipcode Optional String (10) Sender ZIP Code
scountrycode Optional String (2) Sender Country 2-Digit Code
seori_no Optional String (30) Sender EORI Number
customer_btw_number Optional String (30) Customer BTW Number
customer_eori_number Optional String (30) Customer EORI Number
customer_eori_number_gb Optional String (30) Customer EORI Number (For GB)

Errors

The Logic Parcel API uses the following error codes:

Error Code Meaning
Username Please assign username!
Password Please assign password!
InvalidUser Couldnrsquo;t find any users!
WeightEmpty Please assign weight value!
WeightLowerLimit Please assign weight value must be greater than 0!
WeightHigherLimit Please assign weight value in number and not more than 2 digits!
QuantityEmpty Please assign quantity value!
QuantityLowerLimt Please assign quantity must be greater than or equal to 1!
QuantityHigherLimit Please assign quantity only in number and not more than 3 digits!
ReceiverName Please assign receiver name!
Street Please assign street name!
PostalCode Please assign postal code!
City Please assign city name!
CountryCode Please assign valid ISO country code!
PhoneEmpty Please assign phone number!
PhoneInvalid Please assign valid phone number!
EmailEmpty Please assign email!
EmailInvalid Please assign valid email id!
ServiceCode Please assign valid service code!
CountryError No Service for this Country
PostalCodeError Invalid Postal Code!
PermissionError You have not privilege for this country!
AdditionalServiceError Invalid Additional Service Code!
AdditionalServiceCodeError Invalid Service Code!
Example request:

Array
(
    [username] = test
    [password] = test
    [weight] = 1.00
    [quantity] = 1
    [shipto] = Receiver Name
    [contact] = 
    [street] = Street
    [streetno] = 37
    [address1] =
    [address2] =
    [postalcode] = 7532SN
    [city] = Test City
    [countrycode] = NL
    [phone] = 06-12345
    [email] = 
    [eori_no] = NL812095972
    [servicecode] = A
    [reference] = ReferenceNumber
    [goods_type] = D
    [goods_description] = Printed Material
	[goods_sku] = 11AC
    [price] = 250.25
    [currency] = EUR
	[goods_quantity] = 1234
	[goods_weight] = 159.5
    [origin_cncode] = NL
	[hs_code] = 70123900
	[emailnotification] = 1
    [SenderCode] = SA581
    [labeltype] = PDF
    [weightstandard] = G
    [parcel_shop] ={"parcelShopId":245509,"company":" MEESTERLIJKE KOFFIETHEE","street":"Drienerstraat","houseNo":"28","state":"","zipCode":"7551HH","city":"Hengelo","dista
			nce":"1.53","fid":32,"shop_type":1}
  
)

Example response:

    <?xml version="1.0" encoding="UTF-8"?>
	<xml>
		<Success>
			<SuccessMessage>MESSAGE: Shipment has created
		successfully.....</SuccessMessage>
			<Forwarder> FORWARDER: DPD</Forwarder>
			<TrackingDetails>
				<ParcelNumber>PARCEL NUMBER :01447011247059</ParcelNumber>
				<Barcode>BARCODE :%004085101447011247059327276</Barcode>
				<TrackingURL>TRACKING URL: https://www.dpost.be/ParceItracking/tracking/tocken/4Tn5MvY8pJA
				</TrackingURL>
				<LocalTrackingURL>LOCAL TRACKING URL: http://tracking.dpd.de/cgi-bin/delistrack?typ=2lang=depknr=01447011247059</LocalTrackingURL>
			</TrackingDetails>
			<LabelURL> LABEL URL:
			https://www.dpost.be/IabeIs/DPD/pdf/parceI_13O9434O33.pdf
			</LabelURL>
		</Success>
	</xml>

Edit Shipment

Shipment Operation

Type: Request-Response (Client sends a request to ParcelPakket and the ParcelPakket server replies with a response.

Parameter Required Type(Length) Description
username Yes String(20) Client user name
password Yes String(20) Client password
ActionCode Yes String (10) Value should be Edit
ParcelNumber Yes String (50) Parcel number which you want to edit
weight Yes Int (10) Weight of package
quantity Yes Int(4) No of quantity
shipto Yes String(100) Name of receiver
contact Optional String(100) Contact Person
street Yes String(100) Street address print on label
streetno Optional String(20) Street number print on label
address1 Optional String(100) Additional information of ship to address
address2 Optional String(100) Additional address information
postalcode Yes String(8) Postal code Length is depend on ship to country
city Yes String(50) Ship to city name
countrycode Yes String(2) Ship to country code: NL => Netherlands, BE => Belgium
phone Optional String(20) Ship to phone number
email Optional String(100) Ship to email address
eori_no Optional String(100) EORI Number for Receiver
Validate Here
servicecode Yes Alphanumeric (4) A => Home Delivery B => Business Delivery Ex. A30 (A is Home Delivery and 30 is Additional Service) If you don t want any additional service then Servicecode is (A)
reference Optional String (17) Shipment reference number
cod_price Optional Float (10,2) Shipment COD Price
emailnotification Optional Int (1) Email Notification by default 1
SenderCode Optional String (5) Sender code in case you want another sender address on label
labeltype Optional String (250) Label type like PDF if wants complete label data.
weightstandard Optional String (3) Unit of Weight G- for Gram and KG or blank for kilogram
parcel_shop Optional String (250) This is shop details Encoded in Json format. Make sure this value you can get from Parcelshop finder under tag
Custom Declaration Available Parameters (Mandatory for outside EU)
goods_type Optional String (1) Default: C
Available Options:-
C: Commercial
G: Gift
D: Documents
Provide multiple value with pipe(|) seperated.
Example: D|G|C
goods_description Optional String (200) Default: Printed Matter
Provide multiple value with pipe(|) seperated.
Example: Legal Paper|T-shirts|Auto Parts
goods_sku Optional String (4) Provide multiple value with pipe(|) seperated.
Example: 11AC|22AS|36YT
price Optional Float (8,2) Default: 5
Provide multiple value with pipe(|) seperated.
Example: 100.50|250.25|360.75
currency Optional String (3) Currency code of CN-22,CN-23
goods_quantity Optional Int (4) Provide multiple value with pipe(|) seperated.
Example: 1234|5678|9012
goods_weight Optional Float (5,1) Provide multiple value with pipe(|) seperated.
Example: 159.5|854.3|58965.5
origin_cncode Optional String (2) Provide multiple value with pipe(|) seperated.
Example: NL|DE|IN
hs_code Optional String (30) Provide multiple value with pipe(|) seperated.
Example: 70123900|10029000|70023900
Lookup HS Code

Errors

The Logic Parcel API uses the following error codes:

Error Code Meaning
Username Please assign username!
Password Please assign password!
InvalidUser Couldnrsquo;t find any users!
WeightEmpty Please assign weight value!
WeightLowerLimit Please assign weight value must be greater than 0!
WeightHigherLimit Please assign weight value in number and not more than 2 digits!
QuantityEmpty Please assign quantity value!
QuantityLowerLimt Please assign quantity must be greater than or equal to 1!
QuantityHigherLimit Please assign quantity only in number and not more than 3 digits!
ReceiverName Please assign receiver name!
Street Please assign street name!
PostalCode Please assign postal code!
City Please assign city name!
CountryCode Please assign valid ISO country code!
PhoneEmpty Please assign phone number!
PhoneInvalid Please assign valid phone number!
EmailEmpty Please assign email!
EmailInvalid Please assign valid email id!
ServiceCode Please assign valid service code!
CountryError No Service for this Country
PostalCodeError Invalid Postal Code!
PermissionError You have not privilege for this country!
AdditionalServiceError Invalid Additional Service Code!
AdditionalServiceCodeError Invalid Service Code!
Status Invalid Action
ParcelEmpty Please assign Parcel Number!
ParcelNumberError Please assign Valid Parcel Number!
ParcelCheckinError Parcel Has Already Check-In!
Example request:

Array
(
    [username] =test
    [password] =test
    [weight] =1.00
    [quantity] =1
    [shipto] =Receiver Name
    [contact] = 
    [street] =Street
    [streetno] =37
    [address1] =
    [address2] =
    [postalcode] =7532SN
    [city] =Test City
    [countrycode] =NL
    [phone] =06-12345
    [email] = 
    [eori_no] = NL812095972
    [servicecode] = A
    [reference] = ReferenceNumber
    [goods_type] = D
    [goods_description] = Printed Material
	[goods_sku] = 11AC
    [price] = 250.25
    [currency] = EUR
	[goods_quantity] = 1234
	[goods_weight] = 159.5
    [origin_cncode] = NL
	[hs_code] = 70123900
    [emailnotification] = 1
    [SenderCode] = SA581
    [labeltype] = PDF
    [weightstandard] = G
    [parcel_shop] ={"parcelShopId":245509,"company":" MEESTERLIJKE KOFFIE
			THEE","street":"Drienerstraat","houseNo":"28","state":"","zipCode":"7551HH","city":"Hengelo","dista
			nce":"1.53","fid":32,"shop_type":1}
    [ActionCode] = Edit
    [ParcelNumber] = 05128006185646
)

Example response:

    <?xml version="1.0" encoding="UTF-8"?>
	<xml>
		<success>
			<successmessage>MESSAGE: Shipment has edited
			successfully.....</successmessage>
			<forwarder>FORWARDER: DPD</forwarder>
			<trackingdetaiis>
				<parceinumber>PARCEL NUMBER :05128002869303</parceinumber>
				<trackingurl>TRACKING URL:
				https://www.dpost.be/ParceItracking/tracking/barcode_id/4Tn5a1FeXxDKIVM9cq
				- JvNwgAND_NH_ae34kMvY8pJA
				</trackingurl>
			</trackingdetaiis>
			<labeiurl>LABEL URL:
			https://www.dpost.be/IabeIs/DPD/pdf/parceI_13O9434O33.pdf
			</labeiurl>
			<labei>jMKMyAwIG9iago8PC9UeXBIIC9QYWdICi9QYXJIbnQgMSAwIFIKL1JIc291cmNIcyAyID
			AgUgovQ29udGVudHMgNCAwIFI+PgpIbmRvYmoKNCAwIG9iago8PC9GaWxOZXIgLOZsYX
			RIRGVjb2RIIC9MZW5ndGggOTg5Pj4Kc3RyZWFtCnicIVhNb9xGDL37V/CYBIhmyPk+Jk7Tp
			kDXdiOUSG6uIycO1I1O7SLovy81Oi7UoHpKLrtYPfPNDDI8j7LSL2eOY6Yv9qXFvpSLp6CFY
			EtnkOiTdDI6ujQO/XZq45evBEq7Bx1d/RjNzxxwy8ZPjbtc</labei>
		</success>
	</xml>

Delete Shipment

Shipment Operation

Type: Request-Response (Client sends a request to ParcelPakket and the ParcelPakket server replies with a response.

Parameter Required Type(Length) Description
username Yes String(20) Client user name
password Yes String(20) Client password
ActionCode Yes String(10) Value should be Delete
ParcelNumber Yes String(50) Parcel number which you want to Delete

Errors

The Logic Parcel API uses the following error codes:

Code Message Description
Username Please assign username!
Password Please assign password!
InvalidUser Couldnrsquo;t find any users!
Status Invalid Action
ParcelEmpty Please assign Parcel Number!
ParcelNumberError Please assign Valid Parcel Number!
ParcelCheckInError Parcel Has Already Check-In!
Example request:

Array
(
    [username] =test
    [password] =test
    [ActionCode] =Delete
    [ParcelNumber] =05128006185646
)

Example response:

    <?xml version="1.0" encoding="UTF-8"?>
	<xml>
		<success>
			<successmessage>MESSAGE: Shipment has deleted
			successfully.....</successmessage>
		</success>
	</xml>

Sender Code Lists

Shipment Operation

Type: Request-Response (Client sends a request to ParcelPakket and the ParcelPakket server replies with a response.

Parameter Required Type(Length) Description
username Yes String(20) Client user name
password Yes String(20) Client password
ActionCode Yes String(20) Value should be "SenderCodeList"

Errors

The Logic Parcel API uses the following error codes:

Code Message Description
Username Please assign username!
Password Please assign password!
InvalidUser Couldnrsquo;t find any users!
Status Invalid Action
Error There is no sender address!
Example request:

Array
(
    [username] =test
    [password] =test
    [ActionCode] =SenderCodeList
)

Example response:

	<?xml version="1.0" encoding="UTF-8"?>
	<xml>
		<code>
			<sendercode>SA998</sendercode>
			<sendername>Test Company</sendername>
			<senderaddress>Test Street 11 AA</senderaddress>
			<senderpostcode>1032MX</senderpostcode>
			<sendercity>Test City</sendercity>
			<sendercountry>Denmark</sendercountry>
		</code>
		<code>
			<sendercode>SA998</sendercode>
			<sendername>Test Company</sendername>
			<senderaddress>Test Street 11 AA</senderaddress>
			<senderpostcode>1032MX</senderpostcode>
			<sendercity>Test City</sendercity>
			<sendercountry>United Kingdom</sendercountry>
		</code>
	</xml>

Daily Parcel Status

Type: Request-Response (Client sends a request to ParcelPakket and the ParcelPakket server replies with a response.

Parameter Required Type(Length) Description
username Yes String(20) Client user name
password Yes String(20) Client password
ActionCode Yes String(10) Value should be parcelstatus

Errors

The Logic Parcel API uses the following error codes:

Code Message Description
Username Please assign username!
Password Please assign password!
InvalidUser Couldnrsquo;t find any users!
Status Invalid Action
Error There Is no Parcel(s) Updates Today!
Example request:

Array
(
    [username] =test
    [password] =test
    [ActionCode] =parcelstatus
)

Example response:

	<?xml version="1.0" encoding="UTF-8"?>
	<xml>
		<success>
		<successmessage>OK</successmessage>
		<dailystatus>
			<statusdetail>
				<sendername>sjmsoftech</sendername>
				<senderstreet>Moti Nagar</senderstreet>
				<senderaddress></senderaddress>
				<senderpostalcode>110082</senderpostalcode>
				<sendercity>New Delhi</sendercity>
				<sendercountryname>India</sendercountryname>
				<receivername>SJM Developer</receivername>
				<receiverstreet>Euregioweg</receiverstreet>
				<receiverstreetno.></receiverstreetno.>
				<receiveraddress> </receiveraddress>
				<receiverpostalcode>7532SN</receiverpostalcode>
				<receivercity>ENSCHEDE</receivercity>
				<receivercountry>Netherlands</receivercountry>
				<createdate>March 03-2014, 12:48</createdate>
				<checkindate>March 03-2014, 01:02</checkindate>
				<weight>1.00</weight>
				<service>Home Delivery</service>
				<referencenumber>SiM486368SiM</referencenumber>
				<forwarder>DPD</forwarder>
				<barcode>05128005354276</barcode>
				<createdby>Parcel Pakket</createdby>
				<createdip>182.74.157.249</createdip>
				<checked-inby>Parcel Pakket</checked-inby>
				<checked-inip>182.74.157.249</checked-inip>
				<errorname>Wrong Address</errorname>
				<assignby>Parcel Pakket</assignby>
				<assignip>182.74.157.249</assignip>
				<assigndate>16-06-2014</assigndate>
				<deliverydate></deliverydate>
				<cod></cod>
			</statusdetail>
		</dailystatus>
	</success>
</xml>

Shipment History Lists

Type: Request-Response (Client sends a request to ParcelPakket and the ParcelPakket server replies with a response.

Parameter Required Type(Length) Description
username Yes String(20) Client user name
password Yes String(20) Client password
ActionCode Yes String(10) Value should be checkinshipment

Errors

The Logic Parcel API uses the following error codes:

Code Message Description
Username Please assign username!
Password Please assign password!
InvalidUser Couldnrsquo;t find any users!
Status Invalid Action
Error There Is no History of Shipment(s)!
Example request:

Array
(
    [username] =test
    [password] =test
    [ActionCode] =checkinshipment
)

Example response:

	<?xml version="1.0" encoding="UTF-8"?>
	<xml>
		<success>
			<successmessage>OK</successmessage>
			<shipmenthistory>
				<parcel>
					<parcelnumber>11500000020000806883019452</parcelnumber>
					<weight>1.00</weight>
					<quanityt>1</quanityt>
					<forwarder>DPDAT</forwarder>
					<service>Home Delivery</service>
					<destinationcountry>France</destinationcountry>
					<reference>SJM485591SKA</reference>
					<receivername>SKALOUD HELMUTH</receivername>
					<street>Euregioweg</street>
					<housenumber>3</housenumber>
<address></address>
					<postcode>75018</postcode>
					<city>Paris</city>
					<sendername>sjmsoftech</sendername>
					<senderpostcode>110082</senderpostcode>
					<sendercity>New Delhi</sendercity>
					<sendercountry>India</sendercountry>
					<localbarcode>123456</localbarcode>
					<deliverydate>16-06-2014</deliverydate>
					<receivedby>HELMUTH</receivedby>
				</parcel>
			</shipmenthistory>
		</success>
	</xml>	

New Shipment Lists

Type: Request-Response (Client sends a request to ParcelPakket and the ParcelPakket server replies with a response.

Parameter Required Type(Length) Description
username Yes String(20) Client user name
password Yes String(20) Client password
ActionCode Yes String(10) Value should be newshipment

Errors

The Logic Parcel API uses the following error codes:

Code Message Description
Username Please assign username!
Password Please assign password!
InvalidUser Couldnrsquo;t find any users!
Status Invalid Action
Error There Is no new Shipment(s)!
Example request:

Array
(
    [username] =test
    [password] =test
    [ActionCode] =newshipment
)

Example response:

	<?xml version="1.0" encoding="UTF-8"?>
	<xml>
		<success>
			<successmessage>OK</successmessage>
			<newshipment>
				<parcel>
					<parcelnumber>75560043011684</parcelnumber>
					<weight>1.00</weight>
					<quanityt>1</quanityt>
					<forwarder>GLS NL</forwarder>
					<service>Home Delivery</service>
					<destinationcountry>Netherlands</destinationcountry>
					<reference>SJM485640SKA</reference>
					<receivername>SKALOUD HELMUTH</receivername>
					<street>Euregioweg</street>
					<housenumber>4</housenumber>
<address>Netherlands</address>
					<postcode>7532SN</postcode>
					<city>ENSCHEDE</city>
					<sendername>sjmsoftech</sendername>
					<senderpostcode>110082</senderpostcode>
					<sendercity>New Delhi</sendercity>
					<sendercountry>India</sendercountry>
				</parcel>
			</newshipment>
		</success>
	</xml>

Parcel Tracking

Type: Request-Response (Client sends a request to ParcelPakket and the ParcelPakket server replies with a response.

Parameter Required Type(Length) Description
username Yes String(20) Client user name
password Yes String(20) Client password
ActionCode Yes String(10) Value should be tracking
ParcelNumber Yes String(50) Parcel number which you want Track

Errors

The Logic Parcel API uses the following error codes:

Code Message Description
Username Please assign username!
Password Please assign password!
InvalidUser Couldnrsquo;t find any users!
Status Invalid Action
Error Invalid parcel Number

Tracking Events List

Event Code Event Description
Example request:

Array
(
    [username] =test
    [password] =test
    [ActionCode] =tracking
    [ParcelNumber] =05128006185646
)

Example response:

	<?xml version="1.0" encoding="UTF-8"?>
	<xml>
    	<Success>
        	<SuccessMessage>OK</SuccessMessage>
            <Result>
            	<track>
                	<location>Wessem (NL)</location>
                    <statuscode>PS048</statuscode>
                    <status>Parcel Added</status>
                    <updatedon>2020-03-11 15:49:55</updatedon>
                </track>
                <track>
                	<location>Wessem (NL)</location>
                    <statuscode>PS049</statuscode>
                    <status>Label Generated</status>
                    <updatedon>2020-03-11 15:49:55</updatedon>
                </track>
                <track>
                	<location>Enschede (NL)</location>
                    <statuscode>PS053</statuscode>
                    <status>Depot Scan</status>
                    <updatedon>2020-03-12 04:02:04</updatedon>
                </track>
                <track>
                	<location>Best (NL)</location>
                    <statuscode>PS026</statuscode>
                    <status>Arrival at HUB</status>
                    <updatedon>2020-03-11 19:15:16</updatedon>
                </track>
                <track>
                	<location>Best (NL)</location>
                    <statuscode>PS046</statuscode>
                    <status>In-Transit</status>
                    <updatedon>2020-03-11 19:15:16</updatedon>
                </track>
                <track>
                	<location>Tynaarlo (NL)</location>
                    <statuscode>PS007</statuscode>
                    <status>Out for delivery</status>
                    <updatedon>2020-03-12 06:51:41</updatedon>
                </track>
                	<track><location>Tynaarlo (NL)</location>
                    <statuscode>PS003</statuscode>
                    <status>Delivered</status>
                    <updatedon>2020-03-12 10:27:05</updatedon>
                </track>
            </Result>
        </Success>
	</xml>	

Parcelshop Finder

API Endpoints : https://test.dpost.be/Api/parcelsopfinder

Type: This request returns the List of nearest parcelshop for a query postalcode and.

Parameter Required Type(Length) Description
username Yes String(20) Client user name
password Yes String(20) Client password
countrycode Yes String(2) country code
postalcode Yes String(8) Postalcode for which wanted nearest shop.

Errors

The Logic Parcel API uses the following error codes:

Code Message Description
Username Please assign username!
Password Please assign password!
InvalidUser Couldnrsquo;t find any users!
PostalCode Please assign postal code!
CountryCode Please assign valid ISO country code!
Example request:

Array
(
    [username] =test
    [password] =test
    [countrycode] =NL
    [postalcode] =7556AX
)

Example response:

	<?xml version="1.0" encoding="UTF-8"?>
	<xml>
		<success>
			<successmessage>OK</successmessage>
			<result>
				<parcelpoint>
				<parcelshopid>07151057</parcelshopid>
				<company>Parcel.nl </company>
				<street>Slachthuisweg</street>
				<houseno>77</houseno>
				<state />
				<zipcode>7556AX</zipcode>
				<city>Hengelo</city>
				<distance>0.00</distance>
				</parcelpoint>
				<parcel_shop>{"parcelShopId":"07151057","company":"Parcel.nl
				","street":"Slachthuisweg","houseNo":"77","state":"","zipCode":"7556AX","city":"Hengelo","dista
				nce":"0.00","fid":22,"shop_type":4}</parcel_shop>
			</result>
		</success>
	</xml>

Proforma Invoice

Type: Request-Response (Client sends a request to ParcelPakket and the ParcelPakket server replies with a response.

Parameter Required Type(Length) Description
username Yes String(20) Client user name
password Yes String(20) Client password
ActionCode Yes String(20) Value should be proforma_invoice
ParcelNumber Yes String(50) Parcel number which you want Proforma Invoice

Errors

The Logic Parcel API uses the following error codes:

Code Message Description
Username Please assign username!
Password Please assign password!
InvalidUser Couldnrsquo;t find any users!
Status Invalid Action
Error Invalid parcel Number
Example request:

Array
(
    [username] = 'YOUR USERNAME'
    [password] = 'YOUR PASSWORD'
    [ActionCode] = 'proforma_invoice'
    [ParcelNumber] = 'YOUR PARCEL NUMBER'
)

Example response:

<?xml version="1.0" encoding="UTF-8"?>
<xml>
	<Success>
		<SuccessMessage>OK</SuccessMessage>
		<Result>Proforma invoice URL created!</Result>
		<ProformaInvoiceUrl>https://www.dpost.be/private/PERFORMA_INVOICE/Performa_invoice_2021-09_28_15_05_36.pdf</ProformaInvoiceUrl>
	</Success>
</xml>	

Country List

Country ISO 2 Code
Afghanistan AF
African Republic CF
Albania AL
Algeria DZ
American Samoa AS
Andorra AD
Angola AO
Anguilla Al
Antarctica AQ
Arab Emirates AE
Argentina AR
Armenia AM
Aruba AW
Australia AU
Austria AT
Azerbaijan AZ
Atilde;...land AX
Bahamas BS
Bangladesh BD
Barbados BB
Barbuda AG
Belarus BY
Belgium BE
Belize BZ
Benin BJ
Bermuda BM
Bhutan BT
Bolivia BO
Bonaire BQ
Bosnia BA
Botswana BW
Bouvet BV
Brazil BR
Brunei BN
Bulgaria BG
Burkina Faso BF
Burundi BI
Caicos Islands TC
Cambodia KH
Cameroon CM
Canada CA
Cape Verde CV
Cayman Islands KY
Chad TD
Chile CL
China CN
Christmas Island CX
Cocos Islands CC
Colombia CO
Comoros KM
Congo-Brazzavill CG
Congo-Kinshasa CD
Cook Islands CK
Costa Rica CR
Croatia HR
Cuba CU
Curacao Cw
Cyprus CY
Czech Republic CZ
Denmark DK
Djibouti Di
Dominica DM
Dominican Republ DO
East Timor TI
Ecuador EC
Egypt EG
El Salvador SV
EquatorialGuinea GQ
Eritrea ER
Estonia EE
Ethiopia ET
Falkland Islands FK
Faroe Islands FO
Fiji Fi
Finland FI
France FR
French Guyana GF
French Polynesia PF
Gabon GA
Gambia GM
Georgia GE
Germany DE
Ghana GH
Gibraltar GI
Greece GR
Greenland GL
Grenada GD
Guadeloupe GP
Guam GU
Guatemala GT
Guernsey GG
Guinea GN
Guinea-Bissau GW
Guyana GY
Haiti HT
Honduras HN
Hongkong HK
Hungary HU
Iceland Is
India IN
Indonesia ID
Iran IR
Iraq IQ
Ireland IE
Israel IL
Italy IT
Ivory Coast CI
Jamaica JM
Japan Jp
Jersey JE
Jordan JO
Kazakhstan KZ
Kenya KE
Kiribati KI
Kitts and Nevis KN
Kuwait KW
Kyrgyzstan KG
Laos LA
Latvia Lv
Lebanon LB
Lesotho Ls
Liberia LR
Libya LY
Liechtenstein LI
Lithuania LT
Luxembourg L
Macau MO
Macedonia MK
Malagasy MG
Malawi MW
Malaysia MY
Maldives MV
Mali ML
Malta MT
Man IM
Marshall Islands MH
Martinique MQ
Mauritania MR
Mauritius MU
Mayotte YT
Mexico MX
Micronesia FM
Moldova MD
Monaco MC
Mongolia MN
Montenegro ME
Montserrat MS
Morocco MA
Mozambique MZ
Myanmar MM
Namibia NA
Nauru NR
Nepal NP
Netherlands NI
New Caledonia NC
New Zealand NZ
Nicaragua NI
Niger NE
Nigeria NG
Niue NU
NI Antilles AN
Norfolk NF
North Korea KP
Northern Mariana MP
Norway NO
Oman OM
Pacific Islands UM
Pakistan PK
Palau Pw
Palestina PS
Panama PA
Papua New Guinea PG
Paraguay PY
Peru PE
Philippines PH
Pierre Miquelon PM
Pitcairn PN
Poland PL
Portugal PT
Puerto Rico PR
Qatar QA
Reunion RE
Romania RO
Russia RU
Rwanda RW
Saint Lucia LC
Saint-Bartheacute;lemy BL
Saint-Helena SH
Samoa WS
San Marino SM
Sao Tomeacute; ST
Saudi Arabia SA
Senegal SN
Serbia RS
Seychelles SC
Sierra Le
Singapore SG
Slovakia SK
Slovenia SI
Solomon Islands SB
Somalia SO
South Africa ZA
South Georgia GS
South Korea KR
Spain ES
Sri Lanka LK
St. Maarten SX
St. Maarten (FR) MF
Sudan SD
Suriname SR
Svalbard Si
Swaziland SZ
Sweden SE
Switzerland CH
Syria SY
Tadjikistan Ti
Taiwan TW
Tanzania TZ
Thailand TH
Togo TG
Tokelau Islands TK
Tonga TO
TrinidadTobago TT
Tunisia TN
Turkey TR
Turkmenistan TM
Tuvalu TV
U.S. Virgin Isla VI
Uganda UG
Ukraine UA
United Kingdom GB
United States US
Uruguay UY
Uzbekistan UZ
Vanuatu VU
Vatican City VA
Venezuela VE
Vietnam VN
Vincent Grenadin VC
Virgin Islands VG
Wallis Futuna WF
Western Sahara EH
Yemen YE
Zambia ZM
Zimbabwe ZW

Service Code Lists

Service Name Service Code
Home Delivery A
Home Delivery-Parcel.Shop Return C
Home Delivery-Express E
Home Delivery-COD G
Home Delivery-Saturday 17 26
Home Delivery-Saturday 12 25
Home Delivery-Saturday 9 24
Home Delivery-Express 5 23
Home Delivery-Express 12 22
Home Delivery-Express 9 AM 21
Home Delivery-Fragile R
Home Delivery-Parcelletter L
Home Delivery-Po Box Delivery P
Home Delivery-Signature 71
Home Delivery-Priority 72
Home Delivery-Priority Signature 73
Home Delivery-Return H
Home Delivery-Pick Up-Return H1
Home Delivery-Parcel.Shop I
Home Delivery-Sperrgut 13
Home Delivery-Wertpaket W1 15
Home Delivery-Wertpaket W2 12
Home Delivery-Unfrei 14
Home Delivery-Rollenservice 11
Home Delivery-Parcel.Shop COD PC
Business Delivery B
Business Delivery-Signature 74
Business Delivery-Priority 72
Business Delivery-Priority/Signature 73
Business Delivery-Premium BP
Business Delivery-Sperrgut 13
Business Delivery-Wert W1 16
Business Delivery-Wert W2 17
Business Delivery-Unfrei 14
Business Delivery-Rollenservice 11
Business Delivery-Pick Point Delivery C
Business Delivery-Po Box Delivery P
Business Delivery-Fragile R
Business Delivery-Parcelletter L2
Business Delivery-COD G2
Business Delivery-Express E2
Business Delivery-Return Shipment H2
Business Delivery-Parcel.Shop I2
Business Delivery-Saturday 17h E21
Business Delivery-Saturday 12h E22
Business Delivery-Saturday 9h E23
Business Delivery-Express 17h E24
Business Delivery-Express 12h E25
Business Delivery-Express 9h E26
Business Delivery-Parcel.Shop COD PC2
Freight F
Freight-Coli Max 60
Freight-Length 61
Freight-Minipallet 62
Freight-Pallet 63
Freight-Blockpallet 64
Sea Freight S