Passa al contenuto principale

ShipmentService

Versione: 3.5 · Dicembre 2025

Il ShipmentService memorizza gli ordini di spedizione e restituisce le relative etichette dei colli in formato PDF o ZPL.


Metodi

MetodoDescrizione
storeOrdersMemorizza fino a 30 spedizioni e crea i relativi documenti di spedizione

storeOrders

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

Input:

NomeElemento
authentication (header)types_authentication:authentication
parameterstypes:storeOrders

Output:

NomeElemento
returntypes:storeOrdersResponse

Fault:

NomeElemento
AuthenticationFaulttypes_authentication:authenticationFault

Esempi

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

Corpo della richiesta:

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

Risposta (successo):

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

Risposta (errore):

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

Tipi complessi

Namespace: types

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

address

CampoTipo / OccorrenzaDescrizione
name1xs:string / 1..1 · max 35Nome del titolare dell'indirizzo
name2xs:string / 0..1 · max 35Nome 2 del titolare dell'indirizzo
streetxs:string / 1..1 · max 35Via
houseNoxs:string / 0..1 · max 8Numero civico
street2xs:string / 0..1 · max 35Via 2
statexs:string / 0..1 · length 2Cantone/stato (ISO 3166-2, es. ZH)
countryxs:string / 1..1 · length 2Paese (ISO 3166-1 alpha-2, es. CH)
zipCodexs:string / 1..1 · max 9Codice postale
cityxs:string / 1..1 · max 35Città
glnxs:long / 0..1Numero di localizzazione internazionale
customerNumberxs:string / 0..1 · max 17Numero cliente
contactxs:string / 0..1 · max 35Persona di contatto
phonexs:string / 0..1 · max 30Numero di telefono
faxxs:string / 0..1 · max 30Numero di fax
emailxs:string / 0..1 · max 50E-mail (max 40 per le richieste di ritiro)
commentxs:string / 0..1 · max 70Commento
iaccountxs:string / 0..1 · max 50Allocazione contabile / centro di costo

cod (Contrassegno)

CampoTipo / OccorrenzaDescrizione
amountxs:long / 1..1 · max 350000Importo del contrassegno come intero (es. 30000 = 300.00 CHF)
currencyxs:string / 1..1 · length 3Codice valuta ISO 4217 — sempre CHF
inkassoxs:int / 1..1 · 0Tipo di incasso: 0 = contanti
purposexsd:string / 0..1 · max 14Scopo dell'utilizzo
bankCodexs:string / 0..1 · max 25Codice banca (richiede bankName, bankAccountNumber, bankAccountHolder)
bankNamexs:string / 0..1 · max 27Nome della banca
bankAccountNumberxs:string / 0..1 · max 25Numero di conto bancario
bankAccountHolderxs:string / 0..1 · max 30Titolare del conto
ibanxs:string / 0..1 · max 50IBAN
bicxs:string / 0..1 · max 50BIC

generalShipmentData

CampoTipo / OccorrenzaDescrizione
sendingDepotxs:string / 1..1 · length 4Depot responsabile (valore da LoginService, con zeri iniziali, es. 0615)
productxs:string / 1..1Codice prodotto — vedi Servizi e opzioni
sendertypes:address / 1..1Indirizzo del mittente
recipienttypes:address / 1..1Indirizzo del destinatario
identificationNumberxs:string / 0..1 · max 999Chiave alfanumerica univoca per la spedizione
mpsIdxs:string / 0..1 · length 25Numero di spedizione (inizia con MPS, EXP o B2C)
mpsCustomerReferenceNumber1–4xs:string / 0..1 · max 35Numeri di riferimento del cliente
mpsWeightxs:long / 0..1Peso della spedizione in grammi (unità da 10 g, senza decimali)
mpsExpectedSendingDatexs:string / 0..1Data di invio prevista (YYYYMMDD)
mpsExpectedSendingTimexs:string / 0..1Ora di invio prevista (HHMMSS)

notification

CampoTipo / OccorrenzaDescrizione
channelxs:int / 1..11 = e-mail, 3 = SMS
valuexs:string / 1..1 · max 50Indirizzo e-mail o numero di telefono (formato internazionale, es. +41790000000)
languagexs:string / 0..1 · length 2Lingua della notifica (ISO 3166-1 alpha-2, es. DE)

parcel

CampoTipo / OccorrenzaDescrizione
parcelLabelNumberxs:string / 0..1 · length 14Numero di etichetta del collo
customerReferenceNumber1–4xs:string / 0..1 · max 35Numeri di riferimento del collo
weightxs:int / 0..1Peso del collo in grammi (unità da 10 g)
volumexs:int / 0..1Volume in cm³ (formato LLLWWWHHH)
swapxs:boolean / 0..1Flag collo di scambio (predefinito: false)
hazardousLimitedQuantitiesxs:boolean / 0..1Merci pericolose in quantità limitate (predefinito: false)
contentxs:string / 0..1 · max 50Descrizione del contenuto del collo
codtypes:cod / 0..1Dati del contrassegno
returnsxs:boolean / 0..1Flag collo di reso (predefinito: false)
info1xs:string / 0..1 · max 29Campo info 1 (solo richiesta di ritiro, stampato sull'etichetta)
info2xs:string / 0..1 · max 30Campo info 2 (solo richiesta di ritiro, stampato sull'etichetta)

printOptions

CampoTipo / OccorrenzaDescrizione
printerLanguagexs:string / 1..1 · PDF o ZPLFormato di output. L'output è sempre codificato in base64
paperFormatxs:string / 1..1 · A4 o A6Formato carta per l'etichetta
startPositiontypes:startPosition / 0..1Posizione iniziale sul foglio A4
printerResolutionxs:double / 1..1 · 150, 200/203, 300, 600Solo ZPL (ignorato per PDF). Risoluzione della stampante in dpi. Deve corrispondere alla densità fisica della testina di stampa Zebra — altri valori non sono supportati.

productAndServiceData

CampoTipo / OccorrenzaDescrizione
orderTypexs:string / 1..1consignment, collection request order o pickup information
pickuptypes:pickup / 0..1Informazioni sul ritiro
parcelShopDeliverytypes:parcelShopDelivery / 0..1Dati di consegna al punto di ritiro
predicttypes:notification / 0..1Notifica interattiva (solo e-mail o SMS)
exWorksDeliveryxs:boolean / 0..1Il destinatario paga la spedizione (predefinito: false)
guaranteexs:boolean / 0..1Garanzia per spedizioni internazionali (solo prodotti NP, E18)
tyresxs:boolean / 0..1Pneumatici sfusi (solo prodotto NP)

storeOrders

CampoTipo / OccorrenzaDescrizione
printOptionstypes:printOptions / 0..1Opzioni di stampa dell'etichetta
ordertypes:shipmentServiceData / 1..30Dati della spedizione (fino a 30 per chiamata)

storeOrdersResponseType

CampoTipo / OccorrenzaDescrizione
parcellabelsPDFxs:base64Binary / 0..1Dati dell'etichetta del collo in PDF o ZPL (codificati in base64)
shipmentResponsestypes:shipmentResponse / 0..*Dati di risposta per ogni ordine di spedizione

Namespace: types_authentication

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

authentication

CampoTipo / OccorrenzaDescrizione
delisIdxsd:string / 1..1 · 8–10 caratteriID utente DELIS
authTokenxsd:string / 1..1 · 0–64 caratteriToken da LoginService.getAuth
messageLanguagexsd:string / 1..1 · length 5de_CH, fr_CH, it_CH o en_CH

Tipi semplici

startPosition

ValoreDescrizione
UPPER_LEFTPosizione in alto a sinistra sull'A4
UPPER_RIGHTPosizione in alto a destra sull'A4
LOWER_LEFTPosizione in basso a sinistra sull'A4
LOWER_RIGHTPosizione in basso a destra sull'A4

Punti di accesso

AmbienteProtocolloURL
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