Pickup Orders

 

 

To enter a Pickup Request via API, follow the call structure below.

 

This is a separate call from your Shipment calls to assure a driver will come to one of your official pickup addresses to collect the parcels you have prepared for a shipment in case you do not have a daily pickup agreed upon.

This is not a way to arrange a pickup at a third party address to ship a parcel to a custom recipient. For that use, go to https://doc.dpd.be/SWS/CollectionRequest.

 

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>*****</delisId>
      <authToken>*****</authToken>
         <messageLanguage>en_EN</messageLanguage>
      </ns:authentication>
     </soapenv:Header>
   <soapenv:Body>
      <ns1:storeOrders>
         <order>
            <generalShipmentData>
               <sendingDepot>0530</sendingDepot>
               <product>CL</product>
               <sender>
                  <name1>Agreed Account Pickup Address</name1>
                  <street>Your Address 1</street>
                  <country>BE</country>
                  <zipCode>3000</zipCode>
                  <city>Leuven</city>
                  <type>B</type>
               </sender>
               <recipient>
                  <name1>Agreed Account Pickup Address</name1>
                  <street>Your Address 1</street>
                  <country>BE</country>
                  <zipCode>3000</zipCode>
                  <city>Leuven</city>
                  <type>B</type>  
               </recipient>
            </generalShipmentData>
            <productAndServiceData>
               <orderType>pickup information</orderType>
               <pickup>
                  <quantity>1</quantity>
                  <date>20200615</date>
                  <day>1</day>
                  <fromTime1>0900</fromTime1>
                  <toTime1>1800</toTime1>
               </pickup>
            </productAndServiceData>
         </order>
      </ns1:storeOrders>
   </soapenv:Body>
</soapenv:Envelope>

 

!! Attention !!

Do not use this functionality on the LIVE environment before our IT department granted you permission to do so. Orders would be executed and you will be invoiced for the costs, regardless of your testing purposes.

 

!! Attention !!

  • You can develop on the STAGE environment and contact DPD Customer IT before proceeding to the LIVE environment. We will help you validate testing.
  • The response will not return anything except for a MpsID (= order ID). No printable confirmation will be generated. The driver will come and collect the parcels at the specified location. A request is definitive and will be charged by invoice if accepted by the API, even if the request was composed of wrong or incomplete data.
  • Orders must be entered before 22h00 to be executed the next business day.
  • Contact you pickup depot to cancel/modify your pickup request manually. ( Mechelen: transport.530@dpd.be / Aalter: transport.536@dpd.be / Courcelles: transport.534@dpd.be / Flémalle: transport.532@dpd.be / Luxembourg: transport.539@dpd.lu)

 

 

SAMPLE RESPONSE:

 

<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>
      <storeOrdersResponse xmlns="http://dpd.com/common/service/types/ShipmentService/3.3">
         <orderResult>
            <shipmentResponses>
               <mpsId>54263</mpsId>
            </shipmentResponses>
         </orderResult>
      </storeOrdersResponse>
   </soap:Body>
</soap:Envelope>

 

 

Namespace values:

  <sendingDepot>0530</sendingDepot> Pickup Depot for Customer
  <product>CL</product> Mandatory, set to 'CL'
</sender> <name1>Agreed Account Pickup Address</name1> Mandatory, the location name from where the pickup is needed, maxlength=35
</sender> <street>Your Address 1</street> Mandatory, the location address from where the pickup is needed, maxlength=35
</sender> <country>BE</country> Mandatory, the location country from where the pickup is needed, can only be customer BU country
</sender> <zipCode>3000</zipCode> Mandatory, the location ZIP from where the pickup is needed
</sender> <city>Leuven</city> Mandatory, the location city from where the pickup is needed
</sender> <type>B</type> Mandatory, signifies ‘Business’, so hardcode to ‘B’
<recipient> <name1>Agreed Account Pickup Address</name1> Mandatory, to fill out your account details, but neglected in the operational data
<recipient> <street>Your Address 1</street> Mandatory, to fill out your account details, but neglected in the operational data
<recipient> <country>BE</country> Mandatory, to fill out your account details, but neglected in the operational data
<recipient> <zipCode>3000</zipCode> Mandatory, to fill out your account details, but neglected in the operational data
<recipient> <city>Leuven</city> Mandatory, to fill out your account details, but neglected in the operational data
<recipient> <type>B</type> Mandatory, to fill out your account details, but neglected in the operational data
  <orderType>pickup information</orderType> Mandatory, specifies action, so hardcode to ‘pickup information’
  <quantity>1</quantity> Mandatory, number of parcels, max 20        
  <date>20200615</date> Mandatory, date of pickup, minimum one business day after the date of request. : YYYYMMDD
  <day>1</day> Mandatory, day of the week: Monday=1, Tuesday=2, … , Friday=5
Submitted by CustomerIT on Fri, 06/12/2020 - 13:05