This API allows you to register or update a carrier’s cargo information in the system.
Authentication
The Carrier 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/carrier
Execution Steps
1.
2.
Navigate to the /carrier endpoint.
3.
Click [Try it out] to activate input fields.
4.
Enter values according to the following request parameters:
•
Request body: When carrier cargo information is entered, the system registers or updates the cargo details.
5.
Click [Execute].
6.
View results in the response section.
Request body Example
{
"cust_cd": "ABCDEF",
"cust_name": "Seavantage",
"VINs": [
{
"VIN": "string"
}
],
"carrierCode": "EUKO",
"bookingNo": "string",
"mblNo": "SOMEBILL2025001",
"ships": [
{
"pol_en": "Busan",
"pod_en": "New York",
"imo_no": "1234567",
"call_sign": "string",
"vessel_name": "string",
"pol": "KRPUS",
"etd": "20250125010000",
"atd": "20250125010000",
"pod": "USNYC",
"eta": "20250125010000",
"ata": "20250125010000",
"mmsi": "123456789"
}
]
}
JavaScript
복사
Field Description
Field | Description |
cust_cd | Customer code used by the carrier to identify the customer |
cust_name | Customer name used by the carrier to identify the customer |
VIN | Vehicle Identification Number (VIN) |
carrierCode | SCAC code |
bookingNo | Booking number |
mblNo | Master B/L number (M-B/L) |
pol_en | Port of Loading name (English) |
pod_en | Port of Discharge name (English) |
imo_no | IMO number |
call_sign | Call sign |
vessel_name | Vessel name |
pol | Port of Loading UNLOCODE |
etd | Estimated Time of Departure (ETD) at Port of Loading |
atd | Actual Time of Departure (ATD) at Port of Loading |
pod | Port of Discharge UNLOCODE |
eta | Estimated Time of Arrival (ETA) at Port of Discharge |
ata | Actual Time of Arrival (ATA) at Port of Discharge |
mmsi | Unique vessel identifier |
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-22T01:04:57.593170861",
"response": null
}
JSON
복사
Response Field Descriptions
Top-Level Response Fields
Field | Example Value | Description |
code | 201 | Response status code (used in the same way as standard HTTP status codes).
See the list of codes below for reference. |
message | success | Response message (description based on status) |
error | false | Error flag
true: error occurred
false: successful processing |
timestamp | 2025-05-14T01:09:00.834665213 | Time of response creation (UTC) |
response | null | Returns null for both success and failure responses. |
Response Codes
Code | Description |
201 | Created |
400 | Bad request |
401 | Unauthorized |
403 | Forbidden |
422 | Unprocessable entity |
429 | Too many requests |