교환조회 API

Description

[POST] https://sa2.esmplus.com/claim/v1/sa/Exchanges

고객이 교환신청한 주문건에 대해 조회합니다. 교환요청 / 교환수거완료 / 교환보류 / 교환완료 / 교환철회 상태별로 조회할 수 있습니다.

Request Description

항목	항목명	필수여부	Type	Description
SiteType	사이트구분	Y	int	조회하려는 사이트구분 선택 1 : 옥션 2 : G마켓
Type	조회기준 구분	Y	int	조회조건 선택 0 : 주문번호 1 : 장바구니 번호 2 : 교환신청일 3 : 교환완료일(교환 상태 완료 - ApproveDate/철회 주문 조회시 - WithdrawDate) 4 : 교환보류일
ExchangeStatus	교환상태	Y	int	1 : 교환요청/교환물품반송중 2 : 교환수거완료 3 : 교환보류 4 : 교환완료 5 : 교환철회
StartDate	조회기준 시작일		date	YYYY-MM-DD 형태 7일 이하 범위만 조회 가능
EndDate	조회기준 종료일		date	YYYY-MM-DD 형태 7일 이하 범위만 조회 가능
PayNo	장바구니번호		long
OrderNo	주문번호		long
IsGiftOrder	선물하기 주문 구분		string	Y : 선물하기 주문 N : 일반 주문 null : 모든 주문 * 미입력 / skip 시 전체 취소 모두 조회 * G마켓만 구분 조회 가능

JSON
{
  "SiteType": int,
  "ExchangeStatus": int,
  "Type": int,
  "StartDate": "2023-10-01",
  "EndDate": "2023-10-02",
  "PayNo": long,
  "OrderNo": long,
  "IsGiftOrder": "string"
 }

 

Response Description

항목	항목명	Type	Description
ResultCode	결과코드	int	성공 : 0 실패 : Error Massage 참고
Message	메시지	string
data > ExchangeStatus	교환상태	string	조회한 주문의 현재 교환상태 0 : 배송중/배송완료(재발송 처리후) 1 : 교환요청/교환물품반송중 2 : 교환수거완료 3 : 교환보류 4 : 교환완료(G마켓만) 5 : 교환철회 교환 물품 반송 중이면서 보류 중일 경우, 교환보류(3번)에 포함
data > ExchangeShippingFee	교환배송비	number	교환신청 시 구매자에게 부과된 금액
data > WhoExchangeShippingFee	교환배송비 지불주체	int	1 : 사이트 부담 2 : 구매자 부담 3 : 판매자 부담 4 : 무료반품쿠폰사용
data > ExchangeShippingFeeWay	교환배송비 결제수단	int	1 : 지금결제함(카드결제/핸드폰결제 등) 2 : 환불금 차감 대기 3 : 판매자 직접 결제 4 : 상품에 동봉함 5 : 스마일캐시 결제 6 : 기타
data > ResendInfo > ResendDate	재발송일자	date	재발송 송장처리한 날짜
data > ResendInfo > CompleteDate	재발송 배송완료일	date	재발송한 송장의 배송 완료 일자 택배 Tracking 또는 API를 통해 업데이트
data > ResendInfo > DeliveryCompName	재발송 택배사명	string	재발송한 송장의 택배사명
data > ResendInfo > InvoiceNo	재발송 송장번호	string	재발송한 송장의 송장번호
data > ResendInfo > ReceiverInfo > Name	재발송수령인명	string
data > ResendInfo > ReceiverInfo > HpNo	재발송수령인 휴대폰번호	string
data > ResendInfo > ReceiverInfo > TelNo	재발송수령인 일반전화번호	string
data > ResendInfo > ReceiverInfo > ZipCode	재발송수령인 우편번호	string
data > ResendInfo > ReceiverInfo > AddressFront	재발송수령인 주소1	string
data > ResendInfo > ReceiverInfo > AddressBack	재발송수령인 주소2	string
data > ResendInfo > ReceiverInfo > Address	재발송 수령인 주소1+2	string
data > OutItemNo	판매자관리코드	string	판매자가 해당 상품의 판매자관리코드로 등록한 번호
data > ItemOptionCodes	판매자상세관리코드	string	판매자가 해당 상품의 옵션관리코드로 등록한 번호
data > HoldInfo > HoldDate	보류일자	string
data > HoldInfo > IsHold	보류여부	boolean	보류 설정된 상태인지 여부 true : 보류설정된 상태 false : 보류설정되지 않은 상태
data > HoldInfo > Reason	보류사유	string	0 : 기타유보사유 1 : 교환배송비청구 2 (지마켓), 4 (옥션) : 교환입고미확인
data > HoldInfo > FreeDate	보류해제일자	date
data > ShippingInfo > CompleteDate	원배송완료일자	date
data > ShippingInfo > ShippingFee	최초배송비금액	number
data > ShippingInfo > WhoShippingFee	최초배송비 지불주체	int	1 : 사이트 부담 2 : 구매자 부담 3 : 판매자 부담
data > ShippingInfo > DeliveryCompCode	원배송 택배사코드	G마켓: string 옥션: int	택배사코드는 5자리 숫자 (택배사 코드 참고)
data > ShippingInfo > InvoiceNo	원배송 송장번호	string
data > PickupInfo > Status	반품수거상태	string	(G마켓 지정 택배) 직접 택배사에 수거지시를 내리는 주문 건인지, (판매자 자체배송) 판매자가 직접 택배사에 수거지시를 내렸는지 여부 0 : 없음 1 : 사이트 수거지시 2 : 사이트 수거지시 아님
data > PickupInfo > CompleteDate	반품수거완료일자	string
data > PickupInfo > DeliveryCompName	반품수거택배사명	string
data > PickupInfo > InvoiceNo	반품송장번호	string
data > PickupInfo > SenderInfo > Name	수령인명/발송인명	string
data > PickupInfo > SenderInfo > HpNo	수령인/발송인휴대폰번호	string	일반전화번호 고객이 입력했을 경우 일반전화번호도 내려갈 수 있음
data > PickupInfo > SenderInfo > TelNo	수령인/발송인일반전화번호	string	휴대폰 번호 고객이 입력했을 경우 휴대폰 번호도 내려갈 수 있음
data > PickupInfo > SenderInfo > ZipCode	수거지우편번호	string	5자리/6자리 모두 내려갈 수 있음
data > PickupInfo > SenderInfo > AddressFront	수거지주소1	string
data > PickupInfo > SenderInfo > AddressBack	수거지주소2	string	고객이 직접 입력한 수거지주소 고객이 작성하지 않으면 안 내려갈 수 있음
data > PickupInfo > SenderInfo > Address	수거지주소1+2	string
data > PickupInfo > ReceiverInfo > Name	회수인명(판매자정보)	string	판매자가 해당 상품의 반품 배송지로 등록한 정보 내려감
data > PickupInfo > ReceiverInfo > HpNo	회수인휴대폰(판매자정보)	string	판매자가 해당 상품의 반품 배송지로 등록한 정보 내려감
data > PickupInfo > ReceiverInfo > TelNo	회수인전화번호(판매자정보)	string	판매자가 해당 상품의 반품 배송지로 등록한 정보 내려감
data > PickupInfo > ReceiverInfo > ZipCode	회수지우편번호(판매자정보)	string	판매자가 해당 상품의 반품 배송지로 등록한 정보 내려감
data > PickupInfo > ReceiverInfo > AddressFront	회수지주소1(판매자정보)	string	판매자가 해당 상품의 반품 배송지로 등록한 정보 내려감
data > PickupInfo > ReceiverInfo > AddressBack	회수지주소2(판매자정보)	string	판매자가 해당 상품의 반품 배송지로 등록한 정보 내려감
data > PickupInfo > ReceiverInfo > Address	회수지주소1+2(판매자정보)	string	판매자가 해당 상품의 반품 배송지로 등록한 정보 내려감
data > SiteType	사이트구분	int	조회한 조건에 따라 조회한 주문 건의 사이트가 내려감 1 : 옥션 2 : G마켓
data > SellerId	판매자ID	string	해당주문건의 판매자ID
data > PayNo	장바구니번호	long	장바구니번호(결제번호)
data > GroupNo	묶음배송비정책번호	bigint	묶음배송비정책번호(배송번호)
data > OrderNo	주문번호	long
data > GoodsNo	ESM상품번호	string	현재 null로만 내려감(추후 적용예정)
data > SiteGoodsNo	사이트상품번호	string	현재 주문 건의 G마켓 or 옥션 상품번호
data > IsGiftOrder	선물하기 주문 구분	string	Y : 선물하기 주문 N : 일반 주문
data > RequestUser	교환신청자	int	교환신청한 주체 0 : 없음 1 : 구매자 2 : 판매자 3 : 고객센터 4 : 기타 5 : 선물수령인 (G마켓 주문만)
data > ApproveUser	교환처리자	int	교환처리한 주체 0 : 없음 1 : 구매자 2 : 판매자 3 : 고객센터 5 : 기타 * 옥션의 경우, 반품에서 교환 전환 시 재발송까지 진행되므로 처리자가 판매자로 내려감
data > Reason	교환사유	int	0 : 판매자귀책 1 : 구매자귀책 2 : 기타
data > ReasonCode	교환요청사유코드	int	12월 23일부터 제공 반품/교환요청 시, 고객이 선택한 클레임요청 사유코드 추가 [구매자귀책] 1 : 단순변심 2 : 사이즈/색상 등 옵션 변경 [판매자귀책] 3 : 오배송 4 : 상품미도착 5 : 상품불량 6 : 판매자요청 [기타] 0 : 선택없음
data > ReasonDetail	교환사유직접입력	string	구매자가 교환신청 시 입력한 교환 사유 및 상품 내려감
data > OrderDate	주문일자	date
data > PayDate	결제일자	date
data > RequestDate	교환신청일자	date
data > WithdrawDate	교환철회일자	date
data > ApproveDate	교환승인일자	date
data > CompleteDate	교환처리일자	date	내부 시스템 처리 Update 일자

 JSON_Success

{
  "ResultCode": "success",
  "Message": "string",
  "Data": [
    {
      "ExchangeStatus": 0,
      "OutItemNo": "string",
      "ItemOptionCodes": [
        "string"
      ],
      "ExchangeShippingFee": 0,
      "WhoExchangeShippingFee": 0,
      "ExchangeShippingFeeWay": 0,
      "HoldInfo": {
        "HoldDate": "2019-04-22T00:58:47.434Z",
        "IsHold": true,
        "Reason": 0,
        "FreeDate": "2019-04-22T00:58:47.434Z"
      },
      "ShippingInfo": {
        "CompleteDate": "2019-04-22T00:58:47.434Z",
        "ShippingFee": 0,
        "WhoShippingFee": 0,
        "DeliveryCompCode": 0,
        "InvoiceNo": "string"
      },
      "PickupInfo": {
        "Status": 0,
        "CompleteDate": "2019-04-22T00:58:47.434Z",
        "DeliveryCompName": "string",
        "InvoiceNo": "string",
        "SenderInfo": {
          "Name": "string",
          "HpNo": "string",
          "TelNo": "string",
          "ZipCode": "string",
          "AddressFront": "string",
          "AddressBack": "string",
          "Address": "string"
        },
        "ReceiverInfo": {
          "Name": "string",
          "HpNo": "string",
          "TelNo": "string",
          "ZipCode": "string",
          "AddressFront": "string",
          "AddressBack": "string",
          "Address": "string"
        }
      },
      "ResendInfo": {
        "ResendDate": "2019-04-22T00:58:47.435Z",
        "CompleteDate": "2019-04-22T00:58:47.435Z",
        "DeliveryCompName": "string",
        "InvoiceNo": "string",
        "ReceiverInfo": {
          "Name": "string",
          "HpNo": "string",
          "TelNo": "string",
          "ZipCode": "string",
          "AddressFront": "string",
          "AddressBack": "string",
          "Address": "string"
        }
      },
      "SiteType": 0,
      "SellerId": "string",
      "PayNo": 0,
      "GroupNo": 0,
      "OrderNo": 0,
      "GoodsNo": 0,
      "SiteGoodsNo": "string",
      "IsGiftOrder": "string",
      "RequestUser": 0,
      "ApproveUser": 0,
      "Reason": 0,
      "ReasonCode": 0,
      "ReasonDetail": "string",
      "OrderDate": "2019-04-22T00:58:47.435Z",
      "PayDate": "2019-04-22T00:58:47.435Z",
      "RequestDate": "2019-04-22T00:58:47.435Z",
      "WithdrawDate": "2019-04-22T00:58:47.435Z",
      "ApproveDate": "2019-04-22T00:58:47.435Z",
      "CompleteDate": "2019-04-22T00:58:47.435Z"
    }
  ]
}

JSON_Fail

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

Sample Code_Success

지마켓
{
  "ResultCode":0,
  "Message":"Success",
  "Data":[
   {
    "ExchangeStatus":1,
    "OutItemNo":"646620315",
    "ItemOptionCodes":[
    "15"
     ],
    "ExchangeShippingFee":2500.0000,
    "WhoExchangeShippingFee":2,
    "ExchangeShippingFeeWay":5,
    "HoldInfo":{
     "HoldDate":null,
     "IsHold":false,
     "Reason":0,
     "FreeDate":"2019-04-22T07:17:31.61"
       },
    "ShippingInfo":{
     "CompleteDate":"2019-04-17T17:55:23.547",
     "ShippingFee":0.0000,
     "WhoShippingFee":2,
     "DeliveryCompCode":"10008",
     "InvoiceNo":"303962161952"
       },
    "PickupInfo":{
      "Status":2,
      "CompleteDate":null,
      "DeliveryCompName":"자체배송",
      "InvoiceNo":"",
    "SenderInfo":{
      "Name":"수령인발송인명",
      "HpNo":"010-1234-5678",
      "TelNo":"010-1234-5678",
      "ZipCode":"35295 ",
      "AddressFront":"대전광역시 서구 도솔로322번길 3",
      "AddressBack":"101호",
      "Address":"대전광역시 서구 도솔로322번길 3 , 101호"
        },
    "ReceiverInfo":{
     "Name":"회수인명",
     "HpNo":"011-1111-2222",
     "TelNo":"02-1577-1111",
     "ZipCode":"138-210",
     "AddressFront":"서울 송파구 장지동",
     "AddressBack":"물류센터",
     "Address":"서울 송파구 장지동 물류센터"
         }
      },
    "ResendInfo":{
     "ResendDate":null,
     "CompleteDate":null,
     "DeliveryCompName":null,
     "InvoiceNo":null,
     "ReceiverInfo":{
       "Name":"회수인명",
       "HpNo":"010-1234-5678",
       "TelNo":"010-1234-5678",
       "ZipCode":"35295 ",
       "AddressFront":"대전광역시 서구 도솔로322번길 3",
       "AddressBack":"101호",
       "Address":"대전광역시 서구 도솔로322번길 3 , 101호"
        }
      },
    "SiteType":3,
    "SellerId":"sellerid_test",
    "PayNo":4456612117,
    "GroupNo":19218613,
    "OrderNo":2949122576,
    "GoodsNo":0,
    "SiteGoodsNo":"1560111127",
    "IsGiftOrder": "N",
    "RequestUser":1,
    "ApproveUser":0,
    "Reason":0,
    "ReasonCode": 1,
    "ReasonDetail":"사이즈 100으로 교환 바랍니다.(사이즈가 작습니다.)",
    "OrderDate":"2019-04-16T09:05:09.68",
    "PayDate":"2019-04-16T16:27:26.08",
    "RequestDate":"2019-04-22T07:18:00",
    "WithdrawDate":null,
    "ApproveDate":null,
    "CompleteDate":null
        }
    ]
}

옥션
{
  "ResultCode":0,
  "Message":"Success",
  "Data":[
   {
   "ExchangeStatus":1,
   "ExchangeShippingFee":0.0000,
   "WhoExchangeShippingFee":3,
   "ExchangeShippingFeeWay":0,
   "ResendInfo":{
     "ResendDate":null,
     "CompleteDate":null,
     "DeliveryCompName":null,
     "InvoiceNo":null,
   "ReceiverInfo":{
     "Name":null,
     "HpNo":null,
     "TelNo":null,
     "ZipCode":null,
     "AddressFront":null,
     "AddressBack":null,
     "Address":" "
    }
  },
   "OutItemNo":"482521168",
   "ItemOptionCodes":"0",
   "HoldInfo":{
     "HoldDate":null,
     "IsHold":false,
     "Reason":0,
     "FreeDate":null
  },
   "ShippingInfo":{
     "CompleteDate":"2019-04-18T18:44:00",
     "ShippingFee":0.0,
     "WhoShippingFee":2,
     "DeliveryCompCode":10008,
     "InvoiceNo":"303962226514"
   },
   "PickupInfo":{
     "Status":2,
     "CompleteDate":null,
     "DeliveryCompName":"기타",
     "InvoiceNo":"",
   "SenderInfo":{
     "Name":"수령인발송인명",
     "HpNo":"0508-1234-5678",
     "TelNo":"0508-1234-5678",
     "ZipCode":"52144 ",
     "AddressFront":"경상남도 의령군 의령읍 동동리 877-14",
     "AddressBack":"사무실",
     "Address":"경상남도 의령군 의령읍 동동리 877-14 사무실"
     },
   "ReceiverInfo":{
     "Name":"회수인명",
     "HpNo":"1577-1110",
     "TelNo":"010-1234-5678",
     "ZipCode":"135190",
     "AddressFront":"서울특별시 강남구 세곡동 111 - 20",
     "AddressBack":"물류센터",
     "Address":"서울특별시 강남구 세곡동 111 - 20 물류센터"
      }
   },
   "SiteType":1,
   "SellerId":"sellertest",
   "PayNo":1194698273,
   "GroupNo":917487128,
   "OrderNo":1592391140,
   "GoodsNo":0,
   "SiteGoodsNo":"B510130117",
   "RequestUser":1,
   "ApproveUser":0,
   "Reason":0,
   "ReasonCode": 1,
   "ReasonDetail":"",
   "OrderDate":"2019-04-16T21:49:00",
   "PayDate":"2019-04-16T21:49:00",
   "RequestDate":"2019-04-22T10:14:00",
   "WithdrawDate":null,
   "ApproveDate":null,
   "CompleteDate":null
    }
  ]
}

Sample Code_Fail

{
    "ResultCode": 99999,
    "Message": "API Error - 클레임 정보가 없습니다",
    "Data": null
}

 

Error Code

결과코드	메시지	원인
8668	ShowAlertException$조회 기간은 7일 이내로 입력 바랍니다	StartDate ~ EndDate 조회기간 초과
99999	주문정보가 없습니다	주문번호/장바구니번호 조회한 결과 없을 경우