Cargo registrations are allowed up to the limit specified in your contract. Any registrations beyond this limit will incur additional charges in accordance with your contractual terms.

Authentication

The Cargo API uses Basic Authorization on Swagger UI.

Authentication Steps

Click the [Authorize] button in the top right corner.

Enter the provided username and password in the popup window.

Click [Authorize] again to proceed with authentication.

After successful login, click [Close] to close the window.

All API requests from Swagger UI will automatically include the authorization token.

Cargo Registration Request

Request URL

[POST] https://insight.seavantage.com/api/cargo

Execution Steps

In the Swagger Documentation, select Cargo from the Select a definition menu at the top right.

Navigate to the /cargo endpoint.

Click [Try it Out] to activate the input fields.

Enter the request body (refer to the format below).

Click the [Execute] button.

Check the response section below for the registration result.

Cargo Registration Request Body Format

At least one of the following fields must be included along with the carrierCode containerNo, mblNo, bookingNo.

Entering M-B/L Number Only

{
  "carrierCode": "string",
  "mblNo": "string"
}
JSON
복사

Entering Booking Number Only

{
	"carrierCode": "string",
  "bookingNo": "string"
}
JSON
복사

Entering Container Number Only

{
  "carrierCode": "string",
  "containerNo": "string"
}
JSON
복사

Entering M-B/L and Booking Number

{
  "carrierCode": "string",
  "mblNo": "string",
  "bookingNo": "string"
}
JavaScript
복사

Entering M-B/L or Booking Number Along with Detailed Cargo Information

When registering multiple House B/Ls, containers, and shipper/consignee information based on a carrierCode and either an mblNo or bookingNo, use the request structure shown below:

{
  "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
복사

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-06-25T07:33:09.179281503",
  "response": {
    "documentId": "62ea3af6-344e-44f6-a114-432b5b92365c"
  }
}
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	"Created"	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 or Object	Returns cargo data if found Returns null if not found

Response Codes

Code	Description
201	Created
400	Bad request
401	Unauthorized
403	Forbidden
422	Unprocessable entity
429	Too many requests

Detailed Response Description

Depth 1 Field Description (response object)

Field	Example Value	Description
documentId	62ea3af6-344e-44f6-a114-432b5b92365c	Internal unique cargo identifier