home

Cargo DELETE API

이 API는 잘못 등록된 화물이거나, 조회 대상에서 제외해야 하는 경우 화물을 삭제할 때 사용됩니다.
삭제된 화물은 시스템에서 완전히 제거되어 더 이상 조회되지 않도록 처리됩니다.

인증 방법

Cargo Insight API는 사용자 인증을 위해 Swagger UI에서 Basic Authorize 인증 방식을 제공합니다.
인증 절차:
1.
우측 상단의 [Authorize] 버튼 클릭
2.
팝업 창에 제공받은 아이디 / 비밀번호 입력
3.
입력 후 다시 [Authorize] 버튼 클릭
4.
인증 완료 후 [Close] 버튼 클릭
Swagger UI에서 호출되는 모든 API 요청에 인증 토큰이 자동 포함되어 전송됩니다.

화물 삭제 방법

1. 요청 정보

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

2. Swagger UI에서 실행

1.
Swagger 문서 우측 상단 Select a definition 메뉴에서 Cargo 선택
2.
/cargo/{documentId} 경로 선택
3.
[Try it Out] 클릭
4.
documentId에 화물 식별자 입력
5.
[Execute] 클릭
6.
응답 영역에서 결과 확인

3. 필수 입력 값

파라미터명
설명
documentId
/cargo/search API 호출 시 응답받은 화물 구분 식별자

Swagger 예시 화면

Swagger 문서 바로가기

응답 정보

요청이 성공하거나 실패했을 때는 HTTP 응답 코드로 처리 결과를 확인할 수 있습니다.

응답 코드 안내

코드
설명
204
정상 처리 (Deleted)
400
잘못된 파라미터 (Bad Request)
401
인증 필요 (Unauthorized)
403
권한 없음 (Forbidden)
422
처리 불가 (Unprocessable Entity)
429
요청 과다 (Too Many Requests)