Price Online Sweden API. Version 2.8

Transcription

1 Price Online Sweden API Version 2.8

2 Date: Sida 2 av 17 Revision history Version Date Comments Chges according to Prisfrågas förvaltningspaket Budget is no longer a valid product. Weight (consignment_gross_weight) is given as a float with the maximum of one decimal. Extra Gotld: New field (response), only for goods. Comfort chges name to System Appendix B is removed. All error messages d info messages are being sent from Mainframe (both code d text). Appendix C Appendix B Codes in Appendix B updated Three new types of home delivery d a new product Privpak. The field is_home_delivery is now of type Int where four different values c be chosen as long as Privpak is chosen. PAK, other product has been added as well as contract_condition_code Examples has been updated Chges in fields d appendix The following fields are affected in chapter Message IFTMIN: - consignment_length - New - consignment_width - New - consignment_height - New - consignment_cube - C also be used for product parcel Updated Appendix A: Chged country codes to EATA codes. If there is more one price for a country, a digit is used to get unique codes. Updated Appendix A: Removed country Madeira Chges in fields The following fields are affected in chapter Message IFTMIN: - is_expded_insurce - New (has replaced expded_insurce) - expded_insurce - Replaced by is_expded_insurce (field still exists) - is_parcel_pickup_work - New - is_home_delivery - Modified (new for Parcel) The following field is affected in chapter Message IFTMCS: - parcel_pickup_work_fee - New Table updated with country codes. Added Världspaket (WWP) d missing countries Correction of the Release Following fields are affected in chapter Message IFTMIN request: <departure_place_name - Added

3 Date: Sida 3 av 17 <destination_place_name - Added <consignor_zip_number - Modified (no longer mdatory, used together with or instead of destination_place_name) <consignee_zip_number - Modified (no longer mdatory, used together with or instead departure_place_name) The release for POL is completed. Following fields are affected in chapter Message IFTMIN request: is_home_delivery - New is_special - New is_parcel_pickup - New is_logistic_parcel - New departure_place_name - Removed destination_place_name - Removed consignor_zip_number - Modified (now mdatory for all except PAR ) consignee_zip_number - Modified (now mdatory for all except PAR ) contract_condition_code - Modified ( DIR, SPC d HMD are removed as products) Following fields are affected in chapter in chapter in chapter Message IFTMCS response: home_delivery_fee - New special_fee - New minimum_fee_deficit - New DIR, HMD och SPC are removed as product choice for contract_condition_code New information code (4) is added in Appendix B Chged conditions for mdatory fields when a request is made Added field: customs_fee Added fields: edi_fee, departure_place_charge, destination_place_charge, departure_place_type, destination_place_type, trsport_document_number_charge, distribution_charge, information in chapter Message IFTMCS response Added fields: piece, number_of_pallet_places, is_edi_customer in chapter Message IFTMIN request. Added countries: Latvia, Lithuia, Estonia, Cyprus, Greece, Slovenia, Slovakia, Czech Republic. Removed country: Portugal (Madeira) Updated the variable country_code (IFTMIN) from 2 to 3 characters d added available country codes in Appendix A.

4 Date: Sida 4 av New version of application, i.e. PriceOnline 3. Added fields: country_code, percentage_charge, charge, number_of_packages, consignor_zip_number och consignee_zip_number

5 Date: Sida 5 av 17 TABLE OF CONTENTS REVISION HISTORY 2 1. PRICE ONLINE SWEDEN 6 2. GENERAL VARIABLES/NODES REQUEST RESPONSE 7 SYSTEM 7 3. MESSAGE IFTMIN REQUEST 8 4. MESSAGE IFTMCS RESPONSE 13 APPENDIX A 16 APPENDIX B 17

6 Date: Sida 6 av Price Online Sweden The service gives external customers the possibility to connect to Schenker s systems d always get accurate information. Using the api you c create a request to calculate the cost of a consignment according to your contract. Examples ready to run will be found in the documentation. Just copy d paste them in to your web browser to get overview of the possibilities. The service c be invoked by httprequest using XML or HQF (http Query Format) d c also be returned in these two formats. Examples of requests d responses for both ways c be found in this document. Figure 1 Flow chart of the service For further information of how Schenker s online services are built d should be invoked we recommend reading our separate introduction. URL to use for HQF (only POST): URL to use for XML (only POST): This service requires authorization. Information c be found at:

7 Date: Sida 7 av General variables/nodes The general variables are for administrating communication d are mutual for all communication. The variables are: request, response d system. The variable data_list is array with the message information which is specific per method. For XML it will be <request, <response, <system d <data_list which consists of <data index=? nodes with the message information. An XML document c only contain one top node d so we enclose the above mentioned nodes with <xml. A request will thus have the following structure: <?xml version= 1.0? <xml <request...</request <response...</response <system...</system <data_list <data index= 0...</data </data_list </xml The title M symbolizes mdatory field. Sometimes you will find A here. This mes that the field is mdatory only if request comes from external part. 2.1 Request Contains information to the service. Add prefix request. to the variables if using HQF or place the nodes under <xml<request if using XML. Name - hqf Name - xml M Type Stdard Length Explation service.action <service<action M String WDR 10 Value select service.method <service<method M String WDR 10 Value calculate user.user_name <user<login_name M String WDR 10 Username user.password <user<password M String WDR 10 Password user.e_mail <user<e_mail String WDR 40 Users address format.mime <format<mime String WDR 40 The format you send. E.g. text/xml 2.2 Response Contains information from the service. Is found after prefix response. If using HQF or under <xml<response if using XML. Name - hqf Name - xml M Type Stdard Length Explation service.name <service<name M String WDR - Name of the service. service.version <service<version M String WDR - Version number (2.8) data_list_count <data_list_count M Int WDR - Number of items in the data_list. System Contains error code generated from the system. For HQF system.error.id=0 mes OK. For XML <system<error<id0</id</error</system mes OK. Also contains statistic variables to the system. Add prefix system. If using HQF or place the nodes under <xml<system if using XML. Name hqf Name xml M Type Stdard Length Explation error.id <error<id M Int WDR 5 Error code error.message <error<message String WDR 100 Error message

8 Date: Sida 8 av 17 statistics.remote.cou ntry_code statistics.remote.sen d_data_format statistics.remote.acce ss_type statistics.remote.appli cation_name Statistics.user.return_ mime_format statistics.user.orgiz ation_id statistics.user.lgua ge_code <statistics<remote <country_code <statistics<remote <send_data_format <statistics<remote <access_type <statistics<remote <application_name <statistics<user<r eturn_mime_format <statistics<user<o rgization_id <statistics<user<l guage_code M String WDR - Country code for client, ex. se or us M String WDR - Clients way of sending the request, xml or hqf (Http Query Format) M String WDR - Clients request type, A (browser) M String WDR - Clients page or module which sends the request. M String WDR - Format of the swer to the client, text/plain, text/html, text/xml or text/vnd.wap.wml M String WDR - Clients VAT-number or Orgisation number M String WDR - Lguage code for client, ex. sv_se 3. Message IFTMIN request Requests the price of a trsport. Information being sent to the service along with the request variables. In the field (M) Mdatory there are four fields marked with A. The conditions for these is to be found among the explations. Add prefix data_list.0. to variable for HQF or place the node under <xml<data_list<data index= 0 for XML.. When Type is Boole only value 0 or 1 c be used where 0=no d 1=yes. Name hqf Name xml M Type Stdard Length Explation consignor_identificati on <consignor_identifi cation M String NAD-CZ DE The identifier (8 numbers) of the consignor party. Contract_condition_c ode departure_place_nam e Destination_place_na me Consignment_gross_ weight Consignment_cube Consignment_loading _meters <contract_condition _code <departure_place_ name <destination_place _name <consignment_gros s_weight <consignment_cub e <consignment_load ing_meters M String 4065-PAR 4065-COM 4065-CLD A A String TDT DE 3224 String TDT DE 3224 M Float Float Float CNT DE 6066 Unit 6411 CNT DE 6066 Unit 6411 CNT 6069-ZLM DE Product name: Choose one of: PAR = Parcel, PAK = Privpak, COM = System/Direct CLD = Coldsped 13 Consignment location. Used together with or instead of consignor_zip_number. Mdatory for all products except PAR d PAK. 13 Location Consignee. Used together with or instead of consignee_zip_number. Mdatory for all products except PAR d PAK. 5,1 Weight (Kilogram). Mdatory for all products. 6,2 Volume (m3). For products COM, CLD d PAR. 2,2 Loading meters. For products COM, CLD. Consignment_length <consignment_leng th Float 6,2 Length. For products COM, CLD. Is used tockhol with Width d Height instead of Volume/Loading meters. Consignment_width <consignment_widt Float 6,2 Width.

9 Date: Sida 9 av 17 Name hqf Name xml M Type Stdard Length Explation h For products COM, CLD. Is used tockhol with Length d Height instead of Volume/Loading meters. Consignment_height <consignment_heig ht Float 6,2 Height. For products COM, CLD. Is used tockhol with Width d Length instead of Volume/Loading meters. Is_collect <is_collect A Boole 7273=CCT 1 Consignee pays. Mdatory for all products except PAR d PAK. (Schenker unique code) Value = 1 or 0 is_express <is_express Boole 7273=EXP 1 Additional service Express. (Schenker unique code) Value = 1 or 0 is_advise_service Is_dgerous_goods <is_advise_service <is_dgerous_goo ds Boole Boole is_hot_goods <is_hot_goods Boole is_delivery_date_time <is_delivery_date_ti me cash_on_delivery <cash_on_delivery Boole Int 7273=ADS 7273=DAG 7273=HOT 7273=TID 7273=COD 1 Additional service Advising. (Schenker unique code) Value = 1 or 0 Mdatory for all products except PAK. 1 Additional service Dgerous goods. Does not apply for PAR, PAK d CLD. (Schenker unique code) Value = 1 or 0 1 Additional service Hot goods. Does not apply for PAR, PAK d CLD. (Schenker unique code) Value = 1 or 0 1 Additional service Delivery on schedule. Does not apply for PAR d PAK. (Schenker unique code) Value = 1 or 0 7 Additional service COD (SEK). (Schenker unique code) expded_insurce <expded_insur ce Int 7273=INS 7 Extended Cargo Insurce (SEK). (Schenker unique code) budget_pallet_count <budget_pallet_cou nt Int CNT DE 6066 Unit Amount of pallets (ea.). Only applies for BUD. Country_code <country_code 3 Country code (See Appendix A) Only applies for PAR. SE/sverige is default. Percentage_charge <percentage_charg e 4 An additional charge in percent. Applies for all products. Charge <charge 6 An additional charge in SEK. Applies for all products. Number_of_package s Consignor_zip_numb er Consignee_zip_numb er <number_of_packa ges <consignor_zip_nu mber <consignee_zip_nu mber Is_skrymme_code <is_skrymme_code Boole Is_edi_customer <Is_edi_customer Boole 5 Amount of package. Only applies for PAR d PAK. 1 is default. 5 The postal code of the consignor party. Used together with or instead of departure_place_name Applies for all except PAR d PAK. 5 Consignee postcode Used together with or instead of destination_place_name Applies for all except PAR d PAK. 1 Tax weight Only applies for PAR d PAK. 1 An additional administrative fee will be added for EDI customer. Value 1 = Yes or 0 = No, 1 is default. Number_of_pallet_pl aces <number_of_pallet _places Int 7 Qutity of pallet places. Applies for products COM, CLD. Styck <styck Int 7 Qutity of price per unit. Applies for products COM, CLD. Is_home_delivery <is_home_delivery A Int 1 Home delivery to privat person Applies for product PAK d COM Values for PAK: 1 (Home Day with advice & e-pod)

10 Date: Sida 10 av 17 Name hqf Name xml M Type Stdard Length Explation 2 (Home Day without advice & e-pod) 3 (Home Evening with advice & e-pod) If no alternative is chosen is_parcel_pickup=1 is set as default. Is_special <Is_special Boole is_parcel_pickup <is_parcel_pickup Boole Is_logistic_parcel is_expded_insur ce Is_parcel_pickup_wor k <Is_logistic_parcel <is_expded_insu rce <is_parcel_pickup_ work Boole Boole Boole 7273=INS Values for COM: 1 = home delivery 0 = no home delivery (or leave out this parameter) 1 Special Applies for product COM Value = 0 or 1 1 Collect parcel Only applies for PAR Value = 0 or 1 1 Logistic parcel Only applies for PAR Value = 0 or 1 1 Additional service extended insurce of goods. 1 Only applies for PAK Example of HQF request for Privpak, weight 20 kg. ode=pak&request.service.action=select&request.service.method=calculate&data_list.0.consignor _identification= &data_list.0.consignment_gross_weight=20&data_list.0.is_edi_customer= 0&system.statistics.user.return_mime_format=html&system.statistics.remote.country_code=se&sy stem.statistics.user.lguage_code=sv&system.statistics.user.orgization_id= &system.statistics.remote.send_data_format=web2&system.statistics.remote.application_na me=priceonline_3&system.statistics.remote.access_type=a&request.admin.e_mail=kundservice. orebro%40schenker.se&request.user.login_name= &request.user.password= To call the application, use the parameter xml=dinxml after the URL. Example of XML request (same as above example) <?xml version= 1.0 encoding= ISO ? <xml <system <statistics <remote <country_codese</country_code <send_data_formatweb2</send_data_format <admin_e_mail [email protected] </admin_e_mail <access_typea</access_type <application_namepriceonline_3</application_name </remote <user <return_mime_formattext/xml</return_mime_format <orgization_id </orgization_id <lguage_codese</lguage_code </user </statistics </system <data_list <data index= 0 <contract_condition_codepak</contract_condition_code <consignor_identification </consignor_identification <consignment_gross_weight20</consignment_gross_weight </data

11 Date: Sida 11 av 17 </data_list <request <format <mimetext/xml</mime <typefull</type </format <service <actionselect</action <methodcalculate</method </service <user <login_name </login_name <password </password </user </request </xml Same XML request with blk spaces removed: version="1.0" encoding="iso "?<xml<system<statistics<remote<country_codese</country_code<send_data_format ess_typea</access_type<application_namepriceonline_3</application_name</remote<use r<return_mime_formattext/xml</return_mime_format<orgization_id </orgization_id<lguage_codese</lguage_code</user</statistics</system<dat a_list<data index="0"<contract_condition_codepak</contract_condition_code<consignor_identification </consignor_identification<consignment_gross_weight20</consignment_gross_weight </data</data_list<request<format<mimetext/xml</mime<typefull</type</format<servic e<actionselect</action<methodpar</method</service<user<login_name </logi n_name<password </password</user</request</xml Example of HQF request on DB SCHENKERsystem: weight 400 kg, home delivery d insurce of goods chosen, non EDI client. ode=com&request.service.action=select&request.service.method=calculate&data_list.0.consigno r_identification= &data_list.0.consignment_gross_weight=400&data_list.0.is_edi_customer =1&data_list.0.is_home_delivery=1&data_list.0.departure_place_name=stockholm&data_list.0.con signee_zip_number=41509&data_list.0.is_expded_insurce=1&system.statistics.user.return_ mime_format=html&system.statistics.remote.country_code=se&system.statistics.user.lguage_c ode=sv&system.statistics.user.orgization_id= &system.statistics.remote.send_data_format=web2&system.statistics.remote.application_na me=priceonline_3&system.statistics.remote.access_type=a&request.admin.e_mail=kundservice. orebro%40schenker.se&request.user.login_name= &request.user.password= To call the application with XML you put the parameter xml=<yourxml after the URL. Example of XML request (same as above example) <?xml version= 1.0 encoding= ISO ? <xml <system <statistics <remote <country_codese</country_code <send_data_formatweb2</send_data_format

12 Date: Sida 12 av 17 <access_typea</access_type <application_namepriceonline_3</application_name </remote <user <return_mime_formattext/xml</return_mime_format <orgization_id </orgization_id <lguage_codese</lguage_code </user </statistics </system <data_list <data index= 0 <contract_condition_codecom</contract_condition_code <consignor_identification </consignor_identification <consignment_gross_weight400</consignment_gross_weight <is_edi_customer1</is_edi_customer <is_home_delivery1</is_home_delivery <departure_place_namestockholm</departure_place_name <consignee_zip_number41509</consignee_zip_number <is_expded_insurce1</is_expded_insurce </data </data_list <request <format <mimetext/xml</mime <typefull</type </format <service <actionselect</action <methodcalculate</method </service <user <login_name </login_name <password </password </user </request </xml Same XML request with all blk spaces removed: version="1.0" encoding="iso "?<xml<system<statistics<remote<country_codese</country_code<send_data_format web2</send_data_format<[email protected]</admin_e_mail<acc ess_typea</access_type<application_namepriceonline_3</application_name</remote<use r<return_mime_formattext/xml</return_mime_format<orgization_id </orgization_id<lguage_codese</lguage_code</user</statistics</system<dat a_list<data index="0"<contract_condition_codecom</contract_condition_code<consignor_identification </consignor_identification<consignment_gross_weight400</consignment_gross_weight <is_edi_customer1</is_edi_customer<is_home_delivery1</is_home_delivery<departure_pl ace_namestockholm</departure_place_name<consignee_zip_number41509</consignee_zip _number<is_expded_insurce1</is_expded_insurce</data</data_list<request<fo rmat<mimetext/xml</mime<typefull</type</format<service<actionselect</action<meth odcalculate</method</service<user<login_name </login_name<password </password</user</request</xml

13 Date: Sida 13 av Message IFTMCS response Returns requested price for trsport. Information returned from service along with response variables. HQF Add prefix data_list.0. to variables. XML Place nodes under <xml<data_list<data index= 0. Namn hqf Namn xml O Typ Stdard Längd Förklaring chargeable_distce <chargeable_dist Int QTY - Chargeable distce between cities (Km). ce breakpoint_weight <breakpoint_weight Int CNT - Breakpoint weight (Kilogram), actual weight. Chargeable_weight <chargeable_weigh Int QTY - Chargeable weight (Kilogram). t Currency_code <currency_code String CUX Currency code. According to ISO (SEK/EUR) freight_net_cost <freight_net_cost Float TCC - Chargeable distce between cities (Km) administration_fee <administration_fee Float TCC Breakpoint weight (Kilogram), actual weight. Oil_charge <oil_charge Float TCC Chargeable weight (Kilogram). Collect_fee <collect_fee Float TCC freight_cost <freight_cost Float TCC 8023-??? Gotld_charge <gotld_charge Float TCC pallet_fee <pallet_fee Float TCC freight_total_cost <freight_total_cost Float TCC 8023-??? Express_fee <express_fee Float TCC advise_service_fee dgerous_goods_fe e delivery_date_time_f ee <advise_service_fe e <dgerous_goods _fee <delivery_date_tim e_fee Float Float Float TCC TCC TCC 8023-TID - Fee for consignee freight, i.e. it assumes that the paying customer is the receiver. (Pharos code) - Freight cost. Is equal to: freight_net_cost + administration_fee + oil_charge + collect_fee. - Gotld surcharge. (Pharos code) - Pallet fee. (Pharos code) - Freight cost 2. Is equal to: freight_cost + pallet_fee + gotld_charge. - Express fee. (Pharos code) - Notification fee. (Pharos code) - Dgerous goods fee. (Pharos code) - Collection date/time fee. (Schenker unique code)

14 Date: Sida 14 av 17 Namn hqf Namn xml O Typ Stdard Längd Förklaring carrier_fee <carrier_fee Float TCC 8023-CAR - Carrier fee. (Schenker unique code) cash_on_delivery_fee <cash_on_delivery _fee Float TCC Cash on delivery fee. (Pharos code) expded_insurce _fee currency_administrati on_fee <expded_insur ce_fee <currency_administ ration_fee Float Float TCC TCC 8023-??? - Extended Cargo Insurce. (Pharos code) - Currency administration fee. Value_added_tax <value_added_tax Float MOA Value added tax (VAT). 150 Total_cost <total_cost - Total cost. Charge_currency <charge_currency - departure_place_nam <departure_place_ String - Location Consignor e name destination_place_na <destination_place String - Location Consignee me _name edi_fee <edi_fee Float - An additional administrative fee will be added for EDI customer. Edi fee in SEK or EUR departure_place_char <departure_place_c Float - Location surcharge Consignor ge harge destination_place_ch <destination_place Float - Location surcharge Consignee arge _charge departure_place_type <departure_place_t ype String - Type of location surcharge Consignor, see Appendix B for options. Destination_place_ty pe <destination_place _type String - Type of location surcharge Consignee, see Appendix B for options. Trsport_document _number_charge Distribution_charge <trsport_docume nt_number_charge <distribution_charg e Float - Additional multiple package surcharge for Parcel. Float - Distribution surcharge for Coldsped. Customs_fee <customs_fee Float - Customs fee for Parcel. Homedelivery_fee <home_delivery_fe Float - HomeDelivery fee e special_fee <special_fee Float - Special fee minimum_fee_deficit <minimum_fee_defi Float - Minimum debit item fee cit parcel_pickup_work_f <parcel_pickup_wo Float - Parcel to work fee ee rk_fee Is_extra_gotld < Is_extra_gotld String 1 J/ N. J = yes if destination=gotld. Fee is included - 25% of net freight. Example of response: <?xml version="1.0" encoding="iso "? - <xml + <system - <response - <service <version1.0</version <namepriceonline_3</name </service <data_list_count1</data_list_count

15 Date: Sida 15 av 17 </response - <data_list - <data index="0" <freight_net_cost233.00</freight_net_cost <currency_codesek</currency_code <destination_place_charge0.00</destination_place_charge <total_cost296.00</total_cost <charge_currency0.00</charge_currency <minimum_fee_deficit0.00</minimum_fee_deficit <gotld_charge0.00</gotld_charge <dgerous_goods_fee0.00</dgerous_goods_fee <customs_fee0.00</customs_fee <delivery_date_time_fee0.00</delivery_date_time_fee <information01</information <chargeable_weight0</chargeable_weight <cash_on_delivery_fee0.00</cash_on_delivery_fee <express_fee0.00</express_fee <currency_administration_fee0.00</currency_administration_fee <value_added_tax59.00</value_added_tax <freight_total_cost237.00</freight_total_cost <distribution_charge0.00</distribution_charge <pallet_fee0.00</pallet_fee <breakpoint_weight0</breakpoint_weight <calculated_volume0.00</calculated_volume <administration_fee0.00</administration_fee <special_fee0.00</special_fee <carrier_fee0.00</carrier_fee <chargeable_distce0</chargeable_distce <freight_cost237.00</freight_cost <oil_charge4.00</oil_charge <home_delivery_fee0.00</home_delivery_fee <edi_fee0.00</edi_fee <departure_place_charge0.00</departure_place_charge <advise_service_fee0.00</advise_service_fee <trsport_document_number_charge0.00</trsport_document_number_charge <collect_fee0.00</collect_fee <parcel_pickup_work_fee0.00</parcel_pickup_work_fee <expded_insurce_fee0.00</expded_insurce_fee </data </data_list </xml

16 Date: Sida 16 av 17 Appendix A Country codes: Country Sweden Andorra Austria Belgium Bulgaria Cyprus Czech Republic Denmark Estonia Finld Finld (the Åld Islds) Frce Frce (Corsica) Germy Gibraltar Great Britain Greece Holld Hungary Ireld Italy Italy (Sardinia) Italy (Sicily) Latvia Liechtenstein Litaunia Luxembuorg Malta Monaco Norway Pold Portugal Romia S Marino Schwitzerld Slovenia Slovakia Spain Spain (Ibiza) Spain (Mallorca) Spain (Minorca) Turkey Vatic WWP zon 4 WWP zon 5 WWP zon 6 WWP zon 7 WWP zon 8 Country code SE AD AT BE BG CY CZ DK EE FI FI FR1 FR2 DE GI GB GR NL HU IE IT1 IT3 IT2 LV LI LT LU MT MC NO PL PT RO SM CH SI SK ES ES ES ES TR VA Z4 Z5 Z6 Z7 Z8

17 Date: Sida 17 av 17 Appendix B Location surcharge: Type of location surcharge Isld-Location surcharge City surcharge Sparsely populated area surcharge Type of location surcharge letter O S G