취소승인 API

Description

[PUT] https://sa2.esmplus.com/claim/v1/sa/Cancel/{OrderNo}

주문확인 후 고객이 취소요청한 주문에 대해 판매자가 취소 승인합니다. 이미 배송이 되거나 제작중이어서 취소승인할 수 없을 경우 발송처리 API를 호출하면 취소거부 됩니다. 별도 취소거부 API 는 없습니다.

 

Request Description

항목	항목명	필수여부	Type	Description
SiteType	사이트 구분	Y	int	1 : 옥션 2 : G마켓
OrderNo	주문번호	Y	path	해당 주문번호 취소(환불) 승인처리 ※ 취소거부는 발송처리 API 연동 시, 취소 거부됨

JSON
{
  "SiteType": int
}

 

Response Description

항목	항목명	Type	Description
ResultCode	결과	string	성공 : 0 실패 : Error Code참고 옥션의 경우, 아래규칙으로 내려감 Result Code 1000 (데이터 조회 없음) Result Code 2000 (파라미터 유효하지 않음) Result Code 8000 (처리결과 실패) Result Code 8668 (비즈니스 에러) >> 원인별 상세 “BizRuleCode” 값 내려감
Message	메시지	stirng
BizRuleCode	(옥션용)Unique코드	string	ResultCode가 8668(비즈니스에러)일 경우 사유별 처리 가능하도록 Unique 코드 내려감
Data	데이터	string

 JSON_Success

{
   "ResultCode": 0,
   "Message": "string",
   "Data": {}
}

JSON_Fail

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

Sample Code_Success

지마켓
{
   "ResultCode":0,
   "Message":"Success",
   "Data":null
}

옥션

    "ResultCode": 0,
    "Message": "Success",
    "BizRuleCode": "",
    "Data": null
}

Sample Code_Fail

지마켓
{
   "ResultCode":8668,
   "Message":"ShowAlertException$취소 승인 대상이 없습니다",
   "Data":null
}

옥션
 1) Result Code 1000 / 2000 / 8000일 경우,
{
    "ResultCode": 1000,
    "Message": "데이터 조회 실패. - 교환재발송 완료 대상건",
    "BizRuleCode": "",
    "Data": null
}
 
2) Result Code 8668일 경우,
{
    "ResultCode": 8668,
    "Message": "취소 가능한 주문상태가 아닙니다",
    "BizRuleCode": "W8-1",
    "Data": null
}

 

Error Code

결과코드	비즈룰코드	메시지	원인
8668		ShowAlertException$취소 승인 대상이 없습니다.	처리하려는 주문번호가 취소승인 불가한 상태이거나 유효하지 않은 주문번호일 경우
8668		ShowAlertException$이미 취소 승인 되었습니다.	이미 취소 승인 처리된 경우
8668	W8-2	이미 취소 승인 되었습니다	옥션용_이미 처리된 주문건을 호출할 경우