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

반품철회 이력 기간별 조회

KRTW
# 01

요약

반품철회 이력 기간별 조회

# 02

상세

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

기간별로 철회된 반품의 이력을 조회합니다.

최대 7일까지만 조회가 가능합니다.
(참고 : 조회 시작일과 조회 종료일이 검색기간에 포함됩니다)

경로

GET/v2/providers/openapi/apis/api/v4/vendors/{vendorId}/returnWithdrawRequests

예시 엔드포인트

https://api-gateway.coupang.com/v2/providers/openapi/apis/api/v4/vendors/A00012345/returnWithdrawRequests?sizePerPage=3&pageIndex=1&dateFrom=2018-11-03&dateTo=2018-11-06

URL API Name

GET_RETURNWITHDRAW_REQUEST
# 03

Path 파라미터

NameTypeDescription
vendorId*string
판매자 ID

쿠팡에서 업체에게 발급한 고유 코드

예) A00012345
# 04

Query 파라미터

NameTypeDescription
dateFrom*string
조회 시작일 (yyyy-MM-dd)
dateTo*string
조회 종료일 (yyyy-MM-dd)
pageIndexnumber
다음 페이지 조회를 위한 인덱스 값
기본값 : 1
마지막 페이지일 경우 빈 값("")이 노출됨
sizePerPagenumber
페이지당 최대 조회 요청 값
기본값 : 10, 최대값 : 100
# 05

응답 본문

응답 메시지

NameTypeDescription
codeinteger
Http request status code
Example: 200, 400, 500
messagestring
성공 혹은 실패 시 해당 결과메시지가 나타남
dataobject[]
cancelId
data[].cancelId
integer
반품 접수번호
orderId
data[].orderId
integer
주문번호
vendorId
data[].vendorId
string
판매자 ID

쿠팡에서 업체에게 발급한 고유 코드

예) A00012345
refundDeliveryDuty
data[].refundDeliveryDuty
string
반품 귀책
CODE Mean
COM 업체
CUS 고객
COU 쿠팡
createdAt
data[].createdAt
string
반품철회 시각
yyyy-MM-ddThh:mm:ss
vendorItemIds
data[].vendorItemIds
object[]
반품 옵션아이디 목록
nextPageIndexstring
다음 페이지 조회를 위한 인덱스 값
마지막 페이지일 경우 빈 값( "" ) 이 노출됨

Response Example

{
  "code": 200,
  "message": "OK",
  "data": [
    {
      "cancelId": 116607450,
      "orderId": 29000024470847,
      "vendorId": "A00123456",
      "refundDeliveryDuty": "COM",
      "createdAt": "2018-11-06T23:50:39",
      "vendorItemIds": [
        3838728011
      ]
    },
    {
      "cancelId": 116600657,
      "orderId": 7000024098976,
      "vendorId": "A00123456",
      "refundDeliveryDuty": "CUS",
      "createdAt": "2018-11-06T23:03:40",
      "vendorItemIds": [
        3930729129
      ]
    },
    {
      "cancelId": 116590024,
      "orderId": 27000024100568,
      "vendorId": "A00123456",
      "refundDeliveryDuty": "COM",
      "createdAt": "2018-11-06T21:39:57",
      "vendorItemIds": [
        3841979364
      ]
    }
  ],
  "nextPageIndex": "2"
}
# 06

에러 코드

HTTP코드메시지
400HTTP_400Bad Request

오류 사양

HTTP유형오류 메시지해결 방법
400400 (요청변수확인)

Invalid vendor ID

판매자 ID(vendorId) 값을 올바로 입력했는지 확인합니다.

400400 (요청변수확인)

최대 조회 기간은 7 일 입니다.(The maximum view duration is 7 days)

조회기간을 7일 이내로 입력했는지 확인합니다.

400400 (요청변수확인)

종료일자는 시작일자보다 작거나 같아야 합니다.

조회시작일과 종료일을 올바로 입력했는지 확인합니다.

400400 (요청변수확인)

페이지별 최대 표시 갯수(sizePerPage)는 100 입니다. (The maximum number of indications per page (sizePerPage) is 100)

페이지당 최대 조회 요청 값(sizePerPage) 을 100 이하로 입력했는지 확인합니다.

400400 (요청변수확인)

pageindex 는 음수 또는 0 일 수 없습니다. (pageindex can not be negative or 0)

pageindex 값을 음수 또는 0으로 입력했는지 확인합니다.

400400 (요청변수확인)

날짜입력을 확인해 주세요. (형식:yyyy-MM-dd) [Please confirm the date input (format:yyyy-MM-dd)]

조회시작일과 종료일을 올바른 형식으로 입력했는지 확인합니다.

400400 (요청변수확인)

Required String parameter 'dateFrom' is not present

조회시작일을 입력했는지 확인합니다.

400400 (요청변수확인)

Required String parameter 'dateTo' is not present

조회종료일을 입력했는지 확인합니다.