CONTENTS
Search
API
/v1/orders/:order_id/states/:state
METHOD
REQUEST
header
인증
parameter
필드 | 필수 | 설명 |
order_id | • 주문 API의 고유 _id
• 주문 정보의 접수번호 receipt_no
• 운송장 번호 waybill_no
• 주문 번호 no_info1 | |
state | 변경할 주문 상태 |
주문 상태 정의
상태값 | 주문상태 | 설명 |
created | 주문접수 | 주문이 정상적으로 등록된 상태 |
pending | 주문보류 | 물류센터 입고완료 전까지 변경 가능 |
canceled | 주문취소 | 주문을 취소, 상태 원상복구 불가
동일 주문번호로 재접수 불가능 |
removed | 주문삭제 | 주문을 삭제, 상태 원상복구 불가
동일 주문번호로 재접수 가능 |
confirmed | 주문확정 | 등록된 주문 수정 후 확정한 상태 |
requested | 배송요청 | 상품을 물류센터로 발송한 상태
현 시점부터 ICS admin 에서 주문 관리를 할 수 있음 |
sent | 셀러발송 | ICS 집하지로 발송 시 사용하는 국내 택배 송장번호 등
출고 스캔 이력이 필요할 경우 사용 (선택) |
inbound | (물류센터) 입고완료 | 물류센터에서 정상적으로 입고 작업을 마친 상태 |
outbound | (물류센터) 출고완료 | 물류센터에서 정상적으로 출고 작업을 마친 상태 |
departure | 항공기 출발 | 항공기 출발 |
arrival | 항공기 도착 | 항공기 도착 |
incustoms | 통관중 | 통관중 |
customs | 통관완료 | 통관완료 |
shipping | 배송중 | 항공기 출발, 항공기 도착, 통관, 현지 배송 과정을
포함하는 상태 |
delivered | 배송완료 | 고객 배송완료 |
terminated | 배송종료 | 특정 사유로 배송이 종료된 경우 |
변경 가능한 상태
OMS | 현재 상태 ► | 주문접수 | 주문보류 | 주문취소 | 주문삭제 | 주문확정 | 배송요청 | 셀러발송 |
▼ 변경할 상태 | created | pending | canceled | removed | confirmed | requested | sent | |
주문접수 | created | O | O | O | ||||
주문보류 | pending | O | O | O | O | O | ||
주문취소 | canceled | O | O | O | O | O | O | |
주문삭제 | removed | O | O | O | O | O | O | |
주문확정 | confirmed | O | O | O | O | O | ||
배송요청 | requested | O | O | O | O | |||
셀러발송 | sent | O | O |
RESPONSE
응답 규격
필드 | 필수 | 설명 |
code | API 논리적 응답 코드 | |
message | human readable 응답 메시지
header의 Accept-Language 언어 설정별 메시지 출력 (’en’, ‘ko’ 만 지원) | |
result | API 응답의 실제 데이터 | |
host | API 를 처리한 서버 정보 | |
timestamp | API 응답 시간 | |
tid | 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
결과