G-Service. popis webové služby

Webová služba G-Service – dokumentace Str. 1/38

G-Service popis webové služby

VERZE DOKUMENTU:

1.9

DATUM:

6. 1. 2016

Geis CZ s.r.o. Zemská 211/I 337 01 Ejpovice Czech Republic

E-mail: [email protected] Internet: www.geis.cz IČO: 44567359 DIČ: CZ44567359

Telefon: +420 951 277 777 Telefax: +420 951 220 259

Bankovní spojení: UniCredit Bank Czech Republic, a.s.

Č.ú.: 1545471501/2700 (CZK) Č.ú.: 1545471560/2700 (EUR) EUR IBAN: CZ56 2700 0000 0015 45471560 CZK IBAN: CZ97 2700 0000 0015 45471501 SWIFT: BACXCZPP

Společnost zapsána v obchodním rejstříku vedeném Krajským soudem v Plzni, oddíl C, číslo vložky 14475. Pracujeme na základě našich všeobecných obchodních podmínek – aktuální stav.


O službě G-Service G-Service je webová služba určená pro zákazníky skupiny Geis, která umožňuje zákazníkům zcela automatizovat proces zadávání přeprav v obou produktech skupiny Geis (cargo a balíkové přepravy). Webová služba slouží k vytváření zásilek (v režimu expedice nebo objednávka), zjišťování statusů a informací k zásilkám, objednávání svozů, zjišťování dostupných doplňkových služeb. Využití webové služby spočívá především v možnosti plné integrace do produkčních, skladových systémů nebo webshopů zákazníků skupiny Geis. Požadavky na webovou službu a především odpovědi webové služby jsou strukturovány ve formátu XML a umožňují tak další zpracování na straně zákaznických systémů. Služba G-Service pracuje na principu architektury SOAP (https://en.wikipedia.org/wiki/SOAP), přístup je možný pouze zabezpečeným protokolem HTTPS. Pro testování webové služby lze použít například open source program SoapUI (http://www.soapui.org). Pro přístup k webové službě je třeba mít přístupové údaje – kód zákazníka a heslo. Tyto přístupové údaje sdělí na vyžádání přidělený obchodní manažer skupiny Geis. Před přechodem do ostrého provozu je třeba vždy projít nejprve integračními testy v testovacím prostředí, které provádí technické oddělení zákazníka ve spolupráci s EDI oddělením skupiny Geis. Pro zákazníky z České republiky a Slovenska je webová služba dostupná na adresách: • •

https://gclient.geis.cz/GService/GService.svc - přístup do produkčního prostředí https://gclient.geis.cz/GServiceTest/GService.svc – přístup do testovacího prostředí

Pro zákazníky z Polska je webová služba dostupná na adresách: • •

https://gclient.etlogistik.com/GServicetest/GService.svc - přístup do produkčního prostředí https://gclient.etlogistik.com /GServiceTest/GService.svc – přístup do testovacího prostředí

Pro úspěšnou implementaci webové služby v prostředí zákazníka a pochopení širších souvislostí je doporučeno nejprve prostudování příručky Manuál pro systémovou integraci, která je dostupná na webu technické podpory skupiny Geis v sekci Ke stažení, na adrese • •

www.baliky.cz/podpora nebo www.baliky.sk/podpora (česká verze) www.etlogistik.com/support (anglická verze)



Telefon: +420 951 277 777 Telefax: +420 951 220 259





Obsah O službě G-Service .............................................................................................................................................. 2 Change Log.......................................................................................................................................................... 4 Postup implementace na straně zákazníka ........................................................................................................ 5 Minimální testovací scénář ................................................................................................................................. 5 Základní třídy ...................................................................................................................................................... 5 Request ........................................................................................................................................................... 5 RequestHeader ............................................................................................................................................... 6 Language ......................................................................................................................................................... 6 Currency .......................................................................................................................................................... 6 Response ......................................................................................................................................................... 6 ResponseStatus ............................................................................................................................................... 6 ZipCodes.......................................................................................................................................................... 7 Address ........................................................................................................................................................... 7 Contact ............................................................................................................................................................ 7 Chybové kódy...................................................................................................................................................... 7 Metody webové služby ....................................................................................................................................... 8 ServiceList ....................................................................................................................................................... 8 AddServiceList ............................................................................................................................................... 10 StatusList ....................................................................................................................................................... 13 WrapList ........................................................................................................................................................ 15 DeliveryRouting ............................................................................................................................................ 17 ShipmentDetail ............................................................................................................................................. 19 RouteTable .................................................................................................................................................... 23 CreatePickUp ................................................................................................................................................ 25 InsertExport .................................................................................................................................................. 28 InsertOrder ................................................................................................................................................... 32 AssignRange .................................................................................................................................................. 36 IsHealthy ....................................................................................................................................................... 38



Telefon: +420 951 277 777 Telefax: +420 951 220 259





Change Log Verze 1.0

Datum 2015-05-29

1.1 1.2

2015-08-03

1.3

2015-08-24

1.4

2015-08-27

1.5

2015-09-09

1.6 1.7 1.8 1.9.

2015-09-21 2015-11-13 2015-21-02 2016-01-06

Změna Vytvoření služby. Základní metody: - ServiceList - AddServiceList - StatusList - WrapList - DeliveryRouting - ShipmentDetail - RouteTable - CreatePickUp - InsertExport - InsertOrder - AssignRange Přidán číselník měn Currency Změny vstup: - Do ExportService přidán Parameter_5 - InsertOrder opraven parametr MergedOrder - Upraveny povinné parametry v InsertExport - Language CS změněn na CZ - Heslo pro přihlášení rozšířeno na 20 znaků Změny výstup - metoda ShipmentDetail – PackageRow přidána zákaznická reference (Reference) - metoda InserExport přidán seznam čísel sloučených zásilek (MergedPackNumbers) - metoda InsertOrder přidán seznam čísel sloučených objednávek (MergedPackNumbers) Změny vstup: - InsertOrder: přidán parametr pro zadání sloučených objednávek (MergedOrders) - InsertOrder: odstraněn parametr CountItems - InsertExport: přidán parametr pro zadání sloučených zásilek (MergedPackages) - Upravena kontrola třídy Contact, nyní kontroluje formát Emailu a Telefonního čísla Změny vstup: - DeliveryRouting parametr CountryIn změněn na nepovinný pro Parcel Aktualizace povinností parametrů. Korektura Doplnění parametrů rozměrů u objednávky Oprava popisu parametrů u metody DeliveryRouting Doplnění popisu webové služby, postup implementace Doplnění chybových kódů



Telefon: +420 951 277 777 Telefax: +420 951 220 259





Postup implementace na straně zákazníka Postup pro implementaci webové služby na straně zákazníka ověření možnosti zadávání API požadavků a zpracování odpovědí protokolem HTTPS v logistickém systému zákazníka prostudování dokumentace Manuál pro systémovou integraci pro pochopení základních souvislostí (typy produktů, routování zásilek, doplňkové služby, tisk štítků a předávacích protokolů) a této dokumentace vyžádání přístupu do API rozhraní testovací webové služby od obchodního manažera Geis otestování základních metod a tříd, zpracování odpovědí, ošetření návratových kódů vytvoření štítků a předávacího protokolu a jejich zaslání ke schválení obchodnímu manažerovi Geis dohodnutí termínu přechodu do ostrého startu a ostrý start

Minimální testovací scénář V rámci testování webové služby v testovacím prostředí je třeba využít alespoň těchto metod: CreatePickup (založení svozu) InsertExport (vložení zásilky typu expedice pro každý produkt, který bude zákazník využívat – tj. cargo / parcel) s využitím pomocných metod AddServiceList, DeliveryRouting a WrapList (pouze pro produkt cargo) InsertOrder (vložení zásilky typu objednávka pro každý produkt, který bude zákazník využívat) AssignRange (přiřazení číselné řady) - pouze pro produkt parcel ShipmentDetail (zjištění detailu zásilky) s využitím pomocné metody StatusList Pozn.: před vložením zásilky typu expedice v určitém dni je nutné předtím objednat tzv. svoz na tento den. V rámci svozu se specifikuje maximální počet a celková orientační hmotnost zásilek, odesílaných v jednom dni.

Základní třídy webové služby Níže jsou uvedeny základní třídy, které jsou použity u metod služby.

Request Název Header

Type RequestHeader

Popis Hlavička requestu



Telefon: +420 951 277 777 Telefax: +420 951 220 259


Povinný A Č.ú.: 1545471501/2700 (CZK) Č.ú.: 1545471560/2700 (EUR) EUR IBAN: CZ56 2700 0000 0015 45471560 CZK IBAN: CZ97 2700 0000 0015 45471501 SWIFT: BACXCZPP



RequestObject Generic

Vstupní objekt (specifický pro volanou metodu)

A

RequestHeader Název Type Popis CustomerCode String Kód zákazníka Password String Heslo pro přihlášení Language Language Jazyk pro komunikaci *nemusí být povinný u všech volaných metod.

Povinný A* A* A

Language Výčet možných jazyků Hodnota CZ SK EN DE PL

Název/Popis Čeština Slovenština Angličtina Němčina Polština

Currency Výčet možných měn Hodnota UND CZK EUR CHF USD PLN HUF

Název/Popis Nedefinovaná hodnota měny Česká koruna Euro Švýcarský frank Americký dolar Polský zlotý Maďarský forint

Response Název Request

Type Request

ResponseObject ErrorMessage ErrorCode Status

Generic String String ResponseStatus

Popis Vstupní data pro volanou metodu (nastaví se jen v případě, že při zpracování dojde k chybě) Výstupní objekt (specifický pro volanou metodu) Chybová zpráva Chybový kód (seznam chybových kódů je zde) Status průběhu metody

ResponseStatus Hodnota Inserted Deleted Updated

Název/Popis Vložení proběhlo v pořádku Smazání proběhlo v pořádku Aktualizace proběhla v pořádku Geis CZ s.r.o. Zemská 211/I 337 01 Ejpovice Czech Republic


Telefon: +420 951 277 777 Telefax: +420 951 220 259





ErrorOccurred AccesDenied Processed NoDataFound

Při zpracování došlo k chybě Přístup odepřen (neplatná kombinace kódu zákazníka a hesla) Výpis/Zpracování proběhl/o v pořádku Žádná data nalezena

ZipCodes Název ZipCodeFrom ZipCodeTo

Type String String

Délka 10 10

Popis PSČ od PSČ do

Address Název Name Name2 Street City ZipCode Country

Type String String String String String String

Délka 50 50 50 50 10 2

Popis Jméno Doplněk jména Ulice Město PSČ Stát ve formátu ISO 3166-1 alpha-2

Contact Kontaktní údaje Název Email FullName Phone

Type String String String

Délka 50 50 20

Popis E-mail Celé jméno Telefon v mezinárodním formátu (např. +420 111 222 333)

Chybové kódy Kód 1000 1001 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012

Popis Přístup zamítnut Neautorizovaný přístup! [#Název parametru#] je povinný parametr! Distribuční kanál musí mít hodnotu 1 nebo 2! Hodnota [#Hodnota z číselníku#] nebyla nalezena! Žádná data nalezena Routovací tabulka pro tento den neexistuje! Svozová adresa nemá povolen tento druh přepravní služby Špatný rozsah data! Zákazník nemá povoleny typ MJ [#Typ jednotky#]! Je povolen distribuční kanál [#identifikátor distribučního kanálu#]! Typ přepravy může mít hodnoty 1- vnitro / 2-mezinárodní Číslo balíku již bylo použito! Číslo balíku nenáleží číselné řadě přiřazené zákazníkovi! Zákazník nemá povolen tento druh přepravní služby: [#název přepravní Geis CZ s.r.o. Zemská 211/I 337 01 Ejpovice Czech Republic


Telefon: +420 951 277 777 Telefax: +420 951 220 259





služby#]! Nesouhlasí celková hmotnost a hmotnost jednotlivých položek. Svoz na aktuální den lze založit pouze do [#TEXT#] hodin. Zadanou službu [#TEXT#] nelze zpracovat, protože neexistuje ve výčtu služeb. Služba se musí zavést. Kontaktujte podporu. 2017 [#TEXT#] musí být v mezinárodním formátu (např. +420 111 222 333). Povolené předvolby jsou [#TEXT-1#]. 2018 [#TEXT#] musí být ve správném formátu (např. [email protected])! 2019 [#TEXT#] není validní email ani telefon! [#TEXT-1#] [#TEXT-2#]* 2020 Pro aktuální den nelze založit objednávku! 2021 [#TEXT#] Musí být stejný nebo větší než [#TEXT-1#]! 2022 Zadaný kód výdejního místa není validní! 2023 Zadaný kód výdejního místa [#TEXT#] nebyl nalezen. 2024 Pro zásilku na výdejní místo je povinný parametr kontaktní osoba. 2025 Pro zásilku na VM je povinné mít zadaný parametr Telefon u kontaktní osoby. 2026 Přiřazování číselné řady je možné jen pro parcel 2027 Nemůžete použít službu výdejní místo. Nemáte ji aktivní. 2028 Pole země u krycí adresy musí být vyplněno! 2029 Pro svozovou adresu [#TEXT#] není povolen individuální účet pro dobírky. DistributionChannel [#TEXT-1#] 2030 U exportní položky musí být zadané rozměry! 3000 Chyba služby GClientWS! [# Chybová správa ze služby GClientWS #] 9999 Neočekávaná chyba! *obsahuje popis chyb 2017 a 2018 2013 2015 2016

Metody webové služby ServiceList Vrací seznam přepravních služeb, které jsou nastaveny v primárním systému. Může vracet tyto hodnoty: Hodnota 10 11 20 21

Název/Popis Parcel expedice Parcel objednávky Cargo expedice Cargo objednávky

Request Název Type Header RequestHeader RequestObject ServiceRequest

Popis Hlavička requestu Prázdná třída



Telefon: +420 951 277 777 Telefax: +420 951 220 259


Povinný A





Type Request


List<Service> String String ResponseStatus

Popis Vstupní data pro volanou metodu (nastaví se jen v případě, že při zpracování dojde k chybě) List přepravních služeb Chybová zpráva Chybový kód (seznam chybových kódů je zde) Status průběhu metody

Service Detail přepravní služby. Název Code Name

Type String String

Délka 3 30

Popis Kód přepravní služby Název přepravní služby

Příklad volání metody ServiceList Request: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <ServiceList xmlns="http://tempuri.org/">
22054861 CZ <Password>wspwd

Response: <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ServiceListResponse xmlns="http://tempuri.org/"> <ServiceListResult xmlns:a="http://schemas.datacontract.org/2004/07/GService.Manager" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> 0000 Geis CZ s.r.o. Zemská 211/I 337 01 Ejpovice Czech Republic


Telefon: +420 951 277 777 Telefax: +420 951 220 259





10 parcel expedice 11 parcel objednávky 20 cargo expedice 21 cargo objednávky Processed

AddServiceList Vrací seznam doplňkových služeb, které má zákazník nastaven v primárním systému. Mezi tyto služby může patřit například COD - Dobírka, POJ – pojištění atd. Request Název Type Header RequestHeader RequestObject AddServiceRequest AddServiceRequest Název Type Service String

Délka 2

DeliveryCountry String

2

Popis Hlavička requestu Instance třídy AddServiceRequest

Povinný A A

Popis Druh přepravní služby (dle výstupu ServiceList) Stát příjemce ve formátu ISO 3166-1 alpha2

Povinný A A*

*Parametr je povinný jen pro Cargo



Telefon: +420 951 277 777 Telefax: +420 951 220 259






Type Request


List String String ResponseStatus

Popis Vstupní data pro volanou metodu (nastaví se jen v případě, že při zpracování dojde k chybě) List služeb, které může zákazník používat Chybová zpráva Chybový kód (seznam chybových kódů je zde) Status průběhu metody

AddService Detail služby. Název Code Abbreviation Description ZipCodeFrom ZipCodeTo

Type Int String String String String

Délka 2 3 30 10 10

Popis Id služby Zkratka služby Popis služby PSČ od (pokud je nastaveno) PSČ do (pokud je nastaveno)

Příklad volání metody AddServiceList Níže je uveden příklad, ve kterém se dotazujeme metody, jaké služby má zákazník povoleny pro produkt Parcel a navíc nás zajímají pouze expedice. Request: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body>
CZ <Service>10 Geis CZ s.r.o. Zemská 211/I 337 01 Ejpovice Czech Republic


Telefon: +420 951 277 777 Telefax: +420 951 220 259





Response: V odpovědi můžeme vidět, že zákazník má přiřazeny služby COD, POJ a D12. U služby D12 si můžeme všimnout, že má uveden další element ZipCodeList. Tento seznam určuje, pro která PSČ příjemce je možné službu D12 použít. V případě, že bude v metodě InsertExport použita služba D12 s PSČ příjemce, které nebude v intervalu PSČ, nebude expedice zpracována a služba vypíše chybovou hlášku. <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> 0000 COD 2 Dobírka 10 POJ 3 Připojištění 10 D12 6 Doručení do 12 hodin 10 10000 19900 30100 31700 Geis CZ s.r.o. Zemská 211/I 337 01 Ejpovice Czech Republic


Telefon: +420 951 277 777 Telefax: +420 951 220 259





Processed

StatusList Vrací seznam statusů zásilek, které jsou viditelné v Track & Trace. Request Název Type Header RequestHeader RequestObject StatusRequest StatusRequest Název Type DistributionChannel Int Response Název Request

Type Request


List<Status> String String ResponseStatus

Popis Hlavička requestu Instance třídy StatusRequest

Povinný A A

Popis Povinný Druh přepravní služby (1 – Parcel, 2 – Cargo) A

Popis Vstupní data pro volanou metodu (nastaví se jen v případě, že při zpracování dojde k chybě) List statusů, dle přepravní služby Chybová zpráva Chybový kód (seznam chybových kódů je zde) Status průběhu metody

Status Detail statusu zásilky. Název Code Description DistributionChannel

Type String String Int

Délka 3 20 1

Popis Kód statusu Popis služby Druh přepravní služby (1 – Parcel, 2 – Cargo)



Telefon: +420 951 277 777 Telefax: +420 951 220 259





Příklad volání metody StatusList Request:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <StatusList xmlns="http://tempuri.org/">
1

Response: <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <StatusListResponse xmlns="http://tempuri.org/"> <StatusListResult xmlns:a="http://schemas.datacontract.org/2004/07/GService.Manager" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> 0000 10 Převzetí zásilky 1 11 Storno 1 Geis CZ s.r.o. Zemská 211/I 337 01 Ejpovice Czech Republic


Telefon: +420 951 277 777 Telefax: +420 951 220 259





12 Vstupní depo 1 20 Příjem na depo 1 Processed

WrapList Vrací seznam manipulačních jednotek povolených pro zákazníka v primárním systému. Request Název Type Header RequestHeader RequestObject WrapRequest Response Název Request

Popis Hlavička requestu Instance třídy WrapRequest (prázdná třída)

Type Request

Popis Vstupní data pro volanou metodu (nastaví se jen v případě, že při zpracování dojde k chybě) List manipulačních jednotek, které má zákazník povolené Chybová zpráva Chybový kód (seznam chybových kódu je zde) Status průběhu metody

ResponseObject List<Wrap> ErrorMessage ErrorCode Status

Povinný A A

String String ResponseStatus

Wrap Detail manipulační jednotky. Název Code Description Returnable

Type String String Bool

Délka 3 50

Popis Kód manipulační jednotky Popis manipulační jednotky Vratný obal



Telefon: +420 951 277 777 Telefax: +420 951 220 259





Příklad volání metody WrapList Request: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <WrapList xmlns="http://tempuri.org/">

Response: <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <WrapListResponse xmlns="http://tempuri.org/"> <WrapListResult xmlns:a="http://schemas.datacontract.org/2004/07/GService.Manager" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> 0000 FP EUROPALETA true KH POLOPALETA true Processed Geis CZ s.r.o. Zemská 211/I 337 01 Ejpovice Czech Republic


Telefon: +420 951 277 777 Telefax: +420 951 220 259





DeliveryRouting Vrací zemi příjemce, Depo a směr. Tyto informace jsou důležité pro sestavení štítku viz. manuál pro systémovou integraci oddíl 2.4. Specifikace pro tisk štítků na straně 22. Request Název Type Popis Header RequestHeader Hlavička requestu RequestObject DeliveryRoutingRequest Instance třídy DeliveryRoutingRequest

Povinný A A

DeliveryRoutingRequest Název Type DistributionChannel Int

Povinný A

Délka

CountryIn String ZipCodeIn String CountryOut String ZipCodeOut String TemperatureMode String *Parametr je poviný pro Cargo

2 10 2 10


Type Request


DeliveryRouting String String ResponseStatus

DeliveryRouting Název Type DeliveryRoute String DepCode String

Popis Druh přepravní služby (1 – Parcel, 2 – Cargo) Země odesílatele PSČ odesílatele Země příjemce PSČ příjemce Teplotní režim (nepoužito)

A A A* A

Popis Vstupní data pro volanou metodu (nastaví se jen v případě, že při zpracování dojde k chybě) Informace o routování Chybová zpráva Chybový kód (seznam chybových kódu je zde) Status průběhu metody

Délka 4 3

Popis Kód dodací trasy Kód depa



Telefon: +420 951 277 777 Telefax: +420 951 220 259





Příklad volání metody DeliveryRouting Request: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body>
CZ 1 33843 60200

Response: <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> 0000 6010 60 Processed Geis CZ s.r.o. Zemská 211/I 337 01 Ejpovice Czech Republic


Telefon: +420 951 277 777 Telefax: +420 951 220 259





ShipmentDetail Vrací informace o zásilce. Pokud jsou poslány údaje o zákazníkovi a zásilku vytvořil, vrátí metoda informace o službách zásilky, adresu příjemce a adresu odesílatele. Pokud zákazník/plátce zásilku nevytvořil, budou zobrazeny pouze statusy k zásilce. Request Název Type Header RequestHeader RequestObject ShipmentRequest

Popis Hlavička requestu Instance třídy ShipmentRequest

ShipmentRequest Název Type DistributionChannel Int

Délka

ShipmentNumber

11/13

String


Type Request


Shipment String String ResponseStatus

Povinný A A

Popis Druh přepravní služby (1 – Parcel, 2 – Cargo) Číslo zásilky parcel / cargo

Povinný A A

Popis Vstupní data pro volanou metodu (nastaví se jen v případě, že při zpracování dojde k chybě) Detaily o zásilce Chybová zpráva Chybový kód (seznam chybových kódů je zde) Status průběhu metody

Shipment Detail zásilky. Název ShipmentNumber ShipmentNumberCust DelivPerson Weight CodVarCode CodValue DelivDate BorderDate

Type String String String Decimal String Decimal DateTime DateTime

Délka 11 / 13 50 50 (5,2) 10 (12,2)

Volume RecAddress SendAddress History ColliHistory Services Rows

Decimal (9,3) Address Address List<PackageHistory> List List<PackageService> List<PackageRow> Geis CZ s.r.o. Zemská 211/I 337 01 Ejpovice Czech Republic


Telefon: +420 951 277 777 Telefax: +420 951 220 259


Popis Číslo zásilky parcel / cargo Zákaznická reference Jméno příjemce zásilky Hmotnost zásilky Variabilní symbol pro dobírku Hodnota dobírky Datum doručení Datum odeslání (datum naložení na hlavní běh) Objem Adresa příjemce Adresa odesílatele Seznam statusů zásilky Seznam statusů kusu zásilky Seznam služeb zásilky Seznam řádků zásilky Č.ú.: 1545471501/2700 (CZK) Č.ú.: 1545471560/2700 (EUR) EUR IBAN: CZ56 2700 0000 0015 45471560 CZK IBAN: CZ97 2700 0000 0015 45471501 SWIFT: BACXCZPP

Kanál PC PC PC PC PC PC PC C C PC PC PC C PC C



PackageHistory Detail statusu zásilky. Název StatusDate StatusName DepName Description

Type DateTime String String String

Délka 50 50 50

Popis Datum statusu Název statusu Depo statusu Poznámka

ColliHistory Položka statusu kusu zásilky. Název StatusDate StatusName DepName Description ColliNumber

Type DateTime String String String String

Délka 50 50 50 25

Popis Datum statusu Název statusu Depo statusu Poznámka Číslo kusu

PackageService Položka služby zásilky. Název Name Price Currency

Type String Decimal Currency

Délka 30 (12,2)

Popis Název služby Cena služby Měna

Délka

Popis Počet kusů Obal Popis Hmotnost Zákaznická reference Objem Rozměry (vrací prázdnou hodnotu)

PackageRow Položka řádku zásilky. Název CountItems PackingType Description Weight Reference Volume Dimension Chybové kódy Kód 0 1 2 3 4

Type Int String String Decimal String Decimal String

Stav zásilky OK OK OK STORNO Není

30 30 (9,2) 50 (9,3)

Popis Nedoručená, má statusy Doručená, má statusy Ještě nemá statusy Zásilka byla stornována Zásilka neexistuje.



Telefon: +420 951 277 777 Telefax: +420 951 220 259





Příklad volání metody ShipmentDetail Request: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <ShipmentDetail xmlns="http://tempuri.org/">
1 <ShipmentNumber>02093000033

Response: <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ShipmentDetailResponse xmlns="http://tempuri.org/"> <ShipmentDetailResult xmlns:a="http://schemas.datacontract.org/2004/07/GService.Manager" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> 0 Zásilka OK - nedoručená, má statusy. 0001-01-01T00:00:00 1,00 123 0001-01-01T00:00:00 Geis CZ s.r.o. Zemská 211/I 337 01 Ejpovice Czech Republic


Telefon: +420 951 277 777 Telefax: +420 951 220 259





Zásilková reference 2015-09-07T08:23:03.763 Zákaznická reference 2015-09-07T08:23:03.83 Telefon příjemce Mirošov Česká republika Test GService - test GService Prokopova XXX 33843 Ejpovice Česká republika Test GService - svozová adresa Zemská 211/I 33701 UND Mýto 0.0000 UND Diesel příplatek 0.0000 UND Dopravné 0.0000 UND Dobírka 0.0000 Geis CZ s.r.o. Zemská 211/I 337 01 Ejpovice Czech Republic


Telefon: +420 951 277 777 Telefax: +420 951 220 259





UND Soukromá adresa 0.0000 02093000033 Zásilková reference 0 4.00 Processed

RouteTable Vrací routovací tabulku. Tabulku lze vrátit maximálně na 7 dní dopředu. Tato informace je důležitá pro sestavení štítku viz. manuál pro systémovou integraci oddíl 2.4. Specifikace pro tisk štítků na straně 22. Request Název Type Header RequestHeader RequestObject RouteTableRequest RouteTableRequest Název Type DistributionChannel Int ValidDate DateTime Response Název Request

Type Request


List String String ResponseStatus

Popis Hlavička requestu Instance třídy RouteTableRequest

Povinný A A

Popis Druh přepravní služby (1 – Parcel, 2 – Cargo) Datum platnosti

Povinný A A

Popis Vstupní data pro volanou metodu (nastaví se jen v případě, že při zpracování dojde k chybě) List položek routovací tabulky Chybová zpráva Chybový kód (seznam chybových kódů je zde) Status průběhu metody



Telefon: +420 951 277 777 Telefax: +420 951 220 259





RouteTable Název DistributionChannel Country Route ZipCodes ValidDate

Type Int String String ZipCodes Datetime

Délka 2 4

Popis Služba Země Trasa PSČ od/do Platnost

Příklad volání metody RouteTable Request: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body>
1 2015-09-21T00:00:00 Response: <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> 0000 CZ Geis CZ s.r.o. Zemská 211/I 337 01 Ejpovice Czech Republic


Telefon: +420 951 277 777 Telefax: +420 951 220 259





81 1 8109 2015-09-21T00:00:00 29444 29469 CZ 81 1 8111 2015-09-21T00:00:00 29300 29301 Processed

CreatePickUp Vytvoří svoz, který se váže k expedicím. Jedná se o avízo, aby zásilky byly vyzvednuty dle požadavku. Svozy lze objednávat na ten samý den při vytvoření požadavku, ale maximálně jen do 10:00. Poté musí být datum svozu nastaveno dle definice: aktuální den + 1, ale musí se jednat o pracovní dny. Request Název Type Header RequestHeader RequestObject PickUpRequest

Popis Hlavička requestu Instance třídy PickUpRequest



Telefon: +420 951 277 777 Telefax: +420 951 220 259



Povinný A A



PickUpRequest Název Type DistributionChannel Int DateFrom DateTo

Délka

DateTime DateTime?

CountItems Int TotalWeight Decimal Contact Contact Note String PickUpItems List TemperatureMode Int *povinné pro svoz Cargo ** Nabývá hodnot 1, 2

(9,2) 50

Popis Druh přepravní služby(1 – Parcel, 2 – Cargo) Datum a čas svozu od Datum a čas svozu do (den a měsíc musí být stejný jako DateFrom) Počet kusů Celková hmotnost (kg) Kontaktní údaje Poznámka Seznam položek svozu Kód teplotního režimu**

Povinný A A

A A A

PickUpItem Detail položky svozu. Název CountItems Weight Type Reference

Type Int Decimal String String

Délka

Popis Počet položek Hmotnost (kg) Typ manipulační jednotky Reference

(9,2) 3 50


Type Request


PickUp String String ResponseStatus

Povinný

Popis Vstupní data pro volanou metodu (nastaví se jen v případě, že při zpracování dojde k chybě) Prázdná třída Chybová zpráva Chybový kód (seznam chybových kódů je zde) Status průběhu metody

Příklad volání metody CreatePickUp Request: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> Geis CZ s.r.o. Zemská 211/I 337 01 Ejpovice Czech Republic


Telefon: +420 951 277 777 Telefax: +420 951 220 259





<Email>[email protected] +420951277777 5 2015-09-22T00:00:00 1 Poznámka ke svozu.

Response: <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> 0 Svoz přijat a potvrzen. Inserted



Telefon: +420 951 277 777 Telefax: +420 951 220 259





InsertExport Vytvoří zásilku typu expedice daného produktu (Parcel, Cargo). Expedici lze vytvořit na aktuální den, ale musí existovat svoz na tento den, jinak metoda skončí chybou. Pro vyplnění expedice může být potřeba znát několik údajů jako je seznam služeb – společné pro Parcel i Cargo (metoda AddServiceList), seznam sloučených zásilek – jen Parcel, seznam přepravních kusů (manipulačních jednotek, metoda WrapList) – jen Cargo. Objekt InsertExport se skládá z několika objektů, které mohou být zadány jako pole objektů (např. seznam služeb) viz. následující tabulka ExportRequest.

Request Název Type Header RequestHeader RequestObject ExportRequest

Popis Hlavička requestu Instance třídy ExportRequest

ExportRequest Název Type DistributionChannel Int

Délka

ShipmentNumber

String

11 / 13

PickUpDate

DateTime

Reference Note NoteDriver MergedShipment Weight ExportItems CoverAddress DeliveryAddress DeliveryContact ExportServices MergedPackages

String String String Bool Decimal List<ExportItem> Address Address Contact List<ExportService> List<MergedItem>

50 50 50 (9,2)

Povinný A A

Popis Druh přepravní služby(1 – Parcel, 2 – Cargo) Číslo balíku (pro Parcel, dle výstupu metody AssignRange, pro Cargo je číslo zásilky přiřazeno automaticky) Datum svozu (svoz musí být na tento den vytvořen) Reference zásilky Poznámka příjemci Poznámka pro řidiče Sloučená zásilka (pouze parcel) Hmotnost (v kg) (pouze parcel) Přepravní kusy Krycí adresa Dodací adresa Kontakt příjemce Seznam služeb zásilky Seznam sloučených zásilek (povinné při zadání parametru MergedShipment zadaném na „true“)

Povinný A A*

A*

A* A** A

*

*povinné pro svoz Parcel, ** povinné pro Cargo



Telefon: +420 951 277 777 Telefax: +420 951 220 259





ExportService Název Code Parameter_1 Parameter_2 Parameter_3 Parameter_4 Parameter_5

Type String String String String String String

Popis Kód služby Parametr 1 Parametr 2 Parametr 3 Parametr 4 Parametr 5

Povinný A

Parametry služeb Seznam služeb, ke kterým je nutno zadat parametry. Kód ADL ADZ

Parameter_1 Parameter_2 Parameter_3 E-mail Telefon nebo Email AOZ Telefon nebo Email APZ Telefon nebo Email B2C Telefon COD Hodnota dobírky Měna dobírky Variabilní symbol POJ Hodnota Měna pojištění TEL Telefon VM* Kód VM ve tvaru: VM-[0000] nebo [0000] *U služby VM je nutné zadat i kontaktní osobu (Jméno a telefon) ExportItem Název Type Délka CountItems Int Description String 50 Type String 2 Reference String 50 Weight Decimal (9,2) Volume Decimal (9,3) Height Decimal (9,2) Width Decimal (9,2) Length Decimal (9,2) ** Povinný pro zadávání zásilek na území Polska



Telefon: +420 951 277 777 Telefax: +420 951 220 259


Parameter_4

Parameter_5

IBAN

BIC

Popis Počet položek Popis Typ Reference Hmotnost (kg) Objem (v m^3) Výška (v metrech) Šířka (v metrech) Délka (v metrech)


Povinný A A A A** A** A**



MergedItem Název PackNumber Weight

Type String Decimal

Délka 20 (9,2)


Type Request


Export String String ResponseStatus

Popis Číslo balíku Hmotnost (kg)

Povinný

Popis Vstupní data pro volanou metodu (nastaví se jen v případě, že při zpracování doje k chybě) Prázdná třída Chybová zpráva Chybový kód (seznam chybových kódů je zde) Status průběhu metody

Příklad volání metody InsertExport Request: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body>
Ejpovice CZ Josef Novák <Street>Zemská 211/I 33701 <Email>[email protected] Kontaktni osoba +420951277777 Geis CZ s.r.o. Zemská 211/I 337 01 Ejpovice Czech Republic


Telefon: +420 951 277 777 Telefax: +420 951 220 259





1 <ExportItems> <ExportItem> <ExportServices> <ExportService> 2 <Parameter_1>10 <Parameter_2>CZK <Parameter_3 /> <Parameter_4 /> <Parameter_5 /> <MergedPackages> <MergedItem> <PackNumber /> Poznámka k zásilce Poznámka řidiči <PartnerNumber /> 2015-09-22T00:00:00 Zásilková reference <ShipmentNumber>02093120001 <Weight>11.5

Response: <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> 0000 Geis CZ s.r.o. Zemská 211/I 337 01 Ejpovice Czech Republic


Telefon: +420 951 277 777 Telefax: +420 951 220 259





02093120001 Inserted

InsertOrder Vytvoří zásilku typu objednávka daného produktu (Parcel, Cargo). Objednávku lze vytvořit nejdříve na následující pracovní den. Pro vyplnění objednávky může být potřeba znát několik údajů jako je seznam služeb – společné pro Parcel i Cargo (metoda AddServiceList), seznam sloučených zásilek – jen Parcel, seznam přepravních kusů (manipulačních jednotek, metoda WrapList) – jen Cargo. Objekt InsertOrder se skládá z několika objektů, které mohou být zadány jako pole objektů (např. seznam služeb) viz následující tabulka OrderRequest. Request Název Type Header RequestHeader RequestObject OrderRequest

Popis Hlavička requestu Instance třídy OrderRequest



Telefon: +420 951 277 777 Telefax: +420 951 220 259



Povinný A A



OrderRequest Název Type DistributionChannel Int

Délka

PickUpDate Reference

DateTime String

Note NoteDriver Weight Volume MergedOrder ExportItems

String String Decimal Decimal Bool List<ExportItem>

SenderAddress SenderContact DeliveryAddress DeliveryContact ExportServices MergedOrders

Address Contact Address Contact List<ExportService> List<MergedItem>

Popis Druh přepravní služby(1 – Parcel, 2 – Cargo) Datum svozu Zákaznická reference zásilky Poznámka příjemci Poznámka řidiči Hmotnost (kg) Objem (m^3) Sloučená objednávka Seznam přepravních kusů Adresa odesílatele Kontakt odesílatele Adresa příjemce Kontakt příjemce Seznam služeb Seznam sloučených zásilek (povinné při parametru MergedOrder zadaném na „true“)

50 50 50 (9,2) (9,3)

Povinný A A

A* A* A**

A A A**

*povinne pro svoz Parcel, ** povinné pro Cargo Response Název Request

Type Request


Order String String ResponseStatus

Order Název Type PackNumber String MergedPackNumbers List<String>

Popis Vstupní data pro volanou metodu (nastaví se jen v případě, že při zpracování doje k chybě) Informace o vložené objednávce Chybová zpráva Chybový kód (seznam chybových kódů je zde) Status průběhu metody

Délka 20

Popis Číslo balíku Seznam čísel sloučených objednávek



Telefon: +420 951 277 777 Telefax: +420 951 220 259





Příklad volání metody InsertOrder Request: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body>
Ejpovice CZ Josef Novák <Street>Zemská 211/1 33701 <Email>[email protected] +420951277777 1 <ExportItems> <ExportItem> <ExportServices> <ExportService> 15 <Parameter_1 /> <Parameter_2 /> <Parameter_3 /> <Parameter_4 /> <Parameter_5 /> Geis CZ s.r.o. Zemská 211/I 337 01 Ejpovice Czech Republic


Telefon: +420 951 277 777 Telefax: +420 951 220 259





<MergedOrder>true <MergedOrders> <MergedItem> <PackNumber /> <Weight>6 2015-09-22T00:00:00 <SenderAddress> Říčany CZ František Dobrota <Street>Modletice 128, AOS 2 25101 <SenderContact> <Email>[email protected] +420951277777 <Weight>5

Response: <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> 0000 01061224431 Geis CZ s.r.o. Zemská 211/I 337 01 Ejpovice Czech Republic


Telefon: +420 951 277 777 Telefax: +420 951 220 259





01061224430 Inserted

AssignRange Přidělí číselnou řadu (slouží pouze pro zásilky typu Parcel). Každému novému zákazníkovi bude přidělena číselná řada podle předpokládaného počtu zásilek. V případě, že bude prvotní rozsah vyčerpán a vznikne nový požadavek, metoda zjistí, kolik zásilek již zákazník poslal a dle vnitřního algoritmu buď přiřadí novou číselnou řadu, nebo vypíše hlášku, že číselnou řadu nelze přiřadit, protože je k dispozici ještě dostatek volných čísel zásilek. Request Název Type Header RequestHeader RequestObject RangeRequest RangeRequest Název Type DistributionChannel Int TransportType Range

String Int

Popis Hlavička requestu Instance třídy RangeRequest

Povinný A A

Délka Popis Druh přepravní služby (1 – Parcel, 2 – Cargo) 1 Typ přepravy (1- vnitro, 2- mezinárodní) Rozsah (Počet zásilek)


Type Request


Range String String ResponseStatus

Popis Vstupní data pro volanou metodu (nastaví se jen v případě, že při zpracování dojde k chybě) Informace o rozsahu Chybová zpráva Chybový kód (seznam chybových kódů je zde) Status průběhu metody

Range Název RangeLow RangeHigh

Type String String

Popis Dolní hranice rozsahu Horní hranice rozsahu



Telefon: +420 951 277 777 Telefax: +420 951 220 259



Povinný A A



Příklad volání metody AssignRange Request: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body>
1 5 1

Response: <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> 0 Rozsah přidělen. 02093000075 02093000071 Processed



Telefon: +420 951 277 777 Telefax: +420 951 220 259





IsHealthy V případě úspěšného zavolání metody, služba odpoví textem „Healthy“. Tato metoda slouží k jednoduchému testu, zda služba běží. Příklad volání metody IsHealthy Request: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body>

Response: <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> Healthy



Telefon: +420 951 277 777 Telefax: +420 951 220 259




G-Service. popis webové služby

Recommend Documents