주문상태조회 API

Description

[POST] https://sa2.esmplus.com/shipping/v1/Delivery/GetDeliveryStatus

주문번호 또는 기간 내 주문번호별 주문 상태값을 조회합니다.

Request Description

항목	항목명	필수여부	Type	Description
orderNo	주문번호	Y	long	처리하고자 하는 주문번호 입력 기간으로 조회시 0 으로 입력
SearchDateConditionType	기간검색구분	Y	int	1 : 결제일자 2 : 주문확인일자 3 : 최초발송일자 4 : 최초배송완료일자 5 : 구매결정일자 6 : 송금일자 7 : 반품승인일자 8 : 교환승인일자 9 : 취소일자
FromDate	조회기준시작일	Y	date	YYYY-MM-DD 형태 7일 이내 기간으로 조회 가능
ToDate	조회기준종료일	Y	date	YYYY-MM-DD 형태 7일 이내 기간으로 조회 가능
Page	페이지No	Y	int	1 이상 입력 가능

JSON
{
  "OrderNo": long,
  "SearchDateConditionType": int,
  "FromDate": "YYYY-MM-DD",
  "ToDate": "YYYY-MM-DD",
  "Page": int
}

 

Response Description

항목	항목명	Type	Description
ResultCode	결과	string	성공: Success 실패: Error Massage 참고
Message	메시지	string
OrderNo	주문번호	int	처리된 주문번호 Return
Status	주문상태	int	0 : 입금확인중 1 : 신규주문 2 : 배송준비중 3 : 배송중 (교환 재발송 처리시 배송중 으로 변경) 4 : 배송완료 5 : 구매결정 6 : 취소 7 : 반품 8 : 교환 9 : 미수령신고 10 : (옥션) 거래완료 후 환불 (송금 후 취소)
ClaimStatus	클레임세부상태	int	Status > 6번 취소일 경우 1: 취소신청, 2: 취소중, 3: 취소완료 Status > 7번 반품일 경우 1: 반품신청, 2: 반품처리중, 3: 반품완료(환불완료) Status > 8번 교환일 경우 1: 교환신청, 2: 교환수거완료, 3:교환재발송중, 4:교환재발송완료 (교환수거 및 재발송 완료)
StatusChangeDate	세부상태변경시간	date
isGiftOrder	선물하기 주문 구분	string	Y : 선물하기 주문 N : 일반 주문

 JSON_Success

{
  "ResultCode":0,
  "Message":"string",
  "Data":[
   {
    "OrderNo":0,
    "Status":0,
    "ClaimStatus":0,
    "StatusChangeDate":"2019-04-11T04:58:40.015Z",
    "IsGiftOrder": "string"
   }
 ]
}

JSON_Fail

{
    "ResultCode": int,
    "Message": "string",
    "Data": null
}

Sample Code_Success

{
  "ResultCode":0,
  "Message":"Success",
  "Data":[
    {
     "OrderNo":2825793229,
     "Status":2,
     "ClaimStatus":0,
     "StatusChangeDate":"2018-10-10T00:14:24.693",
     "IsGiftOrder": "N"
    },
    {
     "OrderNo":2825792994,
     "Status":3,
     "ClaimStatus":0,
     "StatusChangeDate":"2018-10-10T09:02:59.31",
     "IsGiftOrder": "N"
    }
  ]
}

Sample Code_Fail

{
  "ResultCode":3000,
  "Message":"7일 이내의 데이터만 조회가능합니다.",
  "Data":null
}

 

Error Code

결과코드	메시지	원인
3000	7일 이내의 데이터만 조회가능합니다.	requestDateFrom~requestDateto 조회기간 초과
3000	페이지 번호는 1보다 큰 값을 입력해주세요.	PageNo "0"으로 입력 시