latestOpenAPI 3.0.12026-08-1092443.0 KB
57a25c0addc6
클레임
클레임(취소, 반품, 교환) 목록 조회
가맹점의 클레임(취소, 반품, 교환) 목록을 조회합니다.
사용처
- 고객이 요청한 취소/반품/교환 클레임을 조회하고 관리할 수 있습니다
- 클레임 유형, 상태, 기간 등으로 필터링하여 조회할 수 있습니다
페이지네이션
- size: 페이지 크기 (기본값: 20, 최대: 100)
- 첫 페이지 조회 시 nextToken을 생략합니다
- 다음 페이지 조회 시 응답으로 받은 nextToken 값을 그대로 전달합니다
필터 조건
- status와 type을 보내지 않으면 모든 유형과 모든 상태의 클레임을 반환합니다. status와 type은 모두 포함하거나 모두 없어야 합니다.
- fromRequestDate, toRequestDate는 REQUESTED status일 때 유효합니다. 기본 값을 fromRequestDate는 7일 전, toRequestDate는 오늘이며, 조회 기간은 최대 7일입니다.
- fromRequestRevokedDate, toRequestRevokedDate는 REVOKED_REQUEST status일 때 유효합니다. 기본 값을 fromRequestRevokedDate는 7일 전, toRequestRevokedDate는 오늘이며, 조회 기간은 최대 7일입니다.
클레임 유형
- CANCEL: 취소 (결제 완료 이후 상태에서 취소 요청. 결제 완료 상태에서 사용자 취소나 이후 단계에서 판매자 취소는 클레임으로 잡히지 않습니다.)
- EXCHANGE: 교환 (상품 교환 요청)
- RETURN: 반품 (상품 반품 요청)
get/api/v3/shopping-fep/claims
Query parameters
type'CANCEL' | 'EXCHANGE' | 'RETURN'
조회용 클레임 유형. 값을 입력하지 않으면 모든 type에 대해 내려줍니다. type 값을 입력하지 않을 때는 status도 입력하지 않아야 합니다.
status'REQUESTED' | 'REVOKED_REQUEST'
조회용 클레임 상태. 값을 입력하지 않으면 모든 status에 대해 내려줍니다. status 값을 입력하지 않을 때는 type도 입력하지 않아야 합니다.
fromRequestDatestring date
조회 시작일자 yyyy-MM-dd 형태 (기본값: 오늘)
toRequestDatestring date
조회 종료일자 yyyy-MM-dd 형태 (기본값: fromRequestDate의 7일 전)
fromRequestRevokedDatestring date
클레임 요청 철회 조회 시작일자 yyyy-MM-dd 형태 (기본값: 7일 전, status가 REVOKED_REQUEST일 때 유효)
toRequestRevokedDatestring date
클레임 요청 철회 조회 종료일자 yyyy-MM-dd 형태 (기본값: 오늘, status가 REVOKED_REQUEST일 때 유효)
orderIdsinteger[]
주문 번호 목록 (복수 조회, orderId와 함께 사용 가능)
nextTokenstring
다음 페이지를 위한 커서 정보 (직전 호출에서 받은 nextToken을 그대로 넘겨 호출)
sizeinteger
페이지 사이즈 (기본값: 20, 최대 100)
partnerNamestring
연동 프로그램명 또는 자사 서비스명
Response
모든 응답은 200으로 내려갑니다 (성공 실패 포함) (장애상황에서만 5xx 노출)