Please scroll lower.
Last change log: 19 March 2021.
- Precised what format the value needs to be (fields <customsAmountParcel> and <amountLine>)
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.
It's not possible to send multi-colli shipments to the UK. You can only send single-parcel shipments. Your parcel can however contain multiple items.
It's also only possible to send DPD Classic and DPD Home shipments (regular B2B and regular B2C). Saturday, Collection Request, Express, Parcelshop, etc are not possible.
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 numberof the Sender must be included in the <comment2> field of the <international> segment.
<international> segment
Node |
Type | Length | Description | Mandatory? |
---|---|---|---|---|
<parcelType> | Boolean | n/a | Please always set this to false | Yes |
<customsAmount> | Long | 99999 | Defines the customs amount in total without decimal separator (e.g. 1450 = 14.5 or 100 = 1). | Yes |
<customsCurrency> | String | 3 | Currency code in ISO 4217 alpha-3 format (ex EUR) | Yes |
<customsAmountEx> | Long | 99999 | Defines the converted customs amount in total without decimal separator (e.g. 1450 = 14.5 or 100 = 1). You can repeat what you put in <customsAmount> | Yes |
<customsCurrencyEx> | String | 3 | Currency code in ISO 4217 alpha-3 format. Currency for conversion (destination country). You can repeat what you put in <customsCurrency> | Yes |
<clearanceCleared> | String | 1 |
Please use value N |
Yes |
<prealertStatus> | String | 3 |
Please use value S03 |
Yes |
<exportReason> | String | 2 |
Reason for export : 01:sale 02:return/replacement 03:gift |
Yes |
<customsTerms> | String | 2 |
Declares the customs terms. Please use value 06 |
Yes |
<customsContent> | String | 35 | Describes the content of the parcel. | Yes |
<customsPaper> | String | 20 |
Lists the accompanying documents. The values are to be combined without separator (e.g. "ABG"). Following values are defined: A = commercial invoice B = pro forma invoice C = export declaration D = EUR1 E = EUR2 F = ATR G = delivery note H = third party billing I = T1 document |
No |
<customsEnclosure> | Boolean | n/a | Defines if the accompanying documents are at the parcel or not. Default value is false. | No |
<customsInvoice> | String | 20 | Defines the invoice number. | Yes |
<customsInvoiceDate> | Int | 99999 | Defines the invoice date (format YYYYMMDD). | Yes |
<customsAmountParcel> | Long | 99999 | Value of your entire parcel, with two decimal places without separator. Ex. If your parcel is worth 12.54€, use value 1254. If it's worth 550.20€, use value 55020 |
No |
<linehaul> | String | 2 | Defines mode of line haul. Possible values are AI for air RO for road. |
No |
<shipMrn> | String | 20 | Movement reference number of the electronical export declaration. | No |
<collectiveCustomsClearance> | Boolean | n/a | Flag for determining collective customs clearance. Default value is false | No |
<comment1> | String | 70 | Comment about your shipment | No |
<comment2> | String | 70 | Must contain HMRC number | Yes |
<commercialInvoiceConsigneeVatNumber> | String | 20 | Defines the commercial invoice consignee VAT number. - In case of a B2B shipment: use receiver's VAT number. - In case of a B2C shipment: use sender's VAT number |
Yes |
<commercialInvoiceConsignee> | See lower | n/a | Contains address data of commercial invoice consignee. See <commercialInvoiceConsignee> section | Yes |
<commercialInvoiceConsignor> | See lower | n/a | Contains address data of commercial invoice consignor. See <commercialInvoiceConsignor> section | Yes |
<commercialInvoiceLine> | See lower | n/a | Contains invoice line data | Yes |
<commercialInvoiceConsignee> and <commercialInvoiceConsignor> segments
Node |
Type | Length | Description | Mandatory? |
---|---|---|---|---|
<name1> | String | 35 | Name of the consignee / consignor | Yes |
<street> | String | 35 | Street of the consignee / consignor | Yes |
<houseNo> | String | 8 | House number of the consignee / consignor | Yes |
<country> | String | 2 | Country of the consignee / consignor (ISO 3166-2 Code) | Yes |
<zipCode> | String | 9 | Zipcode of the consignee / consignor. Please do not add prefixes. | Yes |
<city> | String | 35 |
City of the consignee / consignor |
Yes |
<phone> | String | 3 |
Phone of the consignee / consignor. For UK numbers, it needs to be the full phone number startingwith the country prefix. |
Yes |
<email> | String | 30 | Email of the consignee / consignor. It must be on an existing domain. | Yes |
<eoriNumber> | String | 30 | EORI number of the consignee / consignor. Please keep the notes mentioned earlier on this page in mind. | Yes |
<vatNumber> | String | 30 |
VAT number of the consignee / consignor. Please keep the notes mentioned earlier on this page in mind. |
Yes |
<commercialInvoiceLine> segment
You can have multiple <commercialInvoiceLine> segments: one for each item you have.
Node |
Type | Length | Description | Mandatory? |
---|---|---|---|---|
<customsTarif> | String | 8 | HS code of your item | Yes |
<receiverCustomsTarif> | String | 8 | Repeat of the HS code of your item | Yes |
<productCode> | String | 20 | Product code | No |
<content> | String | 80 | Description of your item | Yes |
<grossWeight> | Long | 99999 | Weight of this item in total. So if you have 200 pieces of this item, this is the weight of all 200. | Yes |
<itemsNumber> | Long | 99999 |
How many of this items this parcel has |
Yes |
<amountLine> | Long | 99999 |
Value of this item in total with two decimal places without separator. So if you have 200 pieces of this item, this is the value of all 200. |
Yes |
<customsOrigin> | String | 2 | Origin country of this item (ISO 3166-2 Code) | Yes |
<invoicePosition> | Long | 99999 | Invoice position of this item | Yes |
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>
</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> <!-- Mandatory for non-EU shipments -->
<!-- FOR SHIPMENTS TO NON-EU DESTINATIONS. -->
<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>2225522</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>
<!-- CUSTOMS SEGMENT FOR NON-EU ENDS HERE -->
</parcels>
<productAndServiceData>
<orderType>consignment</orderType>
</productAndServiceData>
</order>
</ns1:storeOrders>
</soapenv:Body>
</soapenv:Envelope>
Sample call B2C
<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>B2B 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>
<!-- Typically, 2C receivers dont have an EORI or VAT. Use the Sender's here instead.-->
<eoriNumber>1133113311</eoriNumber>
<vatNumber>BE123456</vatNumber>
</recipient>
</generalShipmentData>
<parcels>
<customerReferenceNumber1>Box 1234</customerReferenceNumber1>
<weight>340</weight> <!-- Mandatory for non-EU shipments -->
<!-- FOR SHIPMENTS TO NON-EU DESTINATIONS. -->
<international>
<parcelType>false</parcelType>
<customsAmount>1400</customsAmount>
<customsCurrency>EUR</customsCurrency>
<customsAmountEx>1400</customsAmountEx>
<customsCurrencyEx>EUR</customsCurrencyEx>
<clearanceCleared>F</clearanceCleared>
<prealertStatus>S03</prealertStatus>
<exportReason>01</exportReason>
<customsTerms>06</customsTerms>
<customsContent>Paperclips</customsContent>
<customsInvoice>12345</customsInvoice>
<customsInvoiceDate>20190624</customsInvoiceDate>
<comment2>QQ123456C</comment2>
<!-- Typically, 2C receivers dont have an EORI or VAT. Use the Sender's here instead.-->
<commercialInvoiceConsigneeVatNumber>BE123456</commercialInvoiceConsigneeVatNumber>
<commercialInvoiceConsignee>
<name1>B2B 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>
<!-- Typically, 2C receivers dont have an EORI or VAT. Use the Sender's here instead.-->
<eoriNumber>1133113311</eoriNumber>
<vatNumber>BE123456</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>340</grossWeight>
<itemsNumber>1</itemsNumber>
<amountLine>1515</amountLine>
<customsOrigin>BE</customsOrigin>
<invoicePosition>5151</invoicePosition>
</commercialInvoiceLine>
</international>
<!-- CUSTOMS SEGMENT FOR NON-EU ENDS HERE -->
</parcels>
<productAndServiceData>
<orderType>consignment</orderType>
<predict>
<channel>1</channel>
<value>receiver@receivercompany.com</value>
<language>NL</language>
</predict>
</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> <!-- Mandatory for non-EU shipments -->
<!-- FOR SHIPMENTS TO NON-EU DESTINATIONS. -->
<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>
<!-- CUSTOMS SEGMENT FOR NON-EU ENDS HERE -->
</parcels>
<productAndServiceData>
<orderType>consignment</orderType>
</productAndServiceData>
</order>
</ns1:storeOrders>
</soapenv:Body>
</soapenv:Envelope>