POST/carrier

운송사(Carrier)의 화물 정보를 저장하는 API입니다. 해당 API를 통해 화물의 세부 정보를 시스템에 등록하거나 업데이트할 수 있으며, 이후 화물 추적, 적재 계획, 보고 등에 활용할 수 있습니다.

인증 방법

Carrier API는 Swagger UI에서 Basic Authorize 인증 방식을 사용합니다.

인증 절차

우측 상단의 [Authorize] 버튼 클릭

팝업 창에 제공받은 인증 정보(아이디/비밀번호) 입력

[Authorize] 버튼 다시 클릭 → 인증 진행

인증 완료 후 [Close] 버튼 클릭

인증 완료 후 모든 요청에 인증 토큰이 자동으로 포함되어 전송됩니다.

요청 정보

요청 URL

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

Swagger UI 요청 실행 순서

Swagger 문서 우측 상단 메뉴에서 Carrier 선택

/carrier 경로 이동

[Try it Out] 클릭 → 요청창 활성화

요청 Request Body 입력

[Execute] 버튼 클릭

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

요청 예시

{
  "cust_cd": "ABCDEF",
  "cust_name": "Seavantage",
  "VINs": [
    {
      "VIN": "string"
    }
  ],
  "carrierCode": "EUKO",
  "bookingNo": "string",
  "mblNo": "SOMEBILL2025001",
  "ships": [
    {
      "pol_en": "Busan",
      "pod_en": "New York",
      "imo_no": "1234567",
      "call_sign": "string",
      "vessel_name": "string",
      "pol": "KRPUS",
      "etd": "20250125010000",
      "atd": "20250125010000",
      "pod": "USNYC",
      "eta": "20250125010000",
      "ata": "20250125010000",
      "mmsi": "123456789"
    }
  ]
}
JSON
복사

주요 필드 설명

Depth 1

필드명	예시 값	설명
cust_cd	ABCDEF	고객 코드
cust_name	Seavantage	고객명
carrierCode	EUKO	SCAC 4자리 선사 코드
bookingNo	SOMEBILL2025001	Booking 번호
mblNo	SOMEBILL2025001	Master B/L 번호

Depth 2 (VINs 객체)

필드명	예시 값	설명
VIN	string	차량 식별 번호 (Vehicle ID Number)

Depth 3 (ships 객체)

필드명	예시 값	설명
pol_en	Busan	선적지 (영문)
pod_en	New York	양하지 (영문)
imo_no	1234567	IMO Number
call_sign	string	호출부호
vessel_name	string	선명
pol	KRPUS	선적지 UNLOCODE
etd	20250125010000	출발 예정 시각
atd	20250125010000	출발 실제 시각
pod	USNYC	양하지 UNLOCODE
eta	20250125010000	도착 예정 시각
ata	20250125010000	도착 실제 시각
mmsi	123456789	선박 고유 식별 번호 (MMSI)

응답 정보

응답 예시

{
  "code": 200,
  "message": "OK",
  "error": false,
  "timestamp": "2024-12-01T12:00:00",
  "response": {}
}
JSON
복사

응답 필드 설명

필드명	예시 값	설명
code	200	HTTP 상태 코드
message	OK	응답 메시지
error	false	오류 여부 (true / false)
timestamp	2024-12-01T12:00:00	응답 생성 시간 (UTC 기준)

응답 코드 안내

코드	설명
200	정상 응답
201	등록 완료
400	잘못된 파라미터
401	인증 필요
403	권한 없음
422	처리 불가
429	요청 과다 (Rate Limit 초과)