반품보류 API

Description

[POST] https://sa2.esmplus.com/claim/v1/sa/return/{orderNo}/hold

반품 주문에 대해 배송비 및 반품미입고 관련 이슈 있을 경우 보류 설정하는 API입니다. 반품보류는 수거지시 이전, 수거완료 이후 시점만 처리 가능합니다. (택배 Tracking중 보류 불가) 보류사유 업데이트 가능하나 동일한 사유로의 업데이트는 불가합니다. 반품보류 해제는 반품승인 API 호출 시 해제되며 아래 케이스 경우도 해제될 수 있습니다. 1. G마켓, 옥션 CS 인입으로 고객 or 셀러요청 시 2. 보류사유 > 반품배송비 추가로 설정한 경우, 고객이 결제하면 보류해제됨 3. 보류해제 처리가 지연될 경우, 30일 초과 시 System으로 자동으로 보류해제됨

 

Request Description

항목	항목명	필수여부	Type	Description
OrderNo	주문번호	Y	Path	처리하려는 주문번호 입력
HoldReason	보류사유	Y	int	보류사유 코드 입력 0 : 기타유보사유 2 : 추가반품비청구(기타반품비) 4 : 반품미입고
HoldReasonDetail	보류상세사유		string	구매자가 확인할 수 보류사유 구체적으로 입력 구매자 Front에서 노출됨
ReturnShippingFee	추가반품배송비		string	HoldReason > 2일 경우 필수 구매자에게 추가로 결제시키고 싶은 반품배송비 금액 입력 고객 주문확인 페이지에서 추가 결제 요청됨 *옥션은 1000원이상 입력 가능
SiteType	사이트구분	Y	int	처리하려는 주문번호 사이트구분 선택 1 : 옥션 2 : G마켓

JSON
{
  "SiteType": int,
  "HoldReason": int,
  "HoldReasonDetail": "string",
  "ReturnShippingFee": 0
}

 

Response Description

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

JSON_Success

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

JSON_Fail

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

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": "W20-2",
    "Data": null
}

 

Error Code

결과코드	비즈룰코드	메시지	원인
8668		ShowAlertException$반품 보류 불가 상태입니다	환불완료 등 반품보류 가능한 주문 상태가 아닐 경우
8668		ShowAlertException$반품추가비는 1,000원이상 금액만 설정 가능합니다	반품추가비 금액 오류
99999		API Error - 빠른 환불 대상은 보류할 수 없습니다	빠른환불 대상 주문건을 반품보류 처리하려고 할 경우
8668	W19-1	같은 사유로의 변경은 불가능 합니다.	옥션용_동일한 사유로 변경 호출 시도할 경우
8668	W20-2	반품 보류 불가 상태입니다	옥션용_교환상품반송중인 상태의 주문건으로 시도할 경우
8668	W20-3	반품 수거 완료 후 보류 처리 가능합니다	옥션용_수거 택배 Tracking중 보류처리 시도할 경우
8668	W20-4	반품추가비는 1,000원이상 금액만 설정 가능합니다	옥션용_반품추가비 1000원미만으로 설정했을 경우
8668	W20-5	반품추가비는 상품금액보다 큰 금액은 청구불가능합니다	옥션용_반품추가비용을 상품금액보다 높게 설정하여 시도했을 경우
8668	W20-6	빠른환불 대상건은 보류 처리 불가 합니다	옥션용_빠른환불 대상 주문 반품보류 시도할 경우