Gain the ability to choose the greenest or fastest option among upcoming vessel departures, selecting from the best available itineraries per carrier.
This endpoint returns the possible itinerary solutions and their CO2e emissions in the near future, for a given carrier and a given port pair.
The CO2e emissions are returned in grams per TEU.
Input
Location of origin (fromLocode) and destination (toLocode), and carrier information (carrierScac or carrierId) are mandatory fields.
Dates
This endpoint takes two dates as input: fromDate and toDate. It represents the departure date range within which the endpoint will search for itineraries.
Passing the dates is optional. If no date is given, the endpoint will return itineraries sailing 7 days onwards after the current date.
Both dates should be passed using the ISO 8601 format.
Sorting
To get the results in order of preference, use the parameter sortBy. You can input CO2 or TRANSIT_TIME, depending on your main interest.
Response
The response is a feature collections list, where each feature collection is a possible itinerary.
The feature collection is made of:
- one or multiple features
A direct itinerary results in a feature collection made of only one feature.
An itinerary with transshipments results is a feature collection made of multiple features, each of it representing one leg. - one hash
Each itinerary is associated to a unique fingerprint (called "hash") that you can use to retrieve the CO2 breakdown and details of the itinerary via the /co2/v2/execution endpoint.
It will return the CO2e breakdown (total, TTW, WTT, intensity values).
Each feature has its own properties, including details such as duration, departure and arrival dates, locations, distance, mode, service ID, asset (vessel) details, port of calls, total CO2 emissions.
Results are given in the order of sorting requested (CO2 or TRANSIT_TIME). If no sortBy is input, the sorting will be done on the CO2 basis.