Meta API Live Collection Request
Collection Request
-
General
Please note Collection Requests are not the same as Pickup Requests!
Collection Requests, as described here, are a way to ask DPD to go pick up a parcel somewhere and bring it to you or a third party. A Pickup Request on the other hand, is simply asking DPD to come send a driver over to you so they can pick up the parcels you prepared. Pickup Requests are also possible in Meta API and are discussed in it’s separate section.Attention – Live requests will be carried out, even if only for testing purposes. Please agree with the Meta API team or DPD BU Sales/Operational representative to cancel the assignments timely in such case.
Two addresses are identified when making a collection request:
- CollectionPoint: 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. You don’t need to print a label yourself.
- receiver: This is the location where the parcel will be delivered.
Below you will find an example of a basic request, but you can find all possible parameters and fields on the Swagger page.
-
Call Parameters
Method:
- POST
URL:
- https://api.dpdgroup.com/shipping/v1/colreq
Parameters:
- debug true
Authorization:
- X_DPD_TOKEN Bearer Token from login service (326-digits)
Headers
- Content-Type application/json
-
Call Body
Body:
- Object JSON (raw)
{ "customerReferenceNumbers": [ "S_2021-12-16_01" ], "collectionPoint": { "address": { "name1": "DPD BE TEST PICKUP", "street": "Teststraat 25", "country": "BE", "zipCode": "3130", "city": "Begijnendijk" }, "contact": { "phone1": "0499999999", "email": "test@dpd.be", "contactPerson":"DPD Contact" }, "legalEntity": { "businessType": "B" } }, "receiver": { "address": { "name1": "DPD BE RECEIVER", "street": "Egide Walschaertstraat 20", "country": "BE", "zipCode": "2800", "city": "Mechelen" }, "contact": { "phone1": "0499999999", "email": "test@dpd.be", "contactPerson":"DPD Contact" }, "legalEntity": { "businessType": "B" } }, "parcel": { "parcelInfos": { "weight": "6000" }, "senderParcelRefs": [ "P_2021-12-16_01" ] }, "pickup": { "date": "2022-02-03", "fromTime": "1000", "toTime": "1500" } }
-
Response
RESPONSE
Body:
Confirmation with Collection Request Web ID (not the parcel number)
Important:
The Collection Request Label number will only be generated and available the business day of actual pickup. You will have to recover the parcel number from your reporting tools, not via this API.