G-Service. Web service description

G-Service web service – documentation Str. 1/38

G-Service Web service description

DOCUMENT VERSION: 1.8 DATE:

2. 12. 2015

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.


About G-Service G-Service is a web service designed for customers of Geis group, which allows customers to fully automatically process transport entry in both Geis group products (cargo and parcel transport). The web service allows entering shipments (expedition or orders in mode), status detection and other information about shipments, ordering pick-up and detection additional services available for the customer. The use of the web service enables full integration in the production process, storage systems or web shop for the Geis group customers. Requirements for the web service and especially responses from the web service are structured in XML format and allow further processing on the part of customers´ systems. G-Service works on the principle of SOAP architecture (https://en.wikipedia.org/wiki/SOAP). The access is allowed via secured HTTP protocol (HTTPS) only. To test the web service, for example, the open source program SoapUI (http://www.soapui.org) – may be used. To access the web service it is necessary to have access data - customer code and password. These access data are communicated on request from the assigned business manager from the Geis group. Before moving to full operation it is always necessary to go through the first integration tests in the test environment which are done by technical department of customer in cooperation with EDI department of Geis group. The web service is available for customers from the Czech Republic and Slovakia at the following addresses: • •

https://gclient.geis.cz/GService/GService.svc- access to the production environment https://gclient.geis.cz/GServiceTest/GService.svc –access to the test environment

The web service is available for customers from Poland at the following addresses: • •

https://gclient.etlogistik.com/GServicetest/GService.svc - access to the production environment https://gclient.etlogistik.com /GServiceTest/GService.svc – access to the test environment

For the successful implementation of the web service in customer environment and understanding the broader context it is recommended to study the Manual for system integration, which is available on the technical support web site of the Geis group in the downloads section at: • •

www.baliky.cz/podpora orwww.baliky.sk/podpora (Czech version) www.etlogistik.com/support (English version)



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





Content About G-Service .................................................................................................................................................. 2 ChangeLog........................................................................................................................................................... 4 Implementation steps on customer side ............................................................................................................ 5 Minimal test scenario ......................................................................................................................................... 5 Web service base classes .................................................................................................................................... 5 Request ........................................................................................................................................................... 6 RequestHeader ............................................................................................................................................... 6 Language ......................................................................................................................................................... 6 Currency .......................................................................................................................................................... 6 Response ......................................................................................................................................................... 6 ResponseStatus ............................................................................................................................................... 6 ZipCodes.......................................................................................................................................................... 7 Address ........................................................................................................................................................... 7 Contact ............................................................................................................................................................ 7 Errorcodes........................................................................................................................................................... 7 Web service methods ..................................................................................................................................... 8 ServiceList ....................................................................................................................................................... 8 AddServiceList ............................................................................................................................................... 10 StatusList ....................................................................................................................................................... 13 WrapList ........................................................................................................................................................ 15 DeliveryRouting ............................................................................................................................................ 17 ShipmentDetail ............................................................................................................................................. 19 RouteTable .................................................................................................................................................... 23 CreatePickUp ................................................................................................................................................ 25 InsertExport .................................................................................................................................................. 28 InsertOrder ................................................................................................................................................... 32 AssignRange .................................................................................................................................................. 35 IsHealthy ....................................................................................................................................................... 37



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





ChangeLog Version 1.0

Date 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

2015-09-21 2015-11-13

1.8

2015-12-02

Change Service creation. Basic methods: - ServiceList - AddServiceList - StatusList - WrapList - DeliveryRouting - ShipmentDetail - RouteTable - CreatePickUp - InsertExport - InsertOrder - AssignRange Added list of possible currencies Currency Changes in input: - To ExportService added Parameter_5 - InsertOrder corrected parameter MergedOrder - Edited mandatory parameters in InsertExport - Language CS changed to CZ - Password for logging extended to 20 characters Changes in output: - method ShipmentDetail – PackageRow added customer references (Reference) - method InserExport added list of numbers merged shipments (MergedPackNumbers) - method InsertOrder added list of numbers merged orders (MergedPackNumbers) Changes in input: - InsertOrder: added parameter for entering merged orders (MergedOrders) - InsertOrder: removed parameter CountItems - InsertExport: added parameter for entering merged shipments (MergedPackages) - Corrected control of class Contact, now it is checking the format of Email and Telephone number. Changes in input: - DeliveryRouting parameter CountryIn changed to optional for Parcel Updating the obligations parameters. Correction. Supplementing dimensions parameters for order. Changed description of parameters for method DeliveryRouting Added web service description, implementation scenario



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





Implementation steps on customer side For web service implementation, following steps are required on customer side: Check the option of API requests and reply processing via HTTPS protocol in customer logistic software Understanding basic concepts in document Manual for system integration (product types, shipment routing, additional shipment services, labels print and hand-over protocol) and this documentation Require access to API interface of test web service from Geis sales manager Test basic methods and classes, response processing, return codes management Create labels and hand-over protocol and send for validation to Geis sales manager Agreement of schedule and go-live

Minimal test scenario In terms of web service testing in test environment it is important to have used at least following methods:

CreatePickup (collection create) InsertExport (insert expedition shipment for each product, that is planned to be used by customer - cargo / parcel) with use of supplemental methods AddServiceList, DeliveryRouting and WrapList (only for cargo product) InsertOrder (insert order shipment for each product, that is planned to be used by customer) AssignRange (assign shipment number range) – only for parcel product ShipmentDetail (getting shipment detail) with use of supplemental method StatusList Note: before inserting expedition shipment it is necessary to create collection order for given day. In collection order the maximum shipment quantity and approximate total weight for all shipments of that day must be specified.

Web service base classes The base classes are mentioned below. They are used in almost all methods of service. Geis CZ s.r.o. Zemská 211/I 337 01 Ejpovice Czech Republic


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





Request Name Type Header RequestHeader RequestObject Generic

Description Header of request Input object (specific for call method)

Mandatory Y Y

RequestHeader Name Type Description CustomerCode String Customer code Password String Password for login Language Language Language for communication *it does not have to be mandatory for all calls methods.

Mandatory Y* Y* Y

Language List of possible languages: Value CZ SK EN DE PL

Name/Description Czech Slovak English German Polish

Currency List of possible currencies: Value UND CZK EUR CHF USD PLN HUF

Name/Description Undefined value currency Czech crown Euro Swiss franc American dollar Polish Zloty Hungarian forint

Response Name Request

Type Request

ResponseObject ErrorMessage ErrorCode Status

Generic String String ResponseStatus

Description Input for the called method (it is set only in the case when it ends with an error). Output object (specified for call method) Error message. Error code (List of error codes is here) Status of method processing

ResponseStatus Value

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


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





Inserted Deleted Updated ErrorOccurred AccesDenied Processed NoDataFound

Insert was successful. Delete was successful. Update was successful. Error occurred during the processing. Access denied (invalid combination of customer code and password) Listing/Process in passed right. No data found.

ZipCodes Name ZipCodeFrom ZipCodeTo

Type String String

Length 10 10

Description Zip code from Zip code to

Address Name Name Name2 Street City ZipCode Country

Type String String String String String String

Length 50 50 50 50 10 2

Description Name Name supplement Street City ZipCode Country in ISO 3166-1 alpha-2 format

Contact Contact information Name Email FullName Phone

Type String String String

Length 50 50 20

Description E-mail Full name Phone number in an international format (e.g. +420 111 222 333)

Errorcodes Code 1000 1001 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009

Description Access denied Unauthorized access! [#Name of parameter#] is a mandatory parameter! Distribution channel must have value 1 or 2! Value [#Value from list of values#] was not found! No data found Routing table for this day does not exist! This type of transport service is not allowed for this pickup address! Wrong range of data! Type UM [#Typeunit#] is not allowed for this customer! Enabled distribution channel [#distribution channel identifier#]! Type of transport may have value 1- national / 2-international Geis CZ s.r.o. Zemská 211/I 337 01 Ejpovice Czech Republic


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





2010 2011

Parcel number has already been used! Parcel number does not belong to the numerical series assigned to the customer! 2012 This kind of transport service is not allowed for this customer: [#name of the transport service#]! 2013 Total weight and the weight of individual items do not match. 2015 Pick-up for the current day can be created only until [#TEXT#] clock. 2016 The specified service [#TEXT#] cannot be processed, because it does not exist in the list of services. The service must be set up. Contact support. 2017 [#TEXT#] must be in international form (e.g. +420 111 222 333). Allowed preferences are [#TEXT-1#]. 2018 [#TEXT#] must be in correct form (e.g. [email protected])! 2019 [#TEXT#] is not a valid e-mail or phone![#TEXT-1#] [#TEXT-2#]* 2020 Order cannot be placed for this day. 2021 [#TEXT#] must be equal to or greater than [#TEXT-1#]! 2022 Entered code for pickup point is not valid! 2023 Entered pickup point code [#TEXT#] was not found. 3000 Error service GClientWS! [#Error message from the service GClientWS #] 9999 Unexpected Error! *it contains a description of errors 2017 and 2018

Web service methods ServiceList It returns list of transportation services that are set in the primary system. It can return these values: Value 10 11 20 21

Name/Description Parcel expedition Parcel orders Cargo expedition Cargo orders

Request Name Type Header RequestHeader RequestObject ServiceRequest


Type Request

ResponseObject List<Service> ErrorMessage String

Description Header of request Empty class

Mandatory Y

Description Input data for the called method (it is set only in the case when it ends with an error). List of transport services Error message.



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





ErrorCode Status

String ResponseStatus

Error code (list of error codes is here) Status of method processing

Service Detail of transport service. Name Code Name

Type String String

Length 3 30

Description Transport service code Transport service name

An example of ServiceList method 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 EN <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 10 Geis CZ s.r.o. Zemská 211/I 337 01 Ejpovice Czech Republic


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





parcel dispatch 11 parcel orders 20 cargo dispatch 21 cargo orders Processed

AddServiceList It returns the list of additional services that the customer has set up in the primary system. In these service may be included for example COD –Cash on delivery, POJ – insurance etc. Request Name Type Header RequestHeader RequestObject AddServiceRequest

Description Header of request Instance of the class AddServiceRequest

AddServiceRequest Name Type Service String

Length 2

DeliveryCountry String

2

Mandatory Y Y

Description Type of transport service (according to the output ServiceList) Country of recipient in ISO 3166-1 alpha-2 form

Mandatory Y Y*

*Parameter is mandatory only for Cargo



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






Type Request


List String String ResponseStatus

Description Input data for the called method (it is set only in the case when it ends with an error) List of services which customer can use. Error message. Error code (list of error codes is here) Status of method processing.

AddService Detail of service. Name Code Abbreviation Description ZipCodeFrom ZipCodeTo

Type Int String String String String

Length 2 3 30 10 10

Description Service Id Service abbreviation Service description. Zip code from (if set) Zip code to (if set)

An example of AddServiceList call method Here is an example below in which we run method which returns what services are authorized for customer for Parcel product. Moreover we are interested only in expedition. 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>
22054861 EN <Password>wspwd 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: We can see in the answer that customer has assigned services COD, POJ and D12. For service D12 we can notice that another element ZipCodeList is given. This list identifies for which recipient´s Zip code it is possible to use D12 service. In case that D12 service is used in InsertExport method and recipient Zip code is not in the interval Zip code, the expedition won´t be processed and service will display an error message. <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> 0000 COD 2 Cash on delivery 10 POJ 3 Add. insurance 10 D12 6 Delivery within 12hrs 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 It returns a list of the shipments statuses which are visible in Track & Trace. Request Name Type Header RequestHeader RequestObject StatusRequest StatusRequest Name Type DistributionChannel Int


Type Request

ResponseObject List<Status> ErrorMessage ErrorCode Status

String String ResponseStatus

Description Header of request StatusRequest instance class

Mandatory Y Y

Description Type of transport service (1 – Parcel, 2 – Cargo)

Mandatory Y

Description Input data for the called method (it is set only in case when it ends with an error) List of statuses according to the transport service Error message Error code (list of error codes is here) Status process method.

Status Detail of status of the shipment. Name Code Description DistributionChannel

Type String String Int

Length 3 20 1

Description Status code Service description Type of transport service (1 – Parcel, 2 – Cargo)



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





An example of StatusList call method 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 Pick up of parcel 1 11 Cancelled 1 12 Geis CZ s.r.o. Zemská 211/I 337 01 Ejpovice Czech Republic


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





Pick up depot 1 20 received at depot 1 Processed

WrapList This returns a list of manipulation units allowed for the customer in the primary system. Request Name Type Header RequestHeader RequestObject WrapRequest Response Name Request

Description Header of request Instance of the WrapRequest class (empty class)

Type Request

Description Input data for the called method (it is set only in case it ends with an error) List of manipulation units which are allowed for the customer. Error message Error code (list of error codes is here) Status process method.

ResponseObject List<Wrap> ErrorMessage ErrorCode Status

Mandatory Y Y

String String ResponseStatus

Wrap Detail of the manipulation unit. Name Code Description Returnable

Type String String Bool

Length 3 50

Description Manipulation unit code Manipulation unit description Returnable package



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





An example of WrapList call method 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 Europallet true KH Half pallet 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 It returns country of the recipient, depot and direction. This information is important for compilation of the label - see System integration manual for customers section 2.4. Specification for printing labels on the page 22. Request Name Type Description Header RequestHeader Header of request RequestObject DeliveryRoutingRequest Instance of class DeliveryRoutingRequest

Mandatory Y Y

DeliveryRoutingRequest Name Type DistributionChannel Int

Mandatory Y

Length

CountryIn String ZipCodeIn String CountryOut String ZipCodeOut String TemperatureMode String *Parameter is mandatory for Cargo Response Name Request

Type Request


DeliveryRouting String String ResponseStatus

DeliveryRouting Name Type DeliveryRoute String DepCode String

2 10 2 10

Description Type of transport service (1 – Parcel, 2 – Cargo) Sender´s country Sender´s Zip code Recipient ´s country Recipient ´s Zip code Temperature mode (not used)

Y Y Y* Y

Description Input data for the called method (it is set only in case it ends with an error) Information about routing. Error message Error code (list of error codes is here) Status of method processing

Length 4 3

Description Delivery routes code Depot code



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





An example of DeliveryRouting call method 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 It returns information about shipment. If the information about customer is sent and shipment is created, this method returns information about shipment services, recipient´s address and sender´s address. If customer/payer does not create shipment, it will only display the statuses of the shipment. Request Name Type Header RequestHeader RequestObject ShipmentRequest ShipmentRequest Name Type DistributionChannel Int ShipmentNumber

String


Type Request


Shipment String String ResponseStatus

Description Header of request Instance of the class ShipmentRequest

Mandatory Y Y

Length Description Type of transport service (1 – Parcel, 2 – Cargo) 11 / Number of the shipment parcel / cargo 13

Mandatory Y Y

Description Input data for the called method (it is set only in case it ends with an error) Details about shipment Error message Error code (list of error codes is here) Status of method processing.

Shipment Detail of the shipment. Name ShipmentNumber

Type String

Length 11 / 13

ShipmentNumberCust String DelivPerson String

50 50

Weight CodVarCode

Decimal String

(5,2) 10

CodValue DelivDate BorderDate

Decimal DateTime DateTime

(12,2)



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


Description Number of the shipment parcel / cargo Customer´s reference Name of the shipment recipient Weight of the shipment Payment identification code for cash on delivery Cash on delivery value Date of delivery Sending date (date of loading to main run) Č.ú.: 1545471501/2700 (CZK) Č.ú.: 1545471560/2700 (EUR) EUR IBAN: CZ56 2700 0000 0015 45471560 CZK IBAN: CZ97 2700 0000 0015 45471501 SWIFT: BACXCZPP

Channel PC PC PC PC PC PC PC C



Volume RecAddress SendAddress History ColliHistory

Decimal (9,3) Address Address List<PackageHistory> List

Services Rows

List<PackageService> List<PackageRow>

Volume Address of the recipient Address of the sender List of shipment statuses List of statuses for individual pieces of shipment List of shipment services List of shipment rows

C PC PC PC C PC C

PackageHistory Detail of shipment status. Name StatusDate StatusName DepName Description

Type DateTime String String String

Length 50 50 50

Description Date of status Name of status Depot of status Note

ColliHistory Item of the status piece of shipment Name StatusDate StatusName DepName Description ColliNumber

Type DateTime String String String String

Length Description Date of status 50 Name of status 50 Depot of status 50 Note 25 Number of the piece

PackageService Item of shipment service Name Name Price Currency

Type String Decimal Currency

Length 30 (12,2)

Description Name of service Service price Currency

Length

Description Number of pieces Package Description Weight Customer´s reference Volume Dimension (return empty value)

PackageRow Item of the shipment row Name CountItems PackingType Description Weight Reference Volume Dimension

Type Int String String Decimal String Decimal String

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



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





Error codes Code 0 1 2 3 4

Shipment status OK OK OK STORNO Není

Description Non-delivery, it has status Delivery, it has status Does not have status yet Shipment was cancelled. Shipment does not exist.

An example of ShipmentDetail call method 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 Shipment OK - undelivered, has statuses. Geis CZ s.r.o. Zemská 211/I 337 01 Ejpovice Czech Republic


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





0001-01-01T00:00:00 1,00 123 0001-01-01T00:00:00 Reference to shipment 2015-09-07T08:23:03.763 Customer reference 2015-09-07T08:23:03.83 Recipient’s phone 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 surcharge 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 Transport costs 0.0000 UND Cash on delivery 0.0000 UND Private address 0.0000 02093000033 Reference of shipment 0 4.00 Processed

RouteTable It returns route table. It is possible to return the table for 7 days in advance. This information is important for creation of label see System integration manual for customers section 2.4.Specification for printing labels on the page 22. Request Name Type Header RequestHeader RequestObject RouteTableRequest RouteTableRequest Name Type DistributionChannel Int ValidDate DateTime

Description Header of request Instance of the class RouteTableRequest

Mandatory Y Y

Description Type of transport service (1 – Parcel, 2 – Cargo) Validity date



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



Mandatory Y Y




Type Request


List String String ResponseStatus

Description Input data for the called method (it is set only in case it ends with an error) List of items from routing table Error message Error code (list of error codes is here) Status of method processing

RouteTable Name DistributionChannel Country Route ZipCodes ValidDate

Type Int String String ZipCodes Datetime

Length 2 4

Description Service Country Route Zip code from/to Validity

An example of RouteTable call method 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/"> Geis CZ s.r.o. Zemská 211/I 337 01 Ejpovice Czech Republic


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





<s:Body> 0000 CZ 81 1 8109 2015-09-21T00:00:00 29444 29469 CZ 81 1 8111 2015-09-21T00:00:00 29300 29301 Processed

CreatePickUp It creates pick up that belongs to expedition. It is an advice that shipments have been picked up according to the requirement. The pickup may be ordered on the same day when you create requirement, but maximum until 10:00 o´clock. After that, the date of pick up must be set up according to the definition: current day + 1, but it must be a working day.



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





Request Name Type Header RequestHeader RequestObject PickUpRequest

Description Header of request Instance of class PickUpRequest

PickUpRequest Name Type DistributionChannel Int DateFrom DateTo

Length

DateTime DateTime?

CountItems Int TotalWeight Decimal Contact Contact Note String PickUpItems List TemperatureMode Int *mandatory for Cargo pick up ** Assumes values 1, 2

(9,2) 50

Mandatory Y Y

Description Type of transport service(1 – Parcel, 2 – Cargo) Date and time of pick up from Date and time of pick up to (day and month must be same as DateFrom) Number of pieces Total weight (kg) Contact information Note List of pick up items Code of temperature mode **

Mandatory Y Y

Y Y Y

PickUpItem Detail of pick up item. Name CountItems Weight Type Reference

Type Int Decimal String String

Length (9,2) 3 50

Response Název Request

Type Request


PickUp String String ResponseStatus

Description Number of items Weight (kg) Type of manipulating item Reference

Mandatory

Description Input data for the called method (it is set only in case it ends with an error) Empty class Error message Error code (List of error codes is here) Status of method processing



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





An example of CreatePickUp call method 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>
<Email>[email protected] +420951277777 5 2015-09-22T00:00:00 1 Note to pick up.

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


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





Pick up accepted and confirmed. Inserted

InsertExport It creates type of shipment expedition for the product (Parcel, Cargo). Expedition can be created for current day, but there must be pick up for this day, otherwise the method ends with an error. To complete the expedition you may need to know several data such as list of services – common for Parcel and Cargo (method AddServiceList), list of merged shipments – only for Parcel, list of transport items (manipulating items, WrapList method) – only for Cargo. Object InserExport is consists of several objects which can be entered as field of objects (e.g. List of services) see next table ExportRequest.

Request Name Type Header RequestHeader RequestObject ExportRequest

Description Header of request Instance of class ExportRequest

Mandatory Y Y

ExportRequest Name Type DistributionChannel Int

Mandatory Y

ShipmentNumber

Length Description Type of transport service (1 – Parcel, 2 – Cargo) String 11 / Number of shipment (for Parcel, 13 according to output method AssignRange, for Cargo shipment number is assigned automatically) DateTime Date of pick up (pick up must be created for this date) String 50 Shipment references String 50 Note for recipient String 50 Note for driver Bool Merged shipment (only for parcel) Decimal (9,2) Weight (in kg) (only for parcel) List<ExportItem> Transport items Address Cover address Address Delivery address Contact Contact for the recipient List<ExportService> List of shipment services

Y*

PickUpDate Reference Note NoteDriver MergedShipment Weight ExportItems CoverAddress DeliveryAddress DeliveryContact ExportServices



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



Y*

Y* Y** Y



MergedPackages

List of merged shipments (mandatory when parameter MergedShipment is entered as „true“) *it is mandatory for pick up Parcel, **it is mandatory for Cargo ExportService Name Code Parameter_1 Parameter_2 Parameter_3 Parameter_4 Parameter_5

List<MergedItem>

Type String String String String String String

Description Service code Parameter 1 Parameter 2 Parameter 3 Parameter 4 Parameter 5

Y*

Mandatory Y

Services parameter List of services where specific parameters must be entered. Code Parameter_1 Parameter_2 Parameter_3 Parameter_4 ADL E-mail ADZ Phone number or E-mail AOZ Phone numberor E-mail APZ Phone number or E-mail B2C Phone number COD Value of cash on Currency of cash Payment IBAN delivery on delivery identification code POJ Value of Currency insurance TEL Phone number VM* Code VM in form: VM-[0000] or [0000] *In VM service it is necessary to enter contact person (Name and phone number) ExportItem Name CountItems Description Type Reference Weight Volume Height Width

Type Int String String String Decimal Decimal Decimal Decimal

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



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


Description Number of items Description Type References Weight (kg) Volume (v m^3) Height (in meters) Width (in meters) Č.ú.: 1545471501/2700 (CZK) Č.ú.: 1545471560/2700 (EUR) EUR IBAN: CZ56 2700 0000 0015 45471560 CZK IBAN: CZ97 2700 0000 0015 45471501 SWIFT: BACXCZPP

Parameter_5

BIC

Mandatory Y Y Y Y** Y** 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.


Length Decimal **It is mandatory in Poland MergedItem Name PackNumber Weight

Type String Decimal

(9,2)

Length (in meters)

Y**

Length 20 (9,2)

Description Number of shipment Weight (kg)

Mandatory


Type Request


Export String String ResponseStatus

Description Input data for the called method (it is set only in case it ends with an error) Empty class Error message Error code (list of error codes is here) Status of method processing

An example of InsertExport call method 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] Josef Novák Geis CZ s.r.o. Zemská 211/I 337 01 Ejpovice Czech Republic


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





+420951277777 1 <ExportItems> <ExportItem> <ExportServices> <ExportService> 2 <Parameter_1>10 <Parameter_2>CZK <Parameter_3 /> <Parameter_4 /> <Parameter_5 /> <MergedPackages> <MergedItem> <PackNumber /> Note to shipment Note to driver <PartnerNumber /> 2015-09-22T00:00:00 Reference to shipment <ShipmentNumber>02093120001 <Weight>11.5

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


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





0000 02093120001 Inserted

InsertOrder It creates type of shipment order for the product (Parcel, Cargo). The order can be created first for the next working day. To complete the order some data are required such as list of services – common for Parcel and Cargo (method AddServiceList), list of merged shipment – only Parcel, list of transport pieces (manipulating items, WrapList method) – only for Cargo. Object InsertOrder is created from several objects that may be entered as field of objects (e.g. list of services) see following table OrderRequest. Request Name Type Header RequestHeader RequestObject OrderRequest

Description Header of request Instance of class OrderRequest

OrderRequest Name Type DistributionChannel Int

Length

PickUpDate Reference

DateTime String

Note NoteDriver Weight Volume MergedOrder ExportItems SenderAddress SenderContact DeliveryAddress DeliveryContact ExportServices

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

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



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


Mandatory Y Y

Description Type of transport service (1 – Parcel, 2 – Cargo) Date of pick up Customer´s reference of shipment Note to recipient Note for driver Weight (kg) Volume (m^3) Merged order List of transport pieces Sender´s address Sender´s contact Recipient´s address Recipient´s contact List of services Č.ú.: 1545471501/2700 (CZK) Č.ú.: 1545471560/2700 (EUR) EUR IBAN: CZ56 2700 0000 0015 45471560 CZK IBAN: CZ97 2700 0000 0015 45471501 SWIFT: BACXCZPP

Mandatory Y Y

Y* Y* Y** Y Y Y**



MergedOrders

List<MergedItem>

List of merged shipments (mandatory for MergedOrder parameter entered to „true“)

*mandatory for Parcel pickup, ** mandatory for Cargo Response Name Request

Type Request


Order String String ResponseStatus

Description Input data for the called method (it is set only in case it ends with an error) Information about entered order Error message Error code (list of error code is here) Status of method processing

Order Name Type PackNumber String MergedPackNumbers List<String>

Length 20

Description Number of parcel List of numbers merged orders

An example of InsertOrder call method 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 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 1 <ExportItems> <ExportItem> <ExportServices> <ExportService> 15 <Parameter_1 /> <Parameter_2 /> <Parameter_3 /> <Parameter_4 /> <Parameter_5 /> <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 Geis CZ s.r.o. Zemská 211/I 337 01 Ejpovice Czech Republic


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





<Weight>5

Response: <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> 0000 01061224431 01061224430 Inserted

AssignRange It allocates number series (used only for Parcel shipment). To each new customer the number series is allocated according to the expected number of shipments. In case primary range is exhausted and a new requirement is created, the method finds, how many shipments customer has already sent and according to internal algorithm it assigns a new number series or displays a message that number series cannot be assigned, because there are still enough free numbers of shipments. Request Name Type Header RequestHeader RequestObject RangeRequest RangeRequest Name

Type

Description Header of request Instance of class RangeRequest

Length Description



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


Mandatory Y Y

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



DistributionChannel Int TransportType

String

Range

Int

Type of transport service (1 – Parcel, 2 – Cargo) Type of transport (1- internal, 2international) Range (Number of shipment)

1


Type Request


Range String String ResponseStatus

Description Input data for the called method (it is set only in case it ends with an error) Information about range Error message Error code (list of error code is here) Status of method processing

Range Name RangeLow RangeHigh

Type String String

Description Lower limit of range Upper limit of range

Y Y

An example of AssignRange call method 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 Geis CZ s.r.o. Zemská 211/I 337 01 Ejpovice Czech Republic


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





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

IsHealthy In case of successful call method, this service answers with the text “Healthy”. This method is used for simple text in case that service is running. Example of IsHealthy call method 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 Geis CZ s.r.o. Zemská 211/I 337 01 Ejpovice Czech Republic


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







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




G-Service. Web service description

Recommend Documents