교환보류 API

Description

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

교환배송비 및 교환 물품 미입고 관련해서 이슈가 있을 때 보류 설정하는 별도 권한이 필요한 제한 API입니다. 교환보류 시, 고객 알람 전송되므로 명확한 보류 사유가 있을 경우에만 호출합니다. 보류 사유는 업데이트 할 수 있으나 동일한 사유로 업데이트는 불가합니다.

 

Request Description

항목	항목명	필수여부	Type	Description
OrderNo	주문번호	Y	Path	처리하려는 주문번호 입력
HoldReason	보류사유	Y	int	보류사유 코드 입력 0 : 기타유보사유 1 : 교환배송비청구 4 : 교환입고미확인 * 교환 배송비 청구 시, G마켓은 Front에서 배송비 청구 요청되지만 옥션은 되지 않음
ResendExpectDate	재발송예정일		string	재발송할 예정일 입력
SiteType	사이트구분	Y	int	처리하려는 주문번호 사이트구분 선택 1 : 옥션 2 : G마켓

JSON
{
  "SiteType": int,
  "HoldReason": int,
  "ResendExpectDate": "string"
}

 

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": {}
}

Sample Code_Success

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

옥션
{
    "ResultCode": 0,
    "Message": "Success",
    "BizRuleCode": "",
    "Data": null
}

Sample Code_Fail

지마켓
{
   "ResultCode":8668,
   "Message":"같은 사유로의 변경은 불가능 합니다.",
   "Data":null
}

옥션
1) Result Code 1000 / 2000 / 8000일 경우,
{
    "ResultCode": 1000,
    "Message": "데이터 조회 실패. - 교환재발송 완료 대상건",
    "BizRuleCode": "",
    "Data": null
}
 
2) Result Code 8668일 경우,
{
    "ResultCode": 8668,
    "Message": "교환 보류 불가 상태입니다",
    "BizRuleCode": "W20-1",
    "Data": null
}

 

Error Code

결과코드	비즈룰코드	메시지	원인
8668		ShowAlertException$같은 사유로의 변경은 불가능 합니다.	보류사유 동일한 사유로 중복 호출할 경우
8668	W20-1	교환 보류 불가 상태입니다	옥션용_클레임이 반품상태로, 교환보류 가능한 상태가 아닐 경우