취소조회 API

Description

[POST] https://sa2.esmplus.com/claim/v1/sa/Cancels

취소 주문건에 대해 조회합니다. 취소요청 / 취소중 / 취소완료 / 취소철회 / 지마켓, 옥션 CS직권취소완료 / 옥션송금후취소완료 취소 상태별로 조회할 수 있습니다. 주문확인 이전 고객이 취소 했을 경우 판매자의 승인없이 즉시취소되며 주문확인 이후 고객이 취소신청 했을 경우 판매자 승인 후 최종 취소처리합니다. 취소 신청 후 24시간 이내 판매자 승인 없을 경우 자동으로 취소 됩니다.

Request Description

항목	항목명	필수여부	Type	Description
SiteType	사이트 구분	Y	int	1 : 옥션 2 : G마켓
CancelStatus	취소상태	Y	int	0 : 전체 1 : 취소요청 2 : 취소중 3 : 취소완료 4 : 취소철회 5 : 사이트 직권환불 (고객센터 환불처리) 6 :  거래완료 후 환불 (송금 후 취소)
Type	조회기준 구분	Y	int	0 : 주문번호 1 : 장바구니번호 2 : 취소신청일 3 : 취소완료일(취소 상태가 완료 - ApproveDate/철회인 주문건 조회 시 - WithdrawDate) 4 : 결제완료일
StartDate	조회기준 시작일	Y	DateTime	일주일 단위 조회 가능
EndDate	조회기준 종료일	Y	DateTime	일주일 단위 조회 가능
PayNo	장바구니 번호(결제번호)		long
OrderNo	주문번호		long
IsGiftOrder	선물하기 주문 구분		string	Y : 선물하기 주문 N : 일반 주문 null : 모든 주문 * 미입력 / skip 시 전체 취소 모두 조회 * G마켓만 구분 조회 가능

JSON
{
  "SiteType": int,
  "CancelStatus": int,
  "Type": int,
  "StartDate": "2023-10-01",
  "EndDate": "2023-10-02",
  "PayNo": long,
  "OrderNo": long,
  "IsGiftOrder": "string"
}

 

Response Description

항목	항목명	Type	Description
ResultCode	결과코드	string	성공 : 0 실패 : Error Massage 참고
Message	메시지	string
data > CancelStatus	취소상태	int	조회한 주문의 현재 취소상태 1 : 취소요청 2 : 취소중 3 : 취소완료 4 : 취소철회 5 : 사이트 직권환불건(취소완료건 중, 고객센터에서 환불처리한 Case) 6 : 옥션송금후취소
data > AddShippingFee	취소배송비	number	조건부배송정책으로 무료로 구입한 상품을 취소할 경우, 무료배송 조건이 깨질경우 추가금액을 고객에게 부과함
data > SiteType	사이트구분	string	조회한 조건에 따라 조회한 주문건의 사이트가 내려감 1 : 옥션 2 : G마켓
data > SellerId	판매자ID	string	해당주문건의 판매자ID
data > PayNo	장바구니번호	int	장바구니번호(결제번호)
data > GroupNo	묶음배송비정책번호	bigint	묶음배송비정책번호(배송번호)
data > OrderNo	주문번호	int
data > GoodsNo	ESM상품번호	string	현재 null로만 내려감(추후 적용예정)
data > SiteGoodsNo	사이트상품번호	string	현재 주문 건의 G마켓 or 옥션 상품번호
data > IsGiftOrder	선물하기 주문 구분	string	Y : 선물하기 주문 N : 일반 주문
data > RequestUser	취소신청자	string	취소신청한 주체 0 : 없음 1 : 구매자 2 : 판매자 3 : 고객센터 4 : 기타 5 : 선물수령인
data > ApproveUser	취소처리자	string	취소처리한 주체 0 : 없음 1 : 구매자 2 : 판매자 3 : 고객센터 5 : 기타
data > Reason	취소사유	string	0 : 판매자귀책 1 : 구매자귀책 2 : 기타 고객이 Front에서 취소신청할 경우 '1 : 구매자귀책'으로 내려감
data > ReasonCode	취소요청사유코드	int	0 : 기타 1 : 단순변심 2 : 사이즈/색상 등 변경 3 : 오배송 4 : 상품미도착 5 : 상품불량 6 : 재고없음(판매자요청) 7 : 선물수락기한만료 8 : 선물거절 11 : 구매자 취소요청 - 스마일프레시 전용 고객이 Front에서 취소신청할 경우 '1: 단순변심'으로 내려감
data > ReasonDetail	상세취소사유	string
data > OrderDate	주문일자	date
data > PayDate	결제일자	date
data > RequestDate	취소신청일자	date
data > WithdrawDate	취소철회일자	date
data > ApproveDate	취소승인일자	date
data > CompleteDate	취소완료일자	date

JSON_Success

{
  "ResultCode": "success",
  "Message": "string",
  "Data": [
    {
      "CancelStatus": 0,
      "AddShippingFee": 0,
      "SiteType": 0,
      "SellerId": "string",
      "PayNo": 0,
      "GroupNo": 0,
      "OrderNo": 0,
      "GoodsNo": 0,
      "SiteGoodsNo": "string",
      "IsGiftOrder": "string",
      "RequestUser": 0,
      "ApproveUser": 0,
      "Reason": 0,
      "ReasonDetail": "string",
      "OrderDate": "2019-04-19T04:01:30.141Z",
      "PayDate": "2019-04-19T04:01:30.141Z",
      "RequestDate": "2019-04-19T04:01:30.141Z",
      "WithdrawDate": "2019-04-19T04:01:30.141Z",
      "ApproveDate": "2019-04-19T04:01:30.141Z",
      "CompleteDate": "2019-04-19T04:01:30.141Z"
    }
  ]
}

Sample Code_Success

지마켓
{
  "ResultCode":0,
  "Message":"Success",
  "Data":[
  {
   "CancelStatus":3,
   "AddShippingFee":0.0000,
   "SiteType":3,
   "SellerId":"sellerid_test",
   "PayNo":4452427792,
   "GroupNo":19218613,
   "OrderNo":2943387115,
   "GoodsNo":0,
   "SiteGoodsNo":"1582187911",
   "IsGiftOrder": "N",
   "RequestUser":4,
   "ApproveUser":4,
   "Reason":0,
   "ReasonDetail":"",
   "OrderDate":"2019-04-06T17:32:19.75",
   "PayDate":"2019-04-06T17:32:20.85",
   "RequestDate":"2019-04-18T15:26:00",
   "WithdrawDate":null,
   "ApproveDate":"2019-04-18T15:26:00",
   "CompleteDate":"2019-04-18T15:26:24.94"
  }
 ]
}

옥션
{
  "ResultCode":0,
  "Message":"Success",
  "Data":[
  {
   "CancelStatus":2,
   "AddShippingFee":0.0,
   "SiteType":1,
   "SellerId":"sellerid_test",
   "PayNo":1194714838,
   "GroupNo":917505852,
   "OrderNo":1592423011,
   "GoodsNo":0,
   "SiteGoodsNo":"B660881117",
   "RequestUser":1,
   "ApproveUser":2,
   "Reason":1,
   "ReasonDetail":"기타사유",
   "OrderDate":"2019-04-16T22:38:00",
   "PayDate":"2019-04-18T23:06:00",
   "RequestDate":"2019-04-19T09:56:03.357",
   "WithdrawDate":null,
   "ApproveDate":"2019-04-19T09:56:29.603",
   "CompleteDate":null
  }
 ]
}

 

Error Code

결과코드	메시지	원인
8668	ShowAlertException$조회 기간은 7일 이내로 입력 바랍니다.	StartDate ~ EndDate 조회기간 초과
99999	주문정보가 없습니다	주문번호/장바구니 번호 조회한 결과 없을 경우
99999	클레임정보가 없습니다	주문번호/장바구니번호가 클레임 상태가 아닐 경우