coupang
API 문서
상품 API카테고리 API브랜드 API배송 / 주문 API반품 API교환 API프로모션 / 쿠폰물류 정보고객 문의정산Rocket Growth
GET/v2/providers/openapi/apis/api/v4/vendors/{vendorId}/exchangeRequestsv1

교환요청 목록조회

# 01

요약

API 적용 가능한 구매자 사용자 지역 : 한국 교환 접수일자로 최대 7일 이내 의 교환 내역을 확인할 수 있습니다. 각 교환 건에 대한 접수사유(reasonCode)는 아래 자료를 다운받아 확인해주세요.

# 02

상세

API 적용 가능한 구매자 사용자 지역: 한국

교환 접수일자로 최대 7일 이내의 교환 내역을 확인할 수 있습니다.
각 교환 건에 대한 접수사유(reasonCode)는 아래 자료를 다운받아 확인해주세요.

Path

GET

/v2/providers/openapi/apis/api/v4/vendors/{vendorId}/exchangeRequests

Example Endpoint

https://api-gateway.coupang.com/v2/providers/openapi/apis/api/v4/vendors/A00012345/exchangeRequests?createdAtFrom=2018-03-05T00:00:00&createdAtTo=2018-03-10T23:59:59&status=PROGRESS

Request Parameters

Path Segment Parameter

Name Required Type Description
vendorId O String
판매자 ID
쿠팡에서 업체에게 발급한 고유 코드. WING 로그인 후 확인 가능
예) A00012345

Query String Parameter

Name Required Type Description
createdAtFrom O String 
검색 시작일 (yyyy-MM-ddTHH: mm: ss)
예) 2016-03-15T13:00:00
createdAtTo O String 
검색 종료일 (yyyy-MM-ddTHH: mm: ss)
예) 2016-03-16T13:00:00
status   String 
교환진행상태
구체적인 교환 상태를 선택하지 않을시 모든 상태로 반환됩니다.
Name Status
RECEIPT 접수
PROGRESS 진행
SUCCESS 완료
REJECT 불가
CANCEL 철회
orderId   Number 
주문번호
예) 19000009511537
nextToken   String
다음 페이지 조회를 위한 토큰값
첫번째 페이지 조회 시에는 필요하지 않습니다.
maxPerPage   Number
최대 조회 요청 값
기본값 : 10
 

Path Segment Parameter

not require body

 

Response Message

Name Type Description
code Number
server response status code
message String
detail info
data Object
결과
  exchangeId Number
교환 ID
  orderId Number
주문번호
  vendorId String
판매자 ID
  orderDeliveryStatusCode String
주문 배송 상태
Name Status
ACCEPT 결재완료
INSTRUCT 상품준비중
DEPARTURE 배송지시
DELIVERING 배송중
FINAL_DELIVERY 배송완료
NONE_TRACKING 업체 직접 배송(배송 연동 미적용), 추적불가
  exchangeStatus String
교환 상태
Name Status
RECEIPT 접수
PROGRESS 진행
SUCCESS 완료
REJECT 불가
CANCEL 철회
  referType String
접수경로
Name Status
VENDOR 벤더
CS_CENTER CS
WEB_PC 웹 PC
WEB_MOBILE 웹 모바일
  faultType String
귀책
Name Status
COUPANG 쿠팡과실
VENDOR 업체과실
CUSTOMER 고객과실
WMS 물류과실
GENERAL 일반
  exchangeAmount String
교환배송비
  reason String
null *더 이상 사용하지 않는 항목입니다.
  reasonCode String
교환사유코드
해당 페이지 상단에서 VOC 사유코드를 다운받아 확인해주세요.
  reasonCodeText String
교환사유설명
  reasonEtcDetail String
교환사유상세설명
  cancelReason String
교환철회사유
  createdByType String
최초 등록자 유형
Name Status
CUSTOMER 고객
COUNSELOR 상담사
COUPANG 내부직원
VENDOR 업체
ETC 기타
  createdAt String
등록일시
(yyyy-MM-ddTHH: mm: ss)
  modifiedByType String
수정자
Name Status
CUSTOMER 고객
COUNSELOR 상담사
COUPANG 내부직원
VENDOR 업체
ETC 기타
TRACKING 배송추적
  modifiedAt String
수정 일시
(yyyy-MM-ddTHH: mm: ss)
  exchangeItemDtoV1s Array
교환 항목 목록
    exchangeItemId Number
교환 상품 아이디
교환 데이터 저장 시 사용하는 내부ID
    orderItemId Number
원주문 아이템 ID
    orderItemUnitPrice Number
원주문 아이템 단가
    orderItemName String
원주문 아이템 명
    orderPackageId Number
원주문 패키지 ID
    orderPackageName String
원주문 패키지 명
    targetItemId Number
교환 아이템 ID
    targetItemUnitPrice Number
교환 아이템 단가
    targetItemName String
교환 아이템 명
    targetPackageId Number
교환 패키지 ID
    targetPackageName String
교환 패키지 명
    quantity Number
교환수량
    orderItemDeliveryComplete Boolean
True/False
원주문 아이템 배송완료 여부
    orderItemReturnComplete Boolean
True/False
원주문 아이템 반품완료 여부
    targetItemDeliveryComplete Boolean
True/False
교환 아이템 배송완료 여부
    createdAt String
생성 일시
(yyyy-MM-ddTHH: mm: ss)
    modifiedAt String
수정 일시
(yyyy-MM-ddTHH: mm: ss)
    originalShipmentBoxId Number
원배송번호
  exchangeAddressDtoV1 Object
교환 주소
    exchangeAddressId Number
교환 주소 아이디
    returnCustomerName String
반품 신청인 이름
    returnAddressZipCode String
반품지 우편번호
    returnAddress String
반품 신청인 주소
    returnAddressDetail String
상세한 반품주소
    returnPhone String
반품 신청인 전화번호
    returnMobile String
반품 신청인 모바일
    returnMemo String
반품 메모
    deliveryCustomerName String
수취인 이름
    deliveryAddressZipCode String
우편번호
    deliveryAddress String
수취인 주소
    deliveryAddressDetail String
상세한 주소
    deliveryPhone String
수취인 폰
    deliveryMobile String
수취인 모바일 (안심번호)
    deliveryMemo String
배송 메모
    createdAt String
생성 일시
(yyyy-MM-ddTHH: mm: ss)
    modifiedAt String
수정 일시
(yyyy-MM-ddTHH: mm: ss)
    exchangeId Number
교환 ID
  deliveryInvoiceGroupDtos Array
Delivery Invoice informations
    shipmentBoxId Number
배송번호
    boxPrice Number
Box price
    orderId Number
주문번호
    orderType String
주문 유형
    customerType String
사용자 유형
    bundleType String
배송 묶음 유형
    extraMessage String
메모
    shippingDeliveryType String
배송 타입
Name Status
DELIVERY 일반배송
EXCHANGE_DELIVERY 교환배송
FORCED_DELIVERY 추가출고배송
    deliveryInvoiceDtos Array
Delivery Invoice informations
      invoiceNumber String
운송장 번호
      estimatedDeliveryDate String
주문에서 실제 출고까지 리드타임
(yyyy-MM-ddTHH: mm: ss)
      deliveredDate String
배송일
(yyyy-MM-ddTHH: mm: ss)
      statusModifiedAt String
상태 수정 일시
(yyyy-MM-ddTHH: mm: ss)
      invoiceNumberUploadDate String
운송장 번호 업로드 일시
(yyyy-MM-ddTHH: mm: ss)
      statusCode String
발주서 상태
Name Status
ACCEPT 결재완료
INSTRUCT 상품준비중
DEPARTURE 배송지시
DELIVERING 배송중
FINAL_DELIVERY 배송완료
NONE_TRACKING 업체 직접 배송(배송 연동 미적용), 추적불가
      deliverCode String
      isMainShipmentInvoice Boolean
Retail 분리배송 시 대표 송장 여부
      parcelType String
Retail 배송 타입
      invoiceVendorItemDtos Array
vendor item information
        vendorItemId Number
옵션아이디
        quantity Number
수량
        hasAdditionalItem Boolean
일부 여부
        promiseDeliveryDate String
주문시점의 상품별 배송 예정일
(yyyy-MM-ddTHH: mm: ss)
        estimatedShippingDate String
주문시 출고예정일
(yyyy-MM-ddTHH: mm: ss)
  deliveryStatus String
재배송상태
Name Status
BeforeDirection 배송연동 전
CompleteDirection 배송연동
Delivering 배송중
CompleteDelivery 배송완료
DirectionFail 배송연동실패
VendorDirect 업체직송
Fail 배송실패
Withdraw 교환배송철회
NoneData 정보없음
  collectStatus String
회수상태
Name Status
BeforeDirection 회수연동 전
CompleteDirection 회수연동
Delivering 회수중
CompleteCollect 업체전달완료
DirectionFail 회수연동실패
Fail 회수실패
Withdraw 교환회수철회
NoCollect 회수 불필요
NoneData 정보없음
  collectCompleteDate String
입고완료일시
(yyyy-MM-ddTHH: mm: ss)
  collectInformationsDto Object
회수정보
    returnType String
반품유형: 반품 혹은 교환(RETURN or EXCHANGE_RETURN)
    expectedReturnDate String
반품예정일시
(yyyy-MM-ddTHH: mm: ss)
    returndeliveryItemDtos Array
returndeliveryItemDtos
      vendorItemId Number
옵션아이디
      statusCode String
상태코드
Name Status
RETURN_SEND_READY 접수
RETURN_SEND_COMPLETE 전송완료
RETURN_COLLECT_OK 정상반품완료
RETURN_COLLECT_NOT_OK 비정상반품완료(수량불일치 등)
CHANGE_SEND_READY 교환확정
CHANGE_SEND_HOLD 교환확정홀드(교환확정에서 철회될 경우 변경되는 코드)
CHANGE_SEND_COMPLETE 교환정보 전송완료
CHANGE_SEND_FAIL 교환재고없음(미발송)
COLLECT_FAIL 회수실패
      returnCount Number
반품수량
      releaseStatus String
출고상태
Name Status
RELEASED 이미출고
NOT_RELEASED 미출고
      paymentReturnDeliveryMapId Number
paymentReturnDeliveryMapId
      paymentItemId Number
paymentItemId
      modifiedBy String
변경자
      modifiedAt String
최종상태 변경일시
(yyyy-MM-ddTHH: mm: ss)
      createdBy String
접수자
      createdAt String
접수일시
(yyyy-MM-ddTHH: mm: ss)
      count Number
수량
      confirmType String
confirmType
Name Status
RELEASED 이미 출고
STOPPED 출고중지 완료
      collectStatus String
회수상태
Name Status
NONE 값 없음
RETURN 회수진행
NO_RETURN 회수안함
ALREADY_RETURN 이미회수
CANCEL_REQUEST_WHEN_DEPARTURE 출고시 철회요청
    returndeliveryDestinationDto Object
대표회수지 정보
      vendorZipCode String
판매자우편번호
      vendorPhone String
판매자전화번호
      vendorName String
판매자 이름
      vendorMobile String
판매자 휴대전화번호
      vendorAddressDetail String
상세한 판매자주소지
      vendorAddress String
판매자주소
      safetyNumberStatus String
안심번호 상태
Name Status
WAIT 대기
ENABLE 사용가능
DEPOSE 폐기
DISABLE 사용불가
ERROR 오류
RESERVE 보류
      safetyNumberId Number
안심번호Id
      safetyNumber String
안심번호
      returnDeliveryId Number
회수송장번호
      returnCenterCode String
반품지센터코드
      receiptId Number
접수번호
      orderedByMobile String
주문자 전화번호
      orderId Number
주문번호
      message String
메세지
      customerZipCode String
고객우편번호
      customerPhone String
고객전화번호 (안심번호)
      customerName String
고객명
      customerMobile String
고객핸드폰번호 (안심번호)
      customerAddressDetail String
상세한 고객주소지
      customerAddress String
고객 주소
  returnDeliveryDtos Object
회수정보
    deliveryCompanyCode String
택배사 코드
    deliveryInvoiceNo String
회수 운송장 번호
  successable Boolean
True/False
교환 완료 처리 가능여부
  orderDeliveryStatusLabel String
주문 배송 상태 라벨
  exchangeStatusLabel String
교환 상태 라벨
  referTypeLabel String
접수 경로 라벨
  faultTypeLabel String
귀책 (배송비 부담 주체) 라벨
  createdByTypeLabel String
최초 등록자 타입 라벨
  rejectable Boolean
True/False
교환 불가처리 가능여부
  modifiedByTypeLabel String
수정자 라벨
  deliveryInvoiceModifiable Boolean
True/False
송장번호입력 가능여부
nextToken String
다음 페이지 조회를 위한 토큰값

Response Example

{
  "code": 200,
  "message": "OK",
  "data": [
    {
      "exchangeId": 101268974,
      "orderId": 11000013144262,
      "vendorId": "A001234567",
      "orderDeliveryStatusCode": "FINAL_DELIVERY",
      "exchangeStatus": "PROGRESS",
      "referType": "WEB_MOBILE",
      "faultType": "VENDOR",
      "exchangeAmount": 0,
      "reason": null,
      "reasonCode": "DIFFERENTOPT",
      "reasonCodeText": "색상/ 사이즈가 기대와 다름",
      "reasonEtcDetail": "베이지색 주문했는데 브라운이 왔습니다",
      "cancelReason": null,
      "createdByType": "CUSTOMER",
      "createdAt": "2018-03-05T10:54:41",
      "modifiedByType": "TRACKING",
      "modifiedAt": "2018-03-05T10:54:41",
      "exchangeItemDtoV1s": [
        {
          "exchangeItemId": 1765111,
          "orderItemId": 3476137875,
          "orderItemUnitPrice": 35900,
          "orderItemName": null,
          "orderPackageId": null,
          "orderPackageName": null,
          "targetItemId": 3476137875,
          "targetItemUnitPrice": 35900,
          "targetItemName": "후아유(WHO.A.U) 벙커Ⅰ 레터 백팩 / WHAK82104C, (35)Beige, FREE",
          "targetPackageId": -1,
          "targetPackageName": "",
          "quantity": 1,
          "orderItemDeliveryComplete": null,
          "orderItemReturnComplete": null,
          "targetItemDeliveryComplete": null,
          "createdAt": "2018-03-05T10:54:41",
          "modifiedAt": "2018-03-05T10:54:41",
          "originalShipmentBoxId": 123456789012345678
        }
      ],
      "exchangeAddressDtoV1": {
        "exchangeAddressId": 1691712,
        "returnCustomerName": "이***",
        "returnAddressZipCode": "431-0*",
        "returnAddress": "경기도 안양시 동안구 평촌동",
        "returnAddressDetail": "꿈마을건영아파트 *",
        "returnPhone": null,
        "returnMobile": "010-****-****",
        "returnMemo": null,
        "deliveryCustomerName": "이인용",
        "deliveryAddressZipCode": "431-0*",
        "deliveryAddress": "경기도 안양시 동안구 평촌동",
        "deliveryAddressDetail": "꿈마을건영아파트 *",
        "deliveryPhone": null,
        "deliveryMobile": "050382470825",
        "deliveryMemo": null,
        "createdAt": "2018-03-05T10:54:41",
        "modifiedAt": "2018-03-05T10:54:41",
        "exchangeId": 101268974
      },
      "deliveryInvoiceGroupDtos": [],
      "deliveryStatus": "BeforeDirection",
      "collectStatus": "Collecting",
      "collectCompleteDate": null,
      "collectInformationsDto": {
        "returnType": "EXCHANGE_RETURN",
        "expectedReturnDate": "2018-03-08T10:54:41",
        "returndeliveryItemDtos": [
          {
            "vendorItemId": 3476137875,
            "statusCode": "RETURN_SEND_READY",
            "returnCount": null,
            "releaseStatus": "RELEASED",
            "paymentReturnDeliveryMapId": 29713264,
            "paymentItemId": 1,
            "modifiedBy": "104132490",
            "moodifiedAt": "2018-03-05T10:54:41",
            "createdBy": "104132490",
            "createdAt": "2018-03-05T10:54:41",
            "count": 1,
            "confirmType": null,
            "collectStatus": "RETURN"
          }
        ],
        "returndeliveryDestinationDto": {
          "vendorZipCode": "312-14",
          "vendorPhone": "1899-6500",
          "vendorName": "(주)*몰)",
          "vendorMobile": "",
          "vendorAddressDetail": "** 물류센터 지하1층",
          "vendorAddress": "충청남도 천안시 동남구 풍세면 * ()",
          "safetyNumberStatus": "DISABLE",
          "safetyNumberId": 245668944,
          "safetyNumber": "050382470825",
          "returnDeliveryId": null,
          "returnCenterCode": "1000276167",
          "receiptId": null,
          "orderedByMobile": null,
          "orderId": 11000013144262,
          "message": null,
          "customerZipCode": "14101",
          "customerPhone": "05029870825",
          "customerName": "이**",
          "customerMobile": "010*",
          "customerAddressDetail": "꿈마을건영아파트 *",
          "customerAddress": "경기도 안양시 동안구 평촌동"
        }
      },
      "returnDeliveryDtos": [
        {
          "deliveryCompanyCode": "CJGLS",
          "deliveryInvoiceNo": ""
        }
      ],
      "orderDeliveryStatusLabel": "FINAL_DELIVERY",
      "exchangeStatusLabel": "PROGRESS",
      "referTypeLabel": "WEB_MOBILE",
      "faultTypeLabel": "VENDOR",
      "createdByTypeLabel": "CUSTOMER",
      "rejectable": false,
      "modifiedByTypeLabel": "CUSTOMER",
      "deliveryInvoiceModifiable": false,
      "successable": false
    },
    {
      "exchangeId": 101284720,
      "orderId": 3000013258427,
      "vendorId": "A00127960",
      "orderDeliveryStatusCode": "FINAL_DELIVERY",
      "exchangeStatus": "PROGRESS",
      "referType": "WEB_MOBILE",
      "faultType": "VENDOR",
      "exchangeAmount": 0,
      "reason": null,
      "reasonCode": "COMPOMISS",
      "reasonCodeText": "상품의 구성품, 부속품이 제대로 들어있지 않음",
      "reasonEtcDetail": "배송되지 않았어요 확인해주세요",
      "cancelReason": null,
      "createdByType": "CUSTOMER",
      "createdAt": "2018-03-08T16:42:11",
      "modifiedByType": "TRACKING",
      "modifiedAt": "2018-03-08T16:42:11",
      "exchangeItemDtoV1s": [
        {
          "exchangeItemId": 1784732,
          "orderItemId": 3288964806,
          "orderItemUnitPrice": 4900,
          "orderItemName": null,
          "orderPackageId": null,
          "orderPackageName": null,
          "targetItemId": 3288964806,
          "targetItemUnitPrice": 4900,
          "targetItemName": "펠릭스키즈 펠릭스 시그니쳐 맨투맨 FXMS178N3, 30 YELLOW, 100호",
          "targetPackageId": -1,
          "targetPackageName": "",
          "quantity": 1,
          "orderItemDeliveryComplete": null,
          "orderItemReturnComplete": null,
          "targetItemDeliveryComplete": null,
          "createdAt": "2018-03-08T16:42:11",
          "modifiedAt": "2018-03-08T16:42:11",
          "originalShipmentBoxId": 123456789012345679
        },
        {
          "exchangeItemId": 1784733,
          "orderItemId": 3288975565,
          "orderItemUnitPrice": 4900,
          "orderItemName": null,
          "orderPackageId": null,
          "orderPackageName": null,
          "targetItemId": 3288975565,
          "targetItemUnitPrice": 4900,
          "targetItemName": "펠릭스키즈 펠릭스 시그니쳐 맨투맨 FXMS178N3, 30 YELLOW, 120호",
          "targetPackageId": -1,
          "targetPackageName": "",
          "quantity": 1,
          "orderItemDeliveryComplete": null,
          "orderItemReturnComplete": null,
          "targetItemDeliveryComplete": null,
          "createdAt": "2018-03-08T16:42:11",
          "modifiedAt": "2018-03-08T16:42:11",
          "originalShipmentBoxId": 123456789012345677
        }
      ],
      "exchangeAddressDtoV1": {
        "exchangeAddressId": 1707458,
        "returnCustomerName": "김혜은",
        "returnAddressZipCode": "18488",
        "returnAddress": "경기도 화성시 동탄면 동탄대로9길 20",
        "returnAddressDetail": "Lh26단지 *",
        "returnPhone": null,
        "returnMobile": "010-****-****",
        "returnMemo": null,
        "deliveryCustomerName": "김**",
        "deliveryAddressZipCode": "18488",
        "deliveryAddress": "경기도 화성시 동탄면 동탄대로9길 20",
        "deliveryAddressDetail": "Lh26단지 *",
        "deliveryPhone": null,
        "deliveryMobile": "050382470825",
        "deliveryMemo": null,
        "createdAt": "2018-03-08T16:42:11",
        "modifiedAt": "2018-03-08T16:42:11",
        "exchangeId": 101284720
      },
      "deliveryInvoiceGroupDtos": [],
      "deliveryStatus": "BeforeDirection",
      "collectStatus": "Collecting",
      "collectCompleteDate": null,
      "collectInformationsDto": {
        "returnType": "EXCHANGE_RETURN",
        "expectedReturnDate": "2018-03-13T16:42:11",
        "returndeliveryItemDtos": [
          {
            "vendorItemId": 3288975565,
            "statusCode": "RETURN_SEND_READY",
            "returnCount": null,
            "releaseStatus": "RELEASED",
            "paymentReturnDeliveryMapId": 29829105,
            "paymentItemId": 1,
            "modifiedBy": "56373890",
            "moodifiedAt": "2018-03-08T16:42:11",
            "createdBy": "56373890",
            "createdAt": "2018-03-08T16:42:11",
            "count": 1,
            "confirmType": null,
            "collectStatus": "RETURN"
          },
          {
            "vendorItemId": 3288964806,
            "statusCode": "RETURN_SEND_READY",
            "returnCount": null,
            "releaseStatus": "RELEASED",
            "paymentReturnDeliveryMapId": 29829106,
            "paymentItemId": 1,
            "modifiedBy": "56373890",
            "moodifiedAt": "2018-03-08T16:42:11",
            "createdBy": "56373890",
            "createdAt": "2018-03-08T16:42:11",
            "count": 1,
            "confirmType": null,
            "collectStatus": "RETURN"
          }
        ],
        "returndeliveryDestinationDto": {
          "vendorZipCode": "312-14",
          "vendorPhone": "1899-6500",
          "vendorName": "(주)**몰)",
          "vendorMobile": "010-9203-8248",
          "vendorAddressDetail": "**물류센터 4층 이커머스BD",
          "vendorAddress": "충청남도 천안시 동남구 *()",
          "safetyNumberStatus": "ENABLE",
          "safetyNumberId": 247397194,
          "safetyNumber": "0502987****",
          "returnDeliveryId": null,
          "returnCenterCode": "1000274320",
          "receiptId": null,
          "orderedByMobile": null,
          "orderId": 3000013258427,
          "message": null,
          "customerZipCode": "18488",
          "customerPhone": "05029870825",
          "customerName": "김혜은",
          "customerMobile": "05029870825",
          "customerAddressDetail": "Lh26단지 ***",
          "customerAddress": "경기도 화성시 동탄면 동탄대로9길 20"
        }
      },
      "returnDeliveryDtos": [
        {
          "deliveryCompanyCode": "CJGLS",
          "deliveryInvoiceNo": ""
        }
      ],
      "orderDeliveryStatusLabel": "FINAL_DELIVERY",
      "exchangeStatusLabel": "PROGRESS",
      "referTypeLabel": "WEB_MOBILE",
      "faultTypeLabel": "VENDOR",
      "createdByTypeLabel": "CUSTOMER",
      "rejectable": false,
      "modifiedByTypeLabel": "CUSTOMER",
      "deliveryInvoiceModifiable": false,
      "successable": false
    }
  ],
  "nextToken": ""
}

Error Spec

HTTP 상태 코드(오류 유형) 오류 메시지 해결 방법
400 (요청변수확인) error-message=createdAtTo - createdAtFrom should less then 7day. 조회기간이 7일 이하 인지 확인합니다.
400 (요청변수확인) createdAtFrom format should be yyyy-MM-ddTHH:mm:ss. 검색 시작일의 입력형식이  yyyy-MM-ddTHH:mm:ss 인지 확인합니다.
400 (요청변수확인) The vendorId in path or requestBody doesn't match the one got from api-gateway. vendorId (판매자 ID) 값을 올바르게 입력했는지 확인합니다. 
400 (요청변수확인) start time should early or equals to end time 검색 종료일이 검색 시작일 보다 빠른 날짜로 설정 되었는지 확인합니다.

URL API Name

GET_EXCHANGE_REQUEST