취소승인 API – ESM Trading API

취소승인 API

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

Description
고객이 주문확인 후 취소요청한 건에 대해 판매자가 취소승인합니다(취소승인을 하는 것이므로 바로 환불된다는 의미는 아님)
이미 배송이 되거나 제작중이어서 취소승인할 수 없을 경우, 발송처리 API를 호출하면 취소거부됩니다
취소승인 API는 주문번호단위별로 취소승인합니다
취소요청한 건에 대해 판매자는 취소승인이던 발송처리던 빠른처리하지 않으면 자동으로 취소승인될 수 있습니다
Request Description
G마켓/G9 주문조회 시, G마켓 ID의 토큰으로 조회해주세요. 옥션 주문조회 시, 옥션 ID의 토큰으로 조회해주세요
항목항목명필수여부TypeDescription
SiteType사이트 구분Yint1: Auction
2: GMarket/G9
3: G9
OrderNo주문번호Ypath해당 주문번호 취소(환불) 승인처리
※ 취소거부는 발송처리 API 연동 시, 취소 거부됨
JSONSample Code 1
{
  "SiteType": int
}

{
  "SiteType": 1
}


Response Description
항목항목명TypeDescription
ResultCode결과string성공: 0
실패: Error Code참고
옥션의 경우, 아래규칙으로 내려감
Result Code 1000 (데이터 조회 없음)
Result Code 2000 (파라미터 유효하지 않음)
Result Code 8000 (처리결과 실패)
Result Code 8668 (비즈니스 에러) >> 원인별 상세 “BizRuleCode” 값 내려감
Message메시지stirng
BizRuleCode(옥션용)Unique코드stringResultCode가 8668(비즈니스에러)일 경우 사유별 처리 가능하도록 Unique 코드 내려감
Data데이터string
JSONSample Code_Success_GSample Code_Success_ASample Code_Fail_GSample Code_Fail_A
{
   "ResultCode": 0,
   "Message": "string",
   "Data": {}
}
{
   "ResultCode":0,
   "Message":"Success",
   "Data":null
}
{
    "ResultCode": 0,
    "Message": "Success",
    "BizRuleCode": "",
    "Data": null
}
{
   "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
결과코드비즈룰코드메시지원인
8668ShowAlertException$취소 승인 대상이 없습니다.처리하려는 주문번호가 취소승인 불가한 상태이거나 유효하지 않은 주문번호일 경우
8668ShowAlertException$이미 취소 승인 되었습니다.이미 취소 승인 처리된 경우
8668W8-2이미 취소 승인 되었습니다옥션용_이미 처리된 주문건을 호출할 경우