판매취소 API

Description

일반 : [POST] https://sa2.esmplus.com/claim/v1/sa/Cancel/{OrderNo}/SoldOut (제한) 비품절용 : [POST] https://sa2.esmplus.com/claim/v1/sa/Cancel/{OrderNo}

재고가 부족하거나 발송을 할 수 없는 주문을 해야 할 경우 판매취소 API를 호출합니다. 판매취소 API를 호출하면 해당 주문이 고객 환불되고 해당 상품(또는 옵션)은 품절처리 됩니다. 발송 처리 전 주문상태 경우만 가능하고 취소요청 주문은 판매취소 할 수 없고 취소승인 API를 호출합니다. 제한 API는 고객 요청 취소 및 기타 이슈로 품절일 경우에만 허용하며 별도 권한 필요합니다.

 

Request Description

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

JSON
{
  "SiteType": int
}

 

Response Description

항목	항목명	Type	Description
ResultCode	결과	string	성공 : Success 실패 : 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": "success",
  "Message": "string",
  "Data": {}
}

JSON_Fail

{
   "ResultCode": int,
   "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":"8668$취소 가능한 주문상태가 아닙니다",
   "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		취소 가능한 주문상태가 아닙니다.	G마켓용_처리하려는 주문번호가 취소가능한 주문상태가 아닐 경우
8668	W8-1	취소 가능한 주문상태가 아닙니다	옥션용_이미 취소완료된 주문건을 중복 호출했거나 판매취소 가능한 상태가 아닌 주문건을 호출한 경우
8668	W28-1	이미 취소 요청된 주문입니다	옥션용_취소요청인 상태 주문건을 판매취소 중복 호출할 경우