- Příručka programátora Webové služby

Transkript

Příručka programátora
pro integraci zákaznických
řešení a DPD systémů
pomocí webových služeb
Moje DPD
Verze 2015-04-27
Pří ručka program átora pro integraci
z ákaz nických řešení a DPD systém ů
pom ocí w ebových služ eb Moj eDPD
Verze 2015-04-27
Obsah
Úvod ............................................................................................................................................. 4
1
1.1
Jak používat tuto příručku ...................................................................................................... 4
1.2
Procesy a pravidla ................................................................................................................... 4
1.3
Zákaznické aplikace ................................................................................................................ 4
Seznam metod webových služeb .................................................................................................. 6
2
2.1
Hlavní metody .......................................................................................................................... 6
2.2
Doplňkové metody .................................................................................................................. 6
Požadované kroky pro integraci webových služeb ........................................................................ 7
3
3.1
Předpoklady pro použití webových služeb ............................................................................ 7
3.2
Autorizace webových služeb .................................................................................................. 7
3.3
Webové služby - reference ..................................................................................................... 7
3.4
Webové služby – vícenásobné volání .................................................................................... 7
Scénáře použití ............................................................................................................................. 8
4
4.1
Příklad 1 – vytvoření zásilky, tisk štítků a seznamu zásilek ................................................. 9
4.1.1
4.1.2
4.2
Vytvoření zásilky ................................................................................................................ 9
Vytvoření přepravních štítků a seznamu zásilek ................................................................12
Příklad 2 – vytvoření zásilek, vytištění přepravních dokumentů .........................................14
4.2.1
4.2.2
4.2.3
Vytvoření zásilky ...............................................................................................................14
Vytváření přepravních štítků ..............................................................................................17
Uzavření seznamu.............................................................................................................17
4.3
Příklad 3 – zjištění ceny, vytvoření zásilky, vytištění potřebných přepravních
dokumentů.........................................................................................................................................20
4.3.1
4.3.2
4.3.3
4.3.4
Výpočet ceny .....................................................................................................................20
Vytvoření zásilky ...............................................................................................................23
Vytvoření přepravních štítků ..............................................................................................24
Uzavření seznamu zásilek .................................................................................................24
Seznam dostupných webových služeb .........................................................................................26
5
5.1
Služby pro zásilky ..................................................................................................................26
5.1.1
5.1.2
5.1.3
5.1.4
5.1.5
5.1.6
5.1.7
5.1.8
5.1.9
5.1.10
5.2
Metoda pro vytvoření nebo aktualizaci zásilky ...................................................................26
Metoda pro odstranění zásilky ...........................................................................................30
Metoda pro zjištění stavu zásilky .......................................................................................31
Metoda pro výpočet ceny...................................................................................................32
Metoda pro vytvoření přepravního štítku zásilky ................................................................33
Metoda pro přetisk přepravního štítku balíku .....................................................................35
Metoda pro zjištění stavu zásilky .......................................................................................36
Metoda pro zjištění stavu balíku ........................................................................................38
Metoda pro vyhledání zásilky ............................................................................................40
Metoda pro vyhledání DPD ParcelShop ............................................................................41
Služby pro objednávku svozu ...............................................................................................44
Příručka programátora - verze 2015-04-27
Strana 2 / 77
Verze 2015-04-27
5.2.1
5.2.2
5.2.3
5.2.4
5.2.5
5.3
Služby pro zpracování seznamu zásilek ...............................................................................50
5.3.1
5.3.2
5.4
Metoda pro vytvoření objednávky svozu ............................................................................44
Metoda pro odstranění objednávky svozu .........................................................................46
Metoda pro zjištění stavu objednávky svozu ......................................................................47
Metoda pro vyhledání chybějících objednávek svozu ........................................................48
Metoda pro vyhledání objednávky svozu ...........................................................................49
Metoda pro uzavření seznamu zásilek...............................................................................50
Metoda pro opakování tisku seznamu zásilek....................................................................53
Služby pro vyhledání DPD ParcelShop .................................................................................54
5.4.1
Metoda pro vyhledání DPD ParcelShop ............................................................................54
Přílohy..........................................................................................................................................55
6
6.1
Seznam kódů zemí .................................................................................................................55
6.2
Přehled DPD produktů a služeb ............................................................................................61
6.3
Výpis příkladů .........................................................................................................................62
6.3.1
Příklad 1 ............................................................................................................................62
6.3.1.1 Požadavek na vytvoření zásilky .....................................................................................62
6.3.1.2 Odpověď vytvoření zásilky .............................................................................................63
6.3.1.3 Požadavek na uzavření seznamu zásilek.......................................................................64
6.3.1.4 Odpověď uzavření seznamu zásilek ..............................................................................64
6.3.2
Příklad 2 ............................................................................................................................65
6.3.2.3 Požadavek na vytvoření přepravních štíktů k zásilce .....................................................67
6.3.2.4 Odpověď vytvoření přepravních štítků k zásilce .............................................................67
6.3.3
Příklad 3 ............................................................................................................................69
6.3.3.1 Požadavek na zjištění ceny ............................................................................................69
6.3.3.2 Odpověď zjištění ceny....................................................................................................70
6.3.3.5 Požadavek na vytvoření přepravních štítků zásilky ........................................................73
6.3.3.6 Odpověď vytvoření přepravních štítků zásilky ................................................................73
6.3.4
Příklad 4 ............................................................................................................................75
6.3.4.1 Požadavek na vyhledání DPD ParcelShop ....................................................................75
6.3.4.2 Odpověď vyhledání DPD ParcelShop ............................................................................76
Strana 3 / 77
Verze 2015-04-27
1
Úvod
1.1
Jak používat tuto příručku
Tato příručka je určena vývojářům, kteří chtějí integrovat svůj systém se systémy DPD pomocí
webových služeb.
Sekce 1 poskytuje obecné informace o obchodních podmínkách a IT souvislostech
Sekce 2 popisuje dostupné webové služby pro rozhraní s DPD, s rozdělením na klíčové a doplňkové
služby
Sekce 3 popisuje strukturu a funkce webových služeb.
Sekce 4 obsahuje příklady se scénáři možných použití od jednoduchých po složitější
Sekce 5 zobrazuje vstupní a výstupní parametry služeb, seskupené podle účelu na služby týkající se
tvorby zásilek, seznamu zásilek a objednávky svozu.
Sekce 6 zobrazuje předdefinované seznamy a číselníky
1.2
Procesy a pravidla
Většina




1.3
webových služeb vyžaduje tyto klíčové identifikátory:
přihlašovací údaje pro webové služby a ostatní DPD aplikace (wsUserName/wsPassword)
identifikátor společnosti registrované v systému DPD (payerId)
identifikátor adresy odesílatele (senderAddressId). Jeden zákazník může mít více adres.
Pravidla:
Pro svoz vytvořených zásilek je nutná objednávka svozu.
Zákaznické aplikace
Doplňkovým řešením pro proces expedice zásilek jsou zákaznické aplikace DPD, a to SSA
(instalovaná na PC uživatele) a www.mojedpd.cz (webová). Nabízí funkce správy zásilek pro tisk
balíkových štítků, tvorbu seznamu zásilek a objednávku svozu. Pro přístup potřebujete stejné
přihlašovací údaje, jako používáte pro webové služby.
Strana 4 / 77
Verze 2015-04-27
2 Moje DPD / IT4EM
Aktivace služeb poskytovaných se děje na vyžádání. Depo DPD CZ musí webové služby aktivovat.
Poskytované služby jsou:



ShipmentService
ManifestService
PickupOrderService
Služby jsou určeny pro kompletní správu zásilek – vytvoření zásilky, případně editaci, následný tisk,
objednávku svozu, správu seznamu zásilek.
Je vhodná, pokud
 akceptujete nutnost zásilku vytvořit a teprve v následném (samostatném) kroku její štítky
tisknout
 preferujete logiku vytvoření, případně editace zásilky, v DPD systému
 preferujete kompletní zajištění funkcionality na straně DPD, tedy kromě správy zásilek a
tisku štítků zejména i správu číselných řad, objednávku svozu, tisk seznamu zásilek
Služby, jejich metody a použití jsou detailně popsány v dokumentu Příručka programátora
pro integraci zákaznických řešení a DPD systémů pomocí webových služeb IT4EM.
K jejich použití potřebujete uživatelské jméno a heslo, identifikaci plátce (payerId), identifikaci
adresy svozu (addressId), nastavení jazyka (CZ) a parametr applicationType=9.
2.1
ShipmentService
Služba je určena pro výpočty ceny, vytvoření zásilek, tisk jejich přepravních štítků a vyhledávání.
ShipmentService WSDL
https://www.mojedpd.cz/IT4EMWebServices/eshop/ShipmentServiceImpl?wsdl
2.2
ManifestService
Služba je určena pro vytváření seznamu zásilek v procesu dokončení expedice zásilek
ManifestService WSDL
https://www.mojedpd.cz/IT4EMWebServices/eshop/ManifestServiceImpl?wsdl
2.3
PickupOrderService
Služba je určena pro objednávku svozu vytvořených zásilek
PickupOrderService WSDL
https://www.mojedpd.cz/IT4EMWebServices/eshop/PickupOrderServiceImpl?wsdl
Strana 5 / 77
Verze 2015-04-27
3 Seznam metod webových služeb
3.1
Hlavní metody
Seznam klíčových metod, které můžete použít pro integraci svého systému se systémy DPD,
naleznete v tabulce níže. Tyto metody umožňují tvořit zásilky a objednávky jejich svozu, vytvářet
přepravní dokumenty a sledovat balík během jeho přepravy.
Tabulka 1 Hlavní webové služby
Metoda
Popis
Calculate Price
Provádí výpočet cen v závislosti na nastaveném ceníku
Create Shipment
Vytváří zásilku
Print Label for Shipment
Get Shipment Status
Vytváří přepravní štítek zásilky
Vrací stav zásilky v závislosti na provedených skenech – událostech
v přepravním cyklu zásilky
Search Shipment
Vrací seznam zásilek dle vstupních parametrů (datum, zákazník, příjemce…)
Create Pickup Order
Vytváří objednávku svozu.
Pickup Order Status
Vrací stav objednávky svozu
Close Manifest
Uzavírá soupisku (manifest). Volitelně se štítky
3.2
Doplňkové metody
Seznam doplňkových metod, které můžete použít pro integraci svého systému se systémy
DPD, naleznete v tabulce níže. Tyto metody umožňují operace jako rušení, aktualizace, opětovný
tisk apod.
Tabulka 2 Doplňkové webové služby
Metoda
Popis
Delete Shipment
Maže zásilku
Parcel status
Vrací stav balíku v závislosti na provedených skenech – událostech
v přepravním cyklu zásilky (rozvoz, doručeno atd.)
Get Shipment
Vrací data o zásilce
Reprint Label for parcel
Opětovný tisk přepravního štítku balíku
Update Shipment
Aktualizace parametrů zásilky
Search Missing Pickup Order
Vrací množství zásilek, pro které není pořízena objednávka svozu
Search Pickup Order
Vrací seznam objednávek svozu dle vstupních parametrů
Reprint Manifest
Opětovný tisk seznamu zásilek (manifestu). Volitelně se štítky
Delete Pickup Order
Maže objednávku svozu
Strana 6 / 77
Verze 2015-04-27
4 Požadované kroky pro integraci webových služeb
4.1
Předpoklady pro použití webových služeb
Před použitím webových služeb musíte mít:
 Registrovaný účet vaší společnosti a jeho payerId (7mi místné číslo)
 Registrovanou adresu svozu
 Aktivní účet uživatele webových služeb
V případě, že tyto informace nemáte, kontaktujte technickou podporu na [email protected]
4.2
Autorizace webových služeb
Každý požadavek vyžaduje uživatelské jméno a heslo
Název parametru
Typ pole
Povinný
Popis
wsUserName
String
M
web service user
wsPassword
wsLang
String
String
M
M
web service password
web service request language (eg EN, LT, etc)
appliactionType
String
M
integrating application type
4.3
Webové služby - reference
Ve všech operacích, které provádíte, můžete použít svůj unikátní referenční údaj (číslo
objednávky, faktury, výdejky) jako ID záznamu. Později můžete sledovat svou přepravu pomocí této
reference. Podmínkou je, aby tato reference byla unikátní. V odpovědi sice vždy DPD uvádí vlastní
referenci, tu povinně sledovat nemusíte.
4.4
Webové služby – vícenásobné volání
Pokud potřebujete vytvořit více než jednu zásilku nebo objednávku svozu můžete vytvoř it
vícenásobné volání. To provedete vytvořením požadavku s více vnořenými uzly zásilek nebo
objednávek svozu.
Tabulka 3 Vícenásobné volání
Strana 7 / 77
Verze 2015-04-27
5 Scénáře použití
Vaše logistické procesy mohou být různé, v závislosti na druhu vašeho podnikání a dalších
faktorech. Tato kapitola prezentuje několik scénářů, jejichž použití můžete zvážit při plánování
vašeho rozhraní. Tyto příklady ilustrují, jak můžete provést integraci se systémy DPD, pokud:
 Potřebujete pouze vytvořit zásilky a vytisknout přepravní dokumenty (příklad 1) –
2 úkony
 Potřebujete vytvořit zásilky během přípravy a balení zboží v jednom kroku a v dalším
kroku zajistit nakládku zboží (příklad 2) – 3 úkony
 Potřebujete zkontrolovat cenu přepravy před vytvořením zásilky, pokud na tom
vytvoření zásilky závisí, vytisknout štítky a přepravní dokumenty (příklad 3) – 4 úkony
Strana 8 / 77
Verze 2015-04-27
5.1
Příklad 1 – vytvoření zásilky, tisk štítků a seznamu zásilek
Tento příklad ukazuje jak vytvořit zásilku s jedním nebo více balíky a tisknout přepravní
dokumenty, které potřebujete. Tyto kroky musí být uskutečněny:
a) Vyžádat vytvoření zásilky (CreateShipment),
b) Uzavřít soupisku (manifest) (CloseManifest)
První krok pošle požadavek na vytvoření zásilky a vrátí potvrzení s DPD referencí. Druhý krok
vygeneruje štítky a soupisku jako sadu přepravních dokumentů k vytištění na vaší straně.
1. CreateShipment
2. CreateShipment Response
3.CloseManifest
4.CloseManifest Response
Your interface server
DPD api server
Obrázek 1 Dva kroky k odeslání zásilky
5.1.1 Vytvoření zásilky
Požadavek na vytvoření zásilky sestává z jedné nebo více zásilek. Zásilka obsahuje informace jako:
a) Identifikace plátce (payerId) určuje, kdo je vlastníkem zásilky nebo objednávky svozu
b) Identifikace adresy odesílatele (senderAddressId) sděluje z jaké adresy je zásilka odeslána
c) Adresa příjemce určuje zemi, ulici, PSČ, jméno a kontaktní osobu, kam má být zásilka
doručena
d) DPD produkt a služba (mainServiceCode a additionalServices) volitelně určují, jakým DPD
produktem a službou má být přeprava zásilky uskutečněna
e) Detaily balíku (parcels) informují o počtu balíků, hmotnosti, případně objemu
Strana 9 / 77
Verze 2015-04-27
V tomto příkladu společnost A odesílá zboží svým zákazníkům. Společnost B objedná zboží
u společnosti B. Prodávající společnost A vidí objednávku pod interním číslem WS167, které bylo
zadáno společností B k objednávce a zabalí toto zboží do jednoho balíku o hmotnosti 10 kg.
Společnost B se nachází na adrese:
Company B,Toompuiestee 33a, 10149 Tallin, Eesti
Z pohledu DPD je společnost A jako plátce a odesílatel, společnost B je příjemce. Společnost A
objedná přepravu ze své adresy na adresu společnosti B. Společnost A použije pro tuto zásilku
službu DPD CLASSIC.
Klíčové prvky požadavku jsou zobrazeny v tabulce níže, úplný požadavek naleznete v příloze.
Strana 10 / 77
Verze 2015-04-27
Tabulka 4 Data zásilky - příklad 1
element
hodnota
popis
shipmentReferenceNumber
WS167
Vaše reference
payerId
2024559
senderAddressId
2005887
Id plátce a adresy
odesílatele
receiverName
John Smith
receiverFirmName
Company B
receiverCountryCode
EE
receiverZipCode
10149
receiverCity
Tallin
receiverStreet
Toompuiestee
receiverHouseNo
33a
mainServiceCode
1
Adresa příjemce
additionalServices
Služby
parcels
Uzel balíku
Společnost A použije:
 Číslo objednávky jako svou referenci zásilky
 2024559 jako id plátce
 2005887 jako id adresy odesílatele (dříve registrované)
 Adresu společnosti B jako adresu příjemce
 DPD CLASSIC jako způsob přepravy (kód 1 znamená DPD CLASSIC)
A připojí detaily o balíku zásilky
Tabulka 5 Data balíku zásilky - příklad 1
element
hodnota
parcelReferenceNumber
WS3136
weight
10.0
popis
Detaily balíku
Klíčové elementy odpovědi jsou uvedeny níže, kompletní výpis naleznete v kapitole 6
Element
hodnota
popis
Id
29259376
referenceNumber
WS167
Unikátní reference
Zpráva odpovědi vám sděluje unikátní id a referenci, které byla vašemu požadavku p řiřazeny a pod
kterými jsou evidovány v DPD systému.
Strana 11 / 77
Verze 2015-04-27
5.1.2 Vytvoření přepravních štítků a seznamu zásilek
Klíčové prvky požadavku jsou zobrazeny v tabulce níže, úplný požadavek naleznete v příloze.
Poté co společnost A vytvořila zásilku pro zboží objednané společností B, potřebuje vytisknout
přepravní štítek, nalepit je na balík a vytisknout seznam přepravovaných zásilek (manifest). Tento
požadavek
obsahuje:
Společnost A vyšle požadavek pro tisk štítku a tisk seznamu. Klíčové elementy požadavku jsou
zobrazeny níže. Obsahuje dvě části, část pro unikátní referenci a část pro volby nastavení.
Tabulka 5 Data seznamu – příklad 1
element
hodnota
popis
manifestReferenceNumber
MR167
manifestNotes
text
poznámky
komentáře
Vaše reference
Vaše
poznámky
komentáře
pro soupisku
/
/
Tabulka 6 Volby tisku pro tisk seznamu – příklad 1
element
hodnota
manifestPrintOption
PrintManifestWithUnprintedParcels
popis
Možnosti:
Vytvořit pouze
seznam
Vytvořit seznam
a přepravní
štítky pro
Strana 12 / 77
Verze 2015-04-27
-
všechny balíky
seznamu
Vytvořit seznam
a přepravní
štítky dosud
nevytištěné
výstupního
Volby
formátu:
Pdf(generuje
PDF soubor a
vrací je
v odpovědi)
Ftp (generuje
PDF a vrací cestu
kde je uložen)
Data (raw data)
k vytištění na
printOption
Ftp
balíkový štítek
a) Jako reference zásilky je použito číslo objednávky společnosti A (WS165)
b) Zvolena volba pro tisk nevytištěných štítků a seznamu společně (manifestPrintOption=
PrintManifestWithUnprintedParcels)
c) Zvolena preferovaná volba tisku (PDF formát přes FTP) pro výstupní dokumenty
(printOption=Ftp)
Poznámka: Více možností pro volby tisku a formátu naleznete v příloze.
Klíčové elementy odpovědi naleznete níže, úplnou odpověď naleznete v příloze.
Tabulka 7 Data odpověďi tisku seznamu – příklad 1
element
hodnota
popis
manifestId
20043
DPD reference seznamu
MR167
vaše reference seznamu
ftpManifestFileName
eshop_manifest_print_20130228_152506_94.pdf
Název souboru seznamu
v PDF formátu
ftpLabelFileName
eshop_parcel_label_20130228_152506_63.pdf
Název souboru
v PDF formátu
V odpovědi společnost A obdrží:
a) DPD unikátní referenci pro dokument seznamu zásilek
b) PDF soubory pro štítky a seznam. Tyto soubory mohou být uloženy na našem FTP serveru,
nebo na vašem, pokud je použita volba FTP
Dalším krokem pro společnost A je vytisknout tyto dokumenty.
Strana 13 / 77
štítku
Verze 2015-04-27
5.2
Příklad 2 – vytvoření zásilek, vytištění přepravních dokumentů
Tento příklad ukazuje, jak můžete vytvořit zásilku s jedním nebo více balíky a následně tisknout
přepravní štítky (opakovaně) a nakonec tisknout soupisku. Tyto kroky musí být uskutečněny:
a) Nejprve, vytvoření zásilky (CreateShipment),
b) Poté, vytištění štítků zásilky (GetShipmentLabel)
c) Nakonec, uzavření a tisk seznamu (CloseManifest).
První krok pošle požadavek na vytvoření zásilky a vrací potvrzení s vaší klíčovou referencí.
Druhý krok vytiskne přepravní štítky pro nalepení na balíky. Třetí krok vygeneruje soupisku
pro vytištění před příjezdem kurýra pro vyzvednutí zásilek.
1. CreateShipment
3.GetShipment Label
4.GetShipmentLabel Response
5.CloseManifest
DPD api server
Obrázek 2 Vykonání tří kroků
Klíčové elementy požadavku jsou zobrazeny níže, úplný požadavek naleznete v příloze.
Požadavek na vytvoření zásilky se skládá z jedné nebo více zásilek. Zásilka obsahuje informace
jako:
a) Identifikace plátce (payerId) určuje, kdo je vlastníkem zásilky nebo objednávky svozu
b) Identifikace adresy odesílatele (senderAddressId) sděluje z jaké adresy je zásilka odeslána
doručena
Strana 14 / 77
Verze 2015-04-27
V tomto příkladu odesílá společnost A své zboží zákazníkům. Společnost C objedná zboží
od společnosti A. Společnost A vidí objednávku pod číslem WS183, kterou provedla společnost C a
expeduje toto zboží v jednom balíku o hmotnosti 18 kg. Adresa společnosti C je:
Company C, Riia mnt 231a, 80042 Pärnu, Eesti
Z pohledu DPD je společnost A plátce a odesílatel, společnost C je příjemce. Společnost A vytvoří
požadavek na přepravu zásilky ze své adresy na adresu společnosti C. Společnost A použije
k přepravě službu DPD CLASSIC dobírka. Hodnota dobírky je 120 Euro.
Strana 15 / 77
Verze 2015-04-27
Tabulka 8 Klíčová data zásilky – příklad 2
element
hodnota
popis
WS183
Vaše reference
payerId
2024559
senderAddressId
2005887
Id plátce a adresy
odesílatele
receiverName
Mr Kaido
receiverFirmName
Company C
receiverCountryCode
EE
receiverZipCode
80042
receiverCity
Pärnu
receiverStreet
Riia mnt
receiverHouseNo
231a
mainServiceCode
1
additionalServices
COD: 120 EUR,
Cash
Adresa příjemce
Služby (“1” znamená DPD
CLASSIC, COD znamená
dobírka s hodnotou 120
EUR k výběru v hotovosti)
parcels
Uzel balíku
 Číslo objednávky jako svou referenci zásilky,
 2024559 jako id plátce,
 2005887 jako id adresy odesílatele (registrováno předem),
 Adresu společnosti B jako adresu příjemce
 DPD CLASSIC jako způsob přepravy (kód 1 znamená DPD CLASSIC)
Navíc, společnost A poskytne detaily o balících, zobrazené v tabulce níže
Tabulka 9 Data balíku – příklad 2
element
hodnota
WS3154
weight
8.0
popis
Detaily balíku
Strana 16 / 77
Verze 2015-04-27
element
hodnota
popis
id
29259376
referenceNumber
WS183
parcelId
20959
WS3154
printRequired
true
DPD unikátní reference
pro balík
Vaše unikátní reference
pro balík
Příznak, který sdělue,
jestli je vyžadováno
vytvoření štítků.: true
říká,
že
tisk
je
vyžadován
Odpověď sděluje, jaká unikátní reference je vaší zásilce přiřazena, vrací DPD referenci balíku a
indikátor, zda mají být přepravní štítky balíků vytištěny.
5.2.2 Vytváření přepravních štítků
Když chcete tisknout přepravní štítky k vašim dříve vytvořeným zásilkám, volejte metodu
GetShipmentLabel s vaší unikátní referencí a volbami tisku jako parametry.
Tabulka 10 Klíčové elementy pro tisk přepravních štítků – příklad 2
element
hodnota
referenceNumber
WS183
printOption
Pdf
popis
Vaše reference
Vytvořit PDF oubor
Úplný výpis odpovědi naleznete v příloze
Klíčové elementy odpovědi jsou zobrazeny níže, úplný požadavek naleznete v příloze.
Odpověď obsahuje jediný element
Tabulka 11 Odpověď tisku štítků
5.2.3
element
hodnota
pdfFile
Pdf content
popis
Obsah PDF souboru
Uzavření seznamu
Poté, co společnost A vytvoří zásilku pro přepravu zboží objednané společností C, potřebuje
vytisknout přepravní štítky zásilky, nalepit je na balík a vytisknout soupisku. Požadavek vypadá
takto:
Strana 17 / 77
Verze 2015-04-27
Společnost A formuluje požadavek na štítek a soupisku. Klíčové elementy požadavku jsou
zobrazeny níže. Skládá se ze dvou částí: část s unikátní referencí a část s volbami nastavení.
Tabulka 12 Data požadavku na soupisku – příklad 2
element
hodnota
popis
MR183
manifestNotes
your comments here:
Vaše reference
Vaše poznámky / komentáře
k seznamu
Tisknout pouze seznam
manifestPrintOption
PrintOnlyManifest
printOption
Pdf
PDF jako výstupní formát
a) Společnost A použije číslo objednávky (WS183) jako referenci zásilky pro určení která zásilka
má být uzavřena
b) Zvolí volbu k vytvoření seznamu (manifestPrintOption= PrintOnlyManifest). Přepravní štítky
byly již vytvořeny v kroku 2.
c) Zvolí PDF dokument jako preferovaný způsob výstupu (printOption=Pdf).
Poznámka: Více možností voleb tisku seznamu naleznete v příloze.
Klíčové elementy odpovědi naleznete níže, úplný výpis naleznete v příloze.
Strana 18 / 77
Verze 2015-04-27
Tabulka 13 Data odpovědi tisku seznamu – příklad 2
element
hodnota
popis
manifestId
20043
MR183
Vaše reference seznamu
ftpManifestFileName
v PDF formátu
ftpLabelFileName
Název souboru
v PDF formátu
V odpovědi společnost A získá:
a) DPD unikátní referenci seznamu zásilek
b) PDF soubory vytvořené pro štítky a seznam. Tyto soubory mohou být poskytnuty na FTP.
Dalším krokem pro společnost A je vytisknout tyto dokumenty.
Strana 19 / 77
štítku
Verze 2015-04-27
5.3
Příklad 3 – zjištění ceny, vytvoření zásilky, vytištění potřebných přepravních
dokumentů
Tento příklad ukazuje jak vypočítat cenu přepravy, dále, pokud jste s ní spokojeni, můžete
vytvořit zásilku s jedním nebo více balíky, poté vytisknout přepravní štítky a nakonec soupisku. Tyto
kroku musí být uskutečněny:
a) Nejprve je zjištěna cena (priceCalculation),
b) Poté je vytvořena zásilka (CreateShipment),
c) Poté jsou vytištěny přepravní štítky pro balíky (GetShipmentLabel)
d) Nakonec je uzavřena soupiska (CloseManifest).
První krok odešle požadavek na výpočet ceny a odpovědi vrátí výši ceny pro požadovanou
zásilku. Poté, pokud akceptujete náklady na přepravu, vytvoříte zásilku a v odpovědi získáte
referenci. Následně vytvoříte štítky k nalepení na balíky. V posledním kroku před příjezdem kurýra
vytvoříte soupisku.
1. CalculatePrice
2. CalculatePrice Response
3. CreateShipment
5.GetShipment Label
6.GetShipmentLabel Response
7.CloseManifest
DPD api server
Figure 3 Four steps approach
5.3.1 Výpočet ceny
Klíčové elementy požadavku jsou zobrazeny níže, úplný výpis požadavku naleznete v příloze.
Kalkulace ceny se může skládat z jedné nebo více zásilek. Tento požadavek má stejnou strukturu
dat jako požadavek na vytvoření zásilky, kromě reference zásilky a balíku. Požadavek obsahuje
informace:
a) Identifikace plátce (payerId) určuje vlastníka zásilky (komu bude fakturována)
b) Identifikace odesílatele (senderAddressId) sděluje adresu, ze které bude zásilkka odeslána
doručena
Strana 20 / 77
Verze 2015-04-27
V tomto příkladu společnost A odesílá zboží svým zákazníkům. Společnost C si objedná zboží
od společnosti A. Prodejce (společnost A) vidí objednávku č. WS183 zadanou společností C a zabalí
toto zboží do jednoho balíku o hmotnosti 10 kg. Adresa společnosti C je:
Company C, Riia mnt 231a, 80042 Pärnu, Eesti
Z pohledu DPD vystupuje společnost A jako plátce a odesílatel přepravy, společnost C jako
příjemce. Společnost A použije k přepravě zboží službu DPD CLASSIC s doplňkovou službou
sobotní doručení (pozn.: v DPD CZ nedostupné)
Klíčové elementy požadavku jsou zobrazeny v tabulce níže.
Strana 21 / 77
Verze 2015-04-27
Tabulka 15 Klíčová data výpočtu ceny – příklad 3
element
hodnota
payerId
2024559
senderAddressId
2005887
receiverFirmName
Company C
receiverCountryCode
EE
receiverZipCode
80042
receiverCity
Pärnu
receiverStreet
Riia mnt
receiverHouseNo
231a
popis
Id plátce a adresy
odesílatele
Adresa příjemce
mainServiceCode + additional
service
1
,
saturdayDelivery=true
weight
10.00
CLASSIC, Saturday delivery
= true je povolení
doplňkové služby sobotní
doručení)
Uzel balíku
 2024559 jako identifikátor plátce,
 2005887 jako id adresy odesílatele (předem registrované v systému DPD),
 Adresu společnosti C jako adresu příjemce
 DPD CLASSIC jako způsob přepravy (mainServiceCode 1 znamená službu DPD CLASSIC)
 Jeden balík o hmotnosti 10 kg.
Klíčové elementy odpovědi naleznete v tabulce níže, úplný výpis požadavku naleznete v příloze
Tabulka 16 Odpověď požadavku na výpočet ceny – příklad 3
element
hodnota
popis
amount
6.17
Částka ceny bez DPH
vatAmount
1.23
Částka DPH
totalAmount
7.4
Částka ceny s DPH
currency
EUR
Kód měny (měna výpočtu ceny)
amountLocal
6.17
Částka bez DPH v lokální měně
vatAmountLocal
1.23
Částka DPH v lokální měně
totalAmountLocal
7.4
Částka ceny s DPH v lokální měně
currencyLocal
EUR
Kód měny (lokální národní měna)
Strana 22 / 77
Verze 2015-04-27
Společnost A použije všechna data z požadavku na kalkulaci přepravy a přidá dva chybějící
elementy:
 Reference zásilky
 Reference balíku
Volba ceny bude nastavena na možnost bez výpočtu ceny (priceOption=WithoutPrice), protože cena
byla vypočtena v předchozím kroku. Klíčová data jsou zobrazena v tabulce níže:
element
hodnota
popis
payerId
112463
2024559
senderAddressId
2005887
receiverName
Mr Kaido
receiverFirmName
Company C
receiverCountryCode
EE
receiverZipCode
80042
receiverCity
Pärnu
receiverStreet
Riia mnt
receiverHouseNo
231a
Vaše reference
Id plátce a adresy
odesílatele
Adresa příjemce
CLASSIC a volba Sobotní
additionalServices
saturdayDelivery=true
doručení je zapnuta)
Uzel
balíku:
reference
parcelReferenceNumber=LT3246
balíku
=
LT3246
,
parcels
weight=10.0
hmotnost=10.0 kg
Klíčové elementy odpovědi jsou zobrazeny níže, úplný výpis naleznete v příloze.
mainServiceCode
1
element
hodnota
id
29259664
referenceNumber
112463
parcelId
22035
LT3246
printRequired
true
popis
DPD unikátní reference
pro balík
Vaše unikátní reference
pro balík
Příznak určující, zda má
být vytvořen štítek pro
tisk
Zpráva odpovědi vám sděluje unikátní číslo reference, které je přirazeno k vaší zásilce, vrací DPD
unikátní referenci balíku a indikátor, zda potřebujete vytvořit přepravní štítek balíku.
Strana 23 / 77
Verze 2015-04-27
5.3.3 Vytvoření přepravních štítků
Když chcete vytvořit přepravní štítky pro vaše zásilky, voláte metodu getShipmentLabel s unikátní
referencí zásilky a způsobem tisku jako parametry.
Tabulka 17 Klíčové elementy vytvoření přepravního štítku – příklad 3
element
hodnota
referenceNumber
112463
printOption
Pdf
Popis
Vaše reference
Vytvořit PDF soubor
Klíčové elementy odpovědi jsou zobrazeny níže, úplný výpis odpovědi naleznete v příloze.
Odpověď obsahuje jediný element
Tabulka 14 Odpověď tisku štítků
Element
hodnota
pdfFile
Pdf content
popis
Obsah PDF souboru
5.3.4 Uzavření seznamu zásilek
Poté, co společnost A vytvoří objednávku pro přepravu zboží objednaného společností C, musí
vytisknout přepravní štítk, nalepit je na balík a vytisknout soupisku. Požadavek na vytištění seznamu
vypadá takto:
Strana 24 / 77
Verze 2015-04-27
Klíčové elementy požadavku jsou zobrazeny níže.
Požadavek má dvě části, část pro unikátní referenci a část pro volby tisku.
Tabulka 15 Data požadavku na tisk seznamu zásilek – příklad 3
element
hodnota
popis
MR188
manifestNotes
shipmentReferenceList\
referenceNumber
your comments here:
Vaše reference
Vaše poznámky / komentáře
k seznamu
Jedna nebo více referencí
zásilek
Volba pro vytvoření pouze
seznamu
manifestPrintOption
PrintOnlyManifest
printOption
Pdf
112463
Volba pro výstupní formát v
PDF
a) Společnost A použije číslo objednávky (WS183) jako referenci zásilky k označení, které
zásilky mají být uzavřeny
b) Je zvolena volba tisknout pouze seznam (manifestPrintOption= PrintOnlyManifest).
Přepravní štítky byly vytvořeny dříve (krok 2).
c) Jako formát tiskového výstupu pro dokumenty je zvolen PDF soubor (printOption=Pdf)
Poznámka: více voleb pro nastavení možností tisku seznamu zásilek naleznete v příloze.
Klíčové elementy odpovědi jsou zobrazeny níže, úplný výpis naleznete v příloze.
Tabulka 20 Data odpovědi požadavku na tisk seznamu zásilek – příklad 3
element
hodnota
Popis
manifestId
20043
MR183
Vaše reference seznamu
ftpManifestFileName
v PDF formátu
ftpLabelFileName
Název souboru
v PDF formátu
V odpovědi společnost A obdrží zpět:
a) DPD unikátní referenci seznamu zásilek
b) PDF soubor pro vytvořené přepravní štítky balíků a soupisku. Ty mohou být poskytnuty na
FTP.
Dalším krokem pro společnost A je vytištění těchto dokumentů.
Strana 25 / 77
štítku
Verze 2015-04-27
6 Seznam dostupných webových služeb
Přehledové tabulky uvádějí parametry jednotlivých metod.
 Název parametru – název elementu
 Typ pole – datový typ pole
 Povinné – označení, zda je parametr povinný (M = mandatory) nebo volitelný (O = optional)
 Popis – vysvětlení obsahu / hodnoty parametru
6.1
Služby pro zásilky
6.1.1 Metoda pro vytvoření nebo aktualizaci zásilky
Metody createShipment a updateShipment mají tyto elementy – vstupní parametry:
Název
parametru
Typ pole
Povinné
Popis
wsUserName
wsPassword
String
String
M
M
web service user
wsLang
String
M
web service request language
appliactionType
String
M
shipment
ShipmentVO(List)
M
List shipment objects with parcels and products
priceOption
Enum
M
it can be WithPrice or WithoutPrice
ShipmentVO obsahuje tato pole:
Název parametru
Typ pole
Povin
né
Popis
O
M
DPD SYSTEM shipment id leave empty for create operation
Integrators shipment id
shipmentId
shipmentReference
Number
Long
payerId
Long
M
DPD SYSTEM customer id for payer
senderAddressId
Long
receiverName
receiverFirmName
receiverCountryCo
de
receiverZipCode
receiverCity
receiverStreet
receiverHouseNo
receiverPhoneNo
mainServiceCode
additionalServices
parcels
String
String
M
M
DPD SYSTEM address id for sender (shiping address)
Receiver name
O
M
Receiver firm name
Receiver country code (EE, LV…)
M
M
M
O
O
M
O
M
Receiver zip code
Receiver city
Receiver address information
Receiver house number
Receiver phone number
DPD SYSTEM main Product id
Additional services information
List of parcels
String
String
String
String
String
String
String
Long
AdditionalServiceVO
ParcelVO
Strana 26 / 77
Verze 2015-04-27
ParcelVO obsahuje tato pole
Název parametru
Typ pole
Povinné
Popis
O
DPD SYSTEM parcel Id.
M
Integrators parcel id
double
O
Package height (meter)
double
double
double
String
O
Package width (meter)
O
M
O
Package length (meter)
Package weight (kg)
Package description
parcelId
parcelReferenceNu
mber
long
dimensionsHeight
String
dimensionsWidth
dimensionsLength
weight
description
AdditionalServiceVO obsahuje tato pole
Název
parametru
Povinné
Typ pole
Popis
cod
saturdayDelivery
CodVO
Boolean
O
O
COD information
Saturday delivery information
highInsurance
HighInsuranceVO
O
High insurance information
documentReturn
DocumentReturnVO
O
Document return information
expay
ExpayVO
O
External payment service information
parcelShop
ParcelShopShipmentVO
O
Parcel Shop information
CodVO obsahuje tato pole:
Název parametru
Typ pole
Povinné
Popis
amount
Double
M
COD amount
currency
String
M
COD currency (EUR, LAT…)
paymentType
Enum
M
it can be Cash, CreditCard, CrossedCheck
referenceNumber
String
O
HighInsuranceVO obsahuje tato pole:
Název
parametru
Typ pole
Povinné
Popis
goodsValue
Double
M
goods value amount
currency
String
M
COD currency (EUR, LAT…)
content
String
M
goods content
DocumentReturnVO obsahuje tato pole
Název parametru
Typ pole
Povinné
Popis
documentReference
String
M
document return reference number
instructions
String
O
document return instructions
Strana 27 / 77
Verze 2015-04-27
ExpayVO obsahuje tato pole
Název parametru
Povinné
Typ pole
Popis
transactionId
String
M
Eshop reference for the transaction
authenticationId
String
O
Reference number created by external payment provider.
hashCode
String
O
reference
String
O
Hashed pin code. Format of data may be changed according
to providers’ implementation.
Reference information for the transaction. It could be used to
store additional information in DPD system.
parcelShopShipmentVO obsahuje tato pole
Název parametru
parcelShopId
companyName
street
houseNo
countryCode
zipCode
city
Typ pole
Povinné
Popis
long
M
Parcel shop Id
String
String
M
Parcel shop company name
M
Parcel shop street
String
String
String
String
M
Parcel shop house number
M
M
M
Parcel shop country code alpha
Parcel shop zip code
Parcel shop city name
Odpověď createShipmentResponse má tyto elementy – výstupní parametry
Název parametru
Typ pole
Povinné
Popis
transactionId
Long
M
Request log id
resultList
Shipment
ResultVO
M
List of result objects
ShipmentResultVO obsahuje tato pole:
Název parametru
Typ pole
shipmentReference
Povinn
é
Popis
ReferenceVO
M
parcelResultList
ParcelResultVO
M
Object that contains both DPD SYSTEM shipment id
and shipment reference number
List of parcel result information
price
PriceVO
O
Price information of shipment
error
ErrorVO
O
Error information
ReferenceVO obsahuje tato pole:
Název parametru
Typ pole
Povinné
Popis
referenceNumber
String
M
Customer reference number
id
Long
M
DPD SYSTEM id
ParcelResultVO obsahuje tato pole:
Název parametru
Typ pole
Povinné
Popis
parcelId
String
Long
M
M
Customer reference number
DPD SYSTEM id
printRequired
boolean
M
Label print required after create or update
Strana 28 / 77
Verze 2015-04-27
ErrorVO obsahuje tato pole:
Název parametru
Typ pole
Povinné
Popis
Text
String
M
Error description
Code
Id
M
Error code
PriceVO obsahuje tato pole:
Název parametru
Typ pole
Povinné
Popis
Double
Double
M
Price amount
M
Price vat amount
totalAmount
Double
currency
String
M
M
Price amount with vat amount
Price currency
amountLocal
Double
M
Price amount (local currency)
vatAmountLocal
totalAmountLocal
Double
Double
M
Price vat amount (local currency)
M
Price amount with vat amount (local currency)
currencyLocal
String
M
Local price currency
amount
vatAmount
Zpracování chyb
Služba vyhodí výjimku IT4EMWSException
Název parametru
Typ pole
Povinné
Popis
errorCategory
String
O
Error category information
errorCode
Int
M
Error code information
errText
String
M
Error text of wsLang if exists, otherwise EN error Popis
errSolution
String
O
Possible solution will be described
serviceName
String
O
Service name that error occurred
Strana 29 / 77
Verze 2015-04-27
6.1.2 Metoda pro odstranění zásilky
Metoda deleteShipment má tyto elementy – vstupní parametry:
Název parametru
Povinné
Typ pole
Popis
wsUserName
wsPassword
String
String
M
M
web service user
wsLang
String
M
appliactionType
String
M
shipmentReferenceList
ReferenceVO(List)
M
List of shipment ids and reference numbers
Odpověď deleteShipmentResponse má tyto elementy – výstupní parametry:
Název parametru
Povinné
Typ pole
Popis
transactionId
Long
M
Request log id
resultList
ShipmentDelete
ResultVO
M
List of result objects
ShipmentDeleteResultVO obsahuje tato pole:
Název parametru
Typ pole
Povinné
Popis
shipmentReference
ReferenceV
O
ErrorVO
M
Object that contains both DPD SYSTEM shipment id
and shipment reference number
Error information
error
O
Zpracování chyb
Strana 30 / 77
Verze 2015-04-27
6.1.3 Metoda pro zjištění stavu zásilky
Metoda getShipment má tyto elementy – vstupní parametry:
Název parametru
Typ pole
Povinné
Popis
wsUserName
wsPassword
String
String
M
M
web service user
wsLang
String
M
appliactionType
String
M
shipmentReference
ReferenceVO
M
Shipment id and reference number
Odpověď getShipmentResponse má tyto elementy – výstupní parametry:
Název parametru
Typ pole
Povinné
Popis
transactionId
Long
M
Request log id
shipment
error
ShipmentVO
ErrorVO
O
O
whole shipment object with parcels and products
Error information
Zpracování chyb
Strana 31 / 77
Verze 2015-04-27
6.1.4 Metoda pro výpočet ceny
Metoda calculatePrice má tyto elementy – vstupní parametry:
Název
parametru
Typ pole
Povinné
Popis
wsUserName
wsPassword
String
String
M
M
web service user
wsLang
String
M
appliactionType
String
M
shipment
ShipmentVO
M
whole shipment object with parcels and products
Odpověď calculatePriceResponse má tyto elementy – výstupní parametry:
Název parametru
Typ pole
Povinné
Popis
transactionId
Long
M
Request log id
price
error
PriceVO
ErrorVO
O
O
Price calculation result
Error information
Zpracování chyb
Strana 32 / 77
Verze 2015-04-27
6.1.5 Metoda pro vytvoření přepravního štítku zásilky
Metoda getShipmentLabel má tyto elementy – vstupní požadavky:
Název parametru
Typ pole
Povinné
Popis
wsUserName
wsPassword
String
String
M
M
web service user
wsLang
String
M
appliactionType
String
M
shipmentReference
List
printOption
ReferenceV
O
Enum
M
List of shipment ids and reference numbers
M
It can be:
Data – row data to fill label template and manifest template
Pdf – PDF file contains label(s)/manifest to be printed
or Ftp – PDF file contains label(s)/manifest and stored on ftp
server.
Odpověď getShipmentLabelResponse má tyto elementy – výstupní parametry:
Název parametru
Typ pole
Povinné
Popis
transactionId
Long
M
Request log id
printParcelList
PrintDataVO
O
List of PrintDataVO object
ftpFileName
pdfFile
String
Byte
O
O
File name that Pdf file is located
Byte array of Pdf file
error
ErrorVO
O
Error information
PrintDataVO obsahuje tato pole:
Název parametru
Typ pole
Povinné
Popis
Long
M
DPD SYSTEM shipment id
parcelId
Long
senderCustName
String
M
M
DPD SYSTEM parcel id
Sender customer name
senderAddress
String
M
Sender address
senderZipCode
senderCountryAlphaCod
e
String
M
Sender zip code
M
Sender country code
senderTaxNumber
senderTelNumber
String
String
M
Sender tax number
M
Sender phone number
senderCity
String
M
Sender city
senderContact
String
companyName
String
M
M
Sender contact name
DPD company name
companyTaxNumber
String
M
DPD tax number
String
String
M
DPD address
M
DPD phone number
String
O
DPD fax number
barcode
String
barcodeText
shipmentReferenceNum
ber
String
M
M
Label barcode
Label barcode text
O
Integrators shipment id
parcelIndex
Long
M
Index of parcel in shipment
Long
M
Count of parcel in shipment
String
M
Receiver name
shipmentId
companyAddress
companyTelNumber
companyFaxNumber
parcelCount
receiverName
String
String
Strana 33 / 77
Verze 2015-04-27
Název parametru
Typ pole
Povinné
Popis
String
M
Receiver address
String
M
Receiver address (receiver country code – receiver zip code)
receiverZipCode
String
receiverCity
receiverCountryCodeAlp
ha
String
M
M
Receiver zip code
Receiver city
M
Receiver country code
receiverTaxNumber
String
O
Receiver tax number
String
O
Extra information on Label
departureUnitId
deliveryUnitId
String
String
M
Departure depot code of shipment
M
Delivery depot code of shipment
serviceCode
String
M
3 digit DPD service code for products
serviceCombination
String
routeDsort
String
M
M
Service combination information
Route information
routeOsort
String
M
Route information
String
String
O
Receiver contact name
O
String
O
receiverAccessCode
String
codAmountOfValue
double
O
O
receiver access code
COD amount
codCurrency
codReferenceNo
String
String
O
COD currency
O
COD reference number
codPaymentType
String
O
COD payment type
parcelNo
String
weight
double
M
M
14 digit parcel number
Package weight (kg)
volume
double
M
Package volume (m3)
parcelRefNumber
additionalLabelFlag
additionalInformationDat
a
serviceFieldInfo
String
String
O
Integrators parcel id
O
1 if additional Label need to be printed; otherwise 0
O
Additional label information
String
String
O
Service field information
String
O
Service mark
damageInformation
String
parcelNoCsd
String
O
M
Damage information
Parcel no check sum
receiverAddress1
receiverAddress2
extraInformationOnLabel
receiverContactName
receiverPhoneNr1
receiverPhoneNr2
serviceMark
String
Zpracování chyb
Strana 34 / 77
Verze 2015-04-27
6.1.6 Metoda pro přetisk přepravního štítku balíku
Metoda reprintParcelLabel může být volána, pouze pokud již k danému balíku byla volána metoda
getShipmentLabel. Cílem této metody je umožnit přetisk existujícího přepravního štítku balíku.
Metoda reprintParcelLabel má tyto elementy – vstupní parametry:
Název parametru
Typ pole
Povinné
Popis
wsUserName
String
M
web service user
wsPassword
String
M
wsLang
String
M
appliactionType
String
M
parcelReferenceLis
t
printOption
ReferenceV
O
Enum
M
List of parcel ids and reference numbers
M
It can be:
Data – row data to fill label template
Pdf – PDF file contains label(s) to be printed
or Ftp – PDF file contains label(s) and stored on ftp server.
Odpověd reprintParcelLabelResponse má tyto elementy – výstupní požadavky:
Název parametru
Typ pole
Povinné
Popis
transactionId
Long
M
Request log id
printParcelList
PrintDataVO
O
ftpFileName
String
O
File name that Pdf file is located
pdfFile
Byte
O
Byte array of Pdf file
error
ErrorVO
O
Error information
Zpracování chyb
Strana 35 / 77
Verze 2015-04-27
6.1.7 Metoda pro zjištění stavu zásilky
Tato služba zjišťuje stav hlavního balíku.
Metoda getShipmentStatus má tyto elementy – vstupní parametry:
Název parametru
Typ pole
Povinné
Popis
wsUserName
String
M
web service user
wsPassword
String
M
wsLang
String
M
appliactionType
shipmentReference
String
ReferenceV
O
M
M
Sshipment id and reference number
Odpověď getShipmentStatusResponse má tyto elementy – výstupní parametry:
Název parametru
Typ pole
Povinné
Popis
transactionId
Long
M
Request log id
statusInfo
TrackVO
O
Shipment status information
error
ErrorVO
O
Error information
TrackVO obsahuje tato pole
Název parametru
Typ pole
Povinné
ReferenceV
O
M
Parcel reference and id
parcelReference
shipDate
String
M
Shipping date (YYYYMMDD)
shipTime
String
deliveryDate
String
M
O
Shipping time (HHMMSS)
Delivery date (YYYYMMDD)
deliveryTime
String
O
Delivery time (HHMMSS)
parcelNo
serviceCode
String
long
M
14 digit parcel number
M
DPD SYSTEM product id
serviceDescription
String
O
DPD SYSTEM product name
weight
double
dpdUrl
String
M
O
Package weight (kg)
DPD tracking web site url
scans
ScanVO
O
List of parcel’s events
Popis
Strana 36 / 77
Verze 2015-04-27
ScanVO obsahuje tato pole. Pokud sekce ScanVO chybí, znamená to, že pro daný balík není
v systému DPD žádný existující sken.
Název parametru
Typ pole
Povinné
Popis
String
M
Event date (YYYYMMDD)
time
String
scanCode
String
M
M
Event time (HHMMSS)
Event code (05, 03, 13…)
scanDescription
String
O
Event description
countryCode
city
String
String
O
Event country code
O
Event city
zipCode
String
O
Event zip code
date
Zpracování chyb
Strana 37 / 77
Verze 2015-04-27
6.1.8 Metoda pro zjištění stavu balíku
Metoda getParcelStatus má tyto vstupní element – vstupní parametry:
Název parametru
Typ pole
Povinné
Popis
wsUserName
wsPassword
String
String
M
M
web service user
wsLang
String
M
appliactionType
String
M
parcelReference
ReferenceV
O
M
Parcel id and reference number
Odpověď getParcelStatusResponse má tyto elementy – výstupní parametry:
Název parametru
Typ pole
Povinné
Popis
transactionId
long
M
Request log id
statusInfo
TrackVO
O
Shipment status information
error
ErrorVO
O
Error information
TrackVO obsahuje tato pole:
Název parametru
Typ pole
Povinné
Popis
shipDate
String
M
Shipping date (YYYYMMDD)
shipTime
String
deliveryDate
String
M
O
Shipping time (HHMMSS)
Delivery date (YYYYMMDD)
deliveryTime
String
O
Delivery time (HHMMSS)
String
long
M
Parcel number
M
String
O
DPD SYSTEM product name
weight
double
dpdUrl
String
M
O
Package weight (kg)
DPD tracking web site url
Scans
ScanVO
O
List of parcel’s events
parcelNo
serviceCode
serviceDescription
Strana 38 / 77
Verze 2015-04-27
ScanVO obsahuje tato pole. Pokud sekce ScanVO chybí, znamená to, že pro daný balík neexistuje
v systému DPD žádný sken.
Název parametru
Typ pole
Povinné
Popis
String
M
Event date (YYYYMMDD)
time
String
scanCode
String
M
M
Event time (HHMMSS)
Event code (05, 03, 13…)
scanDescription
String
O
Event description
countryCode
city
String
String
O
Event country code
O
Event city
zipCode
String
O
Event zip code
date
Zpracování chyb
Strana 39 / 77
Verze 2015-04-27
6.1.9 Metoda pro vyhledání zásilky
Metoda searchShipment má tyto elementy – vstupní parametry:
Název parametru
Povinné
Typ pole
Popis
wsUserName
wsPassword
String
String
M
M
web service user
wsLang
String
M
appliactionType
String
M
searchParams
ShipmentSearchV
O
M
Parcel id and reference number
ShipmentSearchVO obsahuje tato pole:
Název
parametru
Povinné
Typ pole
Popis
String
M
Start date (YYYYMMDD)
String
M
End date (YYYYMMDD)
receiverName
receiverCountryC
ode
String
O
O
Receiver name
Receiver country code alpha
receiverZipCode
String
payerId
String
O
O
Receiver zip code
Payer id
senderAddressId
String
O
Sender address id
startDate
endDate
String
Odpověď searchShipmentResponse má tyto elementy – výstupní parametry:
Název parametru
Povinné
Typ pole
Popis
transactionId
long
M
Request log id
shipmentInfoList
error
ShipmentInfoVO
ErrorVO
O
O
search result list
Error information
ShipmentInfoVO obsahuje tato pole
Název parametru
Povinné
Typ pole
Popis
M
M
Shipment reference number
long
long
M
Sender address id
M
Payer id
receiverName
receiverCountryCo
de
String
M
Receiver name
M
receiverZipCode
String
M
Receiver zip code
receiverCity
String
receiverStreet
String
M
M
Receiver city
Receiver street
mainServiceCode
long
M
Main product id
double
long
M
Shipment total weight
M
Shipment parcel count
shipmentId
shipmentreference
Number
long
senderAddressId
payerId
totalWeight
parcelCount
String
String
Zpracování chyb
Strana 40 / 77
Verze 2015-04-27
6.1.10 Metoda pro vyhledání DPD ParcelShop
Metoda parcelShopSearch má tyto elementy – vstupní parametry:
Název parametru
Typ pole
Povi
nné
Popis
wsUserName
wsPassword
String
String
M
M
web service user
wsLang
String
M
appliactionType
String
M
searchParams
ParcelShopSearchV
O
M
Manifest id and reference number
ParcelShopSearchVO obsahuje tato pole
Název parametru
Typ
pole
Povinné
Popis
String
O
Parcel shop street
String
O
Parcel shop house number
countryCode
String
zipCode
city
limit
consigneePickupAllowed
returnAllowed
expressAllowed
codAllowed
codPaymentType
String
String
int
String
String
String
String
String
M
O
Parcel shop country code alpha
Parcel shop zip code
street
houseNo
M
M (default: 10)
O
O
O
O
O
Parcel shop city name
The number of rows returned
returnAllowed
expressAllowed
codAllowed
codPaymentType
Odpověď parcelShopResponse má tyto elementy – výstupní parametry:
Název parametru
Typ pole
Povinné
Popis
transactionId
long
M
Request log id
parcelShopList
error
ParcelShopVO
ErrorVO
O
O
search result list
Error information
Strana 41 / 77
Verze 2015-04-27
ParcelShopVo obsahuje tato pole
Název parametru
Typ pole
Povin
né
Popis
parcelShopId
long
M
parcelShopId
companyName
street
string
string
O
O
companyName
street
houseNo
string
O
houseNo
state
string
state
countryCode
string
O
O
zipCode
string
O
zipCode
city
townName
string
string
O
O
city
townName
telNumber
string
O
telNumber
faxNo
string
faxNo
emailAddress
string
O
O
homepage
openingHours
string
ParcelShopOpeningHoursVO
O
O
homepage
openingHours
holiday
ParcelShopHolidayVO
O
holiday
extraInfo
consigneePickupAll
owed
string
O
O
extraInfo
returnAllowed
string
O
returnAllowed
expressAllowed
string
expressAllowed
expressPickupTime
string
O
O
distance
double
O
distance
longitude
latitude
double
double
O
O
longitude
latitude
coordinateX
double
O
coordinateX
coordinateY
double
coordinateY
coordinateZ
double
O
O
codAllowed
codPaymentType
string
string
O
O
codAllowed
codPaymentType
prepaidAllowed
string
O
prepaidAllowed
string
countryCode
emailAddress
expressPickupTime
coordinateZ
Strana 42 / 77
Verze 2015-04-27
ParcelShopOpeningHoursVO obsahuje tato pole
Název parametru
weekday
openMorning
closeMorning
closeAfternoon
openAfternoon
Typ pole
Povinné
Popis
string
O
weekday
string
string
O
openMorning
O
closeMorning
string
O
closeAfternoon
string
O
openAfternoon
ParcelShopHolidayVO obsahuje tato pole
Název parametru
startDate
startTime
endDate
endTime
Typ pole
Povinné
Popis
string
string
O
startDate
O
startTime
string
O
endDate
string
O
endTime
Strana 43 / 77
Verze 2015-04-27
6.2
Služby pro objednávku svozu
6.2.1 Metoda pro vytvoření objednávky svozu
Metoda createPickupOrder má tyto elementy – vstupní parametry:
Název
parametru
Typ pole
Povinné
Popis
wsUserName
wsPassword
String
String
M
M
web service user
wsLang
String
M
appliactionType
String
M
pickupOrderList
PickupOrderVO
M
List of pickup order object
PickupOrderVO obsahuje tato pole:
Název parametru
Typ pole
Povinné
Popis
pickupOrderId
long
O
DPD SYSTEM pickup order id. Leave empty for creation
payerId
senderAddressId
long
long
M
DPD SYSTEM payer customer id
O
DPD SYSTEM address id
AddressVO
O
Free text sender address.
date
String
fromTime
String
M
M
Pickup date (YYYYMMDD)
Pickup time start (HHMMSS)
toTime
String
M
Pickup time end (HHMMSS)
contactName
contactPhone
String
String
M
Sender contact name
M
Sender contact phone number
contactEmail
String
M
Sender contact email address
specialInstruction
String
referenceNumber
String
O
M
Message to driver
Integrator pickup order id
pieces
PickupPieceVO
M
List of Pickup pieces
senderAddress
AddressVO obsahuje tato pole:
Název parametru
Typ pole
Povinné
Popis
String
M
Country code alpha (LV, EE,…)
city
String
street
String
M
M
City name
Street name
zipCode
name
String
String
O
Zip code
M
Sender name
countryCode
PickupPieceVO obsahuje tato pole
Název parametru
Typ pole
Povinné
Popis
serviceCode
long
M
quantity
long
M
Piece count
weight
destinationCountry
Code
double
M
M
Weight
Destination country code
String
Strana 44 / 77
Verze 2015-04-27
Odpověď createPickupOrderResponse má tyto elementy – výstupní parametry:
Název parametru
Typ pole
Povinné
Popis
transactionId
long
M
Request log id
resultList
PickupOrderRes
ultVO
M
Pickup order result list
PickupOrderResultVO obsahuje tato pole
Název parametru
pickupOrderRefere
nce
error
Typ pole
ReferenceVO
ErrorVO
Povinné
Popis
M
Pickup order id and reference number
O
Error information
Zpracování chyb
Strana 45 / 77
Verze 2015-04-27
6.2.2 Metoda pro odstranění objednávky svozu
Metoda deletePickupOrder má tyto elementy – vstupní parametry:
Název
parametru
Typ pole
Povinné
Popis
wsUserName
wsPassword
String
String
M
M
web service user
wsLang
String
M
appliactionType
String
M
pickupOrderRef
erenceList
description
ReferenceVO
M
String
O
cancel Popis
Odpověď deletePickupOrderResponse má tyto elementy – výstupní parametry:
Název parametru
Typ pole
Povinné
Popis
transactionId
long
M
Request log id
resultList
PickupOrderDele
teResultVO
M
Pickup order delete result list
PickupOrderDeleteResultVO obsahuje tato pole
Název parametru
Typ pole
pickupOrderRefere
nce
ReferenceVO
error
ErrorVO
Povinné
Popis
M
O
Error information
Zpracování chyb
Strana 46 / 77
Verze 2015-04-27
6.2.3 Metoda pro zjištění stavu objednávky svozu
Metoda getPickupOrderStatus má tyto elementy – vstupní parametry:
Název
parametru
Typ pole
Povinné
Popis
wsUserName
wsPassword
String
String
M
M
web service user
wsLang
String
M
appliactionType
String
M
pickupOrderRef
erenceList
description
ReferenceVO
M
String
O
cancel description
Odpověď getPickupOrderStatusResponse má tyto elementy – výstupní parametry:
Název parametru
Typ pole
Povinné
Popis
transactionId
long
M
Request log id
resultList
PickupOrderDele
teResultVO
M
Pickup order delete result list
PickupOrderDeleteResultVO obsahuje tato pole
Název parametru
pickupOrderRefere
nce
error
Typ pole
ReferenceVO
ErrorVO
Povinné
Popis
M
O
Error information
Zpracování chyb
Strana 47 / 77
Verze 2015-04-27
6.2.4 Metoda pro vyhledání chybějících objednávek svozu
Metoda searchMissingPickupOrder má tyto elementy – vstupní parametry:
Název
parametru
Typ pole
Povinné
Popis
wsUserName
wsPassword
String
String
M
M
web service user
wsLang
String
M
appliactionType
String
M
Odpověď searchMissingPickupOrderResponse má tyto elementy - výstupní parametry:
Název parametru
Typ pole
Povinné
Popis
transactionId
long
M
Request log id
shipmentCount
long
M
Missing shipment count
lastPickupOrderDate
lastPickupOrderTime
String
String
O
O
Last pickup date
Last pickup time
error
ErrorVO
O
Error information
Zpracování chyb
Strana 48 / 77
Verze 2015-04-27
6.2.5 Metoda pro vyhledání objednávky svozu
Metoda searchPickupOrder má tyto elementy – vstupní parametry:
Název
parametru
Typ pole
Povinné
Popis
wsUserName
wsPassword
String
String
M
M
web service user
wsLang
String
M
appliactionType
String
M
searchParams
PickupOrderSea
rchVO
M
Pickup order search parameters
PickupOrderSearchVO obsahuje tato pole
Název parametru
Typ pole
startDate
String
endDate
String
payerId
senderAddressId
long
long
Povinné
Popis
M
M
Start date (YYYYMMDD)
End date (YYYYMMDD)
O
Pickup order payer id
O
Pickup order sender address id
Odpověď searchPickupOrderResponse má tyto elementy – výstupní parametry:
Název parametru
Typ pole
Povinné
Popis
transactionId
long
M
Request log id
pickupOrderList
PickupOrderVO
O
List of pickup order info
error
ErrorVO
O
Error information
Zpracování chyb
Strana 49 / 77
Verze 2015-04-27
6.3
Služby pro zpracování seznamu zásilek
6.3.1 Metoda pro uzavření seznamu zásilek
Metoda closeManifest má tyto elementy – vstupní parametry:
Název parametru
Typ pole
Povinné
Popis
wsUserName
wsPassword
String
String
M
M
web service user
wsLang
String
M
appliactionType
String
M
manifest
ManifestVO
M
Manifest object
manifestPrintOption
Enum
M
printOption
Enum
M
It can be PrintOnlyManifest,
PrintManifestWithUnprintedParcels or
PrintManifestWithAllParcels
It can be Data, Pdf or Ftp
ManifestVO obsahuje tato pole
Název parametru
Typ pole
manifestNotes
shipmentReferenceList
Povinn
é
Popis
String
O
Manifest reference number
String
ReferenceV
O
O
M
Manifest notes
List of shipment reference number
Odpověď closeManifestResponse má tyto elementy – výstupní parametry:
Název parametru
Typ pole
Povinn
é
Popis
transactionId
long
M
Request log id
manifestId
manifestReference
long
ReferenceVO
M
M
DPD SYSTEM manifest id
manifestName
String
M
Manifest name
manifetPrintDataList
O
List of ManifestPrintDataVO object
printParcelList
ManifestPrintD
ataVO
PrintDataVO
O
ftpManifestFileName
String
O
File name that manifest Pdf file is located
pdfManifestFile
byte
O
Byte array of manifest Pdf file
ftpLabelFileName
String
O
File name that label Pdf file is located
pdfLabelFile
error
byte
ErrorVO
O
O
Byte array of label Pdf file
Error information
Strana 50 / 77
Verze 2015-04-27
ManifestPrintDataVO obsahuje tato pole:
Název parametru
Typ pole
Povinné
Popis
long
M
DPD SYSTEM manifest id
String
String
M
Manifest creation date (YYYYMMDD)
M
Manifest close date (YYYYMMDD)
long
M
Total shipment in the manifest
totalParcelCount
long
totalWeight
double
M
M
Total parcel in the manifest
Total weight (kg)
totalVolume
double
M
Total volume (m3)
senderId
senderCustName
long
String
M
M
DPD SYSTEM sender customer id
senderAddress
String
M
Sender address
senderZipCode
senderCountryAlphaCod
e
String
M
Sender zip code
Sender country code
String
M
senderTaxNumber
String
M
senderTelNumber
String
M
Sender tax number
Sender phone number
senderCity
String
M
Sender city
companyDepotCode
companyName
String
String
M
M
Sender working depot code
companyTaxNumber
String
M
DPD tax number
companyAddress
String
M
companyTelNumber
String
M
DPD address
DPD phone number
companyFaxNumber
String
ShipmentPr
intDataVO
O
DPD fax number
manifestId
creationDate
closeDate
totalShipmentCount
shipmentList
Sender customer name
DPD company name
List of shipments in the manifest
M
ShipmentPrintDataVO obsahuje tato pole:
Název parametru
Typ pole
Povinné
Popis
shipmentId
long
M
receiverName
String
M
Receiver name
receiverAddress
String
receiverZipCode
String
M
M
Receiver address
Receiver zip code
receiverCity
receiverCountryCodeAlp
ha
String
M
Receiver city
M
receiverTaxNumber
string
O
Receiver tax number
String
O
Receiver contact name
String
String
O
O
String
O
Receiver access code
receiverVillage
String
receiverDistrict
String
O
O
Receiver village
Receiver district
receiverTown
codAmountOfValue
String
double
O
Receiver town
O
COD amount
codCurrency
String
O
COD currency
codReferenceNo
String
codPaymentType
String
O
O
COD reference number
COD payment type
receiverContactName
receiverPhoneNr1
receiverPhoneNr2
receiverAccessCode
String
Strana 51 / 77
Verze 2015-04-27
Název parametru
saturdayDelivery
completeDelivery
parcelList
Typ pole
Povinné
Popis
String
O
Saturday delivery information
String
ParcelPrint
DataVO
O
Complete delivery information
M
List of parcels in the manifest
ParcelPrintDataVO obsahuje tato pole
Název parametru
Typ pole
Povinné
Popis
M
M
14 digit parcel number from parcel range
Package weight (kg)
double
String
M
Package volume (m3)
O
Label barcode for parcel
String
O
Label barcode text for parcel
parcelNo
String
weight
double
volume
barcode
barcodeText
Zpracování chyb
Strana 52 / 77
Verze 2015-04-27
6.3.2 Metoda pro opakování tisku seznamu zásilek
Metoda reprintManifest může být volána pouze po metodě closeManifest. Účelem této metody je
umožnit opakovaný tisk již vytištěného seznamu zásilek.
Metoda reprintManifest má tyto elementy – vstupní parametry:
Název parametru
Typ pole
Povinné
Popis
wsUserName
String
M
web service user
wsPassword
String
M
wsLang
String
M
appliactionType
String
M
manifestReference
ReferenceVO
M
manifestPrintOption
Enum
M
printOption
Enum
M
Odpověď reprintManifestResponse má stejné elementy – výstupní parametry – jako odpověď
metody pro uzavření seznamu
Zpracování chyb
Strana 53 / 77
Verze 2015-04-27
6.4
Služby pro vyhledání DPD ParcelShop
6.4.1 Metoda pro vyhledání DPD ParcelShop
Metoda parcelShopSearch má tyto elementy – vstupní parametry:
Název parametru
Typ pole
Povinné
Popis
wsUserName
wsPassword
String
String
M
M
web service user
wsLang
String
M
appliactionType
String
M
manifestReference
ReferenceVO
M
manifestPrintOption
Enum
M
printOption
Enum
M
Strana 54 / 77
Verze 2015-04-27
7 Přílohy
7.1
Seznam kódů zemí
Země
Kód
ACORES
AC
AFGHANISTAN
AF
ÅLAND ISLANDS
AX
ALBANIA
AL
ALGERIA
DZ
AMERICAN SAMOA
AS
ANDORRA
AD
ANGOLA
AO
ANGUILLA
AI
ANTARTICA
AQ
ANTIGUA AND BARBUDA
AG
ARGENTINA
AR
ARMENIA
AM
ARUBA
AW
AUSTRALIA
AU
AUSTRIA
AT
AZERBAIJAN
AZ
BAHAMAS
BS
BAHRAIN
BH
BANGLADESH
BD
BARBADOS
BB
BELARUS
BY
BELGIUM
BE
BELIZE
BZ
BENIN
BJ
BERMUDA
BM
BHUTAN
BT
BOLIVIA
BO
BONAIRE
XB
BOSNIA HERZEGOVINA
BA
BOTSWANA
BW
BOUVET ISLANDS
BV
BRAZIL
BR
BRITISH INDIAN OCEAN TERRITORY
IO
BRUNEI
BN
Strana 55 / 77
Verze 2015-04-27
BULGARIA
BG
BURKINA FASO
BF
BURUNDI
BI
CAMBODIA
KH
CAMEROON
CM
CANADA
CA
CANARY ISLANDS
IC
CAPE VERDE
CV
CAYMAN ISLANDS
KY
CENTRAL AFRICAN REPUBLIC
CF
CHAD
TD
CHILE
CL
CHINA
CN
CHRISTMAS ISLANDS
CX
COCOS (KEELING) ISLANDS
CC
COLOMBIA
CO
COMOROS
KM
CONGO
CG
CONGO DEMOCRATIC
CD
COOK ISLANDS
CK
COSTA RICA
CR
CROATIA
HR
CUBA
CU
CURACAO
XC
CYPRUS
CY
CZECH REPUBLIC
CZ
DENMARK
DK
DJIBOUTI
DJ
DOMINICA
DM
DOMINICAN REPUBLIC
DO
EAST TIMOR
TP
EAST TIMOR
TL
EGYPT
EG
EL SALVADOR
SV
EQUADOR
EC
EQUADOR GUINEA
GQ
ERITREA
ER
ESTONIA
EE
ETHIOPIA
ET
FALKLAND ISLANDS
FK
Strana 56 / 77
Verze 2015-04-27
FAROE ISLANDS
FO
FIJI
FJ
FINLAND
FI
FRANCE
FR
FRANCE, METROPOLITAN
FX
FRENCH GUIANA
GF
FRENCH SOUTHERN TERRITORIES
TF
GABON
GA
GAMBIA
GM
GEORGIA
GE
GERMANY
DE
GHANA
GH
GIBRALTAR
GI
GREAT BRITAIN
GB
GREECE
GR
GREENLAND
GL
GRENADA
GD
GUADELOUPE
GP
GUAM
GU
GUATEMALA
GT
GUERNSEY
GG
GUINEA BISSAU
GW
GUINEA REPUBLIC
GN
GUS
GUS
GUYANA
GY
HAITI
HT
HEARD AND MCDONALD ISLANDS
HM
HONDURAS
HN
HONG KONG
HK
HUNGARY
HU
ICELAND
IS
INDIA
IN
INDONESIA
ID
IRAN
IR
IRAQ
IQ
IRELAND
IE
ISLE OF MAN
IM
ISRAEL
IL
ITALY
IT
JAMAICA
JM
Strana 57 / 77
Verze 2015-04-27
JAPAN
JP
JERSEY
JE
JORDAN
JO
KAZAKHISTAN
KZ
KENYA
KE
KIRIBATI
KI
KOREA, DEMOCRATIC REP. (NORTH)
KP
KOREA, REPUBLIC OF (SOUTH)
KR
KUWAIT
KW
KYRGYZSTAN
KG
LAOS
LA
LATVIA
LV
LEBMN
LB
LESHOTO
LS
LIBERIA
LR
LIBYA
LY
LIECHTENSTEIN
LI
LITHUANIA
LT
LUXEMBOURG
LU
MACAU
MO
MACEDONIA
MK
MADAGASCAR
MG
MADEIRA
ME
MALAWI
MW
MALAYSIA
MY
MALDIVES
MV
MALI
ML
MALTA
MT
MARSHALL ISLANDS
MH
MARTINIQUE
MQ
MAURITANIA
MR
MAURITIUS
MU
MAYOTTE
YO
MAYOTTE
YT
MEXICO
MX
MICRONESIA
FM
MOLDOVA
MD
MONACO
MC
MONGOLIA
MN
MONTENEGRO
MB
Strana 58 / 77
Verze 2015-04-27
MONTSERRAT
MS
MOROCCO
MA
MOZAMBIQUE
MZ
MYANMAR
MM
NAMIBIA
NA
NAURU
NR
NEPAL
NP
NETHERLANDS
NL
NETHERLANDS ANTILLES
AN
NETHERLANDS ANTILLES
MI
NEVIS
KN
NEVIS
XN
NEW CALEDONIA
NC
NEW ZEALAND
NZ
NICARAGUA
NI
NIGER
NE
NIGERIA
NG
NIUE
NU
NORFOLK ISLANDS
NF
NORWAY
NO
OMAN
OM
PAKISTAN
PK
PALAU
PW
PALESTINE
PS
PANAMA
PA
PAPUA NEW GUINEA
PG
PARAGUAY
PY
PERU
PE
PHILIPPINES
PH
PITCAIRN
PN
POLAND
PL
PORTUGAL
PT
PUERTO RICO
PR
QATAR
QA
REPUBLIC, SOUTH AFRICA
ZA
REUNION ISLANDS
RE
ROMANIA
RO
RUSSIA
RU
RWANDA
RW
S.GEORGIA AND S.SANDWICH ISL.
GS
Strana 59 / 77
Verze 2015-04-27
SAIPAN
PC
SAIPAN, NOTHERN MARIANA ISLAND
MP
SAN MARINO
SM
SAO TOME
ST
SAUDI ARABIA
SA
SCOTLAND
WW
SENEGAL
SN
SERBIA
YU
SERBIA & MONTENEGRO
CS
SEYCHELLES
SC
SIERRA LEONE
SL
SINGAPORE
SG
SLOVAKIA
SK
SLOVENIA
SI
SOLOMON ISLANDS
SB
SOMALIA
SO
SPAIN
ES
SRI LANKA
LK
ST BARTHELEMY
XY
ST EUSTATIUS
XE
ST MARTIN
XM
ST.HELENA
SH
ST.LUCIA
LC
ST.PIERRE AND MIQUELON
PM
ST.VINCENT AND THE GRENADINES
VC
SUDAN
SD
SURINAME
SR
SVALBARD AND JANMAYEN ISLANDS
SJ
SWAZILAND
SZ
SWEDEN
SE
SWITZERLAND
CH
SYRIA
SY
TAHITI, FRENCH POLYNESIA
PF
TAIWAN
TW
TAJIKISTAN
TJ
TANZANIA
TZ
THAILAND
TH
TOGO
TG
TOKELAU
TK
TONGA
TO
Strana 60 / 77
Verze 2015-04-27
TRINIDAD AND TOBAGO
TT
TUNISIA
TN
TURKEY
TR
TURKMENISTAN
TM
TURKS AND CAICOS ISLANDS
TC
TUVALU
TV
UGANDA
UG
UKRAINE
UA
UNITED ARAB EMIRATES
AE
UNITED STATES OF AMERICA
US
URUGUAY
UY
US MINOR OUTLYING ISL.
UM
UZBEKISTAN
UZ
VANUATU
VU
VATICAN CITY STATE (HOLY SEE)
VA
VENEZUELA
VE
VIETNAM
VN
VIRGIN ISL. (UK)
VG
VIRGIN ISL.(USA)
VI
WALLIS AND FUTUNA ISLANDS
WF
WESTERN SAHARA
EH
WESTERN SAMOA
WS
YEMEN
YE
ZAIRE
ZR
ZAMBIA
ZM
ZIMBABWE
ZW
7.2
Přehled DPD produktů a služeb
1
40042
40043
109
10
9
50101
DPD CLASSIC
DPD CLASSIC letecká přeprava
DPD 18:00 / GUARANTEE
DPD Private
DPD 10:00
DPD 12:00
DPD ParcelShop
.
Strana 61 / 77
Verze 2015-04-27
7.3
7.3.1
Výpis příkladů
Příklad 1
7.3.1.1 Požadavek na vytvoření zásilky
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ship="http://it4em.yurticikargo.com.tr/eshop/shipment">
<soapenv:Header/>
<soapenv:Body>
<ship:createShipment>
<wsUserName>YOUR USER NAME</wsUserName>
<wsPassword>your password</wsPassword>
<wsLang>EN</wsLang>
<applicationType>9</applicationType>
<shipmentList>
<shipmentId xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<shipmentReferenceNumber>WS167</shipmentReferenceNumber>
<payerId>2024559</payerId>
<senderAddressId>2005887</senderAddressId>
<receiverName>John Smith</receiverName>
<receiverFirmName>Company B</receiverFirmName>
<receiverCountryCode>EE</receiverCountryCode>
<receiverZipCode>10149</receiverZipCode>
<receiverCity>Tallin</receiverCity>
<receiverStreet>Toompuiestee</receiverStreet>
<receiverHouseNo>33a</receiverHouseNo>
<receiverPhoneNo xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<mainServiceCode>1</mainServiceCode>
<additionalServices
xsi:nil="true"
xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance"/>
<parcels>
<parcelReferenceNumber>WS3138</parcelReferenceNumber>
<weight>10.0</weight>
<description xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
</parcels>
</shipmentList>
<priceOption>WithoutPrice</priceOption>
</ship:createShipment>
</soapenv:Body>
</soapenv:Envelope>
Strana 62 / 77
Verze 2015-04-27
7.3.1.2 Odpověď vytvoření zásilky
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns1:createShipmentResponse
xmlns:ns1="http://it4em.yurticikargo.com.tr/eshop/shipment"
xmlns:ns3="http://it4em.yurticikargo.com.tr/eshop/">
<result>
<transactionId>1808</transactionId>
<resultList>
<shipmentReference>
<id>29259376</id>
<referenceNumber>WS167</referenceNumber>
</shipmentReference>
<parcelResultList>
<parcelId>20274</parcelId>
<printRequired>true</printRequired>
</parcelResultList>
<price xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<error xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<shipmentDate>20130228</shipmentDate>
<shipmentTime>145715</shipmentTime>
<message>Your shipment is created successfully. However, You don't have an available
pickup order for this shipment in today.</message>
</resultList>
</result>
</ns1:createShipmentResponse>
</env:Body>
</env:Envelope>
Strana 63 / 77
Verze 2015-04-27
7.3.1.3 Požadavek na uzavření seznamu zásilek
<soapenv:Envelope
xmlns:man="http://it4em.yurticikargo.com.tr/eshop/manifest">
<soapenv:Header/>
<soapenv:Body>
<man:closeManifest>
<wsUserName>YOUR USER NAME</wsUserName>
<wsLang>EN</wsLang>
<manifest>
<manifestReferenceNumber>MR167</manifestReferenceNumber>
<manifestNotes>your comments here:</manifestNotes>
<shipmentReferenceList>
<id xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
</shipmentReferenceList>
</manifest>
<manifestPrintOption>PrintManifestWithUnprintedParcels</manifestPrintOption>
<printOption>Ftp</printOption>
</man:closeManifest>
</soapenv:Body>
</soapenv:Envelope>
7.3.1.4 Odpověď uzavření seznamu zásilek
<env:Header/>
<env:Body>
<ns1:closeManifestResponse
xmlns:ns1="http://it4em.yurticikargo.com.tr/eshop/manifest"
<return>
<manifestId>20043</manifestId>
<manifestReferenceNumber>MR167</manifestReferenceNumber>
<manifestName>2024559_20130228_10</manifestName>
<manifestPrintData
xsi:nil="true"
<ftpManifestFileName>/eeapptest/files/app/web/manifest/eshop_manifest_print_20130228_152506_
94.pdf</ftpManifestFileName>
<pdfManifestFile xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ftpLabelFileName>/eeapptest/files/app/ssa/parcel_label/eshop_parcel_label_20130228_152506_6
3.pdf</ftpLabelFileName>
<pdfLabelFile xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
</return>
</ns1:closeManifestResponse>
</env:Body>
</env:Envelope>
Strana 64 / 77
Verze 2015-04-27
7.3.2
Příklad 2
<soapenv:Envelope
<soapenv:Header/>
<soapenv:Body>
<wsUserName>YOUR USERNAME</wsUserName>
<wsLang>EN</wsLang>
<shipmentList>
<shipmentReferenceNumber>WS183</shipmentReferenceNumber>
<receiverName>Mr Kaido</receiverName>
<receiverFirmName>Company C</receiverFirmName>
<receiverCity>Pärnu</receiverCity>
<receiverStreet>Riia mnt</receiverStreet>
<additionalServices>
<cod>
<amount>120</amount>
<currency>EUR</currency>
<paymentType>Cash</paymentType>
</cod>
<saturdayDelivery>false</saturdayDelivery>
<highInsurance xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
</additionalServices>
<parcels>
</parcels>
</shipmentList>
<priceOption>WithPrice</priceOption>
</soapenv:Body>
</soapenv:Envelope>
Strana 65 / 77
Verze 2015-04-27
<env:Header/>
<env:Body>
<result>
<resultList>
<shipmentReference>
<id>29259489</id>
<parcelResultList>
</parcelResultList>
<price>
<amount>7.38</amount>
<vatAmount>1.47</vatAmount>
<totalAmount>8.85</totalAmount>
<amountLocal>7.38</amountLocal>
<vatAmountLocal>1.47</vatAmountLocal>
<totalAmountLocal>8.85</totalAmountLocal>
<currencyLocal>EUR</currencyLocal>
</price>
</resultList>
</result>
</env:Body>
</env:Envelope>
Strana 66 / 77
Verze 2015-04-27
7.3.2.3 Požadavek na vytvoření přepravních štíktů k zásilce
<soapenv:Envelope
<soapenv:Header/>
<soapenv:Body>
<ship:getShipmentLabel>
<wsLang>EN</wsLang>
<referenceNumber WS183</referenceNumber>
<printOption>Pdf</printOption>
</ship:getShipmentLabel>
</soapenv:Body>
</soapenv:Envelope>
7.3.2.4 Odpověď vytvoření přepravních štítků k zásilce
<env:Header/>
<env:Body>
<ns1:getShipmentLabelResponse xmlns:ns1="http://it4em.yurticikargo.com.tr/eshop/shipment"
<result>
<ftpFileName xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<pdfFile>[pdf content ] </pdfFile>
</result>
</ns1:getShipmentLabelResponse>
</env:Body>
</env:Envelope>
Strana 67 / 77
Verze 2015-04-27
<soapenv:Envelope
<soapenv:Header/>
<soapenv:Body>
<man:closeManifest>
<wsLang>EN</wsLang>
<manifest>
<manifestReferenceNumber>WS183</manifestReferenceNumber>
</manifest>
<manifestPrintOption>PrintManifestWithUnprintedParcels</manifestPrintOption>
<printOption>Ftp</printOption>
</soapenv:Body>
</soapenv:Envelope>
<env:Header/>
<env:Body>
<return>
<manifestReferenceNumber>WS183</manifestReferenceNumber>
<manifestPrintData
xsi:nil="true"
<ftpManifestFileName>/eeapptest/files/app/web/manifest/eshop_manifest_print_20130308_163804_
68.pdf</ftpManifestFileName>
<pdfManifestFile xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ftpLabelFileName xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
</return>
</env:Body>
</env:Envelope>
Strana 68 / 77
Verze 2015-04-27
7.3.3
Příklad 3
7.3.3.1 Požadavek na zjištění ceny
<soapenv:Envelope
<soapenv:Header/>
<soapenv:Body>
<ship:calculatePrice>
<wsPassword>YOUR PASSWORD</wsPassword>
<wsLang>EN</wsLang>
<shipmentList>
<receiverPhoneNo/>
<saturdayDelivery>true</saturdayDelivery>
<parcels>
<weight>10</weight>
</parcels>
</shipmentList>
</ship:calculatePrice>
</soapenv:Body>
</soapenv:Envelope>
Strana 69 / 77
Verze 2015-04-27
7.3.3.2 Odpověď zjištění ceny
<env:Header/>
<env:Body>
<ns1:calculatePriceResponse
<result>
<priceList>
<price>
<amount>6.17</amount>
<vatAmount>1.23</vatAmount>
<totalAmount>7.4</totalAmount>
<amountLocal>6.17</amountLocal>
<vatAmountLocal>1.23</vatAmountLocal>
<totalAmountLocal>7.4</totalAmountLocal>
<currencyLocal>EUR</currencyLocal>
</price>
</priceList>
</result>
</ns1:calculatePriceResponse>
</env:Body>
</env:Envelope>
Strana 70 / 77
Verze 2015-04-27
<soapenv:Envelope
<soapenv:Header/>
<soapenv:Body>
<wsLang>EN</wsLang>
<shipmentList>
<shipmentReferenceNumber>112463</shipmentReferenceNumber>
<saturdayDelivery>true</saturdayDelivery>
<parcels>
<parcelReferenceNumber>LT3246</parcelReferenceNumber>
</parcels>
</shipmentList>
<priceOption>WithoutPrice</priceOption>
</soapenv:Body>
</soapenv:Envelope>
Strana 71 / 77
Verze 2015-04-27
<env:Header/>
<env:Body>
<result>
<resultList>
<shipmentReference>
<id>29259664</id>
<referenceNumber>112463</referenceNumber>
<parcelResultList>
<parcelReferenceNumber>LT3246</parcelReferenceNumber>
</parcelResultList>
<price xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
</resultList>
</result>
</env:Body>
</env:Envelope>
Strana 72 / 77
Verze 2015-04-27
7.3.3.5 Požadavek na vytvoření přepravních štítků zásilky
<soapenv:Envelope
<soapenv:Header/>
<soapenv:Body>
<ship:getShipmentLabel>
<wsLang>EN</wsLang>
</ship:getShipmentLabel>
</soapenv:Body>
</soapenv:Envelope>
7.3.3.6 Odpověď vytvoření přepravních štítků zásilky
<env:Header/>
<env:Body>
<ns1:getShipmentLabelResponse xmlns:ns1="http://it4em.yurticikargo.com.tr/eshop/shipment"
<result>
<ftpFileName xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<pdfFile>(pdf content removed)</pdfFile>
</result>
</ns1:getShipmentLabelResponse>
</env:Body>
</env:Envelope>
Strana 73 / 77
Verze 2015-04-27
<soapenv:Envelope
<soapenv:Header/>
<soapenv:Body>
<man:closeManifest>
<wsLang>EN</wsLang>
<manifest>
<manifestReferenceNumber> MR188</manifestReferenceNumber>
</manifest>
<manifestPrintOption> PrintOnlyManifest </manifestPrintOption>
</soapenv:Body>
</soapenv:Envelope>
<env:Header/>
<env:Body>
<return>
<manifestReferenceNumber> MR188</manifestReferenceNumber>
<manifestPrintData
xsi:nil="true"
<ftpManifestFileName
xsi:nil="true"
<pdfManifestFile> (pdf content remove)</ pdfManifestFile>
<ftpLabelFileName xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
</return>
</env:Body>
</env:Envelope>
Strana 74 / 77
Verze 2015-04-27
7.3.4
7.3.4.1
Příklad 4
Požadavek na vyhledání DPD ParcelShop
<soapenv:Envelope
xmlns:ship='http://it4em.yurticikargo.com.tr/eshop/shipment'
xmlns:soapenv='http://schemas.xmlsoap.org/soap/envelope/'>
<soapenv:Header/>
<soapenv:Body>
<ship:parcelShopSearch xmlns:ship='http://it4em.yurticikargo.com.tr/eshop/shipment'>

<wsUserName> YOUR USERNAME </wsUserName>

<wsPassword> YOUR PASSWORD </wsPassword>

<wsLang>EN</wsLang>


<searchParams>
<countryCode>SK</countryCode>
<city>Bratislava</city>
<limit>10</limit>
<codAllowed>1</codAllowed>
</searchParams>
</ship:parcelShopSearch>
</soapenv:Body>
</soapenv:Envelope>
Strana 75 / 77
Verze 2015-04-27
7.3.4.2
Odpověď vyhledání DPD ParcelShop
<env:Envelope xmlns:env='http://schemas.xmlsoap.org/soap/envelope/'>
<env:Header/>
<env:Body>
<ns1:parcelShopSearchResponse
xmlns:ns1='http://it4em.yurticikargo.com.tr/eshop/shipment'
xmlns:ns2='http://it4em.yurticikargo.com.tr/eshop/shipment' xmlns:ns3='http://it4em.y
urticikargo.com.tr/eshop/'>
<result>
<parcelShopList>
<parcelShopId>400893</parcelShopId>
<companyName>DPD ParcelShop PRESKOLY.sk</companyName>
<street>Mánesovo námestie</street>
<houseNo>6</houseNo>
<state/>
<countryCode>SK</countryCode>
<zipCode>85101</zipCode>
<city>Bratislava</city>
<townName>Petržalka</townName>
<telNumber>+421-(02)44633762</telNumber>
<faxNo>-</faxNo>
<emailAddress>[email protected]</emailAddress>
<homepage xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:nil='true'/>
<openingHours>
<weekday>Monday</weekday>
<openMorning>08:30</openMorning>
<closeMorning>17:00</closeMorning>
<closeAfternoon/>
<openAfternoon/>
</openingHours>
<openingHours>
<weekday>Tuesday</weekday>
<closeAfternoon/>
<openAfternoon/>
</openingHours>
<openingHours>
<weekday>Wednesday</weekday>
<closeAfternoon/>
<openAfternoon/>
</openingHours>
<extraInfo/>
<consigneePickupAllowed>1</consigneePickupAllowed>
<returnAllowed>0</returnAllowed>
<expressAllowed>0</expressAllowed>
<expressPickupTime/>
<distance>1.9995365376363134</distance>
<longitude>17.11109</longitude>
<latitude>48.12866</latitude>
<coordinateX xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:nil='true'/>
Strana 76 / 77
Verze 2015-04-27
<coordinateY xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:nil='true'/>
<coordinateZ xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:nil='true'/>
<codAllowed>1</codAllowed>
<codPaymentType>0</codPaymentType>
<prepaidAllowed>0</prepaidAllowed>
</parcelShopList>
….
<error xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:nil='true'/>
</result>
</ns1:parcelShopSearchResponse>
</env:Body>
</env:Envelope>
Strana 77 / 77

- Příručka programátora Webové služby

Transkript

Podobné dokumenty

G-Service

Jak na Google Tag Manager

Značkovací jazyky na platformě GeoWeb - Institut geoinformatiky

PREPRESS: Vytvoření digitálních dat

provoz jeslí ve vybraných městech ČR Zaostřeno

webová služba pro posílání dávek dat do DB NOR a

Standard elektronické fakturace

Technický manuál - Státní pokladna

Marek Mariusz Tytko Úvod k časopisu "Náboženská a duchovní