교환보류 API – ESM Trading API

교환보류 API

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

Description
교환배송비 및 교환물품미입고 관련해서 이슈가 있을 경우 보류 설정하는 권한 별도 제한 API입니다
교환보류 시, 고객 알람 전송되므로 명확한 보류사유 있을 경우에만 호출합니다
보류사유 업데이트 가능하나 동일한 사유로의 업데이트는 불가합니다
Request Description
G마켓/G9 주문조회 시, G마켓 ID의 토큰으로 조회해주세요. 옥션 주문조회 시, 옥션 ID의 토큰으로 조회해주세요
항목항목명필수여부TypeDescription
OrderNo 주문번호 Y Path 처리하려는 주문번호 입력
HoldReason 보류사유 Y int 보류사유 코드 입력
0 : 기타유보사유
1 : 교환배송비청구
4 : 교환입고미확인
* 교환배송비청구 시, G마켓은 Front에서 배송비 청구 요청되지만 옥션은 되지 않음
ResendExpectDate재발송예정일string 재발송할 예정일 입력
SiteType사이트구분 Y int처리하려는 주문번호 사이트구분 선택
1:옥션
2:G마켓 +G9
3:G9
JSONSample Code 1
{
  "SiteType": int,
  "HoldReason": int,
  "ResendExpectDate": "string"
}

{
  "SiteType": 3,
  "HoldReason": 4,
  "ResendExpectDate": "2019-04-22"
}

Response Description
항목항목명TypeDescription
ResultCode 결과코드 int 성공: 0
실패 :Error Massage 참고
옥션의 경우, 아래규칙으로 내려감
Result Code 1000 (데이터 조회 없음)
Result Code 2000 (파라미터 유효하지 않음)
Result Code 8000 (처리결과 실패)
Result Code 8668 (비즈니스 에러) >> 원인별 상세 “BizRuleCode” 값 내려감
Message 메시지 string
BizRuleCode(옥션용)Unique코드stringResultCode가 8668(비즈니스에러)일 경우 사유별 처리 가능하도록 Unique 코드 내려감
Data 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":"같은 사유로의 변경은 불가능 합니다.",
   "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$같은 사유로의 변경은 불가능 합니다. 보류사유 동일한 사유로 중복 호출할 경우
8668W20-1교환 보류 불가 상태입니다옥션용_클레임이 반품상태로, 교환보류 가능한 상태가 아닐 경우