This API registers users to receive summary information and event notifications for a specific shipment.
Authentication
The Alert API uses Basic Authorization on Swagger UI.
Authentication Steps
1.
Click the [Authorize] button in the top right corner.
2.
Enter the provided username and password in the pop-up window.
3.
Click [Authorize] again to proceed with authentication.
4.
After successful login, click [Close] to close the window.
All API requests from Swagger UI will automatically include the authorization token.
Request Information
Request URL
Request URL : [POST] https://insight.seavantage.com/api/alert/cargo
Execution Steps
1.
2.
Navigate to the /alert/cargo endpoint.
3.
Click [Try it out] to activate input fields.
4.
Enter values according to the following request parameters:
•
Request body: Up to two email recipients can be assigned per shipment.
Request body Example
{
"documentId": "921ee5cc-fa1b-4ca8-912f-77f530f39239",
"sales": {
"email": "email@seavantage.com",
"isEventEmailEnabled": true
},
"operator": {
"email": "email@seavantage.com",
"isEventEmailEnabled": true
}
}
JavaScript
복사
Field Description
◦
documentId
▪
▪
◦
sales
▪
email: Email account to receive notifications (must be an account registered in the customer’s workspace).
▪
isEventEmailEnabled:
•
true: Receive both summary and status change notifications.
•
false: Receive summary emails only.
◦
operator
▪
email: Email account to receive notifications (must be an account registered in the customer’s workspace).
▪
isEventEmailEnabled:
•
true: Receive both summary and status change notifications.
•
false: Receive summary emails only.
5.
Click [Execute].
6.
View results in the response section.
Response Information
The response is returned in the following format, regardless of whether the request is successful or failed.
Sample Response Format
{
"code": 201,
"message": "Created",
"error": false,
"timestamp": "2025-08-27T11:06:57.205562372",
"response": null
}
JSON
복사
To update the email recipient account or notification settings, modify the corresponding values and call the API again.
Response Field Descriptions
Top-Level Response Fields
Field | Example Value | Description |
code | 400 | Response status code (used in the same way as standard HTTP status codes).
See the list of codes below for reference. |
message | Invalid request body. | Response message (description based on status) |
error | true | Error flag
true: error occurred
false: successful processing |
timestamp | 2024-12-01T12:00:00 | Time of response creation (UTC) |
response | Object or null | Returns an Object if data exists, or null if no data is found. |
Response Codes
Code | Description |
201 | Created |
400 | Bad request |
401 | Unauthorized |
403 | Forbidden |
422 | Unprocessable entity |
429 | Too many requests |