[PUT] /cargo/{documentId}

인증 방법

화물 등록

기존에 등록된 mblNo 또는 bookingNo의 hbl정보를 수정하여 다시 등록할 때 사용하는 API 입니다.

Swagger 문서 바로가기

인증 방법

Cargo API는 사용자 인증을 위해 Swagger UI에서 Basic Authorize 인증 방식을 제공합니다.

인증 절차는 다음과 같습니다:

우측 상단의 [Authorize] 버튼을 클릭합니다.

팝업 창에 제공받은 인증 정보(아이디, 비밀번호)를 입력합니다.

입력 후 다시 [Authorize] 버튼을 클릭하여 인증을 진행합니다.

인증이 완료되면 [Close] 버튼을 클릭하여 인증 창을 닫습니다.

Swagger UI에서 호출되는 모든 API 요청에 인증 토큰이 자동으로 포함되어 전송됩니다.

화물 등록

요청 정보

Request URL : [PUT] https://insight.seavantage.com/api/cargo/{documentId}

실행 순서

Swagger 문서에서 우측 상단의 Select a definition 메뉴에서 Cargo를 선택합니다.

/cargo/{documentId} 경로로 이동합니다.

[Try it out] 버튼을 클릭하여 입력창을 활성화합니다.

아래 요청 Parameters 조건에 따라 결과가 반환됩니다.

•

documentId : GET /cargo/search API를 통해 조회한 화물 식별자(ID)를 입력

•

Request body 예시

{
  "bookingRegno": "SOMEBILL2025001",
  "srNo": "1",
  "customColumn1": "Custom column 1",
  "customColumn2": "Custom column 2",
  "customColumn3": "Custom column 3",
  "hbls": [
    {
      "hblNo": "CMAU1234567",
      "ciNo": "1234567890",
      "shipperCode": "C000",
      "shipperName": "CMA CGM",
      "consigneeCode": "C000",
      "consigneeName": "CMA CGM INDIA PVT LTD",
      "ownerCode": "C000",
      "ownerName": "CMA CGM",
      "containers": [
        {
          "containerNo": "CONTAINER1234567",
          "size": "20",
          "type": "GP",
          "commodity": "Electronics",
          "hscode": "123456",
          "qty": 10,
          "gw": 1000,
          "sealNo1": "123456",
          "sealNo2": "123456",
          "sealNo3": "123456"
        }
      ]
    }
  ]
}
JavaScript
복사

주의사항

•

hbls 정보를 등록 시 입력했고, 해당 정보를 이후에도 유지하고 싶다면 업데이트 요청 시 반드시 함께 포함시켜야 합니다.

•

업데이트 시 hbls를 입력하지 않으면, 기존 값은 삭제되며 자동으로 재생성됩니다.

•

Container Tracking은 hbls 입력할 수 없으므로 hbls 객체 제거 후 업데이트 요청해야 합니다.

[Execute] 버튼을 클릭합니다.

하단 응답 영역에서 등록 결과를 확인합니다.

응답 정보

요청이 성공하거나 실패했을 때 공통적으로 아래와 같은 형식으로 응답이 반환됩니다.

응답 예시

{
  "code": 200,
  "message": "OK",
  "error": false,
  "timestamp": "2025-08-11T00:38:03.257175915",
  "response": null
}
JSON
복사

응답 필드 상세 설명

응답 필드 정의

필드명	예시 값	설명
code	200	응답 상태 코드 (HTTP status code와 동일하게 사용됨) (아래 별도 응답 상태 코드표 참조)
message	OK	응답 메시지 (상태에 따른 설명)
error	false	오류 여부 true: 오류 발생 false: 정상 처리
timestamp	2025-05-14T01:09:00.834665213	응답 생성 시각 (UTC 기준)
response	null	성공시 null 반환

응답 코드 종류

코드	설명
200	정상 처리 (Success)
400	잘못된 파라미터 (Bad request)
401	인증 필요 (Unauthorized)
403	권한 없음 (Forbidden)
422	처리 불가 (Unprocessable entity)
429	요청 과다 (Too many requests)