Container event schema
You can specify a webhook in Settings > Integrations to listen in on containter events. Chaine will send new container events as we receive them from the different SeaLines. If there is a new event or change in an existing event (i.e. for ETA events, a change in date-time), we will push those events to your webhook. If there is no change, we won't emit duplicate events. See here for a complete list of events
Although the container events can be mapped to any format in the Integrations settings when creating an integration, the default format is:
Content type: application/json
Request body schema:
| Property | Type | Description |
|---|---|---|
| shipmentID | string | Your unique shipment id provided in the tracking registration |
| containerID | string | Your unique container id provided in the tracking registration |
| chaineReferenceID | string | Chaine's unique container id provided in the tracking registration |
| containerNumber | string | SeaLine issued container number |
| bol | string | SeaLine issued bill of lading number |
| eventMode | string | The mode of the container event. Values are "land" or "sea" |
| eventType | string | The type of event of values 'Inland origin', 'Origin port', 'Destination port', or 'Inland destination'. |
| eventCode | string | Chaine event code for the event. See list of event codes |
| eventDescription | string | Chaine normalized event description for the event code. See list of event descriptions |
| rawEventDescription | string | The raw event description from SeaRates which is the raw event description from the sealines |
| date | string | The date-time of the event. This could be an estimated or actual value depending on the event. |
| isETA | boolean | Specifies if the date is an estimated date-time or actual. |
| location | Location | Location of the event. |
| route | Route | A detailed route of the container's journey. This will contain the port, rail ramp, or other location name, state, country, country code, unlocode and latitude and longitude. This is used by developer's to create very detailed maps of the container's journey. |
| vessel | Vessel | Vessel information if it is available for the event. Not provided for land events. |
| voyage | string | Voyage number if it is available for the event. Not provided for land events. |
Route
The route object
| Property | Type | Description |
| ----------- | -------- | -------------------------------------------------------------------------------------------------------- |
| currentLocationPin | array | Your unique shipment id provided in the tracking registration |
| destination | Location | Your unique container id provided in the tracking registration |
| placeOfDispatch | Location | Chaine's unique container id provided in the tracking registration |
| portOfDischarge | Location | SeaLine issued container number |
| portOfLoading | Location | SeaLine issued bill of lading number |
| routePaths | array | The mode of the container event. Values are "land" or "sea" |
Location The location object.
| Property | Type | Description |
|---|---|---|
| name | string | Your unique shipment id provided in the tracking registration |
| city | string | Your unique container id provided in the tracking registration |
| state | string | Chaine's unique container id provided in the tracking registration |
| country | string | SeaLine issued container number |
| countryCode | string | SeaLine issued bill of lading number |
| unlocode | string | The mode of the container event. Values are "land" or "sea" |
| latitude | number | The type of event of values 'Inland origin', 'Origin port', 'Destination port', or 'Inland destination'. |
| longitude | number | Chaine event code for the event. See docs. |
Vessel The vessel object
| Property | Type | Description |
|---|---|---|
| name | string | Your unique shipment id provided in the tracking registration |
| imo | string | Your unique container id provided in the tracking registration |
| callSign | string | Chaine's unique container id provided in the tracking registration |
| mmsi | string | SeaLine issued container number |
| flag | string | SeaLine issued bill of lading number |
Example event
{
"bol": "123456789",
"containerID": "a917-418374931111",
"containerNumber": "ABCD1234567",
"eventCode": "ECDD",
"eventDescription": "Estimated container discharge at destination port",
"eventMode": "sea",
"eventOrder": 7,
"eventType": "TRANSPORT",
"isETA": true,
"isoCode": "22G1",
"location": {
"country": "United States",
"countryCode": "US",
"geolocation": {
"latitude": 37.80437,
"longitude": -122.2708
},
"name": "Oakland",
"state": "California",
"unlocode": "USOAK"
},
"rawEventDescription": "Estimated Time of Arrival",
"shipmentID":"123456789",
"sizeType": "40' High Cube Dry",
"trackingType": "BOL",
"trackingTypeStatus": "IN_TRANSIT",
"vessel": {
"name": "CMA CGM AMERIGO VESPUCCI",
"imo": 9454395,
"callSign": "FNVK",
"mmsi": 228316800,
"flag": "FR"
},
"voyage": "1TU0RN1MA",
"route": {
"currentLocationPin": [14.666930288125217, -17.71895164417353],
"destination": {
"country": "United States",
"countryCode": "US",
"geolocation": {
"latitude": 37.80437,
"longitude": -122.2708
},
"name": "Oakland",
"state": "California",
"timezone": "America/Los_Angeles"
},
"placeOfDispatch": {
"country": "Ivory Coast",
"countryCode": "CI",
"geolocation": {
"latitude": 4.74851,
"longitude": -6.6363
},
"name": "San-Pedro",
"state": "Bas-Sassandra",
"timezone": "Africa/Abidjan"
},
"portOfDischarge": {
"country": "United States",
"countryCode": "US",
"geolocation": {
"latitude": 37.80437,
"longitude": -122.2708
},
"name": "Oakland",
"state": "California",
"timezone": "America/Los_Angeles"
},
"portOfLoading": {
"country": "Ivory Coast",
"countryCode": "CI",
"geolocation": {
"latitude": 4.74851,
"longitude": -6.6363
},
"name": "San-Pedro",
"state": "Bas-Sassandra",
"timezone": "Africa/Abidjan"
},
"routePaths": [
{
"path": [
[4.7485, -6.6363],
[4.587, -6.5781],
[4.5734, -6.576],
[4.563, -6.5808],
[4.5558, -6.5924],
[4.4914, -6.771],
[4.4841, -6.7898],
[4.476, -6.8082],
[4.467, -6.8262],
[4.2089, -7.3117],
[4.2016, -7.3283],
[4.1967, -7.3456],
[4.1944, -7.3637],
[4.1744, -7.7596],
[4.1748, -7.7745],
[4.1776, -7.7889],
[4.1827, -7.8028],
[4.7845, -9.0884],
[4.7912, -9.1019],
[4.7986, -9.115],
[4.8066, -9.1278],
[7.4988, -13.2127],
[7.5136, -13.2333],
[7.5298, -13.2526],
[7.5476, -13.2706],
[11.0973, -16.5922],
[11.1124, -16.6044],
[11.1289, -16.6141],
[11.147, -16.6213],
[14.666930288125217, -17.71895164417353],
[14.7402, -17.7418],
[14.7553, -17.7455],
[14.7707, -17.7473],
[14.7863, -17.7472],
[20.8328, -17.3203],
[20.8485, -17.319],
[20.8641, -17.3174],
[20.8797, -17.3153],
[21.8205, -17.179],
[21.8363, -17.1762],
[21.8519, -17.1725],
[21.8673, -17.1678],
[27.7389, -15.1868],
[27.7538, -15.1832],
[27.7689, -15.1823],
[27.7842, -15.1841],
[28.1097, -15.2542],
[28.1219, -15.2595],
[28.128, -15.2687],
[28.128, -15.282],
[28.0997, -15.4134]
],
"transportType": "VESSEL",
"type": "SEA"
},
{
"path": [
[28.0997, -15.4134],
[28.127, -15.2867],
[28.1335, -15.2721],
[28.1448, -15.265],
[28.1609, -15.2652],
[28.3297, -15.3016],
[28.3471, -15.3024],
[28.3627, -15.2973],
[28.3764, -15.2862],
[29.7586, -13.7646],
[29.7731, -13.7483],
[29.7872, -13.7316],
[29.801, -13.7147],
[35.8216, -6.1895],
[35.8331, -6.1724],
[35.8413, -6.1539],
[35.8464, -6.134],
[36.5124, -2.1914],
[36.5167, -2.171],
[36.5226, -2.151],
[36.5299, -2.1315],
[36.6274, -1.9004],
[36.6338, -1.8863],
[36.6409, -1.8726],
[36.6486, -1.8593],
[37.4104, -0.6242],
[37.4191, -0.6115],
[37.429, -0.5999],
[37.44, -0.5893],
[38.5575, 0.3879],
[38.5699, 0.3972],
[38.5835, 0.4044],
[38.5982, 0.4095],
[38.8036, 0.4646],
[38.824, 0.4666],
[38.8426, 0.4614],
[38.8591, 0.4491],
[39.2365, 0.0651],
[39.2493, 0.0552],
[39.2638, 0.0494],
[39.28, 0.0477],
[39.4349, 0.0512],
[39.449, 0.0485],
[39.4576, 0.0401],
[39.4607, 0.026],
[39.4697, -0.3774]
],
"transportType": "VESSEL",
"type": "SEA"
},
{
"path": [
[39.4697, -0.3774],
[39.4607, 0.026],
[39.4576, 0.0401],
[39.449, 0.0485],
[39.4349, 0.0512],
[39.28, 0.0477],
[39.2638, 0.0494],
[39.2493, 0.0552],
[39.2365, 0.0651],
[38.8591, 0.4491],
[38.8426, 0.4614],
[38.824, 0.4666],
[38.8036, 0.4646],
[38.5982, 0.4095],
[38.5835, 0.4044],
[38.5699, 0.3972],
[38.5575, 0.3879],
[37.44, -0.5893],
[37.429, -0.5999],
[37.4191, -0.6115],
[37.4104, -0.6242],
[36.6486, -1.8593],
[36.6409, -1.8726],
[36.6338, -1.8863],
[36.6274, -1.9004],
[36.5299, -2.1315],
[36.5226, -2.151],
[36.5167, -2.171],
[36.5124, -2.1914],
[35.8446, -6.1446],
[35.8419, -6.1581],
[35.8385, -6.1714],
[35.8343, -6.1846],
[32.3, -16.245],
[32.2955, -16.2581],
[32.2909, -16.2711],
[32.2864, -16.2841],
[16.7176, -61.4006],
[16.7126, -61.4151],
[16.7075, -61.4296],
[16.7023, -61.4442],
[15.8954, -63.7099],
[15.8879, -63.7309],
[15.8802, -63.7518],
[15.8724, -63.7727],
[9.7798, -79.9034],
[9.7697, -79.9203],
[9.755, -79.9304],
[9.7356, -79.9334],
[9.2639, -79.9191],
[9.2473, -79.9167],
[9.2322, -79.9106],
[9.2186, -79.9009],
[9.1793, -79.865],
[9.1664, -79.8535],
[9.1531, -79.8426],
[9.1394, -79.8321],
[9.1365, -79.83],
[9.1258, -79.82],
[9.1181, -79.808],
[9.1135, -79.794],
[9.1046, -79.7481],
[9.1004, -79.7338],
[9.0936, -79.7208],
[9.0842, -79.7093],
[8.9175, -79.5407],
[8.9072, -79.533],
[8.8957, -79.5295],
[8.8829, -79.5302],
[7.621, -79.8014],
[7.6079, -79.8051],
[7.5955, -79.8103],
[7.5837, -79.817],
[7.0244, -80.1868],
[7.0142, -80.196],
[7.008, -80.2074],
[7.0058, -80.2209],
[7.0042, -81.7753],
[7.0054, -81.7908],
[7.009, -81.8058],
[7.0149, -81.8201],
[18.1403, -103.6134],
[18.1477, -103.6273],
[18.1558, -103.6409],
[18.1644, -103.654],
[19.1644, -105.1062],
[19.1734, -105.1193],
[19.1826, -105.1324],
[19.1917, -105.1454],
[22.7423, -110.1508],
[22.7517, -110.1637],
[22.7614, -110.1763],
[22.7715, -110.1886],
[24.094, -111.7615],
[24.1068, -111.7767],
[24.1197, -111.7919],
[24.1326, -111.807],
[24.7217, -112.4942],
[24.7349, -112.509],
[24.7486, -112.5234],
[24.7627, -112.5374],
[27.7409, -115.3719],
[27.7566, -115.3866],
[27.7724, -115.4012],
[27.7884, -115.4156],
[28.2166, -115.797],
[28.2308, -115.8095],
[28.2451, -115.8219],
[28.2595, -115.8342],
[33.8261, -120.5323],
[33.8377, -120.5417],
[33.8496, -120.5506],
[33.8618, -120.5591],
[36.2347, -122.13],
[36.2472, -122.1381],
[36.2599, -122.1457],
[36.2729, -122.153],
[36.9756, -122.5345],
[36.9875, -122.5406],
[36.9997, -122.5463],
[37.0122, -122.5513],
[37.584, -122.7694],
[37.5953, -122.7714],
[37.6041, -122.7676],
[37.6104, -122.7581],
[37.8044, -122.2708]
],
"transportType": "VESSEL",
"type": "SEA"
}
]
}
}