상품 리뷰 관리

상품리뷰 단건 조회

get

기능설명

  • 상품리뷰 단건 정보를 조회합니다.


상세설명

  • 상품번호를 파라미터로 받아 상품리뷰 상세 정보를 조회합니다.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
revNostringRequired

리뷰번호

Example: 11093301
Header parameters
AuthorizationanyOptional

Access Token

Responses
chevron-right
200

상품평 정보 조회 성공

application/json

상품리뷰 기본정보 DTO

entrNostringOptional

협력사번호

stdCtgNostringOptional

표준카테고리번호

revContstringOptional

리뷰내용

revScrValnumber · floatOptional

리뷰별점

stfd1YnstringOptional

만족도1여부(배송)

stfd2YnstringOptional

만족도2여부(응대)

stfd3YnstringOptional

만족도3여부

get
/v1/review/adv/{revNo}

상품리뷰 수정

put

기능설명

  • 상품평을 수정하는 API 입니다.


상세설명

  • 회원이 기존에 작성했던 상품평을 수정합니다.

  • 마이페이지의 작성한 상품평 화면에서 상품평 수정시 호출됩니다.

  • 리뷰번호를 파라미터로 받아서 해당 리뷰번호에 해당하는 상품평을 수정합니다.

  • 회원정보를 확인하여 본인이 작성한 상품평만 수정이 가능합니다.


검증내용

  • 0000 : 상품평이 성공적으로 수정된 경우입니다.

  • 5002 : request에 회원번호가 없는 경우 발생합니다. 로그아웃 상태에서 상품평 수정 요청시 발생하는 에러입니다.


수정번호

  • Release v2.00_240425: 상품평 작성 여부 수정 API 호출시 필수값 세팅 오류 수정

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
revNostringRequired

리뷰번호

Query parameters
filesstring · binaryOptional

멀티미디어 정보

Header parameters
AuthorizationanyOptional

Access Token

Body

상품리뷰 기본정보 DTO

entrNostringOptional

협력사번호

stdCtgNostringOptional

표준카테고리번호

revContstringOptional

리뷰내용

revScrValnumber · floatOptional

리뷰별점

stfd1YnstringOptional

만족도1여부(배송)

stfd2YnstringOptional

만족도2여부(응대)

stfd3YnstringOptional

만족도3여부

Responses
chevron-right
200

상품평 수정 성공

application/json
timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

payloadanyOptional

payload

errorbooleanOptional

is error

put
/v1/review/adv/{revNo}

상품평 삭제

delete

기능설명

  • 상품평을 삭제하는 API 입니다.


상세설명

  • 마이페이지의 작성한 상품평 화면에서 상품평 삭제시 호출됩니다.

  • 회원정보를 확인하여 본인이 작성한 상품평만 삭제가 가능합니다.

  • 상품평을 물리적으로 삭제하지 않고 삭제 여부만 'Y'로 변경하여 화면에 노출되지 않게합니다.


검증내용

  • 0000 : 상품평이 성공적으로 삭제된 경우입니다.

  • 5000 : 회원 정보가 없는 상태에서 상품평 삭제시 발생합니다. 로그아웃 상태에서 상품평 신고 요청시 발생하는 에러입니다.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
revNostringRequired

리뷰번호

Example: 11093301
Header parameters
AuthorizationanyOptional

Access Token

Responses
chevron-right
200

상품평 삭제 성공

*/*
timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

payloadanyOptional

payload

errorbooleanOptional

is error

delete
/v1/review/adv/{revNo}

상품평 도움돼요 업데이트 및 총 개수 조회

post

기능설명

  • 상품평 도움돼요를 업데이트하고 해당 상품평의 총 도움돼요 개수를 조회합니다.


상세설명

  • 상품평 도움돼요를 업데이트하고 해당 상품평의 총 도움돼요 개수를 조회합니다.

  • 상품평 회원정보를 확인하여 본인이 작성하지 않은 상품평만 도움돼요가 가능합니다.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
revNostringRequired

리뷰번호

Example: 11093301
Header parameters
AuthorizationanyOptional

Access Token

Responses
chevron-right
200

OK

*/*

상품리뷰도움돼요 DTO

revNostringOptional

리뷰번호

mbrNostringOptional

회원번호

delYnstringOptional

삭제여부

hlpfulCntinteger · int32Optional

도움돼요수

post
/v1/review/adv/helpful/{revNo}
200

OK

상품별 상품평 정보 조회

get

기능설명

  • 상품별 상품평 목록 정보를 조회합니다.


상세설명

  • 상품번호를 파라미터로 받아 상품의 상품평 목록을 조회합니다.

  • 상품상세 페이지 진입시 하단 상품평 영역에 상품평 정보 노출을 위해 호출됩니다.

  • 구분 리뷰 개수 조회 시 리뷰구분코드목록이 존재할 경우 구분 리뷰 개수가 조회되지 않습니다.


코드정리

  • 정렬유형코드 : latest:최신순, recommend:추천순

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
goodsNostringRequired

상품번호

Example: 10001921
Query parameters
revGbCdListarrayOptional

리뷰구분코드목록

Example: ["10"]
sortTypeCdstringOptional

정렬유형코드

Example: latest
typeCountYnstringOptional

구분 리뷰 개수 여부

Example: N
pageNostringOptional

integer

Example: 1
pageSizestringOptional

integer

Example: 20
Header parameters
AuthorizationanyOptional

Access Token

Responses
chevron-right
200

상품별 상품평 정보 조회 성공

application/json

상품 리뷰 DTO

get
/v1/review/adv/goods/{goodsNo}

상품리뷰 등록

post

기능설명

  • 상품평을 등록하는 API 입니다.


상세설명

  • 회원이 구매한 상품의 상품평을 등록합니다.

  • 마이페이지의 작성 가능 상품평 화면에서 상품평 등록시 호출됩니다.

  • 상품번호를 파라미터로 받아서 해당 상품번호에 해당하는 상품평을 등록합니다.


검증내용

  • 0000 : 상품평이 성공적으로 등록된 경우입니다.

  • 5002 : request에 회원번호가 없는 경우 발생합니다. 로그아웃 상태에서 상품평 등록 요청시 발생하는 에러입니다.


수정번호

  • Release v2.00_240425: 상품평 작성 여부 수정 API 호출시 필수값 세팅 오류 수정

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
goodsNostringRequired
Query parameters
filesstring · binaryOptional

멀티미디어 정보

Header parameters
AuthorizationanyOptional

Access Token

Body

상품리뷰 기본정보 DTO

entrNostringOptional

협력사번호

stdCtgNostringOptional

표준카테고리번호

revContstringOptional

리뷰내용

revScrValnumber · floatOptional

리뷰별점

stfd1YnstringOptional

만족도1여부(배송)

stfd2YnstringOptional

만족도2여부(응대)

stfd3YnstringOptional

만족도3여부

Responses
chevron-right
200

상품평 등록 성공

*/*
timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

payloadanyOptional

payload

errorbooleanOptional

is error

post
/v1/review/adv/goods/{goodsNo}

상품평 신고

post

기능설명

  • 상품평을 신고 API입니다.


상세설명

  • 리뷰번호, 리뷰신고유형코드를 필수 파라미터로 받아 상품평을 신고합니다.

  • 리뷰신고유형이 기타일 경우 리뷰신고기타사유가 필수 파라미터로 필요합니다.

  • 본인이 작성하지 않은 상품평만 신고할 수 있습니다.


검증내용

  • 0000 : 상품평을 성공적으로 신고한 경우입니다.

  • 5000 : 리뷰신고유형코드 누락 / 기타(90)유형인데 신고기타사유 누락 시 발생하는 에러입니다.

  • 5002 : 회원 정보가 없는 상태에서 상품평 신고시 발생합니다. 로그아웃 상태에서 상품평 신고 요청시 발생하는 에러입니다.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
revNostringRequired

리뷰번호

Example: 10000661
Query parameters
Header parameters
AuthorizationanyOptional

Access Token

Responses
chevron-right
200

상품평 신고 성공

*/*
timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

payloadanyOptional

payload

errorbooleanOptional

is error

post
/v1/review/adv/declaration/{revNo}

상품리뷰 단건 조회 (상품정보 포함)

get

기능설명

  • 상품리뷰 단건 정보와 상품정보를 조회합니다.


상세설명

  • 상품번호를 파라미터로 받아 상품리뷰 상세 정보와 상품정보를 조회합니다.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
revNostringRequired

리뷰번호

Example: 11093301
Header parameters
AuthorizationanyOptional

Access Token

Responses
chevron-right
200

상품평 정보 조회 성공

application/json

상품 리뷰 DTO

get
/v1/review/adv/{revNo}/goods

회원별 상품평 목록 조회

get

기능설명

  • 회원이 작성한 상품평 목록을 조회합니다.


상세설명

  • 회원이 작성한 상품평 목록을 조회합니다.

  • 별도 조회조건 미설정시 최근 1개월 내 작성된 상품평 목록을 조회합니다.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
searchStartDatestringOptional

localDateTime

Example: 20230822
searchEndDatestringOptional

localDateTime

Example: 20231122
pageNostringOptional

integer

Example: 1
pageSizestringOptional

integer

Example: 20
Header parameters
AuthorizationanyOptional

Access Token

Responses
chevron-right
200

회원별 상품평정보 조회 성공

application/json

상품평 목록 정보

revAllListTotalCntinteger · int32Optional

총 리뷰 갯수

get
/v1/review/adv/member

회원별 상품평 총 개수 조회

get

기능설명

  • 회원이 작성한 상품평 총 개수를 조회합니다.


상세설명

  • 회원이 작성한 상품평 총 개수를 조회합니다.

  • 삭제되지 않은 모든 상품평 개수를 조회합니다.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
AuthorizationanyOptional

Access Token

Responses
chevron-right
200

OK

application/json
integer · int64Optional
get
/v1/review/adv/member/count
200

OK

상품별 상품평 요약정보 조회

get

기능설명

  • 상품평 총 개수, 평점, 평가통계, 평가통계 디테일을 조회합니다.


상세설명

  • 해당 상품의 총 상품평 개수, 평점, 평가통계, 평가통계 디테일을 조회합니다.

  • 상품상세 화면 하단 상품평 정보 영역에 해당 상품의 상품평 토탈 정보 노출을 위해 호출됩니다.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
goodsNostringRequired

상품번호

Example: 10001921
Header parameters
AuthorizationanyOptional

Access Token

Responses
chevron-right
200

상품별 상품평 토탈정보 조회 성공

*/*

상품평 토탈정보 DTO

get
/v1/review/adv/goods/{goodsNo}/summary

상품평 사진/동영상 썸네일 조회

get

기능설명

  • 상품평의 사진/동영상 썸네일을 조회합니다.


상세설명

  • 최근 작성된 사진/동영상 첨부 상품평의 썸네일을 조회합니다.

  • 상품상세 화면 하단 상품평 정보 영역과, 상품별 상품평 목록 화면 상단에 사진/동영상 상품평의 썸네일을 노출하기 위해 호출합니다.

  • 각 상품평 별로 1개의 썸네일이 조회되며, 총 개수가 4개가 넘을 경우 더보기 버튼이 호출됩니다.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
goodsNostringRequired

상품번호

Example: 10001921
pageNostringOptional

integer

Example: 1
pageSizestringOptional

integer

Example: 5
Header parameters
AuthorizationanyOptional

Access Token

Responses
chevron-right
200

상품 사진/동영상 썸네일 조회 성공

application/json
totalCntinteger · int64Optional
get
/v1/review/adv/goods/{goodsNo}/represent/thumbnails

상품번호별 평가정보리스트 조회

get

기능설명

  • 상품번호를 통해 카테고리별 평가정보리스트를 조회합니다.


상세설명

  • 상품번호를 통해 표준카테고리번호를 조회합니다.

  • 조회된 표준카테고리번호에 매핑된 표준카테고리별 평가정보리스트를 조회합니다.

  • 상품평 등록 화면에서 해당 상품과 매핑된 표준카테고리와 평가항목을 나타내기 위해 호출됩니다.


수정번호

Release v2.00_240401: 평가정보리스트를 표준카테고리별 조회에서 상품번호별 조회로 변경

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
goodsNostringRequired

상품번호

Example: 10002031
Query parameters
revNostringOptional

리뷰번호

Example: 11093373
Header parameters
AuthorizationanyOptional

Access Token

Responses
chevron-right
200

카테고리별 평가정보리스트 조회 성공

*/*
evltItemNostringOptional

평가항목번호

evltItemNmstringOptional

평가항목명

useYnstringOptional

사용여부

get
/v1/review/adv/evaluations/{goodsNo}

Last updated