Container event (webhook)
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 |
---|---|---|
shipment_id | string | Your unique shipment id provided in the tracking registration |
unique_container_id | string | Your unique container id provided in the tracking registration |
chaine_reference_id | string | Chaine's unique container id provided in the tracking registration |
container_number | string | SeaLine issued container number |
bill_of_lading_number | string | SeaLine issued bill of lading number |
event_mode | string | The mode of the container event. Values are "land" or "sea" |
event_type | string | The type of event of values 'Inland origin', 'Origin port', 'Destination port', or 'Inland destination'. |
event_code | string | Chaine event code for the event. See list of event codes |
event_description | string | Chaine normalized event description for the event code. See list of event descriptions |
raw_event_description | 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. |
is_eta | boolean | Specifies if the date is an estimated date-time or actual. |
location | Location | Location of the event. |
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. |
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 |
call_sign | 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
{
"shipment_id": "a456-426614174000",
"unique_container_id": "a917-418374931111",
"chaine_reference_id": "123u0987-e89b-12d3-a456-426614174000",
"container_number": "EGHU1111111",
"bill_of_lading_number": "MEDUPD111111",
"event_mode": "sea",
"event_type": "Destination port",
"event_code": "CDD",
"event_description": "Container discharge at destination port",
"raw_event_description": "Container discharged at New York City ",
"date": "2022-04-30 13:00:00",
"is_eta": false,
"location": {
"name": "New York City",
"city": "New York City",
"state": "New York",
"country": "United States",
"countryCode": "US",
"unlocode": "USNYC",
"latitude": 40.71427,
"longitude": -74.00597
},
"vessel": {
"name": "APL SENTOSA",
"imo": 9632040,
"call_sign": "9HA5180",
"mmsi": 215560000,
"flag": "MT"
},
"voyage": "0TUNLS1MA"
}