Skip to content

/v1/tonnage-allocation-planning.json​

POST
/v1/tonnage-allocation-planning.json

Tonnage Allocation Planner Data Specification

Item Value
Data Name Tonnage Allocation Planner
Format JSON / JSONP
Region Global
Update -
Forecast Duration -
Time Pitch -
Average Size 250 K
No Data Value -9999999

Route Type / Item List

Route Type Item Category Item Name Description Unit/Format Value Type
Shortest - shortest Shortest voyage route - -
WNI Recomm 1 - wni_recomm1 Weathernews recommendation route - -
Shortest/WNI Recomm 1 ports departure_port_name Departure port name - String
Shortest/WNI Recomm 1 ports departure_port_code Weathernews departure port code - String
Shortest/WNI Recomm 1 ports arrival_port_name Arrival port name - String
Shortest/WNI Recomm 1 ports arrival_port_code Weathernews arrival port code - String
Shortest/WNI Recomm 1 ports vessel_condition Vessel load balance condition (L: Laden, B: Ballast) - String
Shortest/WNI Recomm 1 ports etd_utc Estimated time departure (UTC time) UTC (mm/dd hh:mm) String
Shortest/WNI Recomm 1 ports eta_utc Estimated time arrival (UTC time) UTC (mm/dd hh:mm) String
Shortest/WNI Recomm 1 ports etd_lt Estimated time departure (Local time) LT (mm/dd hh:mm) String
Shortest/WNI Recomm 1 ports eta_lt Estimated time arrival (Local time) LT (mm/dd hh:mm) String
Shortest/WNI Recomm 1 ports -> distance outside_eca Distance of route outside ECA (Emission Control Area) nm Float
Shortest/WNI Recomm 1 ports -> distance inside_eca Distance of route inside ECA (Emission Control Area) nm Float
Shortest/WNI Recomm 1 ports -> days outside_eca Days needed for voyage outside ECA Day Float
Shortest/WNI Recomm 1 ports -> days inside_eca Days needed for voyage inside ECA Day Float
Shortest/WNI Recomm 1 ports -> days dep_port_staying Spending time at departure port Day Float
Shortest/WNI Recomm 1 ports -> fuel ifo Fuel oil needed for voyage MT Float
Shortest/WNI Recomm 1 ports -> fuel eca Fuel oil needed for voyage inside ECA MT Float
Shortest/WNI Recomm 1 ports -> speed average Average speed needed for voyage Knot Float
Shortest/WNI Recomm 1 ports -> speed wf Weather factor through the route Knot Float
Shortest/WNI Recomm 1 ports -> speed cf Current factor through the route Knot Float
Shortest/WNI Recomm 1 sub_total -> distance outside_eca Total distance outside ECA in each port rotation nm Float
Shortest/WNI Recomm 1 sub_total -> distance inside_eca Total distance inside ECA in each port rotation nm Float
Shortest/WNI Recomm 1 sub_total -> days inside_eca Total days inside ECA in each port rotation Day Float
Shortest/WNI Recomm 1 sub_total -> days outside_eca Total days outside ECA in each port rotation Day Float
Shortest/WNI Recomm 1 sub_total -> days dep_port_staying Total spending time at departure port in each port rotation Day Float
Shortest/WNI Recomm 1 sub_total -> fuel ifo Total fuel oil needed in each port rotation MT Float
Shortest/WNI Recomm 1 sub_total -> fuel eca Total fuel oil needed inside ECA in each port rotation MT Float
Shortest/WNI Recomm 1 total distance Total distance inside and outside ECA in each port rotation nm Float
Shortest/WNI Recomm 1 total days Total days inside and outside ECA and total port staying Day Float
Shortest/WNI Recomm 1 total -> fuel ifo Total fuel oil needed in each port rotation MT Float
Shortest/WNI Recomm 1 total -> fuel eca Total fuel oil needed inside ECA in each port rotation MT Float
Shortest/WNI Recomm 1 waypoint -> position lat Latitude of route waypoint Minute Float
Shortest/WNI Recomm 1 waypoint -> position lon Longitude of route waypoint Minute Float
Shortest/WNI Recomm 1 waypoint -> position datetime Date and time of route waypoint mm/dd hh:mm String

Parameters​

Header Parameters

Authorization*

"WniWebApi " + Token ID

Typestring
Required

Request Body​

JSON
{
"imo": "9876543",
"etd": "2025/07/01 12:00",
"laden_draft": 13.5,
"season": "string",
"ports": [
{
"port_code": "YOK",
"vessel_condition": "string",
"staying_days": 1.5,
"good_weather_speed": 13,
"passage": "Suez"
}
]
}

Responses​

Returns the tonnage allocation planner data in JSON or JSONP format. - Return Value: JSON / JSONP - Response Header: None - The response format is automatically determined by the presence of the callback parameter (JSON if not specified).

Playground​

Headers
Body

Samples​

All product names, trademarks and registered trademarks are property of their respective owners.