Not logged in - Login
View History

Shipment Service 2

Shipment Service

The shipment service must be called to generate the 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. So it is not advised and necessary to call the login every time for a call to the shipment service.

URLS

Stage: https://public-dis-stage.dpd.nl/Services/ShipmentService.svc?singlewsdl

Process

The following diagrams illustrate how the process works.

Parameters

Here you will find the definitions of all parameters. In order of the wsdl.

Authentication

ParameterData type LengthDescriptionSupported values
delisIdString6-10Your Delis ID provided by DPD 
authtokenString128Authentication token from the login service 
messageLanguageString5Optional parameter, default us_US,Dutch (nl_NL)
American English (us_US) & (en_US)

StoreOrders

PrinterOptions

ParameterData typeLengthDescriptionSupported values
printerLanguageString3PDFPDF / ZPL
paperFormatString2A6 or A4. Paper format for parcel labels.A4 or A6

Printer

ParameterData typeLengthDescriptionSupported values
offsetInteger50Horizontal offset in mm of the direct printer. Ignored with PDF outputnot used
offsetInteger50Vertical offset in mm of the direct printer. Ignored with PDF outputnot used

generalShipmentData

ParameterData typeLengthDescriptionSupported values
mpsCustomerReferenceNumber1String35Consignment customer reference number 1, also customer reference number for collection request orders (maximal length 50)Col.Req not used
mpsCustomerReferenceNumber2String35Consignment customer reference number 2 
mpsCustomerReferenceNumber3String35Consignment customer reference number 3 
mpsCustomerReferenceNumber4String35Consignment customer reference number 4 
sendingDepotString4  
productString2-3 CL, E10, E12, E18, IE2
mpsVolume   not used
mpsWeight   not used
mpsExpectedSendingDate   not used
mpsExpectedSendingTime   not used

Sender

ParameterData typeLengthDescriptionSupported values
name1String50Name of address owner 
name2String35Name 2 of address owner 
streetString50Street of address owner 
houseNoString8House number of address owner 
stateString2State of address owner in ISO 3166-2 code 
countryString2Country of address owner in ISO 3166-1 alpha-2 code 
zipCodeString9Zip code of address owner 
cityString50City/town of address owner 
glnLong9999999999999International location number of address owner 
contactString35Contact person of address owner 
phoneString30Phone number of address owner. Mandatory if phone is the chosen notification channel. No required data format 
faxString30Fax number of address owner. No required data format 
emailString30Email address of address owner. For collection requests the maximum length is 40, otherwise always 50 
commentString70Comment on address owner 
iaccountString50Account allocation or cost center (for VTG) of invoice data for consignmentsnot used

Recipient

ParameterData typeLengthDescriptionSupported values
name1String50Name of address owner 
name2String35Name 2 of address owner 
streetString50Street of address owner 
houseNoString8House number of address owner 
stateString2State of address owner in ISO 3166-2 code 
countryString2Country of address owner in ISO 3166-1 alpha-2 code 
zipCodeString9Zip code of address owner 
cityString50City/town of address owner 
contactString35Contact person of address owner 
phoneString30Phone number of address owner. Mandatory if phone is the chosen notification channel. No required data format 
faxString30Fax number of address owner. No required data format 
emailString30Email address of address owner. For collection requests the maximum length is 40, otherwise always 50 
commentString70Comment on address owner 

Parcels

ParameterData typeLengthDescriptionSupported values
parcelLabelNumberstring  Not used
customerReferenceNumber1stringmaxLength: 35Printed on Label as Reference 1 
customerReferenceNumber2stringmaxLength: 35Printed on Label as Reference 2 
customerReferenceNumber3stringmaxLength: 35Not printed on Label 
customerReferenceNumber4stringmaxLength: 35Not printed on Label 
volumeint Volume of the single parcel (length/width/height in format LLLWWWHHH) in cm without separators050 = 50 cm
100 = 100 cm
weightint Parcel weight in grams rounded in 10 gram units without decimal delimiter (e.g. 300 equals 3kg)0 = 0 kg
100 = 1kg
3150 = 31,5 kg
codSee table COD
internationalSee table International
commercialInvoiceConsigneeSee table commercialInvoiceConsignee
hazardousSee table Hazardous
returnsBoolean Defines if parcel is a return parcel.
The return parcel must always be next in order to the corresponding outbound parcel.
Default value is false.
false, true

cod

ParameterData typeLengthDescriptionSupported values
amountInteger9Amount, price times 100. Mandatory for COD.See table COD Amounts per country
currencyString3Currency used, example: EUR (default). Mandatory for COD.See table COD Amounts per country
inkassoInteger1Inkasso type 0 = cash, 1 cheque. Mandatory for COD. See Possible Products for minimum and maximum allowed amounts. 

COD Amounts per country

Amount of payment, if the amount is 0 (zero) than COD is not possible. Negative amounts are not allowed. Higher amounts than the maximum specified in table is not allowed.

CountryToCurrencyMaximum cashMaximum cheque
NetherlandsCzech RepublicCZK1200000
NetherlandsHungaryHUF5000000
NetherlandsAustriaEUR25005000
NetherlandsGermanyEUR25005000
NetherlandsBelgiumEUR25005000
NetherlandsLuxembourgEUR25005000
NetherlandsNetherlandsEUR25005000
BelgiumCzech RepublicCZK1200000
BelgiumHungaryHUF5000000
BelgiumAustriaEUR25005000
BelgiumGermanyEUR25005000
BelgiumNetherlandsEUR25005000
BelgiumLuxembourgEUR25005000
BelgiumBelgiumEUR250010000
LuxembourgCzech RepublicCZK1200000
LuxembourgHungaryHUF5000000
LuxembourgAustriaEUR25005000
LuxembourgGermanyEUR25005000
LuxembourgNetherlandsEUR25005000
LuxembourgLuxembourgEUR25005000
LuxembourgBelgiumEUR25005000

ProductAndServiceData

ParameterData typeLengthDescriptionSupported values
saturdayDeliveryBoolean Set to True to allow saturday deliveries.true, false
parcelShopDeliverySee table parcelShopDelivery
predictSee table predict

parcelShopDelivery

ParameterData typeLengthDescriptionSupported values
parcelShopId    

parcelShopNotification

ParameterData typeLengthDescriptionSupported values
channel    
value    
language    

predict

ParameterData typeLengthDescriptionSupported values
channelint1Defines type of proactive notification.1 = email 3 = SMS
valuestring50Data for proactive notification, e.g. email address or mobile phone number.
The data format for the proactive message types: SMS +international country number#phone number Examples: +31612345678, 0031#612345678, 0612345678
10-digit phonenumber starting with 06 and having destinationaddress in NL: assumed to be Dutch mobile number
+316
+31#6
00316
06
+31#06
languagestring2Language of the proactive notification in ISO-3166-1NL, EN, FR for predict within BeNeLux, outside BeNeLux we advise EN

storeOrderResponse

Response object

ParameterData typeLengthDescription
parcellabelsPDFText Base64 encoded string containing the PDF document

Shipment response

ParameterData typeLengthDescription
identificationNumberstring1Serves as unique alphanumeric key of the shipment used by customer
mpsIdstring25The shipment number for consignment data.
If ordertype is pickup information, the shipment number is an internal database id, which is necessary for technical support requests at DPD

In case of an error

NodeDescription
delisIdYour delis ID provided by DPD
authtokenToken to authenticate with the other services provided by the DPD Integration Services
depotDepot number
faultcodeType of fault
faultstringType of fault text string
errorCodeCode that identifies the type of error, see table Error Codes
errorMessageError message in the language provided in the request
authtokenToken to authenticate with the other services provided by the DPD Integration Services

Error codes

CodeExplanationBest Practise
SHIPPING_1parcel label print fails 
SHIPPING_2delete fails on database level during rollback after some other error 
COMMON_1unexpected runtime error 
COMMON_2mandatory input field is empty 
COMMON_3length of data for field does not fit 
COMMON_4input data contains invalid special character 
COMMON_5a swap parcel is ordered, but there is more than one parcel 
COMMON_6some input data field values result in an invalid combination 
COMMON_7input data contains invalid value 
COMMON_8a field is to be stored in database, but there is not database field mapped for it 
DATABASE_6transfer state of order is to be changed but order is already committed 
DATABASE_7update fails on database level during order storing 
DATABASE_8delete fails on database level during rollback after some other error 
DATABASE_21order is to be inserted in databse, but has already a database id 
DATABASE_22order is to be committed after inserting, but there is no database id for update given 
DATABASE_24some other error, but no database id for record is given 
MPSEXP_1parcel label number is already in use 
PARCELNUMBER_3time out 
ROUTING_1no route could be found for depot and feature 
ROUTING_2invalid input data 
ROUTING_3the connection to the database failed 
ROUTING_4an internal failure occurs 
ROUTING_5no depot could be found 
ROUTING_6no pickup date was given 
ROUTING_7internal extension rule error 
ROUTING_8malformed zip code 
ROUTING_9missing country code 
ROUTING_10missing routing place 
ROUTING_11missing service code 
ROUTING_12routing place error 
ROUTING_13sending date error 
ROUTING_14service code error 
ROUTING_15invalid relation of service codes 
ROUTING_16unknown country code 
ROUTING_17unknown destination depot 
ROUTING_18unknown zip code 
ROUTING_19unknown routing place 
ROUTING_20unknown service code 
ROUTING_21invalid service code 
ROUTING_22parcel is labelled as return parcel but returns is not possible 
ROUTING_23missing routing place or destination depot 
ROUTING_24unknown 
SHIPMENT_IE2_COUNTRY_NOT_VALIDInternational Express invoice country is not valid
SHIPMENT_IE2_CURRENCY_NOT_ISO4217International Express currency is not according to the ISO4217 standard 
SHIPMENT_IE2_MISSING_CONTACTInternational Express node missing contact information 
SHIPMENT_IE2_NO_DATA_FOR_INTERNATIONALInternational Express chosen but the international node empty 
SHIPMENT_IE2_REQUIRED_FIELDS_MISSINGInternational Express required fields are: PARCELTYPE, CAMOUNT, CURRENCY, CTERMS, CCONTENT, CNAME1, CSTREET, CCOUNTRYN, CCITY, CPHONE 

Code examples

SOAP Examples

Login Service

Parcel Shop Service

Shipment Service

Depot Service

Parcel LifeCycle Service

C# .NET example

Login Service

Parcel Shop Service

Shipment Service

Depot Service

Parcel LifeCycle Service

PHP example

Login Service

Parcel Shop Service

Shipment Service

Depot Service

Parcel LifeCycle Service