Description of 9 column and basis of rate search:
The new Rate Lookup module incorporates 9 columns to show better detailed insights for the rate result, which are namely:
1. Origin Inland CFS.
2. Consol CFS.
3. Port of Loading (PoL) Routing.
4. Transhipment port T1.
5. Transhipment port T2.
6. Transhipment port T3.
7. Port of Discharge.
8. Deconsol CFS.
9. Destination Inland CFS.
Once you are ready for the integration, you will need to reach out to the WWA IT team at eisupport@wwalliance.com who will complete the necessary set-up on WWA for you to utilize the new tech API.
WWA enables customers, rate portals, and its members to access its rates data via web services using the Representational State Transfer (REST) style communications for various rate lookup-related functionalities.
Rate Lookup Web Service Usage
Along with basic Rate Search, WWA has webservices that offer multiple features such as:
1. Listing of Origin and Destination UN codes (based on rate availability on WWA).
2. Get OFR HeaderID & base rate.
3. Display base & calculated rates based on Pieces, Weight & Volume to generate a Quote.
4. Generate and Send Quotes in PDF format (calculated or non-calculated.
5. Search/View and Resend a Quote based on the existing quote number.
We have listed all the available webservices below in a sequence to replicate the end-to-end User Experience/flow. It is just a guideline and all the webservices can be used independently if you already have the key data to be entered in the Webservice Requests. Please note that some webservices might be dependent on others for some key data. The description below should shed more light on it.
Step by step approach to pull rates
Use the Login webservice to get the (access token). This auth-token needs to be passed in the request header as Authorization key & will be active for the next 30 minutes.
1. To pull the origins (use - Global rate Search Origin webservice).
2. To pull the destinations (use - Global Rate Search Destination webservice).
3. To get the OFR header ID & base rate using one of the origin/destinations from the above API calls (use - Global Rate Search Result webservice). The above 2 API calls may not be needed if the user knows the exact Origin/Destination to be searched. We have also shared the details for the advanced/enhanced version 3.0.3 where the system will pick up the details based on the value provided for the shipment.
4. To get the OFR base rate/calculated rates with surcharges using the OFR header Id (use - Display Charges and Calculated rate for selected Origin/Destination webservice). We have also shared the details for the advanced/enhanced version 3.0.4 which will give the calculated details for a shipment based on the dimension values entered.
5. To generate & send quotes both calculated and non-calculated (use - Generate and Send Quote Calculated and Non-calculated webservice). We have also shared the details for the advanced/enhanced version 3.0.3 which will allow the user to specify the charges that needs to be available as part of the quote generated.
6. To search/view and resend a quote based on the existing quote number (use - Search/View and Resend a Quote based on existing quote number webservice).
Generate Access token using Login webservice
Through this API you will be able to generate the Access token which will be valid for 30 minutes from the time it is generated. You will have to pass this Access token in the request header of all the API requests to receive a successful response back from WWA.
To generate an Access token, please refer to webservice - Webservice to create Access token using REST
i. Listing Origins (city, country, region)
Here we display all the origins (UN Location codes/City Name/Country/Region for which rates are available till a particular date (expiry date). For Listing Origins, please refer webservice - Webservice to search for global rate Origin using REST
i. Listing Destinations (city, country, region) Based on the Parameters, WWA would provide a list of destinations for which there are rates available in the system.
For Listing Destination, please refer webservice - Webservice to search for global rate Destination using REST
i. Search Rates for desired Origin & Destination
Based on the parameters sent in the request, WWA would fetch the Ocean Freight (OFR) base rate in the response back to the user for the selected Origin-Destination UN location code. Each OFR will have a unique key "oceanfreightHeaderID" in response which will be used in further webservice requests.
The Rate search logic implemented to fetch the rates is as below:
The key to search the rates for any port pair now revolves around 4 columns in the same sequence as mentioned below:
1. Origin Inland CFS, (OIC) - Origin
2. Consol CFS, (CC) - Origin
3. Deconsol CFS, (DC) - Destination
4. Destination Inland CFS (DIC) - Destination
The system would check first OIC (Origin Inland CFS) - DIC (Destination Inland CFS), if any of the above-mentioned is not present, the immediate next column in the category (origin/destination would be taken into consideration). For ex: if OIC (Origin Inland CFS) is not present, the system would check CC (Consol CFS) - DIC (Destination Inland CFS), if DIC (Destination Inland CFS) is also not present, CC (Consol CFS) - DC (Deconsol CFS) and so on in a similar manner.
For Global Rate Search Result, please refer to webservice version 3.0.1 - Webservice to search for global rate OFR ID for selected Origin-Destination using REST
For Global Rate Search Result, please refer to enhanced webservice version 3.0.3 - Webservice to search for global rate OFR ID for selected Origin-Destination using REST
i. View detailed and calculated Rates
This API is a combination of the Display Charges and Rate Calculation API in the New tech.
WWA would provide detailed charges for the OFRs rate displayed in the "Search Rate" webservice mentioned above. For the desired OFR rate, the respective unique key "oceanfreightheaderID" should be passed in the request to fetch the detailed result. The result will include a set of detailed Surcharges classified under 3 main groups:
i. Origin Charges FOB (Freight on Board)
ii. OceanFreight OFR
iii. Destination Charges PLC (Post Landing Charges)
Additionally, if the user passes a blank value for the fields (pieces, weight, cube, and UOM) in the request then the response will show the calculated rate as the base rate for all the charges.
For getting detailed rate results, please refer to webservice version 3.0.1 - Webservice to view rates with all surcharges for selected Origin/Destination using REST
For getting detailed rate results, please refer to enhanced webservice version 3.0.4 - Webservice to view rates with all surcharges for selected Origin/Destination using REST
This API is a combination of the Calculated and Non-calculated quote API in the New tech.
WWA can send the Rate search Result (calculated and Non-calculated) as a Quote to a valid email ID in PDF form using the below-mentioned webservice. The key parameter here is again the “OceanfreightHeaderID” that needs to be passed in the webservice along with other details.
To send a quote of calculated or non-calculated rates in PDF format, please refer webservice version 3.0.1 - Webservice to send a quote in email for calculated or non-calculated rates with surcharges for selected Origin/Destination using REST
To send a quote of calculated or non-calculated rates in PDF format, please refer to enhanced webservice version 3.0.3 - Webservice to send a quote in email for calculated or non-calculated rates with surcharges for selected Origin/Destination using REST
Using a valid Quote number provided by WWA in earlier searches, you can view the Rate details (Calculated/Non-calculated) stored in the WWA system for the highlighted quote number.
i. Search/View a Quote based on existing quote number
ii. Resend a Quote based on existing quote number.
For Viewing/Resending Quote details based on the quote number entered by the user, please refer webservice - Webservice to view/resend rates with all surcharges using Quote ID for selected Origin/Destination using REST
API Error Codes 06Sep2022.xlsx
WWA_New_Enhanced_API_Version.xlsx
Note: Please authenticate to obtain the token before proceeding with the API request. The token will be required to access the results.