수출신고 조회

API

/v1/exports

DESCRIPTION

수출신고 이용 고객사의 경우 신고 상태 조회

METHOD

GET

API

/v1/exports

METHOD

$\color{green}\colorbox{#d1ffbd}{\scriptsize\textsf{GET}}$

REQUEST

header

인증

\color{Red}\colorbox{oldlace}{\scriptsize\textsf{필수}}

query

필드	필수	설명
order_id	$\color{#333333}\colorbox{#eeeeee}{\scriptsize\textsf{선택}}$	주문번호 목록
receipt_no	$\color{#333333}\colorbox{#eeeeee}{\scriptsize\textsf{선택}}$	접수번호로 조회
waybill_no	$\color{#333333}\colorbox{#eeeeee}{\scriptsize\textsf{선택}}$	운송장번호로 조회
report_no	$\color{#333333}\colorbox{#eeeeee}{\scriptsize\textsf{선택}}$	신고번호로 조회
simple	$\color{#333333}\colorbox{#eeeeee}{\scriptsize\textsf{선택}}$	간이수출신고 목록변환 여부 X면장 = 간이수출신고 E면장 = 간이수출신고 목록변환 예) /v1/exports?simple=true

RESPONSE

필드정의

상태코드 별 상태값

응답 규격

필드	필수	설명
code	$\color{Red}\colorbox{oldlace}{\scriptsize\textsf{필수}}$	API 논리적 응답 코드
message	$\color{Red}\colorbox{oldlace}{\scriptsize\textsf{필수}}$	human readable 응답 메시지 header의 Accept-Language 언어 설정별 메시지 출력 (’en’, ‘ko’ 만 지원)
result	$\color{Red}\colorbox{oldlace}{\scriptsize\textsf{필수}}$	API 응답의 실제 데이터
host	$\color{Red}\colorbox{oldlace}{\scriptsize\textsf{필수}}$	API 를 처리한 서버 정보
timestamp	$\color{Red}\colorbox{oldlace}{\scriptsize\textsf{필수}}$	API 응답 시간
tid	$\color{Red}\colorbox{oldlace}{\scriptsize\textsf{필수}}$	API 호출 추적용 고유 trace id UUID 값

공통 오류

오류 코드	유형	설명
4000	BAD_REQUEST	API 요청에 사용한 값 오류
4010	UNAUTHORIZED	아래 기재된 실패 사유 이외의 로그인 실패
4011	TOKEN_EXPIRED	Token 유효기간 만료
4012	ACCOUNT_LOCKED	비밀번호 입력을 여러번 실패하여 계정 잠김
4013	TOKEN_INVALID	유효하지 않은 Token 오류
4030	FORBIDDEN	권한이 없는 리소스 접근 시도 오류
4040	NOT_FOUND	존재하지 않는 리소스 접근 시도 오류
4090	CONFLICT	이미 존재하는 리소스 고유 번호로 중복 생성 시도

EXAMPLE

Cmd/Ctrl + Option/Alt + T : 전체 열기/닫기

Request

요청

Response

Success

결과 

Fail

결과

필드	간이신고	간이신고 목록변환	길이	설명
order_no	$\color{Red}\colorbox{oldlace}{\scriptsize\textsf{필수}}$	$\color{Red}\colorbox{oldlace}{\scriptsize\textsf{필수}}$	50	전송한 접수번호 (receipt_no)
receipt_no	$\color{#333333}\colorbox{#eeeeee}{\scriptsize\textsf{선택}}$	$\color{#333333}\colorbox{#eeeeee}{\scriptsize\textsf{선택}}$	50	전송한 주문의 접수번호
waybill_no	$\color{#333333}\colorbox{#eeeeee}{\scriptsize\textsf{선택}}$	$\color{#333333}\colorbox{#eeeeee}{\scriptsize\textsf{선택}}$	50	전송한 주문의 송장번호
invoice_no	$\color{Red}\colorbox{oldlace}{\scriptsize\textsf{필수}}$	$\color{#333333}\colorbox{#eeeeee}{\scriptsize\textsf{선택}}$	30	전송한 Invoice 번호 (보통은 주문번호와 동일)
order_id	$\color{Red}\colorbox{oldlace}{\scriptsize\textsf{필수}}$	$\color{Red}\colorbox{oldlace}{\scriptsize\textsf{필수}}$		전송한 주문의 시스템 내부 고유 번호
tenant_id	$\color{Red}\colorbox{oldlace}{\scriptsize\textsf{필수}}$	$\color{Red}\colorbox{oldlace}{\scriptsize\textsf{필수}}$		전송한 주문의 셀러 시스템 내부 고유 번호
agente_no	$\color{Red}\colorbox{oldlace}{\scriptsize\textsf{필수}}$	$\color{Red}\colorbox{oldlace}{\scriptsize\textsf{필수}}$	20	Agente System 에서 발행한 고유번호
exp_shpr	$\color{Red}\colorbox{oldlace}{\scriptsize\textsf{필수}}$	$\color{Red}\colorbox{oldlace}{\scriptsize\textsf{필수}}$		수출화주 상호 (셀러의 상호명)
state_code	$\color{Red}\colorbox{oldlace}{\scriptsize\textsf{필수}}$	$\color{Red}\colorbox{oldlace}{\scriptsize\textsf{필수}}$	2	상태코드 값(01~20)
state_name	$\color{Red}\colorbox{oldlace}{\scriptsize\textsf{필수}}$	$\color{Red}\colorbox{oldlace}{\scriptsize\textsf{필수}}$	-	상태코드에 따른 표시 문자열
ref_no	$\color{#333333}\colorbox{#eeeeee}{\scriptsize\textsf{선택}}$	$\color{#333333}\colorbox{#eeeeee}{\scriptsize\textsf{선택}}$	50	전송했던 참고번호
report_no	$\color{#333333}\colorbox{#eeeeee}{\scriptsize\textsf{선택}}$	$\color{#333333}\colorbox{#eeeeee}{\scriptsize\textsf{선택}}$	15	수출신고번호
report_ymd	$\color{#333333}\colorbox{#eeeeee}{\scriptsize\textsf{선택}}$	$\color{#333333}\colorbox{#eeeeee}{\scriptsize\textsf{선택}}$	8	수출신고일자 (YYYYMMDD)
accept_ymd	$\color{#333333}\colorbox{#eeeeee}{\scriptsize\textsf{선택}}$	$\color{#333333}\colorbox{#eeeeee}{\scriptsize\textsf{선택}}$	8	수출수리일자 (YYYYMMDD)
load_ymd	$\color{#333333}\colorbox{#eeeeee}{\scriptsize\textsf{선택}}$	$\color{#333333}\colorbox{#eeeeee}{\scriptsize\textsf{선택}}$	8	적재의무기한 (YYYYMMDD)
ship_ymd	$\color{#333333}\colorbox{#eeeeee}{\scriptsize\textsf{선택}}$	$\color{#333333}\colorbox{#eeeeee}{\scriptsize\textsf{선택}}$	8	선적일자 (YYYYMMDD)
invoice	$\color{Red}\colorbox{oldlace}{\scriptsize\textsf{필수}}$	$\color{Red}\colorbox{oldlace}{\scriptsize\textsf{필수}}$		수출신고 전송에 사용한 데이터 (참고용)
state	$\color{#333333}\colorbox{#eeeeee}{\scriptsize\textsf{선택}}$	$\color{#333333}\colorbox{#eeeeee}{\scriptsize\textsf{선택}}$		수출신고 전송 후 상태 확인 API를 실행하면 기록되는 최신 상태 값

수출신고 조회

API

/v1/exports

METHOD

GET\color{green}\colorbox{#d1ffbd}{\scriptsize\textsf{GET}}GET​

REQUEST

header

인증

query

RESPONSE

필드정의

응답 규격

공통 오류

EXAMPLE

Request

Response

Success

Fail

$\color{green}\colorbox{#d1ffbd}{\scriptsize\textsf{GET}}$