본문 바로가기
클레임 API/교환 API

교환재발송 송장등록 API

Description
[POST] https://sa2.esmplus.com/claim/v1/sa/exchange/{orderNo}/resend
교환 주문 건에 대해, 교환 재발송 송장등록을 필수로 등록합니다.
교환 송장등록은 업데이트 가능합니다.

 

Request Description

항목 항목명 필수여부 Type Description
OrderNo 주문번호 Y Path 처리하려는 주문번호 입력
DeliveryCompCode 택배사코드 Y int 택배사별 5자리 코드 (택배사 코드 참고)
InvoiceNo 송장번호 Y string  
SiteType 사이트구분 Y int 처리하려는 주문번호 사이트구분 선택

1 : 옥션
2 : G마켓

 

JSON
{
  "SiteType": int,
  "DeliveryCompCode": int,
  "InvoiceNo": "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": {}
}

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":99999,
  "Message":"API Error - 교환택배사가 존재하지 않습니다",
  "Data":null
}

옥션
1) Result Code 1000 / 2000 / 8000일 경우,
{
    "ResultCode": 1000,
    "Message": "데이터 조회 실패. - 교환재발송 완료 대상건",
    "BizRuleCode": "",
    "Data": null
}
 
2) Result Code 8668일 경우,
{
    "ResultCode": 8668,
    "Message": "유효한 송장번호가 아닙니다. 택배사와 송장번호 확인 바랍니다",
    "BizRuleCode": "W13-5",
    "Data": null
}

 

Error Code

결과코드 비즈룰코드 메시지 원인
99999   API Error - 교환택배사가 존재하지 않습니다 택배사코드가 유효하지 않을 경우
8668 W22-3 요청한 주문번호가 반품 및 교환 배송건이 아닙니다. 옥션용_클레임 이슈가 없는 일반 배송주문건 호출 했을 경우
8668 W22-4 요청한 주문번호가 반품 및 교환 배송건이 아닙니다. 옥션용_교환철회 주문건으로 시도한 경우
8668 W22-6 요청한 송장번호가 유효하지 않습니다. 옥션용_클레임 상태이면서 유효하지 않은 송장번호 입력한 경우

 

'클레임 API > 교환 API' 카테고리의 다른 글

교환수거 송장등록 API  (0) 2023.06.08
교환 수거완료 처리 API  (0) 2023.03.24
교환재발송 배송완료 API  (0) 2022.11.03
교환보류 API  (0) 2022.11.03
교환보류해제 API  (0) 2022.11.03