Zum Hauptinhalt springen

LoginService

Version: 2.1 · December 2025

The LoginService authenticates a user and returns an authToken required by all other Shivah WS services.


Methods

MethodDescription
getAuthCreates an authentication token for the given user if the credentials are valid

getAuth

Action: http://dpd.com/common/service/LoginService/2.1/getAuth

Input:

NameElement
parameterstypes:getAuth

Output:

NameElement
parameterstypes:getAuthResponse

Faults:

NameElement
parameterstypes_authentication:authenticationFault

Examples

getAuth — SOAP

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns="http://dpd.com/common/service/types/LoginService/2.1">
<soapenv:Header/>
<soapenv:Body>
<ns:getAuth>
<delisId>{your delisId}</delisId>
<password>{your password}</password>
<messageLanguage>de_CH</messageLanguage>
</ns:getAuth>
</soapenv:Body>
</soapenv:Envelope>

getAuth — REST

POST {baseUrl}/login

Request body:

{
"delisID": "{your delisId}",
"password": "{your password}",
"messageLanguage": "de_CH"
}

Response (success):

{
"getAuthResponse": {
"return": {
"delisId": "{your delisId}",
"customerUid": "{your customerUid}",
"authToken": "{your authToken}",
"depot": "{your sendingDepot}",
"authTokenExpires": "2021-07-16T05:39:03.9133333Z"
}
},
"status": {
"type": "OK",
"code": "200",
"message": "valid"
}
}

Response (error):

{
"getAuthResponse": null,
"status": {
"type": "AuthenticationFault",
"code": "DELICOM_ERR_AUTHENTICATION",
"message": "Authentication failure, check delisId and password."
}
}

Complex Types

Namespace: types

URL: http://dpd.com/common/service/types/LoginService/2.1

Login

Contains login information returned after successful authentication.

FieldType / OccurrenceDescription
delisIdxsd:string / 1..1The user's DELIS-Id
customerUidxsd:string / 1..1The user's customer UID (usually equal to DELIS-Id for non-subaccounts)
authTokenxsd:string / 1..1The auth token needed for other web service calls
depotxsd:string / 1..1The depot to which the user is assigned
authTokenExpiresxsd:dateTime / 1..1UTC date and time when the token expires

getAuth

FieldType / OccurrenceDescription
delisIdxsd:string / 1..1The DELIS-Id of the user
passwordxsd:string / 1..1The password of the user
messageLanguagexsd:string / 1..1 · length: 5Language for messages: de_CH, fr_CH, it_CH, en_CH

getAuthResponse

FieldType / OccurrenceDescription
returntypes:Login / 1..1The login result object

Namespace: types_authentication

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

authenticationFault

FieldType / OccurrenceDescription
errorCodexsd:string / 1..1The error code
errorMessagexsd:string / 1..1 · maxLength: 255The error message text

Elements

Namespace: types

ElementTypeDescription
getAuthtypes:getAuth / 1..1Input parameter of getAuth
getAuthResponsetypes:getAuthResponse / 1..1Output parameter of getAuth

Namespace: types_authentication

ElementTypeDescription
authenticationFaultAnonymous complex typeAuthentication fault element

Entry Points

EnvironmentProtocolURL
StageSOAPhttps://shivah-st.dpd.ch/external/soap/labelprint/api/v1/login
LiveSOAPhttps://shivah.dpd.ch/external/soap/labelprint/api/v1/login
StageRESThttps://shivah-st.dpd.ch/external/rest/labelprint/api/v1/login
LiveRESThttps://shivah.dpd.ch/external/rest/labelprint/api/v1/login