교환수거완료 처리 API – ESM Trading API

교환수거완료 처리 API

[PUT] https://sa.esmplus.com/claim/v1/sa/exchange/{orderNo}/pickup

Description
교환수거송장의 배송완료처리합니다
택배 Tracking 되지 않는 주문의 경우 해당 수거완료처리를 진행합니다
옥션의 경우 재발송 송장처리를 하면 자동으로 교환수거 완료처리되므로, 교환수거 송장처리 ->교환수거 완료처리 -> 재발송 송장처리 -> 재발송 배송완료처리 순으로 처리합니다
Request Description
G마켓/G9 주문조회 시, G마켓 ID의 토큰으로 조회해주세요. 옥션 주문조회 시, 옥션 ID의 토큰으로 조회해주세요
항목항목명필수여부TypeDescription
OrderNo 주문번호 Y Path 처리하려는 주문번호 입력
PickupCompleteDate 배송완료일자 string 배송완료된 일자
YYYY-MM-DD 형식
SiteType사이트구분 Y int처리하려는 주문번호 사이트구분 선택
1:옥션
2:G마켓 +G9
3:G9
JSONSample Code 1
{
  "SiteType": int,
  "PickupCompleteDate": "2019-04-22T00:58:47"
}

{
  "SiteType": 3,
  "PickupCompleteDate": "2018-04-08T04:37:34",
}

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": "W22-3",

    "Data": null

}

Error Code
결과코드비즈룰코드메시지원인
8668 ShowAlertException$재발송 완료 배송건이 없습니다 재발송 완료 처리 가능한 상태가 아닐 경우
8668W14-2이미 완료 처리 되었습니다옥션용_완료처리된 주문건을 중복 호출했을 경우