LoginService
Version: 2.1 · December 2025
The LoginService authenticates a user and returns an authToken required by all other Shivah WS services.
Methods
| Method | Description |
|---|---|
getAuth | Creates an authentication token for the given user if the credentials are valid |
getAuth
Action: http://dpd.com/common/service/LoginService/2.1/getAuth
Input:
| Name | Element |
|---|---|
| parameters | types:getAuth |
Output:
| Name | Element |
|---|---|
| parameters | types:getAuthResponse |
Faults:
| Name | Element |
|---|---|
| parameters | types_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.
| Field | Type / Occurrence | Description |
|---|---|---|
delisId | xsd:string / 1..1 | The user's DELIS-Id |
customerUid | xsd:string / 1..1 | The user's customer UID (usually equal to DELIS-Id for non-subaccounts) |
authToken | xsd:string / 1..1 | The auth token needed for other web service calls |
depot | xsd:string / 1..1 | The depot to which the user is assigned |
authTokenExpires | xsd:dateTime / 1..1 | UTC date and time when the token expires |
getAuth
| Field | Type / Occurrence | Description |
|---|---|---|
delisId | xsd:string / 1..1 | The DELIS-Id of the user |
password | xsd:string / 1..1 | The password of the user |
messageLanguage | xsd:string / 1..1 · length: 5 | Language for messages: de_CH, fr_CH, it_CH, en_CH |
getAuthResponse
| Field | Type / Occurrence | Description |
|---|---|---|
return | types:Login / 1..1 | The login result object |
Namespace: types_authentication
URL: http://dpd.com/common/service/types/Authentication/2.1
authenticationFault
| Field | Type / Occurrence | Description |
|---|---|---|
errorCode | xsd:string / 1..1 | The error code |
errorMessage | xsd:string / 1..1 · maxLength: 255 | The error message text |
Elements
Namespace: types
| Element | Type | Description |
|---|---|---|
getAuth | types:getAuth / 1..1 | Input parameter of getAuth |
getAuthResponse | types:getAuthResponse / 1..1 | Output parameter of getAuth |
Namespace: types_authentication
| Element | Type | Description |
|---|---|---|
authenticationFault | Anonymous complex type | Authentication fault element |
Entry Points
| Environment | Protocol | URL |
|---|---|---|
| Stage | SOAP | https://shivah-st.dpd.ch/external/soap/labelprint/api/v1/login |
| Live | SOAP | https://shivah.dpd.ch/external/soap/labelprint/api/v1/login |
| Stage | REST | https://shivah-st.dpd.ch/external/rest/labelprint/api/v1/login |
| Live | REST | https://shivah.dpd.ch/external/rest/labelprint/api/v1/login |