상품 API 카테고리 API 브랜드 API 배송 / 주문 API 반품 API 교환 API 프로모션 / 쿠폰 물류 정보 고객 문의 정산 CGF / CGF lite Rocket Growth

반품 API

POST/v2/providers/openapi/apis/api/v4/vendors/{vendorId}/returnWithdrawList2609170000

반품철회 이력 접수번호로 조회

KRTW

# 01

요약

반품철회 이력 접수번호로 조회

# 02

상세

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

취소(반품)접수번호를 이용하여 철회된 반품의 이력을 조회합니다.

경로

POST/v2/providers/openapi/apis/api/v4/vendors/{vendorId}/returnWithdrawList

예시 엔드포인트

https://api-gateway.coupang.com/v2/providers/openapi/apis/api/v4/vendors/A00012345/returnWithdrawList

URL API Name

GET_RETURNWITHDRAW_BY_CANCEL_IDS

# 03

Path 파라미터

Name	Type	Description
vendorId*	string	판매자 ID 쿠팡에서 업체에게 발급한 고유 코드 예) A00012345

# 04

요청 본문

요청 파라미터

본문 파라미터

Name	Type	Description
cancelIds*	object[]	철회 이력을 조회할 취소(반품)접수번호 목록 한 번에 최대 50개까지 cancelIds 조회가 가능합니다. cancelIds는 number 타입이어야 합니다.

요청 예시application/json

{
  "cancelIds": [
    87033689
  ]
}

# 05

응답 본문

응답 메시지

Name

Type

Description

code

string

Http request status code
Example: 200, 400, 500

message

string

성공 혹은 실패 시 해당 결과메시지가 나타남

data

object[]

cancelId

data[].cancelId

integer

취소(반품)접수번호

orderId

data[].orderId

integer

주문번호

vendorId

data[].vendorId

string

업체코드

refundDeliveryDuty

data[].refundDeliveryDuty

string

반품 귀책

CODE	Mean
COM	업체
CUS	고객
COU	쿠팡

createdAt

data[].createdAt

string

취소(반품) 철회 시각
yyyy-MM-ddThh:mm:ss

vendorItemIds

data[].vendorItemIds

object[]

반품 옵션아이디 목록

Response Example

{
  "code": "200",
  "message": "OK",
  "data": [
    {
      "cancelId": 87033689,
      "orderId": 23000016565020,
      "vendorId": "A00001234",
      "refundDeliveryDuty": "COM",
      "createdAt": "2018-06-05T13:40:56",
      "vendorItemIds": [
        3737624764
      ]
    }
  ]
}

# 06

에러 코드

HTTP	코드	메시지
400	HTTP_400	Bad Request

오류 사양

HTTP	유형	오류 메시지	해결 방법
500	500 (요청변수확인)	CReturns getWithdrawnList failed	올바른 반품접수번호(cancelIds)를 입력했는지 확인합니다. 해당 항목 입력을 안할 경우 500 에러가 발생합니다.