Price Online Europe API - Schenker
Price Online Europe API - Schenker
Price Online Europe API - Schenker
You also want an ePaper? Increase the reach of your titles
YUMPU automatically turns print PDFs into web optimized ePapers that Google loves.
<strong>Price</strong> <strong>Online</strong> <strong>Europe</strong><br />
<strong>API</strong><br />
Version 1.0
Document: <strong>API</strong> <strong>Price</strong> <strong>Online</strong> Europa<br />
Specification of messages IFTMIN / IFTMCS<br />
Query <strong>Price</strong> <strong>Online</strong><br />
Version: 1.0 <strong>Schenker</strong> AB, IT Division<br />
Document <strong>API</strong>_schenker_price_europa_eng_1_0.pdf<br />
name:<br />
Date: 2003-08-20 Sida 1 av 9<br />
Revision history<br />
Version Date Comments<br />
1.0 2003-08-20 Document created
Document: <strong>API</strong> <strong>Price</strong> <strong>Online</strong> Europa<br />
Specification of messages IFTMIN / IFTMCS<br />
Query <strong>Price</strong> <strong>Online</strong><br />
Version: 1.0 <strong>Schenker</strong> AB, IT Division<br />
Document <strong>API</strong>_schenker_price_europa_eng_1_0.pdf<br />
name:<br />
Date: 2003-08-20 Sida 2 av 9<br />
TABLE OF CONTENTS<br />
REVISION HISTORY ..................................................................................................... 1<br />
TABLE OF CONTENTS .................................................................................................. 2<br />
1. PRICE ONLINE EUROPE ............................................................................................ 3<br />
2. REQUEST MESSAGE ................................................................................................ 4<br />
2.1 SEARCH PARAMETERS ....................................................................................................... 4<br />
3. XML RESPONSE DEFINITIONS .................................................................................. 6<br />
3.1 RESPONSE.FORMAT=XMLEDIFACT ....................................................................................... 6<br />
3.2 ERROR RESPONSE ............................................................................................................. 6<br />
3.3 ERROR CODES ................................................................................................................. 6<br />
3.4 OTHER CHARGES .............................................................................................................. 7<br />
4. EDIFACT STANDARD DEFINITIONS ........................................................................... 8
Document: <strong>API</strong> <strong>Price</strong> <strong>Online</strong> Europa<br />
Specification of messages IFTMIN / IFTMCS<br />
Query <strong>Price</strong> <strong>Online</strong><br />
Version: 1.0 <strong>Schenker</strong> AB, IT Division<br />
Document <strong>API</strong>_schenker_price_europa_eng_1_0.pdf<br />
name:<br />
Date: 2003-08-20 Sida 3 av 9<br />
1. <strong>Price</strong> <strong>Online</strong> <strong>Europe</strong><br />
The <strong>Price</strong> <strong>Online</strong> <strong>Europe</strong> service can be used as a plug-in to directly obtain freight pricing<br />
information in XML format, which can be used by an external application. The application can<br />
return the XML in the EDIFACT standard format. To use the service as a plug-in, a valid HTTP<br />
request must be made. Information on how to build one will be found in the document.<br />
Figure 1 Flow chart of the service<br />
For further information of how <strong>Schenker</strong>’s online services are built and should be invoked we<br />
recommend reading our separate introduction.<br />
Each request to the <strong>Price</strong> <strong>Online</strong> <strong>Europe</strong> <strong>API</strong> should begin with the servlet location and name,<br />
followed by a query string containing the required search parameters. The current URL for the<br />
production service is as follows:<br />
http://was.schenker.nu/priceonline/com.dcs.servicebroker.http.HttpXSLTServlet?
Document: <strong>API</strong> <strong>Price</strong> <strong>Online</strong> Europa<br />
Specification of messages IFTMIN / IFTMCS<br />
Query <strong>Price</strong> <strong>Online</strong><br />
Version: 1.0 <strong>Schenker</strong> AB, IT Division<br />
Document <strong>API</strong>_schenker_price_europa_eng_1_0.pdf<br />
name:<br />
Date: 2003-08-20 Sida 4 av 9<br />
2. Request message<br />
Information being sent to the service.<br />
The title ’M’ symbolizes mandatory field.<br />
2.1 Search Parameters<br />
Parameter Name M Allowed values Length<br />
request.service M BTL_TELAGRPLUGIN -<br />
request.method M Retrieve -<br />
request.format M xmledifact – for EDIFACT standard tags -<br />
export_import M 1 – Export<br />
2 – Import<br />
3 – Domestic<br />
service_level M 01 – Groupage/Part Loads<br />
05 – Full Loads<br />
origin_country M A valid 2 letter ISO country code representing the<br />
origin country<br />
from_postcode M A valid postcode for the origin_country. Variable<br />
destination_country M A valid 2 letter ISO country code representing the<br />
destination country<br />
to_postcode M A valid postcode for the destination_country. Variable<br />
terms_of_trade M One of the following codes:<br />
001 – EXW<br />
002 – FCA<br />
006 – CPT<br />
007 – CIP<br />
010 – CPT<br />
011 – CIP<br />
014 – CPT<br />
015 – CIP<br />
022 – DDU<br />
023 – DDP<br />
gross_weight M Gross weight in kg 7,2<br />
cube Volume in cbm 6,3<br />
flat Flat weight in ldm 9,2<br />
1<br />
2<br />
2<br />
2<br />
3
Document: <strong>API</strong> <strong>Price</strong> <strong>Online</strong> Europa<br />
Specification of messages IFTMIN / IFTMCS<br />
Query <strong>Price</strong> <strong>Online</strong><br />
Version: 1.0 <strong>Schenker</strong> AB, IT Division<br />
Document <strong>API</strong>_schenker_price_europa_eng_1_0.pdf<br />
name:<br />
Date: 2003-08-20 Sida 5 av 9<br />
tax_weight Tax weight in kg 7,2<br />
currency M The 3 letter ISO code for the desired pricing<br />
currency.<br />
request.user.id M The username to use for the request<br />
request.user.password M The password for the username used.<br />
3<br />
Example of Request message (query string):<br />
http://was.schenker.nu/priceonline/com.dcs.servicebroker.http.HttpXSLTServlet?request.service=<br />
BTL_TELAGRPLUGIN&export_import=2&service_level=05&origin_country=FI&from_postcode=1<br />
0000&destination_country=NO&to_postcode=1000&terms_of_trade=001&gross_weight=1000.00<br />
&cube=0.000&flat=0.00&tax_weight=0.00¤cy=NOK&request.method=retrieve&request.for<br />
mat=xmledifact&request.user.id=xyz&request.user.password=123
Document: <strong>API</strong> <strong>Price</strong> <strong>Online</strong> Europa<br />
Specification of messages IFTMIN / IFTMCS<br />
Query <strong>Price</strong> <strong>Online</strong><br />
Version: 1.0 <strong>Schenker</strong> AB, IT Division<br />
Document <strong>API</strong>_schenker_price_europa_eng_1_0.pdf<br />
name:<br />
Date: 2003-08-20 Sida 6 av 9<br />
3. XML Response definitions<br />
Information returned from the service.<br />
3.1 Response.format=xmledifact<br />
<br />
party id<br />
party name<br />
origin country<br />
origin postcode<br />
destination country<br />
destination postcode<br />
terms of trade<br />
gross weight<br />
volume<br />
loading metres<br />
freight charge<br />
currency code<br />
<br />
<br />
<br />
charge code<br />
charge description<br />
amount<br />
<br />
<br />
<br />
3.2 Error response<br />
If a problem occurs with the user validation data which is supplied to the HTTP server, an error<br />
message will be returned in the xml in the following format (and nothing else).<br />
<br />
Error message<br />
<br />
The following error messages are currently defined:<br />
User not found<br />
User is disabled<br />
Password is incorrect<br />
User is not enrolled in the specified service<br />
3.3 Error codes<br />
The possible error codes, and their meanings which can be returned in the tag<br />
in the xml format response are as follows:
Document: <strong>API</strong> <strong>Price</strong> <strong>Online</strong> Europa<br />
Specification of messages IFTMIN / IFTMCS<br />
Query <strong>Price</strong> <strong>Online</strong><br />
Version: 1.0 <strong>Schenker</strong> AB, IT Division<br />
Document <strong>API</strong>_schenker_price_europa_eng_1_0.pdf<br />
name:<br />
Date: 2003-08-20 Sida 7 av 9<br />
ERR0356 – Unable to Calculate <strong>Price</strong> Based on Transport details Entered<br />
ERR2721 – One of Weight, Volume or Flat/Load must be entered<br />
ERR6154 – Gross Weight entered is greater than the Maximum value allowed<br />
ERR6155 – Volume Weight entered is greater than the Maximum value allowed<br />
ERR6156 – Flat Weight entered is greater than the Maximum value allowed<br />
ERR9433 – No Telephone Agreements Pricing Details Found<br />
ERR9500 – No Agreement Parameters Exist<br />
ERR9561 – Mode of Transport is invalid or missing<br />
ERR9804 – Exchange Rate Not found for selected Currency Code<br />
ERR9931 – Error on Call to Exchange Rate Server<br />
FFE2403 – Client ID not found<br />
3.4 Other charges<br />
The possible codes for other charges, and their meanings which can be returned in the<br />
tag in the xml format response are as follows:<br />
Charge code Charge description, Swedish Charge description, English<br />
235 Expeditionsavgift utrikes Forwarding Fee<br />
236 Avgift saknad EDI Fee no EDI<br />
301 Exportdeklaration Customs clearance<br />
303 Radavgift per rad utöver en Commodity lines Fee<br />
574 Farligt gods Dangerous Goods<br />
575 Termotillägg Thermo<br />
586 Vägskatt Tyskland Maut Germany<br />
587 Vägskatt Österrike Road Tax Austria<br />
598 Vägskatt Tjeckien Road Tax Czech Republic<br />
589 Avgift nya Svinesundsbron Svinesundsbron extra Fee<br />
592 System Top frakttillägg System Top<br />
593 System Top12 frakttillägg System Top12<br />
595 Hamnavgift Finland Harbour Fee Finland<br />
701 Förtullning normalt förfarande Customs Declaration<br />
730 Förtullning i mottagarlandet Customs Declaration import<br />
740 Efterkrav/COD COD
Document: <strong>API</strong> <strong>Price</strong> <strong>Online</strong> Europa<br />
Specification of messages IFTMIN / IFTMCS<br />
Query <strong>Price</strong> <strong>Online</strong><br />
Version: 1.0 <strong>Schenker</strong> AB, IT Division<br />
Document <strong>API</strong>_schenker_price_europa_eng_1_0.pdf<br />
name:<br />
Date: 2003-08-20 Sida 8 av 9<br />
4. Edifact standard definitions<br />
Parameter Name Standard Description<br />
party_id NAD-3039 Client ID<br />
party_name NAD-3036 Client Name<br />
country_of_exportation LOC-3227 Origin Country<br />
place_of_departure LOC-3227 Origin Postcode<br />
country_of_destination LOC-3227 Destination country<br />
place_of_destination LOC-3227 Destination Postcode<br />
terms_of_transport TOD-4053 Terms of Trade<br />
gross_weight MEA-6313-AAD Gross Weight<br />
volume MEA-6313-VOL Volume<br />
loading_metres MEA-6313-LMT Flat Weight<br />
freight_charge MOA-5004 Freight Charge<br />
pricing_currency MOA-6345 Currency Code