Shipment service (all products)

Shipment service

The shipment service is used to generate parcel labels. A request to the shipment service will only succeed after a call to the login service to get a unique token to access the shipment service. The token will be valid 24 hours. Please store it for that time.

For other services and products, choose the corresponding topic in the navigation to the right.

When a ShipmentService request is successful, the system will respond with a Base64 string on the <parcellabelsPDF> segment that can be decoded into a PDF with a label as well as the corresponding 14 digit parcel number in the <parcelLabelNumber> segment, which you capture.

• Live: https://wsshipper.dpd.be/soap/WSDL/ShipmentServiceV34.wsdl
• Stage: https://shipperadmintest.dpd.be/PublicApi/soap/WSDL/ShipmentServiceV34…

Important:

• Labels generated on the STAGE environment are not valid and may not be used for live shipments

Request parameters

<authentication> section

Node	Type	Length	Description	Mandatory?
<delisId>	String	6-10	Your Delis ID provided by DPD	Yes
<authToken>	String	128	Authentication token acquired from the login service	Yes
<messageLanguage>	String	5	This can be set to the default value of en_EN	Yes

 

<printOptions> section

Node	Type	Length	Description	Mandatory?
<printerLanguage>	String	3	Whether the label is returned on PDF (base64 code) or directly on ZPL	Yes
<paperFormat>	String	2	A6 or A4, depending whether you want 1 label on one A6 label or 4 labels on one A4 page.	Yes
<dropOffType>	String	5	Determines if your label is QR format, normal format or both. FULL_LABEL= only normal label (default). QR_CODE= only QR label. BOTH= both a normal and QR label are returned. More details in point 16 of this page. Only works with endpoint v3.5 or higher.	No

 

<printer> section

This section is not used and should not be included in the call.

<generalShipmentData> section

Node	Type	Length	Description	Mandatory?
<mpsId>	String	25	The shipment number for consignment data. The shipment number is only accepted if the parcel label number is allocated by customer. It starts with “MPS“, “EXP” or “B2C“, the last eight digits are the date in format yyyyMMdd	No
<mpsCustomerReferenceNumber1>	String	35	Consignment customer reference number 1. Shown on label and included in electronic data, but not shown on label for Collection Requests. This reference is retained in subsequent data flows.	No
<mpsCustomerReferenceNumber2>	String	35	Consignment customer reference number 2. Shown on label and included in electronic data. This reference is retained in subsequent data flows.	No
<mpsCustomerReferenceNumber3>	String	35	Consignment customer reference number 3. Not shown on the label and not retained in subsequent data flows. Use <mpsCustomerReferenceNumber1> or <mpsCustomerReferenceNumber2> if the reference needs to be retained.	No
<mpsCustomerReferenceNumber4>	String	35	Consignment customer reference number 4. Not shown on the label and not retained in subsequent data flows. Use <mpsCustomerReferenceNumber1> or <mpsCustomerReferenceNumber2> if the reference needs to be retained.	No
<sendingDepot>	String	4	DPD Depot you belong to. DPD Can tell you which one to use	Yes
<product>	String	2-14	The type of shipment: – E10 for Express 10h – E12 for Express 12h – E18 for Express 18h Guarantee – B2B MSG option for B2B Predict (service not active by default) – CL for all other shipment types	Yes

<sender> section

This is the consignor of the shipment as it will appear on your label. Please note that not all fields will appear on the label, but regardless of whether they appear on the label or not, they will be included in the electronic data of your shipment if you provide them in the call:

The following fields will appear on the label if provided:

• name1
• name2
• street
• street2
• houseNo
• country
• zipCode
• city
• contact
• phone

Node	Type	Length	Description	Mandatory?
<name1>	String	35	Name of Sender’s address owner	Yes
<name2>	String	35	Second name (or company) of Sender’s address owner	No
<street>	String	35	Street of Sender’s address owner. Note you can add the house number here too.	Yes
<street2>	String	35	Street2 is optional and may not contain street name and house number, only additional information (floor, building, appartment, …)	No
<houseNo>	String	8	House number of Sender’s address owner. Only needed if you didn’t add the houseno in the <street> field	No
<state>	String	2	State of address Sender’s owner in ISO 3166-2 code	No
<country>	String	2	Country of address Sender’s owner in ISO 3166-1 alpha-2 code	Yes
<zipCode>	String	9	Zip code of address Sender’s owner. Please do not add prefixes.	Yes
<city>	String	35	City/town of address Sender’s owner	Yes
<gln>	Long	99	International location number of Sender’s address owner	No
<customerNumber>	String	17	Customer number of Sender’s address owner. If used, it has to be the full 17 char number. Your DPD contact can give you this.	No
<contact>	String	35	Contact person of Sender’s address owner	No
<phone>	String	30	Phone number of Sender’s address owner. Must be format +<country prefix><full number> Ex: +32470123456	No
<fax>	String	30	Fax number of Sender’s address owner.	No
<email>	String	30	Email address of Sender’s address owner. For collection requests the maximum length is 40, otherwise always 50. This has to be a valid email address format.	No
<comment>	String	70	Comment on Sender’s address owner. This is a free field.	No
<iaccount>	n/a	n/a	Not used, do not include in the call.	No

<recipient> section

Node	Type	Length	Description	Mandatory?
<name1>	String	35	Name of Receiver’s address owner	Yes
<name2>	String	35	Second name (or company) of Receiver’s address owner	No
<street>	String	35	Street of Receiver’s address owner. Note you can add the house number here too.	Yes
<street2>	String	35	Street2 is optional and may not contain street name and house number, only additional information (floor, building, appartment, …)	No
<houseNo>	String	8	House number of Receiver’s address owner. Only needed if you didn’t add the houseno in the <street> field	No
<state>	String	2	State of address Receiver’s owner in ISO 3166-2 code	No
<country>	String	2	Country of address Receiver’s owner in ISO 3166-1 alpha-2 code	Yes
<zipCode>	String	9	Zip code of address Receiver’s owner. Please do not add prefixes.	Yes
<city>	String	35	City/town of address Receiver’s owner	Yes
<gln>	Long	99999	International location number of Receiver’s address owner	No
<customerNumber>	String	17	Customer number of Receiver’s address owner.	No
<type>	String	1	Use value B if it’s a business (a B2B shipment) or P if it’s a private person (B2C shipment). These values will only be included in the data and will not be visible on the label.	Yes
<contact>	String	35	Contact person of Receiver’s address owner	No, unless using Express services
<phone>	String	30	Phone number of Receiver’s address owner. Must be format +<country prefix>#<full number> Ex: +32#470123456	No, unless using Express services
<fax>	String	30	Fax number of Receiver’s address owner.	No
<email>	String	40	Email address of Receiver’s address owner. For collection requests the maximum length is 40, otherwise always 50. This has to be a valid email address format.	No
<comment>	String	70	Comment on Receiver’s address owner. This is a free field.	No
<iaccount>	n/a	n/a	Not used, do not include in the call.	No

<parcel> section

Please note you can have multiple parcel within a shipment (multi-parcel shipment) by having more than one <parcel></parcel> instance. An example is included below the page.

Node	Type	Length	Description	Mandatory?
<parcelLabelNumber>	n/a	n/a	Not used, do not include in the call.	No
<customerReferenceNumber1>	String	Max 35	Reference 1 of this particular parcel. Shown on label and included in electronic data.	No
<customerReferenceNumber2>	String	Max 35	Reference 2 of this particular parcel. Shown on label and included in electronic data, but not shown on Collection Request labels.	No
<customerReferenceNumber3>	String	Max 35	Reference 3 of this particular parcel. Not shown on any label, but included in electronic data.	No
<customerReferenceNumber4>	String	Max 35	Reference 4 of this particular parcel. Not shown on any label, but included in electronic data.	No
<swap>	n/a	n/a	Not used, do not include in the call.	No
<volume>	Int	n/a	Volume of the single parcel (length/width/height in format LLLWWWHHH) in cm without separators, must have 3 digits for each measurement. Example: 10cm x 20cm x 30cm is 010020030	No
<weight>	Int	n/a	Parcel weight in decagrams rounded in 10 gram units without decimal delimiter. Ex. 315 = 3,15kg). If this is smaller than 3 kg, it will be turned into a Small Parcel shipment by itself. Entering a correct weight that reflects reality is important You might notice a special icon on labels if the weight exceeds 10 or 20 kg:	Yes
<hazardousLimitedQuantities>	n/a	n/a	Not used, not shown on label. Do not include in the call.	No
<HigherInsurance>	n/a	n/a	Usage of this function is not allowed without DPD’s explicit approval.	No
<content>	n/a	n/a	Not used, not shown on label. Do not include in the call.	No
<addService>	n/a	n/a	Not used, not shown on label. Do not include in the call.	No
<messageNumber>	n/a	n/a	Not used, not shown on label. Do not include in the call.	No
<function>	n/a	n/a	Not used, not shown on label. Do not include in the call.	No
<parameter>	n/a	n/a	Not used, not shown on label. Do not include in the call.	No
<cod>	n/a	n/a	This service is discontinued since Jan 2019.	No
<international>	n/a	n/a	For shipments outside the EU. See <international> section	No
<hazardous>	n/a	n/a	For shipments with hazardous goods. See <hazardous> section	No
<printInfo1OnParcelLabel>	Boolean	n/a	Only used for Collection Request. Set to true if <info1> needs to be shown on Coll. Request label	No
<info1>	String	20	Not shown on label, except on labels for Coll. Request on which it will appear if above field is set to true.	No
<info2>	String	20	Not shown on label.	No
<returns>	Boolean	n/a	Defines if parcel is a return parcel. When an outbound parcel and its return parcel are created within the same request, the return parcel number is generated immediately after the outbound parcel number. Standalone return parcels are also supported. Default value is false.	No

<ProductAndServiceData> section

Node	Type	Length	Description	Mandatory?
<orderType>	String	50	Defines the shipment type. Use value consignment for a shipment or collection request order for a collection request	Yes
<saturdayDelivery>	Boolean	n/a	Set to true if your shipment should have Saturday Delivery service	No
<exWorksDelivery>	Boolean	n/a	Set to true if your shipment should be Ex-Works delivery	No
<guarantee>	n/a	n/a	Not used, do not include in the call.	No
<tyres>	Boolean	n/a	Set to true if this consignment contains bulk tyres, only for product NP	No
<personalDelivery>	n/a	n/a	Not used, do not include in the call.	No
<pickup>	n/a	n/a	Not used, do not include in the call.	No
<parcelShopDelivery>	n/a	n/a	For shipments to Parcelshops. See <parcelShopDelivery> section	No
<parcelShopNotification>	n/a	n/a	Shipments to Parcelshops must also include a notification. See <parcelShopNotification>	No
<predict>	n/a	n/a	For B2C shipments with a Predict message to the receiver. See <predict> section	No
<personalDeliveryNotification	n/a	n/a	Not used, do not include in the call.	No
<proactiveNotification>	n/a	n/a	Not used, do not include in the call.	No
<delivery>	n/a	n/a	Not used, do not include in the call.	No
<invoiceAddress>	n/a	n/a	Not used, do not include in the call.	No
<countrySpecificService>	n/a	n/a	Not used, do not include in the call.	No

 

Response parameters

Node	Data type	Description
<parcellabelsPDF>	String	This is a base64 code that, after decoding, will give you a proper DPD label in PDF format. ZPL format can also be used for printing directly on a Zebra Label Printer.
<mpsID>	String	The MPSID of your shipment. It starts with one of “MPS“, “EXP” or “B2C“, then contains the parcelnumber and the last eight ciphers are the date in format yyyyMMdd
<parcelLabelNumber>	String	Your parcelnumber. This can be used for tracking purposes. Note that if you have a multi-parcel shipment, you can have several <parcelLabelNumber> instances.

 

Sample call

Basic B2B Normal Parcel shipment with one parcel (mono-colli)

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://dpd.com/common/service/types/Authentication/2.0" xmlns:ns1="http://dpd.com/common/service/types/ShipmentService/3.3">
   <soapenv:Header>
      <ns:authentication>
         <delisId>KD*****</delisId>
         <authToken>****</authToken>
         <messageLanguage>en_EN</messageLanguage> 
      </ns:authentication>
   </soapenv:Header>
   <soapenv:Body>
      <ns1:storeOrders>
         <printOptions>
            <printerLanguage>PDF</printerLanguage>
            <paperFormat>A6</paperFormat>
         </printOptions>
         <order>
            <generalShipmentData>
               <sendingDepot>0530</sendingDepot>
               <product>CL</product> 
               <sender> 
                  <name1>Senders NV</name1>
                  <name2>Jan Janssens</name2>
                  <street>Egide Walschaertsstraat 20</street>
                  <country>BE</country>
                  <zipCode>2800</zipCode>
                  <city>Mechelen</city>
                  <type>B</type>
               </sender>
               <recipient> 
                  <name1>Receivers NV</name1>
                  <street>Teststraat 5</street>
                  <country>BE</country>
                  <zipCode>2800</zipCode>
                  <city>Mechelen</city>
                  <type>B</type> 
               </recipient>
            </generalShipmentData>            
            <parcels>
               <customerReferenceNumber1>Box 1234</customerReferenceNumber1> 
               <weight>340</weight> 
            </parcels>
            <productAndServiceData>
               <orderType>consignment</orderType> 
            </productAndServiceData>
         </order>
       </ns1:storeOrders>
   </soapenv:Body>
</soapenv:Envelope>

 

Basic B2B Normal Parcel shipment with several parcels (multi-colli)

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://dpd.com/common/service/types/Authentication/2.0" xmlns:ns1="http://dpd.com/common/service/types/ShipmentService/3.3">
   <soapenv:Header><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://dpd.com/common/service/types/Authentication/2.0" xmlns:ns1="http://dpd.com/common/service/types/ShipmentService/3.3">
   <soapenv:Header>
      <ns:authentication>
         <delisId>KD*****</delisId>
         <authToken>****</authToken>
         <messageLanguage>en_EN</messageLanguage> 
      </ns:authentication>
   </soapenv:Header>
   <soapenv:Body>
      <ns1:storeOrders>
         <printOptions>
            <printerLanguage>PDF</printerLanguage>
            <paperFormat>A6</paperFormat>
         </printOptions>
         <order>
            <generalShipmentData>
               <sendingDepot>0530</sendingDepot>
               <product>CL</product> 
               <sender> 
                  <name1>Senders NV</name1>
                  <name2>Jan Janssens</name2>
                  <street>Egide Walschaertsstraat 20</street>
                  <country>BE</country>
                  <zipCode>2800</zipCode>
                  <city>Mechelen</city>
                  <type>B</type>
               </sender>
               <recipient> 
                  <name1>Receivers NV</name1>
                  <street>Teststraat 5</street>
                  <country>BE</country>
                  <zipCode>2800</zipCode>
                  <city>Mechelen</city>
                  <type>B</type> 
               </recipient>
            </generalShipmentData>            
            <parcels>
               <customerReferenceNumber1>Box 1</customerReferenceNumber1> 
               <weight>340</weight> 
            </parcels>
            <parcels>
               <customerReferenceNumber1>Box 2</customerReferenceNumber1> 
               <weight>500</weight> 
            </parcels>
            <productAndServiceData>
               <orderType>consignment</orderType> 
            </productAndServiceData>
         </order>
       </ns1:storeOrders>
   </soapenv:Body>
</soapenv:Envelope>

 

Basic B2B Small Parcel

To make a Small Parcel (< 3 kg), you just have to add the weight to the Parcel and make sure it’s lower than 3 kilos. The system will automatically make it a Small Parcel shipment.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://dpd.com/common/service/types/Authentication/2.0" xmlns:ns1="http://dpd.com/common/service/types/ShipmentService/3.3">
   <soapenv:Header>
      <ns:authentication>
         <delisId>KD*****</delisId>
         <authToken>****</authToken>
         <messageLanguage>nl_NL</messageLanguage>
      </ns:authentication>
   </soapenv:Header>
   <soapenv:Body>
      <ns1:storeOrders>
         <printOptions>
            <printerLanguage>PDF</printerLanguage>
            <paperFormat>A6</paperFormat>
         </printOptions>
         <order>
            <generalShipmentData>
               <sendingDepot>0530</sendingDepot>
               <product>CL</product> 
               <sender> 
                  <name1>Senders NV</name1>
                  <name2>Jan Janssens</name2>
                  <street>Egide Walschaertsstraat 20</street>
                  <country>BE</country>
                  <zipCode>2800</zipCode>
                  <city>Mechelen</city>
                  <type>B</type>
               </sender>
               <recipient> 
                  <name1>Receivers NV</name1>
                  <street>Receiverstraat 5</street>
                  <country>BE</country>
                  <zipCode>2800</zipCode>
                  <city>Mechelen</city>
                  <type>B</type> 
               </recipient>
            </generalShipmentData>           
            <parcels>
               <customerReferenceNumber1>Box 1234</customerReferenceNumber1> 
               <weight>100</weight> 
            </parcels>
            <productAndServiceData>
               <orderType>consignment</orderType> 
            </productAndServiceData>
         </order>
       </ns1:storeOrders>
   </soapenv:Body>
</soapenv:Envelope>

Sample of a reponse for a valid call

This is the response you’d get with a label.

   <soap:Envelope xmlns:soap=”http://schemas.xmlsoap.org/soap/envelope/” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns:xsd=”http://www.w3.org/2001/XMLSchema“>
    <soap:Body>
    <orderResult xmlns=”http://dpd.com/common/service/types/ShipmentService/3.3“>
    <parcellabelsPDF>****</parcellabelsPDF>
    <shipmentResponses>
    <identificationNumber/>
    <mpsId>MPS0530880141005820190701</mpsId>
    <parcelInformation>
    <parcelLabelNumber>05308801410058</parcelLabelNumber>
    </parcelInformation>
    </shipmentResponses>
    </orderResult>
    </soap:Body>
    </soap:Envelope>

 

You can consult the tool MyDPD 4 Business to get an overview of your shipments. 

DPD Business (B2B) Shipment

These are examples of the standard shipment product with minimal mandatory namespaces entry.

Sample call

Basic B2B Normal Parcel shipment with one parcel

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://dpd.com/common/service/types/Authentication/2.0" xmlns:ns1="http://dpd.com/common/service/types/ShipmentService/3.3">
   <soapenv:Header>
      <ns:authentication>
         <delisId>KD*****</delisId>
         <authToken>****</authToken>
         <messageLanguage>en_EN</messageLanguage> 
      </ns:authentication>
   </soapenv:Header>
   <soapenv:Body>
      <ns1:storeOrders>
         <printOptions>
            <printerLanguage>PDF</printerLanguage>
            <paperFormat>A6</paperFormat>
         </printOptions>
         <order>
            <generalShipmentData>
               <sendingDepot>0530</sendingDepot>
               <product>CL</product> 
               <sender> 
                  <name1>Senders NV</name1>
                  <name2>Jan Janssens</name2>
                  <street>Egide Walschaertsstraat 20</street>
                  <country>BE</country>
                  <zipCode>2800</zipCode>
                  <city>Mechelen</city>
                  <type>B</type>
               </sender>
               <recipient> 
                  <name1>Receivers NV</name1>
                  <street>Teststraat 5</street>
                  <country>BE</country>
                  <zipCode>2800</zipCode>
                  <city>Mechelen</city>
                  <type>B</type> 
               </recipient>
            </generalShipmentData>            
            <parcels>
               <weight>100</weight> 
            </parcels>
            <productAndServiceData>
               <orderType>consignment</orderType> 
            </productAndServiceData>
         </order>
       </ns1:storeOrders>
   </soapenv:Body>
</soapenv:Envelope>

 

Basic B2B Normal Parcel shipment with several parcels (multi-colli)

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://dpd.com/common/service/types/Authentication/2.0" xmlns:ns1="http://dpd.com/common/service/types/ShipmentService/3.3">
   <soapenv:Header>
      <ns:authentication>
         <delisId>KD*****</delisId>
         <authToken>****</authToken>
         <messageLanguage>en_EN</messageLanguage> 
      </ns:authentication>
   </soapenv:Header>
   <soapenv:Body>
      <ns1:storeOrders>
         <printOptions>
            <printerLanguage>PDF</printerLanguage>
            <paperFormat>A6</paperFormat>
         </printOptions>
         <order>
            <generalShipmentData>
               <sendingDepot>0530</sendingDepot>
               <product>CL</product> 
               <sender> 
                  <name1>Senders NV</name1>
                  <name2>Jan Janssens</name2>
                  <street>Egide Walschaertsstraat 20</street>
                  <country>BE</country>
                  <zipCode>2800</zipCode>
                  <city>Mechelen</city>
                  <type>B</type>
               </sender>
               <recipient> 
                  <name1>Receivers NV</name1>
                  <street>Teststraat 5</street>
                  <country>BE</country>
                  <zipCode>2800</zipCode>
                  <city>Mechelen</city>
                  <type>B</type> 
               </recipient>
            </generalShipmentData>            
            <parcels>
               <customerReferenceNumber1>Box 1</customerReferenceNumber1> 
               <weight>100</weight> 
            </parcels>
            <parcels>
               <customerReferenceNumber1>Box 2</customerReferenceNumber1> 
               <weight>500</weight> 
            </parcels>
            <productAndServiceData>
               <orderType>consignment</orderType> 
            </productAndServiceData>
         </order>
       </ns1:storeOrders>
   </soapenv:Body>
</soapenv:Envelope>

Sample of a reponse for a valid call

This is the response you’d get with a label.

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <orderResult xmlns="http://dpd.com/common/service/types/ShipmentService/3.3">
         <parcellabelsPDF>****</parcellabelsPDF>
         <shipmentResponses>
            <identificationNumber/>
            <mpsId>MPS0530880141005820190701</mpsId>
            <parcelInformation>
               <parcelLabelNumber>05308801410058</parcelLabelNumber>
            </parcelInformation>
         </shipmentResponses>
      </orderResult>
   </soap:Body>
</soap:Envelope>

DPD Home (B2C) Shipment

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://dpd.com/common/service/types/Authentication/2.0" xmlns:ns1="http://dpd.com/common/service/types/ShipmentService/3.3">
   <soapenv:Header>
      <ns:authentication>
         <delisId>KD*****</delisId>
         <authToken>****</authToken>
         <messageLanguage>nl_NL</messageLanguage>
      </ns:authentication>
   </soapenv:Header>
   <soapenv:Body>
      <ns1:storeOrders>
         <printOptions>
            <printerLanguage>PDF</printerLanguage>
            <paperFormat>A6</paperFormat>
         </printOptions>
         <order>
            <generalShipmentData>
               <sendingDepot>0530</sendingDepot>
               <product>CL</product>
               <sender>
                  <name1>Sender NV</name1>
                  <name2>Jan Jansens</name2>
                  <street>Egide Walschaertsstraat 20</street>
                  <country>BE</country>
                  <zipCode>2800</zipCode>
                  <city>Mechelen</city>
                  <type>B</type>
               </sender>
               <recipient>
                  <name1>Receivers LTD</name1>
                  <street>Receiverstreet 5</street>
                  <country>BE</country>
                  <zipCode>2800</zipCode>
                  <city>Mechelen</city>
                  <type>P</type>
                  <phone>+32#479000000</phone>
                  <email>testaddress@dpd.be</email>
               </recipient>
            </generalShipmentData>
            <parcels>
               <customerReferenceNumber1>Box 1234</customerReferenceNumber1>
               <weight>340</weight>
            </parcels>
            <productAndServiceData>
               <orderType>consignment</orderType>
               <predict>
                  <channel>1</channel> 
                  <value>testaddress@dpd.be</value> 
                  <language>NL</language> 
               </predict>
            </productAndServiceData>
         </order>
      </ns1:storeOrders>
   </soapenv:Body>
</soapenv:Envelope>

DPD Business Predict (B2B) Shipment

DPD Shop (B2C) Shipment

This looks almost identical to a regular DPD Business shipment. In order to turn it into a shipment via parcelshop, you have to add the <parcelShopDelivery> segment in the <productAndServiceData> section. This one has a couple of child segments too:

• <parcelShopId>: this is the ID of the Parcelshop you want DPD to drop the shipment at. This ID is acquired thought the Parcelshopfinder service (see separate section for this). In the Parcelshopfinder service, you will receive a response containing <parcelShopId>. It’s this value you use for this field.
• <parcelShopNotification>: this contain the details of the Predict message that will be sent to the receiver to let him know his parcel arrived in the shop. Please note that you use <parcelShopNotification> here as opposed to <predict> for a B2C Predict shipment without Parcelshop.
  Parcelshopnotification has a few child segments of it’s own, which are similar to those of <predict>:
  • <channel>: the type of Predict you wish to send. Using value 1 will send an email, value 3 an SMS.
  • <value>: the email address or portable phone number the message must be sent to. Obviously, use a valid email address if the channel is 1 and a valid phone number if the channel is 3.
    Note: phone number must be in format +<countrycode>#<rest of the number> so if the number is for example 0032479123456, use value +32@479123456
  • <language>: The language in which the Predict message should be sent in ISO2 format: FR, NL, EN, etc. Keep in mind that while BE is a correct country code, BE as a language doesn’t exist. It should be one of the country languages or EN.

You will also have to make sure you fill in the <phone> field in the <recipient> segment since for several countries, Parcelshop Shipments require that field to be used.
Once you print your label, you’ll notice how the receiver area contains the Parcelshop’s address and not your final Receiver’s address. However, the Receiver’s details are included in the electronic data of this shipment.

Sample call

    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://dpd.com/common/service/types/Authentication/2.0" xmlns:ns1="http://dpd.com/common/service/types/ShipmentService/3.3">
       <soapenv:Header>
          <ns:authentication>
             <delisId>KD*****</delisId>
             <authToken>****</authToken>
             <messageLanguage>nl_NL</messageLanguage>
          </ns:authentication>
       </soapenv:Header>
       <soapenv:Body>
          <ns1:storeOrders>
             <printOptions>
                <printerLanguage>PDF</printerLanguage>
                <paperFormat>A6</paperFormat>
             </printOptions>
             <order>
                <generalShipmentData>
                   <sendingDepot>0530</sendingDepot>
                   <product>CL</product>
                   <sender>
                      <name1>Sender NV</name1>
                      <name2>Jan Jansens</name2>
                      <street>Egide Walschaertsstraat 20</street>
                      <country>BE</country>
                      <zipCode>2800</zipCode>
                      <city>Mechelen</city>
                      <type>B</type>
                   </sender>
                   <recipient>
                      <name1>Receivers LTD</name1>
                      <street>IJzerenleen 13</street>
                      <country>BE</country>
                      <zipCode>2800</zipCode>
                      <city>Mechelen</city>
                      <type>P</type>
                      <phone>+32#479123456</phone>
                      <email>testaddress@dpd.be</email>
                   </recipient>
                </generalShipmentData>
                <parcels>
                   <customerReferenceNumber1>Box 1234</customerReferenceNumber1>
                   <weight>340</weight>
                </parcels>
                <productAndServiceData>
                   <orderType>consignment</orderType>              
                   <parcelShopDelivery>
                      <parcelShopId>666910179</parcelShopId>                
                      <parcelShopNotification>
                         <channel>3</channel> 
                         <value>+32#479123456</value>
                         <language>NL</language> 
                      </parcelShopNotification>
                      </parcelShopDelivery>            
                </productAndServiceData>
             </order>
          </ns1:storeOrders>
       </soapenv:Body>
    </soapenv:Envelope>

Express 10, 12, 18 Guarantee Shipment

non-EU Rest of World shipments

• For other shipments outside the EU that aren’t the UK, please stay on this page.
• For UK Brexit Shipments, go to the dedicated point 12.

More details about each field will be added later, but for now, please base yourself on the example below.

Each shipment outside the EU, which includes countries like Switzerland, Norway and Iceland, must have an <international> section under the <parcels> section. Please note that you will need a separate  <commercialInvoiceLine>  for each different kind of item you’re shipping. An object that has it’s own HS code, constitutes a separate item.
These segments will be described in the raster below (please scroll lower)

It’s extremely important to provide all details required by law, which can differ from destination to destination. Please make sure you familiarize yourself with the general rules for RoW shipments which are described here
It’s also on that page that you can find which fields are mandatory and what the limitations are of your specific destination.

<international> segment

<commercialInvoiceConsignee> and <commercialInvoiceConsignor> segments

<commercialInvoiceLine> segment

You can have multiple <commercialInvoiceLine> segments: one for each item you have.

Basic example of a shipment to the United States of America

In our example, we’ll be sending some office supplies to the USA.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://dpd.com/common/service/types/Authentication/2.0" xmlns:ns1="http://dpd.com/common/service/types/ShipmentService/3.5">
   <soapenv:Header>
      <ns:authentication>
         <delisId>***</delisId>
         <authToken>***</authToken>
         <messageLanguage>en_EN</messageLanguage>
      </ns:authentication>
   </soapenv:Header>
   <soapenv:Body>
      <ns1:storeOrders>
<printOptions>
<printerLanguage>PDF</printerLanguage>
<paperFormat>A6</paperFormat>
</printOptions>
<order>
<generalShipmentData>
<sendingDepot>0530</sendingDepot>
<product>CL</product>
<sender>
   <name1>Belgian Sender NV</name1>
   <name2/>
   <street>De Tyraslaan</street>
   <houseNo>2</houseNo>
   <country>BE</country>
   <zipCode>1800</zipCode>
   <city>Vilvoorde</city>
   <phone>+32490123456</phone>
   <email>sendertest@dpd.be</email>
</sender>
<recipient>
  <name1>USA Receiver</name1>
  <street>Ashburn Street</street>
  <houseNo>8</houseNo>
  <state>MI</state> <!-- For shipments to Canada and US, State is mandatory and needs to be the ISO code -->
  <country>US</country>
  <zipCode>49740</zipCode>
  <city>Harbor Springs</city>
  <phone>+12315263300</phone>
  <email>usareceivertest@dpd.be</email>
  <eoriNumber>US987654321000</eoriNumber>
  <vatNumber>USVAT987654321</vatNumber>
</recipient>
</generalShipmentData>
<parcels>
<customerReferenceNumber1/>
<volume>010020055</volume> <!-- Mandatory and must reflect reality. LLLWWWHHH in cm (010020055 = 10x20x55 cm)-->
<weight>800</weight> <!-- Mandatory and must reflect reality, rounded in 10gr units (800=8 kg) -->
<international>
                  <parcelType>0</parcelType> <!--1 for docs, 0 for non docs-->
                  <customsAmount>1500</customsAmount>
                  <customsCurrency>EUR</customsCurrency>
                  <customsAmountEx>1500</customsAmountEx>
                  <customsCurrencyEx>EUR</customsCurrencyEx>
                  <exportReason>01</exportReason> <!-- 01:sale, 02:return/replace, 03: gift -->
                  <customsTerms>07</customsTerms>
                  <customsContent>Office Supplies</customsContent>
                  <customsInvoice>112233</customsInvoice>
                  <customsInvoiceDate>20260707</customsInvoiceDate>
                  <commercialInvoiceConsignee>
                     <name1>USA Receiver</name1>
                     <street>Ashburn Street</street>
                     <houseNo>8</houseNo>
                     <state>MI</state>
                     <country>US</country>
                     <zipCode>49740</zipCode>
                     <city>Harbor Springs</city>
                     <phone>+12315263300</phone>
                     <email>usareceivertest@dpd.be</email>
                     <eoriNumber>US987654321000</eoriNumber>
                     <vatNumber>USVAT987654321</vatNumber>
                  </commercialInvoiceConsignee>
                  <commercialInvoiceConsignor>
                     <name1>Belgian Sender NV</name1>
                     <street>De Tyraslaan</street>
                     <houseNo>2</houseNo>
                     <country>BE</country>
                     <zipCode>1800</zipCode>
                     <city>Vilvoorde</city>
                     <phone>+32490123456</phone>
                     <email>sendertest@dpd.be</email>
                     <eoriNumber>BE0123456789</eoriNumber>
                     <vatNumber>BE0123456789</vatNumber>
                  </commercialInvoiceConsignor>
                  <!--1 or more repetitions:-->
                  <commercialInvoiceLine>
                     <customsTarif>12345678</customsTarif> <!-- HS number -->
                     <receiverCustomsTarif>12345678</receiverCustomsTarif> <!-- Repeat of HS number -->
                     <content>Pencils</content>
                     <grossWeight>600</grossWeight>
                     <itemsNumber>100</itemsNumber> <!--How many of this item in this shipment?-->
                     <amountLine>1200</amountLine> <!-- Total value of all of this item, so in this example: €1200 for all 100 pencils -->
                     <customsOrigin>BE</customsOrigin>
                  </commercialInvoiceLine>
                  <commercialInvoiceLine>
                     <customsTarif>87654321</customsTarif> <!-- HS number -->
                     <receiverCustomsTarif>87654321</receiverCustomsTarif> <!-- Repeat of HS number -->
                     <content>Paper Clips</content>
                     <grossWeight>200</grossWeight>
                     <itemsNumber>2000</itemsNumber> <!--How many of this item in this shipment?-->
                     <amountLine>300</amountLine> <!-- Total value of all of this item -->
                     <customsOrigin>BE</customsOrigin>
                  </commercialInvoiceLine>
               </international>
</parcels>
<productAndServiceData>
<orderType>consignment</orderType>
</productAndServiceData>
</order>
      </ns1:storeOrders>
   </soapenv:Body>
</soapenv:Envelope>

Shop Return Shipment

Saturday Delivery Shipment

Tyres (bulk) Shipment

DPD Shop 2 Shop shipment

A DPD Shop 2 Shop shipment is almost identical to a DPD Parcelshop shipment. The only difference being the product used. For DPD Shop 2 Shop, we use value S2S in the <product> segment

Just like with a DPD Parcelshop shipment, the entire <parcelShopDelivery> segment is mandatory, as describe above in point 5. DPD Shop (B2C) Shipment

Sample call

    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://dpd.com/common/service/types/Authentication/2.0" xmlns:ns1="http://dpd.com/common/service/types/ShipmentService/3.3">
       <soapenv:Header>
          <ns:authentication>
             <delisId>KD*****</delisId>
             <authToken>****</authToken>
             <messageLanguage>nl_NL</messageLanguage>
          </ns:authentication>
       </soapenv:Header>
       <soapenv:Body>
          <ns1:storeOrders>
             <printOptions>
                <printerLanguage>PDF</printerLanguage>
                <paperFormat>A6</paperFormat>
             </printOptions>
             <order>
                <generalShipmentData>
                   <sendingDepot>0530</sendingDepot>
                   <product>S2S</product>
                   <sender>
                      <name1>Sender NV</name1>
                      <name2>Jan Jansens</name2>
                      <street>Egide Walschaertsstraat 20</street>
                      <country>BE</country>
                      <zipCode>2800</zipCode>
                      <city>Mechelen</city>
                      <type>B</type>
                   </sender>
                   <recipient>
                      <name1>Receivers LTD</name1>
                      <street>IJzerenleen 13</street>
                      <country>BE</country>
                      <zipCode>2800</zipCode>
                      <city>Mechelen</city>
                      <type>P</type>
                      <phone>+32#479123456</phone>
                      <email>testaddress@dpd.be</email>
                   </recipient>
                </generalShipmentData>
                <parcels>
                   <customerReferenceNumber1>Box 1234</customerReferenceNumber1>
                   <weight>340</weight>
                </parcels>
                <productAndServiceData>
                   <orderType>consignment</orderType>              
                   <parcelShopDelivery>
                      <parcelShopId>666910179</parcelShopId>                
                      <parcelShopNotification>
                         <channel>3</channel> 
                         <value>+32#479123456</value>
                         <language>NL</language> 
                      </parcelShopNotification>
                      </parcelShopDelivery>            
                </productAndServiceData>
             </order>
          </ns1:storeOrders>
       </soapenv:Body>
    </soapenv:Envelope>

Ex-Works Shipment

Shipments to United Kingdom after Brexit

Request parameters

Shipments to post-Brexit United Kingdom must have an <international> section under the <parcels> section. Please note that you will need a separate  <commercialInvoiceLine>  for each different kind of item you’re shipping. An object that has it’s own HS code, constitutes a separate item.
These segments will be described in the raster below.

Other changes

• Sender phone (<phone> field under <sender>) is mandatory.
  Note: phone number must be format +<country code><rest of the number> in all fields. For example: +3215124578 or +442012345678.
• Sender email (<email> field under <sender>) is mandatory.
  Note: the email must be on an existing domain.
• Receiver phone (<phone> field under <recipient>) is mandatory and in correct format.
• Receiver email (<email> field under <recipient>) is mandatory and on an existing domain.
• Sender and Receiver house number must be in their separate fields <houseNo>. This has to be the case for the <sender>, <recipient>, <commercialInvoiceConsignee> and <commercialInvoiceConsignor> segments.
• The value in the <weight> field in the <parcels> segment needs to be the total of all <grossweight> values in the <commercialInvoiceLine> segment.

Notes about EORI, HMRC and VAT number

• The Sender VAT and EORI number are always mandatory and must be included in two segments: the <sender> segment and the <commercialInvoiceConsignor> segment.
• The Receiver VAT and EORI number must be given in the <receiver> segment, the <commercialInvoiceConsignee> segment and in the <commercialInvoiceConsigneeVatNumber> field. However, these values can vary depending whether or not your shipment is B2B or B2C:
  – For B2B Shipments: these fields must contain the Receiver EORI and VAT number.
  – For B2C Shipments: these fields must contain the Sender EORI and VAT number, since B2C receivers don’t have a VAT or EORI.
• The HMRC number of the Sender must be included in the <comment2> field of the <international> segment.
  AND
  The HMRC number of the Sender must be included in the <destinationCountryRegistration> field of the <sender> segment.

<sender> segment

Is identical as for any other shipments, taking into consideration the mandatory fields mentioned above. In case of shipment creation where HMRC number entry applies, be sure to add HMRC number here as well as in the ‘comment2’ section of the international segment.
This especially important if you are shipping on behalf of a third party

<international> segment

<commercialInvoiceConsignee> and <commercialInvoiceConsignor> segments

<commercialInvoiceLine> segment

You can have multiple <commercialInvoiceLine> segments: one for each item you have.

Sample call B2B

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://dpd.com/common/service/types/Authentication/2.0" xmlns:ns1="http://dpd.com/common/service/types/ShipmentService/3.3">
   <soapenv:Header>
      <ns:authentication>
         <delisId>KD*****</delisId>
         <authToken>****</authToken>
         <messageLanguage>nl_NL</messageLanguage>
      </ns:authentication>
   </soapenv:Header>
   <soapenv:Body>
      <ns1:storeOrders>
         <printOptions>
            <printerLanguage>PDF</printerLanguage>
            <paperFormat>A6</paperFormat>
         </printOptions>
         <order>
            <generalShipmentData>
               <sendingDepot>0530</sendingDepot>
               <product>CL</product>
               <sender>
                  <name1>Sender NV</name1>
                  <name2>Jan Jansens</name2>
                  <street>Egide Walschaertsstraat</street>
                  <houseNo>20</houseNo>
                  <country>BE</country>
                  <zipCode>2800</zipCode>
                  <city>Mechelen</city>
                  <phone>+3215124578</phone>
                  <email>sender@sendercompany.com</email>
                  <eoriNumber>1133113311</eoriNumber>
                  <vatNumber>BE123456</vatNumber>
                  <destinationCountryRegistration>QQ123456C</destinationCountryRegistration>
               </sender>
               <recipient>
                  <name1>British Test</name1>
                  <street>Receiverstraat</street>
                  <houseNo>5</houseNo>
                  <country>GB</country>
                  <zipCode>LS101AB</zipCode>
                  <city>Leeds</city>
                  <phone>+442012345678</phone>
                  <email>receiver@receivercompany.com</email>
                  <eoriNumber>7788778877</eoriNumber>
                  <vatNumber>GB654321</vatNumber> 
               </recipient>
            </generalShipmentData>
            <parcels>
               <customerReferenceNumber1>Box 1234</customerReferenceNumber1>
               <weight>123</weight>
                <international>
                  <parcelType>false</parcelType> 
                  <customsAmount>1400</customsAmount> 
                  <customsCurrency>EUR</customsCurrency>
                  <customsAmountEx>1400</customsAmountEx> 
                  <customsCurrencyEx>EUR</customsCurrencyEx>
                  <clearanceCleared>N</clearanceCleared> 
                  <prealertStatus>S03</prealertStatus>
                  <exportReason>01</exportReason>
                  <customsTerms>06</customsTerms>
                  <customsContent>Paperclips</customsContent>                 
                  <customsInvoice>12345</customsInvoice>
                  <customsInvoiceDate>20190624</customsInvoiceDate>
                  <comment2>QQ123456C</comment2>
                  <commercialInvoiceConsigneeVatNumber>GB654321</commercialInvoiceConsigneeVatNumber>                    
                  <commercialInvoiceConsignee>
                       <name1>British Test</name1>
                       <street>Receiverstraat</street>
                       <houseNo>5</houseNo>
                       <country>GB</country>
                       <zipCode>LS101AB</zipCode>
                       <city>Leeds</city>
                       <phone>+442012345678</phone>
                       <email>receiver@receivercompany.com</email>
                       <eoriNumber>7788778877</eoriNumber>
                       <vatNumber>GB654321</vatNumber>               
                  </commercialInvoiceConsignee>
                  <commercialInvoiceConsignor>
                       <name1>Sender NV</name1>
                       <name2>Jan Jansens</name2>
                       <street>Egide Walschaertsstraat</street>
                       <houseNo>20</houseNo>
                       <country>BE</country>
                       <zipCode>2800</zipCode>
                       <city>Mechelen</city>
                       <phone>+3215124578</phone>
                       <email>sender@sendercompany.com</email> 
                       <eoriNumber>1133113311</eoriNumber>
                       <vatNumber>BE123456</vatNumber>    
                  </commercialInvoiceConsignor>
                 <commercialInvoiceLine>
                     <customsTarif>22255222</customsTarif>
                     <receiverCustomsTarif>5552255</receiverCustomsTarif>
                     <productCode>88776655</productCode>
                     <content>Paperclips</content>
                     <grossWeight>123</grossWeight>                  
                     <itemsNumber>1</itemsNumber>
                     <amountLine>1515</amountLine>
                     <customsOrigin>BE</customsOrigin>
                     <invoicePosition>5151</invoicePosition>
                  </commercialInvoiceLine>   
               </international>
            </parcels>
            <productAndServiceData>
               <orderType>consignment</orderType>
            </productAndServiceData>
         </order>
      </ns1:storeOrders>
   </soapenv:Body>
</soapenv:Envelope>

Sample call B2B with several different items

<soapenv:Envelope xmlns:ns1="http://dpd.com/common/service/types/ShipmentService/3.3" xmlns:ns="http://dpd.com/common/service/types/Authentication/2.0" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header>
<ns:authentication>
         <delisId>KD***</delisId>
         <authToken>*****</authToken>
    <messageLanguage>nl_NL</messageLanguage>
</ns:authentication>
</soapenv:Header>
<soapenv:Body>
    <ns1:storeOrders>
 <printOptions>
        <printerLanguage>ZPL</printerLanguage>
        <paperFormat>A6</paperFormat>
      </printOptions>
      <order>
       <generalShipmentData>
               <sendingDepot>0530</sendingDepot>
               <product>CL</product>
               <sender>
                    <name1>Sender NV</name1>
                    <name2>Jan Jansens</name2>
                    <street>Egide Walschaertsstraat</street>
                    <houseNo>20</houseNo>
                    <country>BE</country>
                    <zipCode>2800</zipCode>
                    <city>Mechelen</city>
                    <phone>003215123456</phone>
                    <email>sender@sendercompany.com</email>
                    <eoriNumber>1133113311</eoriNumber>
                    <vatNumber>BE123456</vatNumber>
               </sender>
               <recipient>
                   <name1>British Test</name1>
                   <street>Receiverstraat</street>
                   <houseNo>5</houseNo>
                   <country>GB</country>
                   <zipCode>LS101AB</zipCode>
                   <city>Leeds</city>
                   <phone>00446123456</phone>
                   <email>receiver@receivercompany.com</email>
                   <eoriNumber>7788778877</eoriNumber>
                   <vatNumber>GB654321</vatNumber>
               </recipient>
            </generalShipmentData>
            <parcels>
               <customerReferenceNumber1>Box 1234</customerReferenceNumber1>
               <weight>470</weight>      
               <international>
                  <parcelType>false</parcelType>
                  <customsAmount>2700</customsAmount>
                  <customsCurrency>EUR</customsCurrency>
                  <customsAmountEx>2700</customsAmountEx>
                  <customsCurrencyEx>EUR</customsCurrencyEx>
                  <clearanceCleared>N</clearanceCleared>
                  <prealertStatus>S03</prealertStatus>
                  <exportReason>01</exportReason>
                  <customsTerms>06</customsTerms>
                  <customsContent>Paperclips</customsContent>                 
                  <customsInvoice>12345</customsInvoice>
                  <customsInvoiceDate>20190624</customsInvoiceDate>
                  <comment2>QQ123456C</comment2>
                  <commercialInvoiceConsigneeVatNumber>GB654321</commercialInvoiceConsigneeVatNumber>                    
                  <commercialInvoiceConsignee>
                       <name1>British Test</name1>
                       <street>Receiverstraat</street>
                       <houseNo>5</houseNo>
                       <country>GB</country>
                       <zipCode>LS101AB</zipCode>
                       <city>Leeds</city>
                       <phone>00446123456</phone>
                       <email>receiver@receivercompany.com</email>
                       <eoriNumber>7788778877</eoriNumber>
                       <vatNumber>GB654321</vatNumber>               
                  </commercialInvoiceConsignee>
                  <commercialInvoiceConsignor>
                       <name1>Sender NV</name1>
                       <name2>Jan Jansens</name2>
                       <street>Egide Walschaertsstraat</street>
                       <houseNo>20</houseNo>
                       <country>BE</country>
                       <zipCode>2800</zipCode>
                       <city>Mechelen</city>
                       <phone>003215123456</phone>
                       <email>sender@sendercompany.com</email>
                       <eoriNumber>1133113311</eoriNumber>
                       <vatNumber>BE123456</vatNumber>    
                  </commercialInvoiceConsignor>
                 <commercialInvoiceLine>
                     <customsTarif>2225522</customsTarif>
                     <receiverCustomsTarif>5552255</receiverCustomsTarif>
                     <productCode>88776655</productCode>
                     <content>Paperclips</content>
                     <grossWeight>230</grossWeight>                  
                     <itemsNumber>1</itemsNumber>
                     <amountLine>1200</amountLine>
                     <customsOrigin>BE</customsOrigin>
                     <invoicePosition>5151</invoicePosition>
                  </commercialInvoiceLine>
                   <commercialInvoiceLine>
                     <customsTarif>885588</customsTarif>
                     <receiverCustomsTarif>558855</receiverCustomsTarif>
                     <productCode>10101212</productCode>
                     <content>Pencils</content>
                     <grossWeight>240</grossWeight>                  
                     <itemsNumber>1</itemsNumber>
                     <amountLine>1500</amountLine>
                     <customsOrigin>BE</customsOrigin>
                     <invoicePosition>5151</invoicePosition>
                  </commercialInvoiceLine>  
               </international>              
            </parcels>
            <productAndServiceData>
               <orderType>consignment</orderType>
            </productAndServiceData>
      </order>
    </ns1:storeOrders>
  </soapenv:Body>
</soapenv:Envelope>

Pickup Orders

Collection Request Orders

Small Parcel

Any type of service code has a “small” variant. You can have a Small B2B shipment, Small B2C shipment, Small Parcelshop shipments, etc.

There is no specific code or call to make you shipment be considered as small: the system will automatically turn your parcel into the small variant based on the weight of the parcel: if the value in the <weight> field within the <parcel> instance is lower than 3 kg, the system will turn your shipment in a small parcel shipment by itself.

Older documentation and other API's

Download the full original  Web Service Reference Documentation (PDF)

The DPD Belux Shipper API strongly resembles the DPD NL and DPD CH versions, but is still different and has other endpoints. Originally Shipper API was built in the image of the DPD DE API. Some references in the downloadable documentation above still relate to it, but can be ignored. This documentation contains more examples, but is no longer updated

Troubleshooting Guide

This section provides a detailed list of common errors you may encounter while using our API, along with explanations, root causes, and step-by-step solutions. If you need further assistance, please contact our support team it.cs@dpd.be.

Important Note:
When contacting our support team about an error you cannot resolve, please include the following details:

• Request ID: A unique identifier that looks like this: aa4ffae0-3967-4856-9276-9f6eca7b28a1.
• If the Request ID is unavailable, provide your login name along with the approximate date and time of the request.
• Your XML request and response: Including the raw XML request and response will help our team perform a thorough troubleshooting.

Providing this information helps us quickly locate and resolve your issue.

17.1 SHP_VALID_ERR_PICKUP_PAST

Description:
This error occurs when a pickup request contains a date in the past.

Root Cause:
The <date> field in the <pickup> request is set to a date that has already passed. The system validates pickup dates to ensure they are scheduled for today or a future date.

Solution:

1. Verify the <date> field in the request.
2. Update the <date> to a valid future date in the format YYYYMMDD.
3. Resubmit the request.

Example:

<pickup>
    <date>20250110</date>
</pickup>

17.2 ERROR_INCORRECT_EMAIL_ADDRESS_DOMAIN

Description:
This error is triggered when an invalid or unapproved email domain is provided in the request.

Root Cause:
The domain of the email address does not match the approved list of domains.

Solution:

1. Check the email address domain in your request.
2. Replace the email address with one from an approved domain.

Example:

<email>valid@approveddomain.com</email>

17.3 DELICOM_ERR_AUTHENTICATION

Description:
Authentication failed due to invalid credentials or an expired token.

Root Cause:

• The username or password is incorrect.
• The token used for authentication has expired.

Solution:

1. Double-check your credentials.
2. Generate a new authentication token and include it in the request header.

Example Header:

<delisId>BE1234</delisId>
<password>PASSWORD</password>

17.4 ERROR_PARCEL_EXCEEDS_MAXIMUM_ALLOWED_WEIGHT

Description:
The parcel weight exceeds the system’s maximum allowable limit.

Root Cause:
The <weight> field value is greater than the permitted maximum.

Solution:

1. Verify the weight of the parcel.
2. Adjust the <weight> field to a valid value within the allowable limit.
3. Check <parcel> section above

Example:

<weight>90</weight>

17.5 ERROR_MY_PUDO

Description:
This error occurs when the <parcelShopId> provided in the request is incorrect or invalid.

Root Cause:
The system was unable to locate the parcel shop associated with the specified <parcelShopId>.

Solution:

1. Verify the <parcelShopId> in your request. Ensure that it matches the correct and active parcel shop ID in our database.
2. Use our Parcel Shop Finder API to retrieve valid parcel shop IDs if necessary.

Example:

<parcelShopId>836920114</parcelShopId>

17.6 ERROR_INVALID_DEST_ZIP

Description:
This error occurs when the destination ZIP code provided in the request is invalid or does not match the corresponding country.

Root Cause:

• The <zipCode> field contains an incorrect or non-existent postal code.
• The ZIP code does not align with the destination country specified in <country>

• The ZIP code is currently not supported by our services.

Solution:

1. Double-check the <zipCode> field in your request.
2. Ensure the <zipCode> is accurate and matches the destination <country>.
3. Contact our services to check the availability of our services for this destination.

Example of Invalid Request:

<country>FR</country>
<zipCode>1000</zipCode> <!-- Incorrect ZIP code for France -->

Corrected Request:

<country>FR</country>
<zipCode>75001</zipCode>

17.7 SCHEMA_VALIDATION

Description:
This error occurs when the structure of your API request does not conform to the required schema or contains invalid values.

Root Cause:

• The request XML structure is incorrect.
• Required fields are missing or contain invalid data.
• Field values are improperly formatted.

Solution:

1. Review the API documentation to ensure your request adheres to the schema.
2. Verify that all required fields are included and correctly formatted.
3. Validate your request against the schema using an XML schema validator.

Example of Invalid Request:

<pickup>
    <date>19-10-2024</date> <!-- Incorrect date format -->
</pickup>

Corrected Request:

<pickup>
    <date>20241019</date> <!-- Correct date format (YYYYMMDD) -->
</pickup>