/ship/search API (1)

1. API 소개

이 API는 잘못 등록된 화물이거나, 조회 대상에서 제외해야 하는 경우 화물을 삭제할 때 사용됩니다.

삭제된 화물은 시스템에서 완전히 제거되어 더 이상 조회되지 않도록 처리됩니다.

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

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

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

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

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

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

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

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

Swagger 문서에서 우측 상단의 Select a definition 메뉴에서 Cargo 선택

 /cargo/{documentId} 경로로 이동

[Try it Out] 클릭 → 입력창 활성화

요청 Parameters documentId 값을 입력

[Execute] 버튼 클릭

하단 응답 영역에서 등록 결과 확인

아래 조건을 입력하신 후 [Execute]를 클릭하면 응답 정보를 확인할 수 있습니다.

Parameters

•

documentId: /cargo/search API에서 조회된 documentId(화물 구분 식별자)를 입력해야 됩니다.

요청이 성공하거나 실패했을 때 http 상태  코드로 구분이 가능합니다.

응답 코드 종류 (code 필드 기준)