Příručka programátora pro integraci zákaznických řešení a DPD systémů pomocí webových služeb Moje DPD. Verze

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ákaznických řešení a DPD s ystémů pomocí webových služeb MojeDPD Verze 2015-04-27

Obsah 1

Úvod ..................................................................................................................................................4

1.1

Jak používat tuto příručku ..........................................................................................................4

1.2

Procesy a pravidla .......................................................................................................................4

1.3

Zákaznické aplikace ....................................................................................................................4

2

Seznam metod webových služeb ......................................................................................................5

2.1

Hlavní metody ..............................................................................................................................5

2.2

Doplňkové metody.......................................................................................................................5

3

Požadované kroky pro integraci webových služeb ...........................................................................6

3.1

Předpoklady pro použití webových služeb ...............................................................................6

3.2

Autorizace webových služeb......................................................................................................6

3.3

Webové služby - reference .........................................................................................................6

3.4

Webové služby – vícenásobné volání .......................................................................................6

4

Scénáře použití .................................................................................................................................7

4.1

Příklad 1 – vytvoření zásilky, tisk štítků a seznamu zásilek....................................................8

4.1.1 4.1.2 4.2

Vytvoření zásilky.....................................................................................................................8 Vytvoření přepravních štítků a seznamu zásilek ..................................................................11

Příklad 2 – vytvoření zásilek, vytištění přepravních dokumentů ..........................................13

4.2.1 4.2.2 4.2.3

Vytvoření zásilky...................................................................................................................13 Vytváření přepravních štítků.................................................................................................16 Uzavření seznamu ...............................................................................................................16

4.3 Příklad 3 – zjištění ceny, vytvoření zásilky, vytištění potřebných přepravních dokumentů ............................................................................................................................................19 4.3.1 4.3.2 4.3.3 4.3.4 5

Výpočet ceny ........................................................................................................................19 Vytvoření zásilky...................................................................................................................22 Vytvoření přepravních štítků.................................................................................................23 Uzavření seznamu zásilek ...................................................................................................23

Seznam dostupných webových služeb ...........................................................................................25

5.1

Služby pro zásilky......................................................................................................................25

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 .....................................................................25 Metoda pro odstranění zásilky .............................................................................................29 Metoda pro zjištění stavu zásilky..........................................................................................30 Metoda pro výpočet ceny .....................................................................................................31 Metoda pro vytvoření přepravního štítku zásilky ..................................................................32 Metoda pro přetisk přepravního štítku balíku .......................................................................34 Metoda pro zjištění stavu zásilky..........................................................................................35 Metoda pro zjištění stavu balíku ...........................................................................................37 Metoda pro vyhledání zásilky ...............................................................................................39 Metoda pro vyhledání DPD ParcelShop ..............................................................................40

Služby pro objednávku svozu ..................................................................................................43

Příručka programátora - verze 2015-04-27

Strana 2 / 76


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 .................................................................................49

5.3.1 5.3.2 5.4

Metoda pro uzavření seznamu zásilek .................................................................................49 Metoda pro opakování tisku seznamu zásilek .....................................................................52

Služby pro vyhledání DPD ParcelShop ...................................................................................53

5.4.1 6

Metoda pro vytvoření objednávky svozu ..............................................................................43 Metoda pro odstranění objednávky svozu ...........................................................................45 Metoda pro zjištění stavu objednávky svozu ........................................................................46 Metoda pro vyhledání chybějících objednávek svozu ..........................................................47 Metoda pro vyhledání objednávky svozu .............................................................................48

Metoda pro vyhledání DPD ParcelShop ..............................................................................53

Přílohy .............................................................................................................................................54

6.1

Seznam kódů zemí.....................................................................................................................54

6.2

Přehled DPD produktů a služeb ...............................................................................................60

6.3

Výpis příkladů ............................................................................................................................61

6.3.1 Příklad 1 ...............................................................................................................................61 6.3.1.1 Požadavek na vytvoření zásilky .......................................................................................61 6.3.1.2 Odpověď vytvoření zásilky................................................................................................62 6.3.1.3 Požadavek na uzavření seznamu zásilek ........................................................................63 6.3.1.4 Odpověď uzavření seznamu zásilek ................................................................................63 6.3.2 Příklad 2 ...............................................................................................................................64 6.3.2.1 Požadavek na vytvoření zásilky .......................................................................................64 6.3.2.2 Odpověď vytvoření zásilky................................................................................................65 6.3.2.3 Požadavek na vytvoření přepravních štíktů k zásilce .......................................................66 6.3.2.4 Odpověď vytvoření přepravních štítků k zásilce ...............................................................66 6.3.2.5 Požadavek na uzavření seznamu zásilek ........................................................................67 6.3.2.6 Odpověď uzavření seznamu zásilek ................................................................................67 6.3.3 Příklad 3 ...............................................................................................................................68 6.3.3.1 Požadavek na zjištění ceny ..............................................................................................68 6.3.3.2 Odpověď zjištění ceny ......................................................................................................69 6.3.3.3 Požadavek na vytvoření zásilky .......................................................................................70 6.3.3.4 Odpověď vytvoření zásilky................................................................................................71 6.3.3.5 Požadavek na vytvoření přepravních štítků zásilky ..........................................................72 6.3.3.6 Odpověď vytvoření přepravních štítků zásilky ..................................................................72 6.3.3.7 Požadavek na uzavření seznamu zásilek ........................................................................73 6.3.3.8 Odpověď uzavření seznamu zásilek ................................................................................73 6.3.4 Příklad 4 ...............................................................................................................................74 6.3.4.1 Požadavek na vyhledání DPD ParcelShop ......................................................................74 6.3.4.2 Odpověď vyhledání DPD ParcelShop ..............................................................................75


Strana 3 / 76


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 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.

1.3 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 / 76


2 Seznam metod webových služeb 2.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

2.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 5 / 76


3 Požadované kroky pro integraci webových služeb 3.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]

3.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

String

M

web service password

wsLang

String

M

web service request language (eg EN, LT, etc)

appliactionType

String

M

integrating application type

3.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.

3.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 6 / 76


4 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 7 / 76


4.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ě.

Obrázek 1 Dva kroky k odeslání zásilky

4.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 8 / 76


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 9 / 76


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

Id

29259376

referenceNumber

WS167

popis 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 10 / 76


4.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 11 / 76


-

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 balíkový štítek printOption Ftp 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 12 / 76

štítku


4.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.

Obrázek 2 Vykonání tří kroků

4.2.1 Vytvoření zásilky 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 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 13 / 76


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. Klíčové elementy požadavku jsou zobrazeny níže, úplný požadavek naleznete v příloze.


Strana 14 / 76


Tabulka 8 Klíčová data zásilky – příklad 2

element

hodnota

popis


WS183

Vaše reference

payerId

2024559

senderAddressId

2005887


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

Společnost A použije: • Čí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 15 / 76


Klíčové elementy požadavku jsou zobrazeny níže, úplný požadavek naleznete v příloze. element

hodnota

id

29259376

referenceNumber

WS183

parcelId

20959


WS3154

printRequired

true

popis Unikátní reference 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. 4.2.2 Vytváření přepravních štítků Klíčové elementy požadavku jsou zobrazeny níže, úplný požadavek naleznete v příloze. 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ů

4.2.3

element

hodnota

pdfFile

Pdf content

popis Obsah PDF souboru

Uzavření seznamu

Klíčové elementy požadavku jsou zobrazeny níže, úplný požadavek naleznete v příloze. 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 16 / 76


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 17 / 76


Tabulka 13 Data odpovědi tisku seznamu – příklad 2

element

hodnota

popis

manifestId

20043



MR183

Vaše reference seznamu

ftpManifestFileName



ftpLabelFileName



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 18 / 76

štítku


4.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.

Figure 3 Four steps approach

4.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 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 19 / 76


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 20 / 76


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

Služby (“1” znamená DPD CLASSIC, Saturday delivery = true je povolení doplňkové služby sobotní doručení) Uzel balíku

Společnost A použije: • 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 21 / 76


4.3.2 Vytvoření zásilky Klíčové elementy požadavku jsou zobrazeny níže, úplný výpis požadavku naleznete v příloze. 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


112463

Vaše reference

payerId

2024559

senderAddressId

2005887


receiverName

Mr Kaido

receiverFirmName

Company C

receiverCountryCode

EE

receiverZipCode

80042

receiverCity

Pärnu

receiverStreet

Riia mnt

receiverHouseNo

231a

Adresa příjemce

Služby (“1” znamená DPD 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 Unikátní reference DPD unikátní reference pro balíku Vaše unikátní reference pro balíku 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 22 / 76


4.3.3 Vytvoření přepravních štítků Klíčové elementy požadavku jsou zobrazeny níže, úplný výpis požadavku naleznete v příloze. 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

4.3.4 Uzavření seznamu zásilek Klíčové elementy požadavku jsou zobrazeny níže, úplný výpis požadavku naleznete v příloze. 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 23 / 76


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



ftpLabelFileName



f 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 24 / 76

štítku


5 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

5.1 Služby pro zásilky 5.1.1 Metoda pro vytvoření nebo aktualizaci zásilky Metody createShipment a updateShipment mají tyto elementy – vstupní parametry: Název parametru wsUserName

Typ pole

String

Povinné

M

Popis

web service user

wsPassword

String

M


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

O

DPD SYSTEM shipment id leave empty for create operation Integrators shipment id

Long

M

DPD SYSTEM customer id for payer

Long

M

DPD SYSTEM address id for sender (shiping address)

String String

M

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

payerId receiverName receiverFirmName receiverCountryCo de receiverZipCode receiverCity receiverStreet receiverHouseNo receiverPhoneNo mainServiceCode additionalServices parcels

Popis

M

shipmentId shipmentReference Number senderAddressId

Povin né

Long

String String String String String String Long AdditionalServiceVO ParcelVO


Strana 25 / 76


ParcelVO obsahuje tato pole Název parametru

Typ pole

Povinné

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 String

dimensionsHeight dimensionsWidth dimensionsLength weight description

Popis

AdditionalServiceVO obsahuje tato pole Název parametru

Typ pole

Povinné

Popis

cod

CodVO

O

COD information

saturdayDelivery

Boolean

O

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

currency

String

M

COD amount 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

currency

String

M

goods value amount 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 26 / 76


ExpayVO obsahuje tato pole Název parametru

Typ pole

Povinné

Popis

transactionId

String

M

authenticationId

String

O

Eshop reference for the transaction 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

M

Parcel shop company name

String

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

Povinn é

Popis

shipmentReference

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


String

M

Customer reference number

parcelId

Long

M

DPD SYSTEM id

printRequired

boolean

M

Label print required after create or update


Strana 27 / 76


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

M

Price amount

Double

M

Price vat amount

Double

M

Price amount with vat amount

String

M

Price currency

Double

M

Price amount (local currency)

vatAmountLocal

Double

M

Price vat amount (local currency)

totalAmountLocal

Double

M

Price amount with vat amount (local currency)

currencyLocal

String

M

Local price currency

amount vatAmount totalAmount currency amountLocal

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 28 / 76


5.1.2 Metoda pro odstranění zásilky Metoda deleteShipment má tyto elementy – vstupní parametry: Název parametru

wsUserName

Typ pole

Povinné

String

M

Popis

web service user

wsPassword

String

M


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

Typ pole

Povinné

Popis

transactionId

Long

M

Request log id

resultList

ShipmentDelete ResultVO

M

List of result objects

ShipmentDeleteResultVO obsahuje tato pole: Název parametru

Typ pole

shipmentReference

ReferenceV O ErrorVO

error

Povinné

Popis

M

Object that contains both DPD SYSTEM shipment id and shipment reference number Error information

O



Strana 29 / 76


5.1.3 Metoda pro zjištění stavu zásilky Metoda getShipment má tyto elementy – vstupní parametry: Název parametru

wsUserName

Typ pole

String

Povinné

M

Popis

web service user

wsPassword

String

M


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

ShipmentVO

O

whole shipment object with parcels and products

error

ErrorVO

O

Error information



Strana 30 / 76


5.1.4 Metoda pro výpočet ceny Metoda calculatePrice má tyto elementy – vstupní parametry: Název parametru wsUserName

Typ pole

String

Povinné

Popis

M

web service user

wsPassword

String

M


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

PriceVO

O

Price calculation result

error

ErrorVO

O

Error information



Strana 31 / 76


5.1.5 Metoda pro vytvoření přepravního štítku zásilky Metoda getShipmentLabel má tyto elementy – vstupní požadavky: Název parametru

wsUserName

Typ pole

String

Povinné

M

Popis

web service user

wsPassword

String

M


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

printParcelList

PrintDataVO

O

Request log id List of PrintDataVO object

ftpFileName

String

O

File name that Pdf file is located

pdfFile

Byte

O

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

Long

M

DPD SYSTEM parcel id

String

M

Sender customer name

senderAddress

String

M

Sender address

senderZipCode senderCountryAlphaCod e

String

M

Sender zip code

M

Sender country code

String

senderTaxNumber

String

M

Sender tax number

senderTelNumber

String

M

Sender phone number

senderCity

String

M

Sender city

senderContact

String

M

Sender contact name

companyName

String

M

DPD company name

String

M

DPD tax number

String

M

DPD address

String

M

DPD phone number

String

O

DPD fax number

barcode

String

M

Label barcode

barcodeText shipmentReferenceNum ber

String

M

Label barcode text

O

Integrators shipment id

String

parcelIndex

Long

M

Index of parcel in shipment

Long

M

Count of parcel in shipment

String

M

Receiver name

shipmentId parcelId senderCustName

companyTaxNumber companyAddress companyTelNumber companyFaxNumber

parcelCount receiverName


Strana 32 / 76


Název parametru

Typ pole

Povinné

Popis

String

M

Receiver address

String

M

Receiver address (receiver country code – receiver zip code)

receiverZipCode

String

M

Receiver zip code

receiverCity receiverCountryCodeAlp ha

String

M

Receiver city

M

Receiver country code

String

receiverTaxNumber

String

O

Receiver tax number

String

O

Extra information on Label

departureUnitId

String

M

Departure depot code of shipment

deliveryUnitId

String

M

Delivery depot code of shipment

serviceCode

String

M

3 digit DPD service code for products

serviceCombination

String

M

Service combination information

String

M

Route information

String

M

Route information

String

O

Receiver contact name

String

O

Receiver phone number

String

O


String

O

receiver access code

double

O

COD amount

String

O

COD currency

codReferenceNo

String

O

COD reference number

codPaymentType

String

O

COD payment type

parcelNo

String

M

14 digit parcel number

weight

double

M

Package weight (kg)

volume

double

M

Package volume (m3)

parcelRefNumber

String

O

Integrators parcel id

String

O

1 if additional Label need to be printed; otherwise 0

O

Additional label information

receiverAddress1 receiverAddress2

extraInformationOnLabel

routeDsort routeOsort receiverContactName receiverPhoneNr1 receiverPhoneNr2 receiverAccessCode codAmountOfValue codCurrency

additionalLabelFlag additionalInformationDat a

String

serviceFieldInfo

String

O

Service field information

String

O

Service mark

String

O

Damage information

String

M

Parcel no check sum

serviceMark damageInformation parcelNoCsd



Strana 33 / 76


5.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

printParcelList

PrintDataVO

O

Request log id List of PrintDataVO object

ftpFileName

String

O

File name that Pdf file is located

pdfFile

Byte

O

Byte array of Pdf file

error

ErrorVO

O

Error information



Strana 34 / 76


5.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

String

M


shipmentReference

ReferenceV O

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é

Popis

ReferenceV O

M

Parcel reference and id

parcelReference shipDate

String

M

Shipping date (YYYYMMDD)

String

M

Shipping time (HHMMSS)

deliveryDate

String

O

Delivery date (YYYYMMDD)

deliveryTime

String

O

Delivery time (HHMMSS)

parcelNo

String

M

14 digit parcel number

serviceCode

long

M

DPD SYSTEM product id

serviceDescription

String

O

DPD SYSTEM product name

weight

double

M

Package weight (kg)

dpdUrl

String

O

DPD tracking web site url

scans

ScanVO

O

List of parcel’s events

shipTime


Strana 35 / 76


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)

String

M

Event time (HHMMSS)

String

M

Event code (05, 03, 13;)

scanDescription

String

O

Event description

countryCode

String

O

Event country code

city

String

O

Event city

zipCode

String

O

Event zip code

date time scanCode



Strana 36 / 76


5.1.8 Metoda pro zjištění stavu balíku Metoda getParcelStatus má tyto vstupní element – vstupní parametry: Název parametru

wsUserName

Typ pole

String

Povinné

M

Popis

web service user

wsPassword

String

M


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

shipTime

String

M

Shipping time (HHMMSS)

deliveryDate

String

O

Delivery date (YYYYMMDD)

deliveryTime

String

O

Delivery time (HHMMSS)

String

M

Parcel number

long

M


serviceDescription

String

O

DPD SYSTEM product name

weight

double

M

Package weight (kg)

dpdUrl

String

O

DPD tracking web site url

Scans

ScanVO

O

List of parcel’s events

parcelNo serviceCode


Shipping date (YYYYMMDD)

Strana 37 / 76


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)

String

M

Event time (HHMMSS)

String

M

Event code (05, 03, 13;)

scanDescription

String

O

Event description

countryCode

String

O

Event country code

city

String

O

Event city

zipCode

String

O

Event zip code

date time scanCode



Strana 38 / 76


5.1.9 Metoda pro vyhledání zásilky Metoda searchShipment má tyto elementy – vstupní parametry: Název parametru

wsUserName

Typ pole

Povinné

String

M

Popis

web service user

wsPassword

String

M


wsLang

String

M


appliactionType

String

M


searchParams

ShipmentSearchV O

M

Parcel id and reference number

ShipmentSearchVO obsahuje tato pole: Název parametru

startDate endDate

Typ pole

Povinné

Popis

String

M

String

M

Start date (YYYYMMDD) End date (YYYYMMDD)

String

O

Receiver name

O

Receiver country code alpha

receiverName receiverCountryC ode

String

receiverZipCode

String

O

Receiver zip code

String

O

Payer id

String

O

Sender address id

payerId senderAddressId

Odpověď searchShipmentResponse má tyto elementy – výstupní parametry: Název parametru

transactionId

Typ pole

Povinné

long

M

Popis

Request log id

shipmentInfoList

ShipmentInfoVO

O

search result list

error

ErrorVO

O

Error information

ShipmentInfoVO obsahuje tato pole Název parametru

Typ pole

Popis

M


M

Shipment reference number

long

M

Sender address id

long

M

Payer id

String

M

Receiver name

M


shipmentId shipmentreference Number

String

senderAddressId payerId

Povinné

long

receiverName receiverCountryCo de

String

receiverZipCode

String

M

Receiver zip code

String

M

Receiver city

String

M

Receiver street

long

M

Main product id

double

M

Shipment total weight

long

M

Shipment parcel count

receiverCity receiverStreet mainServiceCode totalWeight parcelCount



Strana 39 / 76


5.1.10 Metoda pro vyhledání DPD ParcelShop Metoda parcelShopSearch má tyto elementy – vstupní parametry: Název parametru

wsUserName

Typ pole

Povi nné

String

M

Popis

web service user

wsPassword

String

M


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

String

O

Parcel shop house number

countryCode

String

M

Parcel shop country code alpha

zipCode city limit consigneePickupAllowed returnAllowed expressAllowed codAllowed codPaymentType

String String int String String String String String

M M (default: 10) O O O O O

street houseNo

Parcel shop street

O

Parcel shop zip code Parcel shop city name The number of rows returned consigneePickupAllowed returnAllowed expressAllowed codAllowed codPaymentType

Odpověď parcelShopResponse má tyto elementy – výstupní parametry: Název parametru

Typ pole

Povinné

Popis

transactionId

long

M

parcelShopList

ParcelShopVO

O

search result list

error

ErrorVO

O

Error information


Request log id

Strana 40 / 76


ParcelShopVo obsahuje tato pole Název parametru

Typ pole

Povin né

Popis

parcelShopId

long

M

parcelShopId

companyName

string

O

companyName

street

string

O

street

houseNo

string

O

houseNo

state

string

O

state

countryCode

string

O

countryCode

zipCode

string

O

zipCode

city

string

O

city

townName

string

O

townName

telNumber

string

O

telNumber

faxNo

string

O

faxNo

emailAddress

string

O

emailAddress

homepage

string

O

homepage

openingHours

ParcelShopOpeningHoursVO

O

openingHours

holiday

ParcelShopHolidayVO

O

holiday

extraInfo consigneePickupAll owed

string

O

extraInfo

returnAllowed

string

O

returnAllowed

expressAllowed

string

O

expressAllowed

expressPickupTime

string

O

expressPickupTime

distance

double

O

distance

longitude

double

O

longitude

latitude

double

O

latitude

coordinateX

double

O

coordinateX

coordinateY

double

O

coordinateY

coordinateZ

double

O

coordinateZ

codAllowed

string

O

codAllowed

codPaymentType

string

O

codPaymentType

prepaidAllowed

string

O

prepaidAllowed

O string


consigneePickupAllowed

Strana 41 / 76


ParcelShopOpeningHoursVO obsahuje tato pole Název parametru

weekday openMorning closeMorning closeAfternoon openAfternoon

Typ pole

Povinné

Popis

string

O

weekday

string

O

openMorning

string

O

closeMorning

string

O

closeAfternoon

string

O

openAfternoon

ParcelShopHolidayVO obsahuje tato pole Název parametru

startDate startTime endDate endTime

Typ pole

Povinné

Popis

string

O

startDate

string

O

startTime

string

O

endDate

string

O

endTime


Strana 42 / 76


5.2 Služby pro objednávku svozu 5.2.1 Metoda pro vytvoření objednávky svozu Metoda createPickupOrder 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


pickupOrderList

PickupOrderVO

M

List of pickup order object

PickupOrderVO obsahuje tato pole: Název parametru

Typ pole

Povinné

Popis

pickupOrderId

long

O

payerId

long

M

DPD SYSTEM payer customer id

senderAddressId

long

O

DPD SYSTEM address id

senderAddress

AddressVO

O

Free text sender address.

String

M

Pickup date (YYYYMMDD)

String

M

Pickup time start (HHMMSS)

String

M

Pickup time end (HHMMSS)

String

M

Sender contact name

contactPhone

String

M

Sender contact phone number

contactEmail

String

M

Sender contact email address

specialInstruction

String

O

Message to driver

referenceNumber

String

M

Integrator pickup order id

pieces

PickupPieceVO

M

List of Pickup pieces

date fromTime toTime contactName

DPD SYSTEM pickup order id. Leave empty for creation

AddressVO obsahuje tato pole: Název parametru

Typ pole

Povinné

Popis

String

M

Country code alpha (LV, EE,;)

String

M

City name

String

M

Street name

zipCode

String

O

Zip code

name

String

M

Sender name

countryCode city street

PickupPieceVO obsahuje tato pole Název parametru

Typ pole

Povinné

Popis

long

M


quantity

long

M

Piece count

weight destinationCountry Code

double

M

Weight

M

Destination country code

serviceCode

String


Strana 43 / 76


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

Typ pole

pickupOrderRefere nce

ReferenceVO

error

ErrorVO

Povinné

Popis

M

Pickup order id and reference number

O

Error information



Strana 44 / 76


5.2.2 Metoda pro odstranění objednávky svozu Metoda deletePickupOrder má tyto elementy – vstupní parametry: Název parametru wsUserName

Typ pole

String

Povinné

M

Popis

web service user

wsPassword

String

M


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


ReferenceVO

error

ErrorVO

Povinné

Popis

M


O

Error information



Strana 45 / 76


5.2.3 Metoda pro zjištění stavu objednávky svozu Metoda getPickupOrderStatus má tyto elementy – vstupní parametry: Název parametru wsUserName

Typ pole

String

Povinné

M

Popis

web service user

wsPassword

String

M


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

Typ pole


ReferenceVO

error

ErrorVO

Povinné

Popis

M


O

Error information



Strana 46 / 76


5.2.4 Metoda pro vyhledání chybějících objednávek svozu Metoda searchMissingPickupOrder má tyto elementy – vstupní parametry: Název parametru wsUserName

Typ pole

String

Povinné

M

Popis

web service user

wsPassword

String

M


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

String

O

Last pickup date

lastPickupOrderTime

String

O

Last pickup time

error

ErrorVO

O

Error information



Strana 47 / 76


5.2.5 Metoda pro vyhledání objednávky svozu Metoda searchPickupOrder 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


searchParams

PickupOrderSea rchVO

M

Pickup order search parameters

PickupOrderSearchVO obsahuje tato pole Název parametru

Typ pole

Povinné

Popis

String

M

String

M

End date (YYYYMMDD)

payerId

long

O

Pickup order payer id

senderAddressId

long

O

Pickup order sender address id

startDate endDate

Start date (YYYYMMDD)

Odpověď searchPickupOrderResponse má tyto elementy – výstupní parametry: Název parametru

Typ pole

Povinné

Popis

transactionId

long

M

pickupOrderList

PickupOrderVO

O

Request log id List of pickup order info

error

ErrorVO

O

Error information



Strana 48 / 76


5.3 Služby pro zpracování seznamu zásilek 5.3.1 Metoda pro uzavření seznamu zásilek Metoda closeManifest 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


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

manifestReferenceNumber manifestNotes shipmentReferenceList

Povinn é

Popis

String

O

Manifest reference number

String ReferenceV O

O

Manifest notes

M

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

long

M

DPD SYSTEM manifest id

manifestReference

ReferenceVO

M


manifestName

String

M

Manifest name

manifetPrintDataList

O

List of ManifestPrintDataVO object

printParcelList

ManifestPrintD ataVO PrintDataVO

O

List of PrintDataVO object

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

byte

O

Byte array of label Pdf file

error

ErrorVO

O

Error information


Strana 49 / 76


ManifestPrintDataVO obsahuje tato pole: Název parametru

Typ pole

Povinné

Popis

long

M

DPD SYSTEM manifest id

String

M

Manifest creation date (YYYYMMDD)

String

M

Manifest close date (YYYYMMDD)

long

M

Total shipment in the manifest

long

M

Total parcel in the manifest

totalWeight

double

M

Total weight (kg)

totalVolume

double

M

Total volume (m3)

senderId

long

M

DPD SYSTEM sender customer id

senderCustName

String

M

Sender customer name

senderAddress

String

M

Sender address

senderZipCode senderCountryAlphaCod e

String

M

Sender zip code

String

M

senderTaxNumber

String

M

Sender tax number

senderTelNumber

String

M

Sender phone number

senderCity

String

M

Sender city

companyDepotCode

String

M

Sender working depot code

companyName

String

M

DPD company name

companyTaxNumber

String

M

DPD tax number

companyAddress

String

M

DPD address

companyTelNumber

String

M

DPD phone number

companyFaxNumber

String ShipmentPr intDataVO

O

manifestId creationDate closeDate totalShipmentCount totalParcelCount

shipmentList

Sender country code

DPD fax number 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

String

M

Receiver address

String

M

Receiver zip code

String

M

Receiver city

M


receiverAddress receiverZipCode receiverCity receiverCountryCodeAlp ha

String

receiverTaxNumber

string

O

Receiver tax number

String

O

Receiver contact name

String

O


String

O


String

O

Receiver access code

String

O

Receiver village

String

O

Receiver district

receiverTown

String

O

Receiver town

codAmountOfValue

double

O

COD amount

codCurrency

String

O

COD currency

codReferenceNo

String

O

COD reference number

codPaymentType

String

O

COD payment type

receiverContactName receiverPhoneNr1 receiverPhoneNr2 receiverAccessCode receiverVillage receiverDistrict


Strana 50 / 76


Název parametru

saturdayDelivery completeDelivery parcelList

Typ pole

Povinné

Popis

String

O

String ParcelPrint DataVO

O

Saturday delivery information Complete delivery information

M

List of parcels in the manifest

ParcelPrintDataVO obsahuje tato pole Název parametru

Typ pole

Povinné

Popis

parcelNo

String

M

14 digit parcel number from parcel range

weight

double

M

Package weight (kg)

volume

double

M

Package volume (m3)

barcode

String

O

Label barcode for parcel

String

O

Label barcode text for parcel

barcodeText



Strana 51 / 76


5.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 Služba vyhodí výjimku IT4EMWSException


Strana 52 / 76


5.4 Služby pro vyhledání DPD ParcelShop 5.4.1 Metoda pro vyhledání DPD ParcelShop Metoda parcelShopSearch 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



Strana 53 / 76


6 Přílohy 6.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 54 / 76


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 55 / 76


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 56 / 76


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 57 / 76


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 58 / 76


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 59 / 76


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

6.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 60 / 76


6.3 Výpis příkladů 6.3.1

Příklad 1

6.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 <wsPassword>your password <wsLang>EN 9 <shipmentList> <shipmentId xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/> <shipmentReferenceNumber>WS167 <payerId>2024559 <senderAddressId>2005887 John Smith Company B EE 10149 Tallin Toompuiestee 33a <mainServiceCode>1 <parcels> <parcelReferenceNumber>WS3138 <weight>10.0 <description xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/> <priceOption>WithoutPrice


Strana 61 / 76


6.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:ns2="http://it4em.yurticikargo.com.tr/eshop/shipment" xmlns:ns3="http://it4em.yurticikargo.com.tr/eshop/"> 1808 <shipmentReference> 29259376 WS167 <parcelResultList> <parcelId>20274 <parcelReferenceNumber>WS3138 <printRequired>true <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 <shipmentTime>145715 <message>Your shipment is created successfully. However, You don't have an available pickup order for this shipment in today.


Strana 62 / 76


6.3.1.3 Požadavek na uzavření seznamu zásilek <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:man="http://it4em.yurticikargo.com.tr/eshop/manifest"> <soapenv:Header/> <soapenv:Body> <man:closeManifest> <wsUserName>YOUR USER NAME <wsPassword>your password <wsLang>EN 9 <manifest> <manifestReferenceNumber>MR167 <manifestNotes>your comments here: <shipmentReferenceList> WS168 <manifestPrintOption>PrintManifestWithUnprintedParcels <printOption>Ftp 6.3.1.4 Odpověď uzavření seznamu zásilek <env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"> <env:Header/> <env:Body> <ns1:closeManifestResponse xmlns:ns1="http://it4em.yurticikargo.com.tr/eshop/manifest" xmlns:ns2="http://it4em.yurticikargo.com.tr/eshop/manifest" xmlns:ns3="http://it4em.yurticikargo.com.tr/eshop/"> 1815 <manifestId>20043 <manifestReferenceNumber>MR167 <manifestName>2024559_20130228_10 <manifestPrintData xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance"/> /eeapptest/files/app/web/manifest/eshop_manifest_print_20130228_152506_ 94.pdf /eeapptest/files/app/ssa/parcel_label/eshop_parcel_label_20130228_152506_6 3.pdf <error xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>


Strana 63 / 76


6.3.2

Příklad 2

6.3.2.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 USERNAME <wsPassword>your password <wsLang>EN 9 <shipmentList> <shipmentId xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/> <shipmentReferenceNumber>WS183 <payerId>2024559 <senderAddressId>2005887 Mr Kaido Company C EE 80042 Pärnu Riia mnt 231a <mainServiceCode>1 120 <currency>EUR <paymentType>Cash <saturdayDelivery>false <parcels> <parcelReferenceNumber>WS3154 <weight>8.0 <description xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/> <priceOption>WithPrice


Strana 64 / 76


6.3.2.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:ns2="http://it4em.yurticikargo.com.tr/eshop/shipment" xmlns:ns3="http://it4em.yurticikargo.com.tr/eshop/"> 2415 <shipmentReference> 29259489 WS183 <parcelResultList> <parcelId>20959 <parcelReferenceNumber>WS3154 <printRequired>true <price> 7.38 1.47 8.85 <currency>EUR 7.38 1.47 8.85 <currencyLocal>EUR <error xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/> <shipmentDate>20130308 <shipmentTime>163803 <message>Your shipment is created successfully. However, You don't have an available pickup order for this shipment in today.


Strana 65 / 76


6.3.2.3 Požadavek na vytvoření přepravních štíktů k zásilce <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ship="http://it4em.yurticikargo.com.tr/eshop/shipment"> <soapenv:Header/> <soapenv:Body> <ship:getShipmentLabel> <wsUserName>YOUR USERNAME <wsPassword>your password <wsLang>EN 9 <shipmentReferenceList> <printOption>Pdf 6.3.2.4 Odpověď vytvoření přepravních štítků k zásilce <env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"> <env:Header/> <env:Body> <ns1:getShipmentLabelResponse xmlns:ns1="http://it4em.yurticikargo.com.tr/eshop/shipment" xmlns:ns2="http://it4em.yurticikargo.com.tr/eshop/shipment" xmlns:ns3="http://it4em.yurticikargo.com.tr/eshop/"> 2418 [pdf content ] <error xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>


Strana 66 / 76


6.3.2.5 Požadavek na uzavření seznamu zásilek <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:man="http://it4em.yurticikargo.com.tr/eshop/manifest"> <soapenv:Header/> <soapenv:Body> <man:closeManifest> <wsUserName>YOUR USERNAME <wsPassword>your password <wsLang>EN 9 <manifest> <manifestReferenceNumber>WS183 <manifestNotes>your comments here: <shipmentReferenceList> WS183 <manifestPrintOption>PrintManifestWithUnprintedParcels <printOption>Ftp 6.3.2.6 Odpověď uzavření seznamu zásilek <env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"> <env:Header/> <env:Body> <ns1:closeManifestResponse xmlns:ns1="http://it4em.yurticikargo.com.tr/eshop/manifest" xmlns:ns2="http://it4em.yurticikargo.com.tr/eshop/manifest" xmlns:ns3="http://it4em.yurticikargo.com.tr/eshop/"> 2417 <manifestId>20064 <manifestReferenceNumber>WS183 <manifestName>2024559_20130308_3 <manifestPrintData xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance"/> /eeapptest/files/app/web/manifest/eshop_manifest_print_20130308_163804_ 68.pdf <error xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>


Strana 67 / 76


6.3.3

Příklad 3

6.3.3.1 Požadavek na zjištění ceny <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ship="http://it4em.yurticikargo.com.tr/eshop/shipment"> <soapenv:Header/> <soapenv:Body> <ship:calculatePrice> <wsUserName>YOUR USERNAME <wsPassword>YOUR PASSWORD <wsLang>EN 9 <shipmentList> <payerId>2024559 <senderAddressId>2005887 Mr Kaido Company C EE 80042 Pärnu Riia mnt 231a <mainServiceCode>1 <saturdayDelivery>true <parcels> <weight>10 <description xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>


Strana 68 / 76


6.3.3.2 Odpověď zjištění ceny <env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"> <env:Header/> <env:Body> <ns1:calculatePriceResponse xmlns:ns1="http://it4em.yurticikargo.com.tr/eshop/shipment" xmlns:ns2="http://it4em.yurticikargo.com.tr/eshop/shipment" xmlns:ns3="http://it4em.yurticikargo.com.tr/eshop/"> 3073 <priceList> <price> 6.17 1.23 7.4 <currency>EUR 6.17 1.23 7.4 <currencyLocal>EUR <error xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>


Strana 69 / 76


6.3.3.3 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 USERNAME <wsPassword>YOUR PASSWORD <wsLang>EN 9 <shipmentList> <shipmentId xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/> <shipmentReferenceNumber>112463 <payerId>2024559 <senderAddressId>2005887 Mr Kaido Company C EE 80042 Pärnu Riia mnt 231a <mainServiceCode>1 <saturdayDelivery>true <parcels> <parcelReferenceNumber>LT3246 <weight>10.0 <description xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/> <priceOption>WithoutPrice


Strana 70 / 76


6.3.3.4 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:ns2="http://it4em.yurticikargo.com.tr/eshop/shipment" xmlns:ns3="http://it4em.yurticikargo.com.tr/eshop/"> 3079 <shipmentReference> 29259664 112463 <parcelResultList> <parcelId>22035 <parcelReferenceNumber>LT3246 <printRequired>true <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>20130409 <shipmentTime>151254 <message>Your shipment is created successfully. However, You don't have an available pickup order for this shipment in today.


Strana 71 / 76


6.3.3.5 Požadavek na vytvoření přepravních štítků 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:getShipmentLabel> <wsUserName>YOUR USERNAME <wsPassword>YOUR PASSWORD <wsLang>EN 9 <shipmentReferenceList> 112463 <printOption>Pdf 6.3.3.6 Odpověď vytvoření přepravních štítků zásilky <env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"> <env:Header/> <env:Body> <ns1:getShipmentLabelResponse xmlns:ns1="http://it4em.yurticikargo.com.tr/eshop/shipment" xmlns:ns2="http://it4em.yurticikargo.com.tr/eshop/shipment" xmlns:ns3="http://it4em.yurticikargo.com.tr/eshop/"> 3080 (pdf content removed) <error xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>


Strana 72 / 76


6.3.3.7 Požadavek na uzavření seznamu zásilek <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:man="http://it4em.yurticikargo.com.tr/eshop/manifest"> <soapenv:Header/> <soapenv:Body> <man:closeManifest> <wsUserName>YOUR USERNAME <wsPassword>YOUR PASSWORD <wsLang>EN 9 <manifest> <manifestReferenceNumber> MR188 <manifestNotes>your comments here: <shipmentReferenceList> 112463 <manifestPrintOption> PrintOnlyManifest <printOption>Pdf 6.3.3.8 Odpověď uzavření seznamu zásilek <env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"> <env:Header/> <env:Body> <ns1:closeManifestResponse xmlns:ns1="http://it4em.yurticikargo.com.tr/eshop/manifest" xmlns:ns2="http://it4em.yurticikargo.com.tr/eshop/manifest" xmlns:ns3="http://it4em.yurticikargo.com.tr/eshop/"> 3081 <manifestId>20106 <manifestReferenceNumber> MR188 <manifestName>2024559_20130409_3 <manifestPrintData xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance"/> (pdf content remove) <error xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>


Strana 73 / 76


6.3.4 6.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 <wsPassword> YOUR PASSWORD <wsLang>EN 9 <searchParams> SK Bratislava 10 1


Strana 74 / 76


6.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/'> 81757 <parcelShopList> <parcelShopId>400893 DPD ParcelShop PRESKOLY.sk <street>Mánesovo námestie 6 <state/> SK 85101 Bratislava Petržalka +421-(02)44633762 - <emailAddress>[email protected] <weekday>Monday 08:30 17:00 <weekday>Tuesday 08:30 17:00 <weekday>Wednesday 08:30 17:00 <extraInfo/> 1 0 <expressAllowed>0 <expressPickupTime/> 1.9995365376363134 17.11109 48.12866


Strana 75 / 76


1 0 <prepaidAllowed>0 L. <error xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:nil='true'/>


Strana 76 / 76

Příručka programátora pro integraci zákaznických řešení a DPD systémů pomocí webových služeb Moje DPD. Verze

Recommend Documents