ShipmentService-Public_4_3 Web Service Reference

ShipmentService-Public_4_3

Web Service Reference

Version 4.3.0

14.10.2019

ShipmentService-Public_4_3

Web Service Reference

Table of contents

History ............................................................................................................................................................ 5

Methods ......................................................................................................................................................... 6

storeOrders ................................................................................................................................................ 7

Complex Types ........................................................................................................................................... 10

types ....................................................................................................................................................... 10

OutputType ......................................................................................................................................... 10

additionalInvoiceLine .......................................................................................................................... 11

address ............................................................................................................................................... 12

cod ...................................................................................................................................................... 14

delivery ............................................................................................................................................... 15

faultCodeType .................................................................................................................................... 16

generalShipmentData ......................................................................................................................... 18

hazardous ........................................................................................................................................... 20

higherInsurance .................................................................................................................................. 23

international ........................................................................................................................................ 23

notification ........................................................................................................................................... 26

parcel .................................................................................................................................................. 27

parcelInformationType ........................................................................................................................ 30

parcelShopDelivery ............................................................................................................................. 30

personalDelivery ................................................................................................................................. 31

ShipmentService-Public_4_3

Web Service Reference

pickup ................................................................................................................................................. 32

printOption .......................................................................................................................................... 34

printOptions ........................................................................................................................................ 35

printer .................................................................................................................................................. 35

proactiveNotification ............................................................................................................................ 36

productAndServiceData ...................................................................................................................... 37

shipmentResponse ............................................................................................................................. 39

shipmentServiceData .......................................................................................................................... 40

storeOrders ......................................................................................................................................... 40

storeOrdersResponse ......................................................................................................................... 41

storeOrdersResponseType ................................................................................................................. 41

types_authentication ............................................................................................................................. 42

anonymous ........................................................................................................................................ 42

authentication ................................................................................................................................ 42

authenticationFault ........................................................................................................................ 43

Simple Types .............................................................................................................................................. 44

types ....................................................................................................................................................... 44

OutputFormatType .............................................................................................................................. 44

startPosition ........................................................................................................................................ 44

Elements ...................................................................................................................................................... 45

types ....................................................................................................................................................... 45

ShipmentService-Public_4_3

Web Service Reference

storeOrders ......................................................................................................................................... 45

storeOrdersResponse ......................................................................................................................... 45

types_authentication ............................................................................................................................. 46

authentication ..................................................................................................................................... 46

authenticationFault ............................................................................................................................. 46

ShipmentService-Public_4_3

Web Service Reference

History

Version 4.3.0

- New structure for parcel labels, now including ZPL labels and other types.

- New fields for ParcelLock in Pickup (boxId and boxTan).

- New field mobile in type address.

- New fields customsAmountExport, customsCurrencyExport, commercialInvoiceConsignor,

commercialInvoiceConsignorVatNumber, additionalInvoiceLines in type international.

- New type additionalInvoiceLine.

- Changed field extraPickup in type pickup from Boolean to Integer and invoicePosition in type

international from String to Integer.

- Changed field length of field email in type address, customsAmount, customsAmountParcel,

customsContent, customsTarif in type international, parcelClass in type parcel, phone in type

personalDelivery.

- New product DPD MAX (MAX in generalShipmentData).

- New product DPD Priority (PM4 in generalShipmentData).

- New feature DPD Food (DID).

Version 3.2.0

- New field extraPickup in pickup.

- New field startPosition in printOptions.

Version 3.1.0

- New field tyres in productAndServiceData.

- Field customerNumber in sender/recipient address and field invoicePosition in international must be

numeric.

- Parcelblock is optional, for only one parcel with no additional data.

- Return parcel label in format A7 support.

- Return parcel label receipt support.

- Variable sender address support.

- Parcel with 0kg weight handle as classic parcel.

Version 3.0.0

- New field countrySpecificService in productAndServiceData.

- Removed field paperFormat in storeOrders.

- Introduced new element printOptions in storeOrders with paperformat, printertype and printer options.

ShipmentService-Public_4_3

Web Service Reference

Methods

Following methods are available for the service ShipmentService-Public_4_3

Method name Description

storeOrders Stores up to 30 shipments and creates corresponding shipment

documents.

ShipmentService-Public_4_3

Web Service Reference

Method: storeOrders

Description

Stores up to 30 shipments and creates corresponding shipment documents.

Sample request:

<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/4.3">

<soapenv:Header>

<ns:authentication>

</ns:authentication>

</soapenv:Header>

<soapenv:Body>

<ns1:storeOrders>

</printOption>

</printOptions>

<order>

<name1>Abholer1</name1>

<street>Strasse 1</street>

</sender>

<name1>Test-Empfaenger</name1>

<street>Test-Strasse</street>

ShipmentService-Public_4_3

Web Service Reference

<city>Aschaffenburg</city>

</recipient>

</generalShipmentData>

</parcels>

<orderType>consignment</orderType>

</productAndServiceData>

</order>

</ns1:storeOrders>

</soapenv:Body>

</soapenv:Envelope>

Action

http://dpd.com/common/service/ShipmentService/4.3/storeOrders

Input

The input for method storeOrders is as follows:

Name Element

authentication * types_authentication:authentication

parameters types:storeOrders

* header parameter

Output

The output for method storeOrders is as follows:

Name Element

return types:storeOrdersResponse

ShipmentService-Public_4_3

Web Service Reference

Faults

The defined faults for method storeOrders are as follows:

Name Element

AuthenticationFault types_authentication:authenticationFault

ShipmentService-Public_4_3

Web Service Reference

Complex Types

Namespace: types

URL: http://dpd.com/common/service/types/ShipmentService/4.3

Namespace: types

Complex Type: OutputType

Description

Contains the output data, e.g. parcel labels.

Field name Data type /

Occurrence /

Range

Description

format types:OutputFormatType

1 .. 1 /

The type of the output data.

content xs:base64Binary /

1 .. 1 /

The output data

ShipmentService-Public_4_3

Web Service Reference

Namespace: types

Complex Type: additionalInvoiceLine

Description

Bundles information about an invoice position for international parcels.

Field name Data type /

Occurrence /

Range

Description

customsInvoicePosition xs:int /

0 .. 1 /

maxInclusive: 999999

Number of invoice position.

quantityItems xs:int /

0 .. 1 /

maxInclusive: 9999

Number of items.

customsContent xs:string /

1 .. 1 /

maxLength: 200

Content.

customsTarif xs:string /

0 .. 1 /

maxLength: 10

Customs tarif number.

customsAmountLine xs:long /

0 .. 1 /

maxInclusive: 999999999

999999

Value of invoice position (in invoice currency) with

two decimal digits without separator.

customsOrigin xs:int /

0 .. 1 /

maxInclusive: 999

Country of invoice origin (ISO 3166).

customsNetWeight xs:int /

0 .. 1 /

maxInclusive: 99999999

Parcel net weight in gramm rounded in 10 gramm

units without decimal delimiter (e.g. 300 equals

3kg).

ShipmentService-Public_4_3

Web Service Reference

customsGrossWeight xs:int /

0 .. 1 /

maxInclusive: 99999999

Parcel gross weight in gramm rounded in 10 gramm

units without decimal delimiter (e.g. 300 equals

3kg).

Namespace: types

Complex Type: address

Description

Bundles address data.

Field name Data type /

Occurrence /

Range

Description

name1 xs:string /

1 .. 1 /

maxLength: 50

Name of address owner. For dangerous goods the

maximum length is 50, otherwise always 35.

name2 xs:string /

0 .. 1 /

maxLength: 35

Second name of address owner.

street xs:string /

1 .. 1 /

maxLength: 50

Street of address owner. For dangerous goods the

maximum length is 50, otherwise always 35.

houseNo xs:string /

0 .. 1 /

maxLength: 8

House number of address owner.

state xs:string /

0 .. 1 /

length: 2

State of address owner in ISO 3166-2 code (e.g. BY

= Bayern).

country xs:string /

1 .. 1 /

length: 2

Country of address owner in ISO 3166-1 alpha-2

format (e.g. 'DE').

ShipmentService-Public_4_3

Web Service Reference

zipCode xs:string /

1 .. 1 /

maxLength: 9

Zip code of address owner.

city xs:string /

1 .. 1 /

maxLength: 50

City/town of address owner. For dangerous goods

the maximum length is 50, otherwise always 35.

gln xs:long /

0 .. 1 /

maxInclusive: 99999999

99999

International location number of address owner.

customerNumber xs:string /

0 .. 1 /

maxLength: 17

Customer number of address owner. Maximum

length is 17 for consignment and pickup information,

11 for collection request.

Mandatory for sender's address.

contact xs:string /

0 .. 1 /

maxLength: 35

Contact person of address owner.

phone xs:string /

0 .. 1 /

maxLength: 30

Phone number of address owner. Mandatory if

phone is the chosen notification channel.

If SMS notification is chosen, either mobile or phone

must be filled.

mobile xs:string /

0 .. 1 /

maxLength: 30

Mobile phone number of address owner. If SMS

notification is chosen, either mobile or phone must

be filled.

fax xs:string /

0 .. 1 /

maxLength: 30

Fax number of address owner. No required data

format.

email xs:string /

0 .. 1 /

pattern: [\w\p{L}!#$%&'*+

/=?^_`{|}~-]+(\.[\w\p{L}!#$

%&'*+/=?^_`{|}~-]+)*@[\w

][\w\p{L}\-]*(\.[\w\p{L}\-]+)*

(\.[a-z]{2,16})

minLength: 5

maxLength: 100

The email address including at minimum one "@"

character as a delimiter between addresser and

domain. The domain must include at minimum

one "." as a delimiter between domain-name and

domain-country.

ShipmentService-Public_4_3

Web Service Reference

comment xs:string /

0 .. 1 /

maxLength: 70

Comment on address owner.

iaccount xs:string /

0 .. 1 /

maxLength: 50

Account allocation or cost center (for VTG) of invoice

data for consignments.

Namespace: types

Complex Type: cod

Description

Bundles cash on delivery data.

Field name Data type /

Occurrence /

Range

Description

amount xs:long /

1 .. 1 /

maxInclusive: 99999999

COD amount in the currency of the destination

country. The amount is specified as integer value

e.g. 300.00 becomes 30000.

Please note the national ceilings for cod in the

corresponding relations.

currency xs:string /

1 .. 1 /

length: 3

ISO 4217 alpha-3 currency code (destination

country).

inkasso xs:int /

1 .. 1 /

Declares type of collection.

Possible values are:

0 = Cash,

1 = Crossed cheque.

purpose xs:string /

0 .. 1 /

maxLength: 14

Purpose of use.

ShipmentService-Public_4_3

Web Service Reference

bankCode xs:string /

0 .. 1 /

maxLength: 25

Bank code. If this value is filled, parameters

for bankName, bankAccountNumber and

bankAccountHolder must also be filled.

bankName xs:string /

0 .. 1 /

maxLength: 27

Bank name. If this value is filled, parameters

for bankCode, bankAccountNumber and

bankAccountHolder must also be filled.

bankAccountNumber xs:string /

0 .. 1 /

maxLength: 25

Bank account number. If this value is filled,

parameters for bankCode, bankName and

bankAccountHolder must also be filled.

bankAccountHolder xs:string /

0 .. 1 /

maxLength: 30

Account holder. If this value is filled, parameters for

bankCode, bankName and bankAccountNumber

must also be filled.

iban xs:string /

0 .. 1 /

maxLength: 50

International account number.

If this value is filled, parameters for bankCode,

bankName, bankAccountNumber and

bankAccountHolder must also be filled.

bic xs:string /

0 .. 1 /

maxLength: 50

Bank identifier code.

If this value is filled, parameters for bankCode,

bankName, bankAccountNumber and

bankAccountHolder must also be filled.

Namespace: types

Complex Type: delivery

Description

Bundles delivery data.

Field name Data type /

Occurrence /

Range

Description

day xs:string /

0 .. 1 /

maxLength: 20

Allowed delivery days in the week (0 = Sunday, 1 =

Monday etc.).

ShipmentService-Public_4_3

Web Service Reference

Comma separated list of possible delivery days (e.g.

"2,3,4,5").

dateFrom xs:int /

0 .. 1 /

maxInclusive: 99999999

Fixed delivery from date - format YYYYMMDD, e.g.

20080213.

dateTo xs:int /

0 .. 1 /

maxInclusive: 99999999

Fixed delivery to date - format YYYYMMDD, e.g.

20080213.

timeFrom xs:int /

0 .. 1 /

maxInclusive: 2400

Time from which the consignee is available - format

hhmm (local time receipient country), e.g. 1400 or

0830.

timeTo xs:int /

0 .. 1 /

maxInclusive: 2400

Time until the consignee is available - format hhmm

(local time receipient country), e.g. 1600 or 0930.

Namespace: types

Complex Type: faultCodeType

Description

Bundles fault code type data.

Field name Data type /

Occurrence /

Range

Description

faultCode xs:string /

1 .. 1 /

Possible error codes are:

SHIPPING_1 - Pickup address is unknown for

customer,

SHIPPING_2 - Parcel label print fails,

COMMON_1 - Unexpected runtime error,

COMMON_2 - Mandatory input field is empty,

COMMON_3 - Length of data for field does not fit,

COMMON_4 - Input data contains invalid special

character,

COMMON_5 - A swap parcel is ordered, but there is

more than one parcel,

ShipmentService-Public_4_3

Web Service Reference

COMMON_6 - Some input data field values result in

an invalid combination,

COMMON_7 - Input data contains invalid value,

COMMON_8 - A field is to be stored in database, but

there is not database field mapped for it,

DATABASE_6 - Transfer state of order is to be

changed but order is already committed,

DATABASE_7 - Update fails on database level

during order storing,

DATABASE_8 - Delete fails on database level

during rollback after some other error,

DATABASE_21 - Order is to be inserted in databse,

but has already a database id,

DATABASE_22 - Order is to be committed after

inserting, but there is no database id for update

given,

DATABASE_24 - Feletion is necessary because of

some other error, but no database id for record is

given,

MPSEXP_1 - Parcel label number is already in use,

ROUTING_1 - No route could be found for depot

and feature,

ROUTING_2 - Invalid input data,

ROUTING_3 - The connection to the database

failed,

ROUTING_4 - An internal failure occurs,

ROUTING_5 - No depot could be found,

ROUTING_6 - No pickup date was given,

ROUTING_7 - Internal extension rule error,

ROUTING_8 - Malformed zip code,

ROUTING_9 - Missing country code,

ROUTING_10 - Missing routing place,

ROUTING_11 - Missing service code,

ROUTING_12 - Routing place error,

ROUTING_13 - Sending date error,

ROUTING_14 - Service code error,

ROUTING_15 - Invalid relation of service codes,

ROUTING_16 - Unknown country code,

ROUTING_17 - Unknown destination depot,

ROUTING_18 - Unknown zip code,

ROUTING_19 - Unknown routing place,

ROUTING_20 - Unknown service code,

ROUTING_21 - Invalid service code,

ROUTING_21 - Parcel is labelled as return parcel

but returns is not possible,

ROUTING_22 - Missing allow,

ShipmentService-Public_4_3

Web Service Reference

ROUTING_23 - Missing routing place or destination

depot.

message xs:string /

1 .. 1 /

Message with detailed information for the fault (e.g.

incorrect field).

Namespace: types

Complex Type: generalShipmentData

Description

Bundles general shipment data.

Field name Data type /

Occurrence /

Range

Description

mpsId xs:string /

0 .. 1 /

maxLength: 25

The shipment number for consignment data.

The shipment number is only accepted if the parcel

label number is allocated by customer.

It starts with one of "MPS", "EXP" or "B2C", the last

eight ciphers are the date in format yyyyMMdd.

cUser xs:string /

0 .. 1 /

maxLength: 10

User ID of the person who made the entry.

mpsCustomerReference

Number1

xs:string /

0 .. 1 /

maxLength: 50

Consignment customer reference number 1

(maximal length 35), also customer reference

number for collection request orders (maximal

length 50).

mpsCustomerReference

Number2

xs:string /

0 .. 1 /

maxLength: 35

Consignment customer reference number 2.

mpsCustomerReference

Number3

xs:string /

0 .. 1 /

maxLength: 35

Consignment customer reference number 3.

ShipmentService-Public_4_3

Web Service Reference

mpsCustomerReference

Number4

xs:string /

0 .. 1 /

maxLength: 35

Consignment customer reference number 4.

identificationNumber xs:string /

0 .. 1 /

maxLength: 999

Serves as unique alphanumeric key of the shipment

used by customer.

sendingDepot xs:string /

1 .. 1 /

length: 4

Sending depot for consignment, ordering depot

for collection request, customer's depot for pickup

information or creating/sending depot for dangerous

goods.

Four alphanumeric positions, including leading

zeros, e.g. 0163.

product xs:string /

1 .. 1 /

E830

E10

E12

E18

IE2

MAIL

MAX

PL+

PM4

Selection of product, exactly one per shipment,

mandatory for consignment data. Possible values

are:

CL = DPD CLASSIC

E830 = DPD 8:30

E10 = DPD 10:00

E12 = DPD 12:00

E18 = DPD 18:00

IE2 = DPD EXPRESS

MAIL = DPD International Mail

MAX = DPD MAX

PL = DPD PARCELLetter

PL+ = DPD PARCELLetterPlus

PM4 = DPD Priority

mpsCompleteDelivery xs:boolean /

0 .. 1 /

Specifies if this shipment should be sent as

complete delivery. Mandatory for COD. Default

value is false.

mpsCompleteDelivery

Label

xs:boolean /

0 .. 1 /

Specifies if the label for complete delivery is printed

for pickup. Mandatory for COD. Default value is

false.

mpsVolume xs:long /

0 .. 1 /

maxInclusive: 999999999

Volume per consignment in cm3 (without positions

after the decimal point).

mpsWeight xs:long /

0 .. 1 /

maxInclusive: 99999999

Shipment weight in grams rounded in 10 gram units

without decimal point (e.g. 300 equals 3kg).

ShipmentService-Public_4_3

Web Service Reference

mpsExpectedSending

Date

xs:string /

0 .. 1 /

pattern: [2][0-9]{3}([0][0-9

]|[1][0-2])(0[1-9]|[12][0-9]|

3[01])

Date when the shipment is expected to be

transferred to the system. Format is YYYYMMDD.

mpsExpectedSending

Time

xs:string /

0 .. 1 /

pattern: (([1][0-9]|[2][0-3]

|[0][0-9])([0-5][0-9])([0-5][

0-9]))|([0-9]([0-5][0-9])([0-

5][0-9]))

Time when the shipment is expected to be

transferred to the system. Format is HHMMSS.

sender types:address /

1 .. 1 /

Consignment sender's address, collection

request customer's address or pickup information

customer's address.

recipient types:address /

1 .. 1 /

Address of the recipient. For parcel shop delivery

address of the real recipient.

Namespace: types

Complex Type: hazardous

Description

Bundles hazardous materials data.

Field name Data type /

Occurrence /

Range

Description

identificationUnNo xs:string /

1 .. 1 /

length: 4

Defines UN number of hazardous substance. UN

numbers range between 0004 and 9004.

identificationClass xs:string /

1 .. 1 /

maxLength: 6

Declares class of hazardous substance. Possible

values range from 1 to 9. Subclasses are specified

as position after decimal point

(e.g. class 1 is "explosives", class 1.6 is "extremely

insensitive explosives").

ShipmentService-Public_4_3

Web Service Reference

classificationCode xs:string /

0 .. 1 /

maxLength: 5

Declares classification code of hazardous

substance.

packingGroup xs:string /

0 .. 1 /

maxLength: 5

Declares packing group of hazardous substance.

Valid values are "I", "II" and "III".

packingCode xs:string /

1 .. 1 /

0A1

0A2

1A1

1A2

1B1

1B2

1H1

1H2

3A1

3A2

3B1

3B2

3H1

3H2

4H1

4H2

Declares packing code.

Possible values are:

0A = Thin sheet packing,

0A1 = Thin sheet packing with non removable head,

0A2 = Thin sheet packing with removable head,

1A = Steel barrel,

1A1 = Steel barrel with non removable head,

1A2 = Steel barrel with removable head,

1B = Aluminium barrel,

1B1 = Aluminium barrel with non removable head,

1B2 = Aluminium barrel with removable head,

1H = Plastics barrel,

1H1 = Plastics barrel with non removable head,

1H2 = Plastics barrel with removable head,

3A = Steel canister,

3A1 = Steel canister with non removable head,

3A2 = Steel canister with removable head,

3B = Aluminium canister,

3B1 = Aluminium canister with non removable head,

3B2 = Aluminium canister with removable head,

3H = Plastics canister,

3H1 = Plastics canister with non removable head,

3H2 = Plastics canister with removable head,

4A = Steel crates,

4B = Aluminium crate,

4D = Plywood crate,

4G = Cardboard crate,

4H = Plastics crate,

4H1 = Plastics crate plastics expanded,

4H2 = Plastics crate plastics solid,

5H = Plastics bags,

5M = Paper bags,

6H = Combination packings.

description xs:string /

1 .. 1 /

maxLength: 160

Description of hazardous substance (redundant).

ShipmentService-Public_4_3

Web Service Reference

subsidiaryRisk xs:string /

0 .. 1 /

maxLength: 10

Subsidiary risk of hazardous substance (redundant).

tunnelRestrictionCode xs:string /

0 .. 1 /

Tunnel restriction code of hazardous substance.

Possible values are "A", "B", "C", "D" or "E".

hazardousWeight xs:decimal /

1 .. 1 /

totalDigits: 6

fractionDigits: 2

Weight of hazardous substance with up to 4 pre-

decimal point positions and 2 decimal digits with

separator.

netWeight xs:decimal /

0 .. 1 /

totalDigits: 6

fractionDigits: 2

Net weight of hazardous substance with up to 4

pre-decimal point positions and 2 decimal point

positions.

factor xs:int /

1 .. 1 /

maxInclusive: 999

Factor of hazardous substance, 999 means

unlimited.

notOtherwiseSpecified xs:string /

0 .. 1 /

maxLength: 150

A not otherwise specified text which is mandatory for

some substances.

ShipmentService-Public_4_3

Web Service Reference

Namespace: types

Complex Type: higherInsurance

Description

Bundles data for higher insurance.

Field name Data type /

Occurrence /

Range

Description

amount xs:long /

1 .. 1 /

maxInclusive: 99999999

Increased insurance value with 2 decimal point

positions without separators.

currency xs:string /

1 .. 1 /

length: 3

Currency code for increased insurance in format ISO

4217 alpha 3.

Namespace: types

Complex Type: international

Description

Bundles express international data.

Field name Data type /

Occurrence /

Range

Description

parcelType xs:boolean /

1 .. 1 /

Specifies if the type of parcel is

"documents" (allowed for air based destination

only). Default value is false.

ShipmentService-Public_4_3

Web Service Reference

customsAmount xs:long /

1 .. 1 /

maxInclusive: 999999999

999999

Declared customs amount (in invoice currency) in

total with two decimal digits without separator (e.g.

14.00 = 1400),

for "documents" it is 0.

customsAmountParcel xs:long /

0 .. 1 /

maxInclusive: 999999999

999999

Parcel value (in invoice currency) with two decimal

digits without separator.

customsCurrency xs:string /

1 .. 1 /

length: 3

Invoice currency code in ISO 4217 alpha-3 format.

customsAmountExport xs:long /

0 .. 1 /

maxInclusive: 999999999

999999

Converted customs amount (in export currency) in

total with two decimal digits without separator (14,

00 = 1400),

for "documents" it is set to 0.

customsCurrencyExport xs:string /

0 .. 1 /

length: 3

Export currency code in ISO 4217 alpha-3 format.

customsTerms xs:string /

1 .. 1 /

Declares the customs terms.

Possible values are:

01 = DAP, cleared,

02 = DDP, delivered duty paid (incl. duties and excl.

taxes),

03 = DDP, delivered duty paid (incl. duties and

taxes),

05 = ex works (EXW),

06 = DAP.

customsContent xs:string /

0 .. 1 /

maxLength: 200

Declares the content of the parcel.

customsTarif xs:string /

0 .. 1 /

maxLength: 10

Declares the customs tarif number.

customsPaper xs:string /

0 .. 1 /

maxLength: 20

Declares accompanying documents without

separator (e.g. "ABG"), composed by following

values:

A = Commercial invoice,

ShipmentService-Public_4_3

Web Service Reference

B = Pro forma invoice,

C = Export declaration,

D = EUR1,

E = EUR2,

F = ATR,

G = Delivery note,

H = Third party billing,

I = T1 document.

customsEnclosure xs:boolean /

0 .. 1 /

Specifies if the accompanying documents are at the

parcel or not. Default value is false.

customsInvoice xs:string /

0 .. 1 /

maxLength: 20

Declares the invoice number.

customsInvoiceDate xs:int /

0 .. 1 /

maxInclusive: 99999999

Declares the invoice date in format YYYYMMDD.

customsOrigin xs:string /

0 .. 1 /

length: 2

Origin country in ISO 3166-1 alpha-2 format (e.g.

DE, EN).

customsOrder xs:string /

0 .. 1 /

maxLength: 25

Central customs order number for collective customs

clearance.

linehaul xs:string /

0 .. 1 /

Declares mode of line haul, possible values are "AI"

for air or "RO" for road.

shipMrn xs:string /

0 .. 1 /

maxLength: 20

Movement reference number of the electronical

export declaration.

collectiveCustoms

Clearance

xs:boolean /

0 .. 1 /

Flag for determining collective customs clearance.

Default value is false.

invoicePosition xs:int /

0 .. 1 /

maxInclusive: 999999

Declares the invoice position.

ShipmentService-Public_4_3

Web Service Reference

comment1 xs:string /

0 .. 1 /

maxLength: 70

Comment.

comment2 xs:string /

0 .. 1 /

maxLength: 70

Second comment.

commercialInvoice

ConsigneeVatNumber

xs:string /

0 .. 1 /

maxLength: 20

Declares the commercial invoice consignee VAT

number.

commercialInvoice

Consignee

types:address /

1 .. 1 /

Contains address data of commercial invoice

consignee.

commercialInvoice

ConsignorVatNumber

xs:string /

0 .. 1 /

maxLength: 20

Declares the commercial invoice consignor VAT

number.

commercialInvoice

Consignor

types:address /

1 .. 1 /

Contains address data of commercial invoice

consignor.

additionalInvoiceLines types:additionalInvoice

Line /

0 .. * /

Contains additional invoice lines.

Namespace: types

Complex Type: notification

Description

Bundles notification data.

Field name Data type /

Occurrence /

Range

Description

channel xs:int /

1 .. 1 /

Declares channel of notification.

Possible values are:

1 = Email,

2 = Telephone,

ShipmentService-Public_4_3

Web Service Reference

3 3 = SMS.

value xs:string /

1 .. 1 /

maxLength: 50

Value for the chosen channel, i.e. the phone number

or the e-mail address.

language xs:string /

0 .. 1 /

length: 2

Language of the notification in ISO 3166-1 alpha-2

format (e.g. 'DE').

Namespace: types

Complex Type: parcel

Description

Bundles parcel data.

Field name Data type /

Occurrence /

Range

Description

parcelLabelNumber xs:string /

0 .. 1 /

minLength: 11

maxLength: 14

Parcel label number. Number range and validity are

checked.

customerReference

Number1

xs:string /

0 .. 1 /

maxLength: 35

Parcel customer reference number 1.

customerReference

Number2

xs:string /

0 .. 1 /

maxLength: 35

Parcel customer reference number 2.

customerReference

Number3

xs:string /

0 .. 1 /

maxLength: 35

Parcel customer reference number 3.

customerReference

Number4

xs:string /

0 .. 1 /

maxLength: 35

Parcel customer reference number 4.

ShipmentService-Public_4_3

Web Service Reference

swap xs:boolean /

0 .. 1 /

Specifies if this parcel is a consignment swap parcel.

Default value is false.

volume xs:int /

0 .. 1 /

maxInclusive: 999999999

Volume of the single parcel (length/width/height in

format LLLWWWHHH) in cm without separators.

weight xs:int /

0 .. 1 /

maxInclusive: 99999999

Parcel weight in grams rounded in 10 gram units

without decimal point (e.g. 300 equals 3kg).

Consignment allows 8-digit values, collection

requests 7-digit and dangerous goods 6-digit.

hazardousLimited

Quantities

xs:boolean /

0 .. 1 /

Specifies if this parcel is a limited quantities

hazardous goods parcel. Default value is false.

higherInsurance types:higherInsurance /

0 .. 1 /

Specifies if this parcel has increased insurance

value. Default value is false.

content xs:string /

0 .. 1 /

maxLength: 50

Content of this parcel, mandatory for increased

insurance.

For collection requests maximum length is 50, for

consignment it is 35.

addService xs:int /

0 .. 1 /

minInclusive: 1

maxInclusive: 3

Additional service.

Possible values are:

1 = Delivery information,

2 = Documents return,

3 = Written permission to deposit goods by sender.

messageNumber xs:int /

0 .. 1 /

maxInclusive: 99999

Message number for consignment shipper

information. Default value is 1.

function xs:string /

0 .. 1 /

LOCKDZB

LOCKASG

LOCKEVM

LOCKSHOP

LOCKTV

Blockable functions.

Possible values are:

LOCKDZB = Delivery to a third party with notification

of delivery,

LOCKASG = Written permission to deposit goods,

LOCKEVM = Delivery with non-recurring authority,

LOCKSHOP = Parcel shop,

LOCKTV = Appointment.

parameter xs:string /

0 .. 1 /

maxLength: 300

Free text for blockable functions.

ShipmentService-Public_4_3

Web Service Reference

cod types:cod /

0 .. 1 /

Contains COD data for COD consignments.

international types:international /

0 .. 1 /

Contains data for consignments across customs

borders.

hazardous types:hazardous /

0 .. 4 /

Contains packing and substance data for dangerous

goods.

printInfo1OnParcelLabel xs:boolean /

0 .. 1 /

Flag for determining if content of parameter info1 will

be added on the label of a collection request parcel.

Default value is false.

info1 xs:string /

0 .. 1 /

maxLength: 29

Information text 1. This will be printed on the parcel

label if the flag printInfo1OnParcellabel is set to

true.

info2 xs:string /

0 .. 1 /

maxLength: 30

Information text 2. This will not be printed on the

parcel label.

returns xs:boolean /

0 .. 1 /

Specifies if parcel is a return parcel.

The return parcel must always be next in order to

the corresponding outbound parcel. Default value is

false.

parcelClass xs:string /

0 .. 1 /

maxLength: 50

Parcel class. See Parcelclass in MPSEXPDATA

specification for valid values.

ShipmentService-Public_4_3

Web Service Reference

Namespace: types

Complex Type: parcelInformationType

Description

Bundles parcel information type data.

Field name Data type /

Occurrence /

Range

Description

parcelLabelNumber xs:string /

0 .. 1 /

The parcel label number of the corresponding

parcel.

dpdReference xs:string /

0 .. 1 /

The DPD reference for this parcel.

output types:OutputType /

0 .. * /

The content for the parcel.

Namespace: types

Complex Type: parcelShopDelivery

Description

Bundles parcel shop delivery data.

Field name Data type /

Occurrence /

Range

Description

parcelShopId xs:long /

1 .. 1 /

Parcel shop ID for parcel shop delivery.

Can be obtained from parcel shop finder. Assumes

that parameter type of

personal delivery is filled with a value from 3 to 5,

which means parcel shop delivery. Mandatory in this

case.

ShipmentService-Public_4_3

Web Service Reference

parcelShopNotification types:notification /

1 .. 1 /

Contains data for personal notification for parcel

shop consignments.

Namespace: types

Complex Type: personalDelivery

Description

Bundles personal delivery data.

Field name Data type /

Occurrence /

Range

Description

type xs:int /

1 .. 1 /

minInclusive: 1

maxInclusive: 5

Declares type of personal delivery.

Possible values are:

1 = Department delivery (without personal

identification),

2 = Personal delivery with personal identification (ID-

Check),

3 = Personal delivery without personal identification

at drop point (e.g. parcel shop),

4 = Personal delivery with personal identification at

drop point (e.g. parcel shop),

5 = Personal delivery with personal identification at

drop point plus ID-Check (e.g. parcel shop).

For parcel shop delivery the parcel shop id must

be declared in productAndServiceData. It can be

obtained from parcel shop finder.

floor xs:string /

0 .. 1 /

maxLength: 30

Floor where the personal delivery shall take place.

This field is only used for department delivery.

building xs:string /

0 .. 1 /

maxLength: 30

Building where the personal delivery shall take

place. This field is only used for department delivery

(type 1).

ShipmentService-Public_4_3

Web Service Reference

department xs:string /

0 .. 1 /

maxLength: 30

Department where the personal delivery shall take

place. This field is only used for department delivery

(type 1).

name xs:string /

0 .. 1 /

maxLength: 35

Name of the person authorised to accept the

consignment. This field is only used for delivery with

ID-Check (types 2 and 5).

phone xs:string /

0 .. 1 /

maxLength: 30

Telephone number of the person authorised to

accept the consignment. This field is only used for

delivery with ID-Check (types 2 and 5).

personId xs:string /

0 .. 1 /

maxLength: 35

Personal identification number of the person

authorised to accept the consignment. This field is

only used for delivery with ID-Check (types 2 and

5).

Namespace: types

Complex Type: pickup

Description

Bundles pickup data.

Field name Data type /

Occurrence /

Range

Description

tour xs:int /

0 .. 1 /

maxInclusive: 999

Tour number (between 000 and 999).

quantity xs:int /

1 .. 1 /

maxInclusive: 99999

Quantity of pickup parcels. Mandatory for

consignment.

date xs:int /

1 .. 1 /

maxInclusive: 99999999

Pickup date in consignments and collection

requests. The collection day for advice customers.

The from date for pickup information. Format is

YYYYMMDD.

ShipmentService-Public_4_3

Web Service Reference

It can also be used as pickup date for collection

requests, then format is YYMMDD. Mandatory for

consignment.

day xs:int /

1 .. 1 /

maxInclusive: 6

Pickup day of week for consignments and pickup

information. Allowed values are 0..6 (0=Sunday,

1=Monday, etc.). Mandatory for consignment.

fromTime1 xs:int /

0 .. 1 /

maxInclusive: 2400

From time 1 for consignments and pickup

information. Format is hhmm. Mandatory for

consignment and variable consignor address.

toTime1 xs:int /

0 .. 1 /

maxInclusive: 2400

Until time 1 for consignments and pickup

information. Format is hhmm. Mandatory for

consignment and variable consignor address.

fromTime2 xs:int /

0 .. 1 /

maxInclusive: 2400

From time 2 for consignments and pickup

information. Format is hhmm.

toTime2 xs:int /

0 .. 1 /

maxInclusive: 2400

Until time 2 for consignments and pickup

information. Format is hhmm.

extraPickup xs:int /

0 .. 1 /

minInclusive: 1

maxInclusive: 2

Detemines whether an extra pickup tour is created

for this shipment with express service.

Possible values are:

1: Extra pickup without express service

2: Extra pickup with express service

boxId xs:string /

0 .. 1 /

maxLength: 100

The ID of the parcel box.

boxTan xs:string /

0 .. 1 /

maxLength: 6

The TAN of the parcel box for this order.

collectionRequest

Address

types:address /

0 .. 1 /

Contains pickup address information for

consignments and collection requests. Mandatory

for consignment.

ShipmentService-Public_4_3

Web Service Reference

Namespace: types

Complex Type: printOption

Description

Options how to return the parcel labels

Field name Data type /

Occurrence /

Range

Description

outputFormat types:OutputFormatType

1 .. 1 /

The format in which the parcel labels should be

returned.

PDF, BARCODE_IMAGE, MULTIPAGE_IMAGE as

file output; DPL, PDL, ZPL for direct printing.

In any case the output is base64 encoded.

paperFormat xs:string /

0 .. 1 /

Declares the paper format for parcel label print,

either "A4", "A6" or "A7".

For direct printing must be set to "A6". "A7" only

prints return labels.

printer types:printer /

0 .. 1 /

Information about the printer, if direct printing is

enabled.

startPosition types:startPosition /

0 .. 1 /

The start position of the first parcellabel on the first

page, if page format A4 is chosen. Ignored on other

paperformats

ShipmentService-Public_4_3

Web Service Reference

Namespace: types

Complex Type: printOptions

Description

Options how to return the parcel labels

Field name Data type /

Occurrence /

Range

Description

printOption types:printOption /

1 .. * /

The formats in which the parcel labels should be

returned.

If more than one format is set, the option

splitByParcel is set implicitly.

splitByParcel xs:boolean /

0 .. 1 /

Determines whether a complete parcel label sheet

will be created or a single one for each parcel.

If format is BARCODE_IMAGE then this is set

implicitly.

Namespace: types

Complex Type: printer

Description

Information about the printer, if direct printing is used.

Field name Data type /

Occurrence /

Range

Description

manufacturer xs:string /

0 .. 1 /

The printer's manufacturer. At the moment only for

informational purposes.

model xs:string /

0 .. 1 /

The printer's model. At the moment only for

informational purposes.

ShipmentService-Public_4_3

Web Service Reference

revision xs:string /

0 .. 1 /

The printer's revision / version. At the moment only

for informational purposes.

offsetX xs:decimal /

1 .. 1 /

The horizontal offset in mm for the direct printer file

(Not used with normal PDF output).

offsetY xs:decimal /

1 .. 1 /

The vertical offset in mm for the direct printer file

(Not used with normal PDF output).

connectionType xs:string /

1 .. 1 /

SERIAL

PARALLEL

The connection type of the printer: serial or parallel

connection.

barcodeCapable2D xs:boolean /

1 .. 1 /

If the printer can print AZTEC barcodes, set this flag

to true.

Namespace: types

Complex Type: proactiveNotification

Description

Bundles proactive notification data.

Field name Data type /

Occurrence /

Range

Description

channel xs:int /

1 .. 1 /

Declares type of proactive notification.

Possible values are:

1 = Email,

2 = Telephone,

3 = SMS,

6 = FAX,

7 = Postcard.

value xs:string /

1 .. 1 /

maxLength: 50

Data for proactive notification, e.g. telephone

number, email address, etc.

The data format for the proactive message types

SMS, phone and FAX is as follows:

+international country number#phone number

ShipmentService-Public_4_3

Web Service Reference

Examples:

+49#1725673423

+49#01725673423

rule xs:int /

1 .. 1 /

maxInclusive: 31

Specifies for which events a notification is to be

issued.

Each event has a certain integer value. By

adding the different values, it is possible to build

combinations of events, e.g. notification for pick-up

and delivery is 5.

The different values are:

1 = Pick-up,

2 = Non-delivery,

4 = Delivery,

8 = Inbound,

16 = Out for delivery.

So maximum value can be 31.

language xs:string /

1 .. 1 /

length: 2

Language of the proactive notification in ISO-3166-1

alpha-2 format (e.g. 'DE').

Namespace: types

Complex Type: productAndServiceData

Description

Bundles product and service data for ShipmentService.

Field name Data type /

Occurrence /

Range

Description

orderType xs:string /

1 .. 1 /

consignment

collection request order

pickup information

Defines the shipment type.

Possible values are:

consignment,

collection request order,

pickup information.

saturdayDelivery xs:boolean /

0 .. 1 /

Specifies if saturday delivery is demanded. Only

selectable for product "E12". Default value is false.

ShipmentService-Public_4_3

Web Service Reference

exWorksDelivery xs:boolean /

0 .. 1 /

Specifies if the recipient has to pay the consignment.

Default value is false.

guarantee xs:boolean /

0 .. 1 /

Set to true if an international shipment should

use Guarantee, only for products CL and E18 for

international parcels.

tyres xs:boolean /

0 .. 1 /

Set to true if this consignment contains bulk tyres,

only for product CL.

food xs:boolean /

0 .. 1 /

Set to true if the parcel should deliver as product

'DPD Food'.

personalDelivery types:personalDelivery /

0 .. 1 /

Contains information for personal delivery.

pickup types:pickup /

0 .. 1 /

Contains information for pickup consignments,

pickup address for collection requests or details for

pickup information.

parcelShopDelivery types:parcelShopDelivery

0 .. 1 /

Contains the necessary information, if a parcel shop

delivery is intended.

predict types:notification /

0 .. 1 /

Contains data for interactive notification for

consignments. The notification type "phone" is

forbidden here.

personalDelivery

Notification

types:notification /

0 .. 1 /

Contains data for personal delivery notification for

consignments.

proactiveNotification types:proactive

Notification /

0 .. 5 /

Contains information of proactive notification for

consignments.

delivery types:delivery /

0 .. 1 /

Contains special delivery data for consignments.

invoiceAddress types:address /

0 .. 1 /

Contains data about invoice recipient if it differs for

consignment.

ShipmentService-Public_4_3

Web Service Reference

countrySpecificService xs:string /

0 .. 1 /

In some relations a specific service code can be set,

which overwrites the feature selection.

Namespace: types

Complex Type: shipmentResponse

Description

Bundles shipment response data.

Field name Data type /

Occurrence /

Range

Description

identificationNumber xs:string /

0 .. 1 /

maxLength: 999

Serves as unique alphanumeric key of the shipment

used by customer.

mpsId xs:string /

0 .. 1 /

maxLength: 25

The 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.

parcelInformation types:parcelInformation

Type /

0 .. * /

Contains information about the single parcels.

faults types:faultCodeType /

0 .. 3 /

Contains information about errors during shipment

order processing.

ShipmentService-Public_4_3

Web Service Reference

Namespace: types

Complex Type: shipmentServiceData

Description

Bundles shipment service data.

Field name Data type /

Occurrence /

Range

Description

generalShipmentData types:generalShipment

Data /

1 .. 1 /

Contains general data for a shipment.

parcels types:parcel /

0 .. * /

Contains information for the parcels.

productAndServiceData types:productAndService

Data /

1 .. 1 /

Contains special data for a shipment.

Namespace: types

Complex Type: storeOrders

Description

Stores up to 30 shipments and creates corresponding shipment documents.

Field name Data type /

Occurrence /

Range

Description

printOptions types:printOptions /

0 .. 1 /

The Options which should be used for parcel

printing.

ShipmentService-Public_4_3

Web Service Reference

order types:shipmentService

Data /

1 .. 30 /

Contains the whole data for the shipments.

Namespace: types

Complex Type: storeOrdersResponse

Description

Contains return object.

Field name Data type /

Occurrence /

Range

Description

orderResult types:storeOrders

ResponseType /

1 .. 1 /

Contains return object.

Namespace: types

Complex Type: storeOrdersResponseType

Description

Bundles storeOrders response data.

Field name Data type /

Occurrence /

Range

Description

output types:OutputType /

0 .. 1 /

Contains parcel label data in bytes.

shipmentResponses types:shipmentResponse

0 .. * /

Contains response data for every shipment order.

ShipmentService-Public_4_3

Web Service Reference

Namespace: types_authentication

URL: http://dpd.com/common/service/types/Authentication/2.0

Namespace: types_authentication

Anonymous Complex Type of Element: authentication

Description

The data structure for authentication data.

Field name Data type /

Occurrence /

Range

Description

delisId xsd:string /

1 .. 1 /

minLength: 8

maxLength: 10

The delis user id for authentication.

authToken xsd:string /

1 .. 1 /

minLength: 0

maxLength: 64

The token for authentication. Field authToken of

Method "getAuth" of LoginService.

messageLanguage xsd:string /

1 .. 1 /

minLength: 5

maxLength: 5

The language (Java format) for messages.

"de_DE" for german messages.

"en_US" for english messages.

ShipmentService-Public_4_3

Web Service Reference

Namespace: types_authentication

Anonymous Complex Type of Element: authenticationFault

Description

The data structure for authentication errors.

Field name Data type /

Occurrence /

Range

Description

errorCode xsd:string /

1 .. 1 /

The error code. Valid codes:

NoAccessAuthenticationFault=-1

NoRightsAuthenticationFault=-2

errorMessage xsd:string /

1 .. 1 /

minLength: 1

maxLength: 255

The error message text.

ShipmentService-Public_4_3

Web Service Reference

Simple Types

Namespace: types

URL: http://dpd.com/common/service/types/ShipmentService/4.3

Namespace: types

Simple Type: OutputFormatType

Field name Data type /

Occurrence /

Range

Description

OutputFormatType xs:string /

PDF

ZPL

DPL

PDL

BARCODE_IMAGE

MULTIPAGE_IMAGE

Content of output format.

Supported types are:

PDF,

ZPL,

DPL,

PDL,

BARCODE_IMAGE,

MULTIPAGE_IMAGE.

Namespace: types

Simple Type: startPosition

Field name Data type /

Occurrence /

Range

Description

startPosition xs:string /

UPPER_LEFT

UPPER_RIGHT

LOWER_LEFT

LOWER_RIGHT

Start positions

ShipmentService-Public_4_3

Web Service Reference

Elements

Namespace: types

URL: http://dpd.com/common/service/types/ShipmentService/4.3

Namespace: types

Element: storeOrders

Field name Data type /

Occurrence /

Range

Description

storeOrders types:storeOrders /

1 .. 1 /

See types:storeOrders

Namespace: types

Element: storeOrdersResponse

Field name Data type /

Occurrence /

Range

Description

storeOrdersResponse types:storeOrders

Response /

1 .. 1 /

See types:storeOrdersResponse

ShipmentService-Public_4_3

Web Service Reference

Namespace: types_authentication

URL: http://dpd.com/common/service/types/Authentication/2.0

Namespace: types_authentication

Element: authentication

Anonymous Complex Type types_authentication:authentication

Namespace: types_authentication

Element: authenticationFault

Anonymous Complex Type types_authentication:authenticationFault