Aller au contenu principal

ShipmentService

Version: 3.2 · December 2025

The ShipmentService stores shipment orders and returns the corresponding parcel labels as PDF or ZPL.


Changelog

VersionChanges
1.0.4Field printerResolution added to printOptions. Products DPD PARCEL LETTER and DPD PARCELBOX added
1.0.3REST support added

Methods

MethodDescription
storeOrdersStores up to 30 shipments and creates corresponding shipment documents

storeOrders

Action: http://dpd.com/common/serviceShipmentService/3.2/storeOrders

Input:

NameElement
authentication (header)types_authentication:authentication
parameterstypes:storeOrders

Output:

NameElement
returntypes:storeOrdersResponse

Faults:

NameElement
AuthenticationFaulttypes_authentication:authenticationFault

Examples

storeOrders — SOAP

<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.2">
<soapenv:Header>
<ns:authentication>
<delisId>{your delisId}</delisId>
<authToken>{your authToken}</authToken>
<messageLanguage>de_CH</messageLanguage>
</ns:authentication>
</soapenv:Header>
<soapenv:Body>
<ns1:storeOrders>
<printOptions>
<printerLanguage>PDF</printerLanguage>
<paperFormat>A6</paperFormat>
</printOptions>
<order>
<generalShipmentData>
<sendingDepot>{your sendingDepot}</sendingDepot>
<product>B2B</product>
<sender>
<name1>Sender Name</name1>
<street>Sender Street</street>
<country>CH</country>
<zipCode>8000</zipCode>
<city>Sender City</city>
</sender>
<recipient>
<name1>Recipient Name</name1>
<street>Recipient Street</street>
<country>CH</country>
<zipCode>8000</zipCode>
<city>Recipient City</city>
</recipient>
</generalShipmentData>
<parcels/>
<productAndServiceData>
<orderType>consignment</orderType>
</productAndServiceData>
</order>
</ns1:storeOrders>
</soapenv:Body>
</soapenv:Envelope>

storeOrders — REST

POST {baseUrl}/services/ShipmentService

Request body:

{
"authentication": {
"delisId": "{your delisId}",
"authToken": "{your authToken}",
"messageLanguage": "de_CH"
},
"storeOrders": {
"printOptions": {
"printerLanguage": "PDF",
"paperFormat": "A6"
},
"order": [{
"generalShipmentData": {
"sendingDepot": "0615",
"product": "B2B",
"sender": {
"name1": "Sender Name",
"street": "Sender Street",
"country": "CH",
"zipCode": "8000",
"city": "Sender City"
},
"recipient": {
"name1": "Recipient Name",
"street": "Recipient Street",
"country": "CH",
"zipCode": "8000",
"city": "Recipient City"
}
},
"parcels": [{}],
"productAndServiceData": {
"orderType": "consignment"
}
}]
}
}

Response (success):

{
"orderResult": {
"parcellabelsPDF": "{BASE64-Label}",
"shipmentResponses": [{
"identificationNumber": "",
"mpsId": "B2C0608000000174920200525",
"parcelInformation": [{
"parcelLabelNumber": "06080000001749",
"dpdReference": null
}],
"faults": []
}]
},
"status": { "type": "OK", "code": "200", "message": "valid" }
}

Response (error):

{
"orderResult": null,
"status": {
"type": "FaultCodeType",
"code": "ERR_DELICOM_TOKEN_EXPIRED",
"message": "token has expired"
}
}

Complex Types

Namespace: types

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

address

FieldType / OccurrenceDescription
name1xs:string / 1..1 · max 35Name of address owner
name2xs:string / 0..1 · max 35Name 2 of address owner
streetxs:string / 1..1 · max 35Street
houseNoxs:string / 0..1 · max 8House number
street2xs:string / 0..1 · max 35Street 2
statexs:string / 0..1 · length 2State (ISO 3166-2, e.g. ZH)
countryxs:string / 1..1 · length 2Country (ISO 3166-1 alpha-2, e.g. CH)
zipCodexs:string / 1..1 · max 9Zip code
cityxs:string / 1..1 · max 35City
glnxs:long / 0..1International location number
customerNumberxs:string / 0..1 · max 17Customer number
contactxs:string / 0..1 · max 35Contact person
phonexs:string / 0..1 · max 30Phone number
faxxs:string / 0..1 · max 30Fax number
emailxs:string / 0..1 · max 50Email (max 40 for collection requests)
commentxs:string / 0..1 · max 70Comment
iaccountxs:string / 0..1 · max 50Account allocation / cost center

cod (Cash on Delivery)

FieldType / OccurrenceDescription
amountxs:long / 1..1 · max 350000COD amount as integer (e.g. 30000 = 300.00 CHF)
currencyxs:string / 1..1 · length 3ISO 4217 currency code — always CHF
inkassoxs:int / 1..1 · 0Collection type: 0 = cash
purposexsd:string / 0..1 · max 14Purpose of use
bankCodexs:string / 0..1 · max 25Bank code (requires bankName, bankAccountNumber, bankAccountHolder)
bankNamexs:string / 0..1 · max 27Bank name
bankAccountNumberxs:string / 0..1 · max 25Bank account number
bankAccountHolderxs:string / 0..1 · max 30Account holder
ibanxs:string / 0..1 · max 50IBAN
bicxs:string / 0..1 · max 50BIC

generalShipmentData

FieldType / OccurrenceDescription
sendingDepotxs:string / 1..1 · length 4Responsible depot (value from LoginService, with leading zeros, e.g. 0615)
productxs:string / 1..1Product code — see Service Codes
sendertypes:address / 1..1Sender address
recipienttypes:address / 1..1Recipient address
identificationNumberxs:string / 0..1 · max 999Unique alphanumeric key for the shipment
mpsIdxs:string / 0..1 · length 25Shipment number (starts with MPS, EXP, or B2C)
mpsCustomerReferenceNumber1–4xs:string / 0..1 · max 35Customer reference numbers
mpsWeightxs:long / 0..1Shipment weight in grams (10g units, no decimal)
mpsExpectedSendingDatexs:string / 0..1Expected sending date (YYYYMMDD)
mpsExpectedSendingTimexs:string / 0..1Expected sending time (HHMMSS)

notification

FieldType / OccurrenceDescription
channelxs:int / 1..11 = email, 3 = SMS
valuexs:string / 1..1 · max 50Email address or phone number (international format, e.g. +41790000000)
languagexs:string / 0..1 · length 2Notification language (ISO 3166-1 alpha-2, e.g. DE)

parcel

FieldType / OccurrenceDescription
parcelLabelNumberxs:string / 0..1 · length 14Parcel label number
customerReferenceNumber1–4xs:string / 0..1 · max 35Parcel reference numbers
weightxs:int / 0..1Parcel weight in grams (10g units)
volumexs:int / 0..1Volume in cm³ (format LLLWWWHHH)
swapxs:boolean / 0..1Swap parcel flag (default: false)
hazardousLimitedQuantitiesxs:boolean / 0..1Limited quantities hazardous goods (default: false)
contentxs:string / 0..1 · max 50Parcel content description
codtypes:cod / 0..1COD data
returnsxs:boolean / 0..1Return parcel flag (default: false)
info1xs:string / 0..1 · max 29Info field 1 (collection request only, printed on label)
info2xs:string / 0..1 · max 30Info field 2 (collection request only, printed on label)

printOptions

FieldType / OccurrenceDescription
printerLanguagexs:string / 1..1 · PDF or ZPLOutput format. Output is always base64 encoded
paperFormatxs:string / 1..1 · A4 or A6Paper format for label
startPositiontypes:startPosition / 0..1Start position on A4 paper
printerResolutionxs:double / 1..1 · 200–600ZPL only — printer resolution in dpi

productAndServiceData

FieldType / OccurrenceDescription
orderTypexs:string / 1..1consignment, collection request order, or pickup information
pickuptypes:pickup / 0..1Pickup information
parcelShopDeliverytypes:parcelShopDelivery / 0..1Parcel shop delivery data
predicttypes:notification / 0..1Interactive notification (email or SMS only)
exWorksDeliveryxs:boolean / 0..1Recipient pays the consignment (default: false)
guaranteexs:boolean / 0..1Guarantee for international shipments (products NP, E18 only)
tyresxs:boolean / 0..1Bulk tyres (product NP only)

storeOrders

FieldType / OccurrenceDescription
printOptionstypes:printOptions / 0..1Label print options
ordertypes:shipmentServiceData / 1..30Shipment data (up to 30 per call)

storeOrdersResponseType

FieldType / OccurrenceDescription
parcellabelsPDFxs:base64Binary / 0..1Parcel label PDF or ZPL data (base64 encoded)
shipmentResponsestypes:shipmentResponse / 0..*Response data per shipment order

Namespace: types_authentication

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

authentication

FieldType / OccurrenceDescription
delisIdxsd:string / 1..1 · 8–10 charsDELIS user ID
authTokenxsd:string / 1..1 · 0–64 charsToken from LoginService.getAuth
messageLanguagexsd:string / 1..1 · length 5de_CH, fr_CH, it_CH, or en_CH

Simple Types

startPosition

ValueDescription
UPPER_LEFTTop-left position on A4
UPPER_RIGHTTop-right position on A4
LOWER_LEFTBottom-left position on A4
LOWER_RIGHTBottom-right position on A4

Service Codes

CodeServiceDescription
B2BDPD CLASSICStandard domestic and international delivery
B2BIDPD CLASSIC InternationalInternational B2B shipment
B2BPDPD CLASSIC PredictWith recipient notification
PM2DPD CLASSIC GuaranteeGuaranteed delivery by 18:00
B2CDPD COMFORTWith recipient notification
HOMEDPD HOMEWith recipient notification
AM1DPD EXPRESS 10:00Guaranteed delivery by 10:00
AM2DPD EXPRESS 12:00Guaranteed delivery by 12:00
IE2DPD EXPRESSExpress delivery
PSDDPD SHOPParcel shop delivery
PLDPD PARCEL LETTERSmall items, max 2 kg
PBOXDPD PARCELBOXGPS + photo, max 5 kg
RETReturnReturn goods
CRCollection RequestPickup from customer to end customer
LQLimited QuantitiesHazardous goods (limited quantities)
SWAPSWAPQuick replacement for rejected goods
TYRETyresBulk tyre shipping
remarque

Available services are configured per customer account. Contact your DPD account manager for the full list of services enabled for your account.


Entry Points

EnvironmentProtocolURL
StageSOAPhttps://shivah-st.dpd.ch/external/soap/services/ShipmentService
LiveSOAPhttps://shivah.dpd.ch/external/soap/services/ShipmentService
StageRESThttps://shivah-st.dpd.ch/external/rest/services/ShipmentService
LiveRESThttps://shivah.dpd.ch/external/rest/services/ShipmentService