Model: Routes & Schedules
The Route & Schedules data presents the detailed information about the route and the schedule for a priced offer. The data presents details about each segment (journey between two schedules stops) of the route and the vessels used to transport the shipment in the route. This data is retrieved by calling the Product Offers endpoints (see Endpoints: Product Offers).
Data representation
Each product has a set of general attributes as shown below in an example of data representation. The data was created by requested
.../offers/v2/offers/brand/MAEU/departuredate/2019-10-15?containers=1x20DRY&originRkstCode=CNDAI&destinationRkstCode=ESBCN
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 |
|
Data description
NOTE: The attributes present in the JSON structure but missing in the below description are used only for internal purposes and should not be used by Maersk external customers. Some attributes are self-explanatory, eg "vesselName"
A schedule has the following attributes:
-
productId
: An identifier for the currently returned schedule. The id changes for each request, hence cannot be used to identify one particular schedule. The product id is used for Maersk internal purposes and should not be used by Maersk external consumers. -
productSequence
: An identifier in the sequence of returned schedules. It cannot be used to identify one particular schedule. The product sequence is used for Maersk internal purposes and should not be used by Maersk external consumers. -
fromLocation
: Data about the requested origin:-
siteGeoId
: The geo ID for the site of departure in the requested origin. The ID is used internally in Maersk network -
siteName
: The name of the site of departure in the requested origin -
rkstCode
: The RKST code for the site of departure in the requested origin. The code is used internally in Maersk network -
date
: The departure date of the vessel from the site of departure -
time
: The departure time of the vessel from the site of departure
-
-
toLocation
: Data about the requested destination:-
siteGeoId
: The geo ID for the site of arrival in the requested destination. The ID is used internally in Maersk network -
siteName
: The name of the site of arrival in the requested destination -
rkstCode
: The RKST code for the site of arrival in the requested destination. The code is used internally in Maersk network -
date
: The arrival date of the vessel from the site of arrival -
time
: The arrival time of the vessel from the site of arrival
-
-
vessel
: Information about the first ocean vessel in the full schedule:-
code
: The vessel code -
name
: The short name of the vessel -
longName
: The long name of the vessel (it can be the same as the short name) -
flagCode
: The code of the flag under which the vessel travels. The flag is a representation of the vessel’s nationality, which means the vessel is under control by the registered country. -
flagName
: The name of the flag under which the vessel travels. The flag is a representation of the vessel’s nationality, which means the vessel is under control by the registered country. The name displays the country in which the vessel is registered. -
imoNumber
: The International Maritime Organization (IMO) number for that vessel, which is a unique reference for ships, registered ship owners and management companies -
buildYear
: The year when the vessel was build -
callSign
: The maritime call sign assigned as unique identifier for the vessel -
capacityTEU
: The full capacity of the vessel measured in TEU. A TEU is a Twenty-foot equivalent unit as a unit of measurement to count the number of containers. -
vesselClass
: The class which the vessel belongs to
-
-
voyageNumber
: The number of the full voyage . A voyage represents the full route from the origin to destination, including all the legs in between -
transitTime
: The estimated time in minutes required to complete the voyage from origin to destination -
scheduleDetails
: The details of the schedule. The data provides information for each leg:-
deadlines
: The group of deadlines valid for the returned offer -
fromLocation
: The from location for the specific segment. See above "fromLocation" for details about the data. -
toLocation
: The to location for the specific segment. See above "toLocation" for details about the data. -
transport
: Details about the transport on the specific leg-
transportMode
: The transport mode, eg.MVS
for Mother Vessel,FEF
for Feeder Foreign. -
vessel
: See above "vessel" -
tradeLane
: The name of the trade lane on which the vessel sails -
voyageNumber
: The number of the full voyage. A voyage represents the full route from the origin to destination on the specific leg
-
-
serviceCode
: The code of the service that the vessel is sailing on. Is usually used for internal purposes -
serviceName
: The name of the service that the vessel is sailing on. Is usually used for internal purposes
-