Zum Hauptinhalt springen

ShipmentService

Version: 3.5 · Dezember 2025

Der ShipmentService speichert Versandaufträge und gibt die entsprechenden Paketetiketten als PDF oder ZPL zurück.


Methoden

MethodeBeschreibung
storeOrdersSpeichert bis zu 30 Sendungen und erstellt die entsprechenden Versanddokumente

storeOrders

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

Eingabe:

NameElement
authentication (Header)types_authentication:authentication
parameterstypes:storeOrders

Ausgabe:

NameElement
returntypes:storeOrdersResponse

Faults:

NameElement
AuthenticationFaulttypes_authentication:authenticationFault

Beispiele

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/storeOrders

Anfragetext:

{
"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"
}
}]
}
}

Antwort (Erfolg):

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

Antwort (Fehler):

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

Komplexe Typen

Namespace: types

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

address

FeldTyp / VorkommenBeschreibung
name1xs:string / 1..1 · max. 35Name des Adressinhabers
name2xs:string / 0..1 · max. 35Name 2 des Adressinhabers
streetxs:string / 1..1 · max. 35Strasse
houseNoxs:string / 0..1 · max. 8Hausnummer
street2xs:string / 0..1 · max. 35Strasse 2
statexs:string / 0..1 · Länge 2Bundesland/Kanton (ISO 3166-2, z. B. ZH)
countryxs:string / 1..1 · Länge 2Land (ISO 3166-1 alpha-2, z. B. CH)
zipCodexs:string / 1..1 · max. 9Postleitzahl
cityxs:string / 1..1 · max. 35Stadt
glnxs:long / 0..1Internationale Standortnummer
customerNumberxs:string / 0..1 · max. 17Kundennummer
contactxs:string / 0..1 · max. 35Kontaktperson
phonexs:string / 0..1 · max. 30Telefonnummer
faxxs:string / 0..1 · max. 30Faxnummer
emailxs:string / 0..1 · max. 50E-Mail (max. 40 bei Abholaufträgen)
commentxs:string / 0..1 · max. 70Kommentar
iaccountxs:string / 0..1 · max. 50Kontozuordnung / Kostenstelle

cod (Nachnahme)

FeldTyp / VorkommenBeschreibung
amountxs:long / 1..1 · max. 350000Nachnahmebetrag als Ganzzahl (z. B. 30000 = 300.00 CHF)
currencyxs:string / 1..1 · Länge 3ISO-4217-Währungscode — immer CHF
inkassoxs:int / 1..1 · 0Inkassoart: 0 = bar
purposexsd:string / 0..1 · max. 14Verwendungszweck
bankCodexs:string / 0..1 · max. 25Bankleitzahl (erfordert bankName, bankAccountNumber, bankAccountHolder)
bankNamexs:string / 0..1 · max. 27Bankname
bankAccountNumberxs:string / 0..1 · max. 25Bankkontonummer
bankAccountHolderxs:string / 0..1 · max. 30Kontoinhaber
ibanxs:string / 0..1 · max. 50IBAN
bicxs:string / 0..1 · max. 50BIC

generalShipmentData

FeldTyp / VorkommenBeschreibung
sendingDepotxs:string / 1..1 · Länge 4Zuständiges Depot (Wert vom LoginService, mit führenden Nullen, z. B. 0615)
productxs:string / 1..1Produktcode — siehe Services und Optionen
sendertypes:address / 1..1Absenderadresse
recipienttypes:address / 1..1Empfängeradresse
identificationNumberxs:string / 0..1 · max. 999Eindeutiger alphanumerischer Schlüssel für die Sendung
mpsIdxs:string / 0..1 · Länge 25Sendungsnummer (beginnt mit MPS, EXP oder B2C)
mpsCustomerReferenceNumber1–4xs:string / 0..1 · max. 35Kundenreferenznummern
mpsWeightxs:long / 0..1Sendungsgewicht in Gramm (10-g-Einheiten, ohne Dezimalstellen)
mpsExpectedSendingDatexs:string / 0..1Voraussichtliches Versanddatum (YYYYMMDD)
mpsExpectedSendingTimexs:string / 0..1Voraussichtliche Versandzeit (HHMMSS)

notification

FeldTyp / VorkommenBeschreibung
channelxs:int / 1..11 = E-Mail, 3 = SMS
valuexs:string / 1..1 · max. 50E-Mail-Adresse oder Telefonnummer (internationales Format, z. B. +41790000000)
languagexs:string / 0..1 · Länge 2Sprache der Benachrichtigung (ISO 3166-1 alpha-2, z. B. DE)

parcel

FeldTyp / VorkommenBeschreibung
parcelLabelNumberxs:string / 0..1 · Länge 14Paketetikettennummer
customerReferenceNumber1–4xs:string / 0..1 · max. 35Paketreferenznummern
weightxs:int / 0..1Paketgewicht in Gramm (10-g-Einheiten)
volumexs:int / 0..1Volumen in cm³ (Format LLLWWWHHH)
swapxs:boolean / 0..1Tauschpaket-Kennzeichen (Standard: false)
hazardousLimitedQuantitiesxs:boolean / 0..1Gefahrgut in begrenzten Mengen (Standard: false)
contentxs:string / 0..1 · max. 50Beschreibung des Paketinhalts
codtypes:cod / 0..1Nachnahmedaten
returnsxs:boolean / 0..1Retourenpaket-Kennzeichen (Standard: false)
info1xs:string / 0..1 · max. 29Infofeld 1 (nur Abholauftrag, wird auf dem Etikett gedruckt)
info2xs:string / 0..1 · max. 30Infofeld 2 (nur Abholauftrag, wird auf dem Etikett gedruckt)

printOptions

FeldTyp / VorkommenBeschreibung
printerLanguagexs:string / 1..1 · PDF oder ZPLAusgabeformat. Die Ausgabe ist immer base64-codiert
paperFormatxs:string / 1..1 · A4 oder A6Papierformat für das Etikett
startPositiontypes:startPosition / 0..1Startposition auf A4-Papier
printerResolutionxs:double / 1..1 · 150, 200/203, 300, 600Nur ZPL (von PDF ignoriert). Druckerauflösung in dpi. Muss der physischen Druckkopfdichte des Zebra-Druckers entsprechen — andere Werte werden nicht unterstützt.

productAndServiceData

FeldTyp / VorkommenBeschreibung
orderTypexs:string / 1..1consignment, collection request order oder pickup information
pickuptypes:pickup / 0..1Abholinformationen
parcelShopDeliverytypes:parcelShopDelivery / 0..1Daten zur Paketshop-Zustellung
predicttypes:notification / 0..1Interaktive Benachrichtigung (nur E-Mail oder SMS)
exWorksDeliveryxs:boolean / 0..1Empfänger zahlt die Sendung (Standard: false)
guaranteexs:boolean / 0..1Garantie für internationale Sendungen (nur Produkte NP, E18)
tyresxs:boolean / 0..1Reifen als Sperrgut (nur Produkt NP)

storeOrders

FeldTyp / VorkommenBeschreibung
printOptionstypes:printOptions / 0..1Etikettendruckoptionen
ordertypes:shipmentServiceData / 1..30Sendungsdaten (bis zu 30 pro Aufruf)

storeOrdersResponseType

FeldTyp / VorkommenBeschreibung
parcellabelsPDFxs:base64Binary / 0..1Paketetikett als PDF- oder ZPL-Daten (base64-codiert)
shipmentResponsestypes:shipmentResponse / 0..*Antwortdaten pro Versandauftrag

Namespace: types_authentication

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

authentication

FeldTyp / VorkommenBeschreibung
delisIdxsd:string / 1..1 · 8–10 ZeichenDELIS-Benutzer-ID
authTokenxsd:string / 1..1 · 0–64 ZeichenToken von LoginService.getAuth
messageLanguagexsd:string / 1..1 · Länge 5de_CH, fr_CH, it_CH oder en_CH

Einfache Typen

startPosition

WertBeschreibung
UPPER_LEFTPosition oben links auf A4
UPPER_RIGHTPosition oben rechts auf A4
LOWER_LEFTPosition unten links auf A4
LOWER_RIGHTPosition unten rechts auf A4

Einstiegspunkte

UmgebungProtokollURL
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/storeOrders
LiveRESThttps://shivah.dpd.ch/external/rest/services/ShipmentService/storeOrders