1. API Overview
The Cargo Insight API allows you to track cargo movement in real time, monitor the Estimated Time of Arrival (ETA), the Predicted Time of Arrival (PTA), and determine whether delays have occurred.
This API enables users to store cargo information to make it traceable.
To track cargo, you must store it using at least one of the following identifiers:
•
Master B/L Number
•
Booking Number
•
Container Number
2. Authentication Method
The Cargo API uses the Basic Authorize method for authentication via Swagger UI.
Authentication steps:
1.
Click the [Authorize] button at the top-right corner.
2.
Enter the provided ID and Password in the popup window.
3.
Click [Authorize] again to complete authentication.
4.
Click [Close] to close the popup.
Once authenticated, an access token is automatically included in all API requests made via Swagger UI.
3. 화물 등록
3-1. Request Info
Request URL:
3-2. Execution Steps
1.
In Swagger, select the definition Cargo from the top-right dropdown.
2.
Navigate to the /cargo endpoint.
3.
Click [Try it Out] to enable input fields.
4.
Enter the request body data.
5.
Click [Execute].
6.
Check the response area for results.
3-3. Request Body Examples
You must include carrierCode and at least one of the following: mblNo, bookingNo, or containerNo.
When only M-B/L Number is provided:{
"carrierCode": "string",
"mblNo": "string"
}
JSON
복사
When only Booking Number is provided:{
"carrierCode": "string",
"bookingNo": "string"
}
JSON
복사
When only Container Number is provided:{
"carrierCode": "string",
"containerNo": "string"
}
JSON
복사
When both M-B/L and Booking Numbers are provided:{
"carrierCode": "string",
"mblNo": "string",
"bookingNo": "string"
}
JavaScript
복사
When registering multiple House B/Ls and container details:Use this format when registering additional details like multiple House B/Ls, containers, and cargo owners, based on a single M-B/L or Booking Number.
{
"carrierCode": "string",
"mblNo": "string",
"bookingNo": "string",
"containerNo": "string",
"bookingRegno": "string",
"srNo": "string",
"customColumn1": "string",
"customColumn2": "string",
"customColumn3": "string",
"hbls": [
{
"hblNo": "string",
"ciNo": "string",
"shipperCode": "string",
"shipperName": "string",
"consigneeCode": "string",
"consigneeName": "string",
"ownerCode": "string",
"ownerName": "string",
"containers": [
{
"containerNo": "string",
"size": "string",
"type": "string",
"commodity": "string",
"hscode": "string",
"qty": 0,
"gw": 0,
"sealNo1": "string",
"sealNo2": "string",
"sealNo3": "string"
}
]
}
]
}
JavaScript
복사
3-4. Response Info
The response will follow the same structure whether the request is successful or fails.
Example Response{
"code": 201,
"message": "Created",
"error": false,
"timestamp": "2025-05-14T01:09:00.834665213",
"response": null
}
JSON
복사
Response Field Details필드명 (Attr) | 예시 값 (Example) | 설명 (Desc) |
code | 201 | HTTP status code |
message | "Created" | Response message |
error | false | Indicates error (true: error occurred, false: success) |
timestamp | "2025-05-14T01:09:00.834665213" | Time of response (UTC) |
response | null 또는 Object | Response data (can be null or a data object) |
Response Code Types코드 | 설명 |
201 | Successfully created |
400 | Invalid parameters (Bad Request) |
401 | Authentication required (Unauthorized) |
403 | Forbidden (No access rights) |
422 | Unprocessable Entity (Validation failed) |
429 | Too many requests (Rate limit exceeded) |