Collection Request Orders

 

 

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

Three addresses are identified, be sure they are entered in the right namespaces

 

  • Sender: This is your data, our customer, who orders the parcel collection to take place at point A and be delivered to point B. This address is not the place where the parcel will be picked up nor delivered. The fields are mandatory but the data in these namespaces can be masked would you like to do so.
  • Receiver: This is the location where the parcel will be delivered.
  • Collection Request Address: This is the location where the driver will present himself to pick up the parcel. The driver will bring the label himself and attach it to the parcel at pickup.

 

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>nl_NL</messageLanguage>
      </ns:authentication>
   </soapenv:Header>
    <soapenv:Body>
      <ns1:storeOrders>
         <order>
            <generalShipmentData>
               <sendingDepot>0530</sendingDepot>
               <product>CL</product>
               <sender>
                  <name1>Your (masked) account ordering the CR</name1>
                  <street>Office Street 1 (or masked address)</street>
                  <country>BE</country>
                  <zipCode>3000</zipCode>
                  <city>Leuven</city>
                  <type>B</type>
                  <phone>+3216000000</phone>
                  <email>cr-order@test.be</email>
               </sender>
               <recipient>
                  <name1>(Masked) Delivery Destination</name1>
                  <street>CR Destination Street 1</street>
                  <country>BE</country>
                  <zipCode>2800</zipCode>
                  <city>Mechelen</city>
                  <type>B</type>
                  <phone>+3215000000</phone>
                  <email>cr-receiver@test.be</email>          
               </recipient>
            </generalShipmentData>
             <parcels>
               <customerReferenceNumber1>TEST parcel 1</customerReferenceNumber1>
               <weight>100</weight>
               <printInfo1OnParcelLabel>true</printInfo1OnParcelLabel>
               <info1>Return Item 1</info1>
               <info2>123456789</info2>
            </parcels>
            <productAndServiceData>
               <orderType>collection request order</orderType>
               <pickup>
                  <quantity>1</quantity>
                  <date>20200615</date>
                  <day>1</day>
                  <collectionRequestAddress>
                      <name1>Pickup Place for Goods</name1>
                     <street>CR Pickup Street 1</street>
                      <country>BE</country>
                     <zipCode>2000</zipCode>
                     <city>Antwerpen</city>
                      <type>B</type>
                     <phone>+3230000000</phone>
                      <email>pickupaddress@test.be</email>
                  </collectionRequestAddress>
               </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 your Sales representative meanwhile to discuss your go live of this product for your account. 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 reference. No label will be generated. The driver will take the label to the place of pickup. 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.
  • Collection Request orders need to be transmitted before 15h30 to assure next business day exectution. All collection requests received after the daily cut-off, will be moved to the following business day.
  • Contact us through cr.530@dpd.be to cancel/modify your Collection Request manually, before 15h30 of the day the order was placed.

 

 

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>
               <parcelInformation>
                  <dpdReference/>
               </parcelInformation>
            </shipmentResponses>
         </orderResult>
      </storeOrdersResponse>
   </soap:Body>
</soap:Envelope>

 

 

Namespace values:

  <sendingDepot> Depot belonging to the account you are using to give the CR order.
  <product> Choose 'CL', can be hardcoded, the productcode will be overruled anyhow by the namespace <orderType>
<sender> <name1> The account name giving the order for the CR. Can be Customer or a masked name of your partner. This address is neglected operationally.
<sender> <street> The account address giving the order for the CR. Can be Customer or a masked address of your partner. This address is neglected operationally.
<sender> <country> The account country belonging to the name and address above. Has to be BE to make it a Belgian order
<sender> <zipCode> The account ZIP belonging to the name and address above
<sender> <city> The account city, corresponding to the ZIP above
<sender> <type> Choose 'B', can be hardcoded. Signifies this address is a 'Business' address (versus P = 'Private')
<sender> <phone> Optional. Use form +32###########
<sender> <email> Optional
<recipient> <name1> The actual destination name of the parcel after pickup and transit. Can be Customer or a masked name of your partner.
<recipient> <street> The actual destination address of the parcel after pickup and transit. Can be Customer or a masked -but real- address of your partner.
<recipient> <country> The actual country belonging to the name and address above. Can be any EU country.
<recipient> <zipCode> The actual ZIP belonging to the name and address above
<recipient> <city> The actual city, corresponding to the ZIP above
<recipient> <type> Choose 'B', can be hardcoded. Signifies this address is a 'Business' address (versus P = 'Private')
<recipient> <phone> Optional, but highly recommended. Use form +32###########
<recipient> <email> Optional
  <customerReferenceNumber1> Order Reference 
  <weight> Mandatory. Wheigt is entered in decagrams. So '100' translates to 1kg.
  <printInfo1OnParcelLabel> Boolean. Set to 'true' if you want the namespace value for <info1> (below) printed on the label
  <info1> Parcel Reference 1 for the CR (printable on the label) For now, please make 1 call per CR, multiparcel CR can be supported later on.
  <info2> Parcel Reference 2 for the CR (only visible in data/reporting) For now, please make 1 call per CR, multiparcel CR can be supported later on.
  <orderType> Choose 'collection order request', can be hardcoded.
  <quantity> Number of parcels to be collected. For now, please make 1 call per CR, multiparcel CR can be supported later on.
  <date> The date for the CR to be executed. Needs to be at least the next business day. Cut-off is 16h00 CET (minus some minutes for data handling/forwarding) Make last order of the day at 15h30 CET
  <day> Day of the week, as verification. '1' is Monday, '2' is Tuesday, … ,'5' is Friday
<collectionRequestAddress> <name1> The pickup address of the CR. Name of the original location the driver needs to go to. The end customer returning goods.
<collectionRequestAddress> <street> The pickup address of the CR.  Address of the original location the driver needs to go to. The end customer returning goods.
<collectionRequestAddress> <country> The pickup address of the CR.  Country of the original location the driver needs to go to. The end customer returning goods.
<collectionRequestAddress> <zipCode> The pickup address of the CR.  ZIP of the original location the driver needs to go to. The end customer returning goods.
<collectionRequestAddress> <city> The pickup address of the CR.  City of the original location the driver needs to go to. The end customer returning goods.
<collectionRequestAddress> <type> Choose 'B' or 'P'. Signifies this address is a 'Business' or  'Private'.
<collectionRequestAddress> <phone> Optional, but highly recommended. Use form +32###########
<collectionRequestAddress> <email> Optional, but highly recommended.

 

Submitted by CustomerIT on Fri, 06/12/2020 - 11:59