본문으로 건너뛰기
API docs by Redocly

브이리뷰 Admin API

브이리뷰 어드민 기능을 API로 활용할 수 있습니다.

관리자 정보

관리자 정보 조회

Authorizations:
HTTPBasic
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "username": "string",
  • "name": "string",
  • "phoneNumber": "string",
  • "email": "string",
  • "passwordChangedAt": "string"
}

관리자 정보 수정 🚧

출시 예정입니다.

Authorizations:
HTTPBasic
header Parameters
authorization
required
string
Request Body schema: application/json
required
username
string

로그인 아이디

name
string

이름

phoneNumber
string

연락처

email
string

이메일

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "name": "string",
  • "phoneNumber": "string",
  • "email": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "username": "string",
  • "name": "string",
  • "phoneNumber": "string",
  • "email": "string",
  • "passwordChangedAt": "string"
}

비밀번호

관리자 비밀번호 변경

Authorizations:
HTTPBasic
header Parameters
authorization
required
string
Request Body schema: application/json
required
password
required
string

새 비밀번호

Responses

Request samples

Content type
application/json
{
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "username": "string",
  • "name": "string",
  • "phoneNumber": "string",
  • "email": "string",
  • "passwordChangedAt": "string"
}

쇼핑몰 정보

쇼핑몰 정보 조회

Authorizations:
HTTPBasic
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "uuid": "string",
  • "name": "string"
}

쇼핑몰 정보 수정

Authorizations:
HTTPBasic
header Parameters
authorization
required
string
Request Body schema: application/json
required
name
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "uuid": "string",
  • "name": "string"
}

쇼핑몰 설정

쇼핑몰 설정 조회

Authorizations:
HTTPBasic
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "isDeliveryAlimtalkEnabled": true,
  • "isThanksAlimtalkEnabled": true,
  • "isMonthlyAlimtalkEnabled": true,
  • "thanksAlimtalkDelayDays": 0,
  • "rewardName": "string",
  • "rewardUnit": "string",
  • "isAutomaticRewardEnabled": true,
  • "videoReviewRewardAmount": 0,
  • "imageReviewRewardAmount": 0,
  • "textReviewRewardAmount": 0,
  • "textReviewRewardCondition": 0,
  • "reviewAllowedDays": 0,
  • "languageFilterSubstitutions": [
    ],
  • "idleTimeoutMinutes": 0,
  • "twoFactorAuthPhoneNumber": "string"
}

쇼핑몰 설정 수정

Authorizations:
HTTPBasic
header Parameters
authorization
required
string
Request Body schema: application/json
required
isDeliveryAlimtalkEnabled
boolean

배송 완료 알림톡 활성화 여부

isThanksAlimtalkEnabled
boolean

감사톡 활성화 여부

isMonthlyAlimtalkEnabled
boolean

한달톡 활성화 여부

thanksAlimtalkDelayDays
integer

배송 완료일 기준 감사톡 발송 지연 일수

rewardName
string

리워드 이름

rewardUnit
string

리워드 단위

isAutomaticRewardEnabled
boolean

리워드 자동 지급 여부

videoReviewRewardAmount
integer

비디오 리뷰 리워드 수량

imageReviewRewardAmount
integer

이미지 리뷰 리워드 수량

textReviewRewardAmount
integer

텍스트 리뷰 리워드 수량

textReviewRewardCondition
integer

텍스트 리뷰 최소 글자수 조건

reviewAllowedDays
integer

리뷰 작성 기한 일수

reviewTextProhibitedWords
Array of strings

리뷰 금칙어 목록

idleTimeoutMinutes
integer

Idle timeout 시간 (분)

twoFactorAuthPhoneNumber
string

2FA 인증 코드를 수신할 연락처 (E164 포맷)

Responses

Request samples

Content type
application/json
{
  • "isDeliveryAlimtalkEnabled": true,
  • "isThanksAlimtalkEnabled": true,
  • "isMonthlyAlimtalkEnabled": true,
  • "thanksAlimtalkDelayDays": 0,
  • "rewardName": "string",
  • "rewardUnit": "string",
  • "isAutomaticRewardEnabled": true,
  • "videoReviewRewardAmount": 0,
  • "imageReviewRewardAmount": 0,
  • "textReviewRewardAmount": 0,
  • "textReviewRewardCondition": 0,
  • "reviewAllowedDays": 0,
  • "reviewTextProhibitedWords": [
    ],
  • "idleTimeoutMinutes": 0,
  • "twoFactorAuthPhoneNumber": "string"
}

Response samples

Content type
application/json
{
  • "isDeliveryAlimtalkEnabled": true,
  • "isThanksAlimtalkEnabled": true,
  • "isMonthlyAlimtalkEnabled": true,
  • "thanksAlimtalkDelayDays": 0,
  • "rewardName": "string",
  • "rewardUnit": "string",
  • "isAutomaticRewardEnabled": true,
  • "videoReviewRewardAmount": 0,
  • "imageReviewRewardAmount": 0,
  • "textReviewRewardAmount": 0,
  • "textReviewRewardCondition": 0,
  • "reviewAllowedDays": 0,
  • "languageFilterSubstitutions": [
    ],
  • "idleTimeoutMinutes": 0,
  • "twoFactorAuthPhoneNumber": "string"
}

상품

상품 목록 조회

Authorizations:
HTTPBasic
query Parameters
sort
string
Default: "ID"
Enum: "ID" "NAME" "REVIEW_COUNT"

정렬 필드 (ProductOrderField)

direction
string
Default: "DESC"
Enum: "ASC" "DESC"

정렬 방향 (OrderDirection)

first
integer

조회할 개수 (기본값: 30, 최대값: 100)

after
string

조회할 시작 커서 (응답의 pageInfo.endCursor)

productGroupIds
Array of strings

상품 그룹 ID 목록

isAlimtalkEnabled
boolean

알림톡 활성화 여부

header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "data": [
    ],
  • "pageInfo": {
    }
}

상품 생성

Authorizations:
HTTPBasic
header Parameters
authorization
required
string
Request Body schema: application/json
required
originId
required
string

고객사 상품 ID

name
required
string

상품 이름

imageUrl
string

상품 이미지 URL

Array of objects

카테고리 목록 (CreateProductBodyCategory)

groupId
string

상품 그룹 ID. 존재하지 않는 ID를 입력한 경우 경우 실패합니다.

groupName
string

상품 그룹 이름. 존재하지 않는 이름을 입력한 경우 자동으로 상품 그룹을 생성합니다.

isAlimtalkEnabled
boolean
Default: true

알림톡 활성화 여부

Responses

Request samples

Content type
application/json
{
  • "originId": "string",
  • "name": "string",
  • "imageUrl": "string",
  • "categories": [
    ],
  • "groupId": "string",
  • "groupName": "string",
  • "isAlimtalkEnabled": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "originId": "string",
  • "name": "string",
  • "image": {
    },
  • "url": "string",
  • "categories": [
    ],
  • "group": {
    },
  • "brand": {
    },
  • "isAlimtalkEnabled": "string",
  • "reviewCount": 0,
  • "reviewRatingAverage": 0
}

상품 조회

Authorizations:
HTTPBasic
path Parameters
productId
required
string
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "originId": "string",
  • "name": "string",
  • "image": {
    },
  • "url": "string",
  • "categories": [
    ],
  • "group": {
    },
  • "brand": {
    },
  • "isAlimtalkEnabled": "string",
  • "reviewCount": 0,
  • "reviewRatingAverage": 0
}

상품 수정

Authorizations:
HTTPBasic
path Parameters
productId
required
string
header Parameters
authorization
required
string
Request Body schema: application/json
required
name
string

상품 이름

imageUrl
string

상품 이미지 URL

Array of objects

카테고리 목록 (CreateProductBodyCategory)

groupId
string

상품 그룹 ID

isAlimtalkEnabled
boolean
Default: true

알림톡 활성화 여부

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "imageUrl": "string",
  • "categories": [
    ],
  • "groupId": "string",
  • "isAlimtalkEnabled": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "originId": "string",
  • "name": "string",
  • "image": {
    },
  • "url": "string",
  • "categories": [
    ],
  • "group": {
    },
  • "brand": {
    },
  • "isAlimtalkEnabled": "string",
  • "reviewCount": 0,
  • "reviewRatingAverage": 0
}

상품 일괄 생성

상품을 일괄 생성합니다. 한 번에 최대 100개까지 요청할 수 있습니다. 요청한 즉시 비동기 작업이 생성되며, 비동기 작업 상태를 조회할 수 있는 jobId가 요청한 데이터 순서대로 반환됩니다. 이 값을 일괄 생성 작업 조회 API에 사용해서 작업 상태를 조회할 수 있습니다.

Authorizations:
HTTPBasic
header Parameters
authorization
required
string
Request Body schema: application/json
required
Array
originId
required
string

고객사 상품 ID

name
required
string

상품 이름

imageUrl
string

상품 이미지 URL

Array of objects

카테고리 목록 (CreateProductBodyCategory)

groupId
string

상품 그룹 ID. 존재하지 않는 ID를 입력한 경우 경우 실패합니다.

groupName
string

상품 그룹 이름. 존재하지 않는 이름을 입력한 경우 자동으로 상품 그룹을 생성합니다.

isAlimtalkEnabled
boolean
Default: true

알림톡 활성화 여부

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

상품 그룹

상품 그룹 목록 조회

Authorizations:
HTTPBasic
query Parameters
ordering
string
Default: "-created_at"
Enum: "name" "review_count" "created_at" "-created_at"

정렬 방식 (ProductGroupOrdering)

first
integer

조회할 개수 (기본값: 30, 최대값: 100)

after
string

조회할 시작 커서 (응답의 pageInfo.endCursor)

name
string

상품 그룹 이름

header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "data": [
    ],
  • "pageInfo": {
    }
}

상품 그룹 조회

Authorizations:
HTTPBasic
path Parameters
productGroupId
required
string
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "image": {
    },
  • "productCount": 0,
  • "reviewCount": 0,
  • "reviewRatingAverage": 0,
  • "createdAt": "string",
  • "updatedAt": "string"
}

상품 그룹 삭제

Authorizations:
HTTPBasic
path Parameters
productGroupId
required
string
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

상품 그룹 수정

Authorizations:
HTTPBasic
path Parameters
productGroupId
required
string
header Parameters
authorization
required
string
Request Body schema: application/json
required
name
string

상품 그룹 이름

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "image": {
    },
  • "productCount": 0,
  • "reviewCount": 0,
  • "reviewRatingAverage": 0,
  • "createdAt": "string",
  • "updatedAt": "string"
}

상품 그룹 생성

Authorizations:
HTTPBasic
header Parameters
authorization
required
string
Request Body schema: application/json
required
name
required
string

상품 그룹 이름

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "image": {
    },
  • "productCount": 0,
  • "reviewCount": 0,
  • "reviewRatingAverage": 0,
  • "createdAt": "string",
  • "updatedAt": "string"
}

상품 그룹에 상품 추가

Authorizations:
HTTPBasic
path Parameters
productGroupId
required
string
productId
required
string
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "image": {
    },
  • "productCount": 0,
  • "reviewCount": 0,
  • "reviewRatingAverage": 0,
  • "createdAt": "string",
  • "updatedAt": "string"
}

상품 그룹에서 상품 제거

Authorizations:
HTTPBasic
path Parameters
productGroupId
required
string
productId
required
string
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

카테고리

카테고리 목록 조회

Authorizations:
HTTPBasic
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "data": [
    ],
  • "pageInfo": {
    }
}

카테고리 생성

Authorizations:
HTTPBasic
header Parameters
authorization
required
string
Request Body schema: application/json
required
originId
required
string

고객사 카테고리 ID

name
required
string

카테고리 이름

isVisible
boolean
Default: true

카테고리 노출 여부

position
integer
Default: 0

카테고리 노출 순서

parentOriginId
string

부모 카테고리 고유 ID

Responses

Request samples

Content type
application/json
{
  • "originId": "string",
  • "name": "string",
  • "isVisible": true,
  • "position": 0,
  • "parentOriginId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "originId": "string",
  • "name": "string",
  • "isVisible": true
}

카테고리 조회

Authorizations:
HTTPBasic
path Parameters
categoryId
required
string
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "originId": "string",
  • "name": "string",
  • "isVisible": true
}

카테고리 삭제

Authorizations:
HTTPBasic
path Parameters
categoryId
required
string
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
null

카테고리 수정

Authorizations:
HTTPBasic
path Parameters
categoryId
required
string
header Parameters
authorization
required
string
Request Body schema: application/json
required
name
string

카테고리 이름

isVisible
boolean
Default: true

카테고리 노출 여부

position
integer

카테고리 노출 순서

parentOriginId
string

부모 카테고리 고유 ID

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "isVisible": true,
  • "position": 0,
  • "parentOriginId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "originId": "string",
  • "name": "string",
  • "isVisible": true
}

카테고리 일괄 생성

Authorizations:
HTTPBasic
header Parameters
authorization
required
string
Request Body schema: application/json
required
Array
originId
required
string

고객사 카테고리 ID

name
required
string

카테고리 이름

isVisible
boolean
Default: true

카테고리 노출 여부

position
integer
Default: 0

카테고리 노출 순서

parentOriginId
string

부모 카테고리 고유 ID

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

주문

주문 생성

Authorizations:
HTTPBasic
header Parameters
authorization
required
string
Request Body schema: application/json
required
originId
required
string

고객사 주문 ID

memberOriginId
string

고객사 회원 ID

orderedAt
required
string <date-time>

주문 일시

object

주문 구매자 정보 (OrderBuyerInput)

object

주문 수령인 정보 (OrderRecipientInput)

alimtalkTemplateCode
string

챗봇 템플릿 코드 - 브이리뷰 팀에서 안내받은 템플릿이 없다면 null을 입력해주세요.

required
Array of objects

주문 아이템 목록 (CreateOrderBodyOrderItem)

Responses

Request samples

Content type
application/json
{
  • "originId": "string",
  • "memberOriginId": "string",
  • "orderedAt": "2019-08-24T14:15:22Z",
  • "buyer": {
    },
  • "recipient": {
    },
  • "alimtalkTemplateCode": "string",
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "originId": "string",
  • "orderedAt": "string",
  • "memberOriginId": "string",
  • "alimtalkTemplateCode": "string",
  • "buyer": {
    },
  • "recipient": {
    },
  • "items": [
    ]
}

주문 조회

Authorizations:
HTTPBasic
path Parameters
orderId
required
string
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "originId": "string",
  • "orderedAt": "string",
  • "memberOriginId": "string",
  • "alimtalkTemplateCode": "string",
  • "buyer": {
    },
  • "recipient": {
    },
  • "items": [
    ]
}

주문 수정

Authorizations:
HTTPBasic
path Parameters
orderId
required
string
header Parameters
authorization
required
string
Request Body schema: application/json
required
memberOriginId
string

고객사 회원 ID

orderedAt
string <date-time>

주문 일시

object

주문 구매자 정보 (OrderBuyerInput)

object

주문 수령인 정보 (OrderRecipientInput)

alimtalkTemplateCode
string

챗봇 템플릿 코드 - 브이리뷰 팀에서 안내받은 템플릿이 없다면 null을 입력해주세요.

Array of objects

주문 아이템 목록 (CreateOrderBodyOrderItem)

Responses

Request samples

Content type
application/json
{
  • "memberOriginId": "string",
  • "orderedAt": "2019-08-24T14:15:22Z",
  • "buyer": {
    },
  • "recipient": {
    },
  • "alimtalkTemplateCode": "string",
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "originId": "string",
  • "orderedAt": "string",
  • "memberOriginId": "string",
  • "alimtalkTemplateCode": "string",
  • "buyer": {
    },
  • "recipient": {
    },
  • "items": [
    ]
}

주문 일괄 생성

주문을 일괄 생성합니다. 한 번에 최대 100개까지 요청할 수 있습니다. 요청한 즉시 비동기 작업이 생성되며, 비동기 작업 상태를 조회할 수 있는 jobId가 요청한 데이터 순서대로 반환됩니다. 이 값을 일괄 생성 작업 조회 API에 사용해서 작업 상태를 조회할 수 있습니다.

Authorizations:
HTTPBasic
header Parameters
authorization
required
string
Request Body schema: application/json
required
Array
originId
required
string

고객사 주문 ID

memberOriginId
string

고객사 회원 ID

orderedAt
required
string <date-time>

주문 일시

object

주문 구매자 정보 (OrderBuyerInput)

object

주문 수령인 정보 (OrderRecipientInput)

alimtalkTemplateCode
string

챗봇 템플릿 코드 - 브이리뷰 팀에서 안내받은 템플릿이 없다면 null을 입력해주세요.

required
Array of objects

주문 아이템 목록 (CreateOrderBodyOrderItem)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

주문 아이템

주문 아이템 조회

Authorizations:
HTTPBasic
path Parameters
orderItemId
required
string
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "originId": "string",
  • "status": "DELIVERED",
  • "product": {
    },
  • "selectedOptions": [
    ],
  • "shipment": {
    }
}

주문 아이템 수정

Authorizations:
HTTPBasic
path Parameters
orderItemId
required
string
header Parameters
authorization
required
string
Request Body schema: application/json
required
productOriginId
required
string

고객사 상품 ID

status
string
Enum: "DELIVERED" "RETURN" "CANCEL" "FAIL" "EXCHANGE"

주문 아이템 상태 (OrderItemStatus)

Array of objects

주문한 옵션 목록 (SelectedOptionInput)

object

배송 정보 (CreateShipmentBody)

Responses

Request samples

Content type
application/json
{
  • "productOriginId": "string",
  • "status": "DELIVERED",
  • "selectedOptions": [
    ],
  • "shipment": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "originId": "string",
  • "status": "DELIVERED",
  • "product": {
    },
  • "selectedOptions": [
    ],
  • "shipment": {
    }
}

리뷰

리뷰 목록 조회

Authorizations:
HTTPBasic
query Parameters
sort
string
Default: "CREATED_AT"
Enum: "REVIEW_TYPE" "HELPFUL_COUNT" "CREATED_AT" "EDITED_AT" "UPDATED_AT"

정렬 필드 (ReviewOrderField)

direction
string
Default: "DESC"
Enum: "ASC" "DESC"

정렬 방향 (OrderDirection)

first
integer

조회할 개수 (기본값: 30, 최대값: 100)

after
string

조회할 시작 커서 (응답의 pageInfo.endCursor)

contentTypes
Array of strings
Items Enum: "VIDEO" "IMAGE" "TEXT"

콘텐츠 타입 (ReviewContentType)

ratings
Array of integers

평점

text
string

리뷰 내용

productOriginIds
Array of strings

상품 ID 목록

productName
string

상품 이름

orderOriginIds
Array of strings

주문 번호 목록

orderMemberOriginId
string

리뷰 작성자 ID

orderName
string

상품 구매자 또는 수령인 이름

orderPhone
string

상품 구매자 또는 수령인 연락처 (exact 검색)

isVisible
boolean

리뷰 노출 여부

isBlocked
boolean

리뷰 노출 제한 여부

isFixed
boolean

고정 리뷰 여부

isRewarded
boolean

적립금 지급 여부

isCommented
boolean

관리자 댓글 존재 여부

isReported
boolean

신고 여부

uploadFroms
Array of strings
Items Enum: "CHATBOT" "WEB" "INGEST" "SPRAY" "ADMIN" "DEMO"

리뷰 작성 경로 (ReviewUploadFrom)

createdAtStart
string

리뷰 작성일 시작 일시 (ISO-8601)

createdAtEnd
string

리뷰 작성일 종료 일시 (ISO-8601)

editedAtStart
string

리뷰 작성일 시작 일시 (ISO-8601)

editedAtEnd
string

리뷰 작성일 종료 일시 (ISO-8601)

updatedAtStart
string

리뷰 작성일 시작 일시 (ISO-8601)

updatedAtEnd
string

리뷰 작성일 종료 일시 (ISO-8601)

header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "data": [
    ],
  • "pageInfo": {
    }
}

리뷰 조회

Authorizations:
HTTPBasic
path Parameters
reviewId
required
string
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "originId": "string",
  • "userNickname": "string",
  • "title": "string",
  • "text": "string",
  • "rating": 0,
  • "uploadFrom": "CHATBOT",
  • "videos": [
    ],
  • "images": [
    ],
  • "product": {
    },
  • "order": {
    },
  • "orderItem": {
    },
  • "questionAnswers": [
    ],
  • "isVisible": true,
  • "isBlocked": true,
  • "blockReason": "DUPLICATE_VIDEO",
  • "helpfulCount": 0,
  • "reportStatus": "PENDING",
  • "createdAt": "string",
  • "updatedAt": "string"
}

리뷰 정보 수정

Authorizations:
HTTPBasic
path Parameters
reviewId
required
string
header Parameters
authorization
required
string
Request Body schema: application/json
required
isVisible
boolean

리뷰 노출 여부

Responses

Request samples

Content type
application/json
{
  • "isVisible": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "originId": "string",
  • "userNickname": "string",
  • "title": "string",
  • "text": "string",
  • "rating": 0,
  • "uploadFrom": "CHATBOT",
  • "videos": [
    ],
  • "images": [
    ],
  • "product": {
    },
  • "order": {
    },
  • "orderItem": {
    },
  • "questionAnswers": [
    ],
  • "isVisible": true,
  • "isBlocked": true,
  • "blockReason": "DUPLICATE_VIDEO",
  • "helpfulCount": 0,
  • "reportStatus": "PENDING",
  • "createdAt": "string",
  • "updatedAt": "string"
}

리뷰 일괄 생성

리뷰를 일괄 생성합니다. 한 번에 최대 100개까지 요청할 수 있습니다. 요청한 즉시 비동기 작업이 생성되며, 비동기 작업 상태를 조회할 수 있는 jobId가 요청한 데이터 순서대로 반환됩니다. 이 값을 일괄 생성 작업 조회 API에 사용해서 작업 상태를 조회할 수 있습니다.

Authorizations:
HTTPBasic
header Parameters
authorization
required
string
Request Body schema: application/json
required
Array
originId
required
string

고객사 리뷰 ID

productOriginId
required
string

고객사 상품 ID

authorName
string <= 255 characters

작성자 이름

title
string <= 255 characters

리뷰 제목

videoUrls
Array of strings

리뷰 비디오 URL 목록

imageUrls
Array of strings

리뷰 이미지 URL 목록

text
string

리뷰 본문

rating
integer

리뷰 평점 (1-5)

Array of objects

질문 답변 목록 (CreateReviewBodyQuestionAnswer)

orderItemOriginId
string

고객사 주문 아이템 ID

createdAt
string <date-time>

리뷰 생성 일시

isVisible
boolean
Default: true

리뷰 노출 여부

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

고정 리뷰

상품별 고정 리뷰 조회

Authorizations:
HTTPBasic
path Parameters
productId
required
string
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

상품별 고정 리뷰 설정

Authorizations:
HTTPBasic
path Parameters
productId
required
string
header Parameters
authorization
required
string
Request Body schema: application/json
required
ids
required
Array of strings

고정할 리뷰 ID 목록

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

상품 그룹별 고정 리뷰 설정

Authorizations:
HTTPBasic
path Parameters
productGroupId
required
string
header Parameters
authorization
required
string
Request Body schema: application/json
required
ids
required
Array of strings

고정할 리뷰 ID 목록

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

베스트 리뷰

베스트 리뷰 목록 조회

Authorizations:
HTTPBasic
query Parameters
sort
string
Default: "CREATED_AT"
Enum: "REVIEW_TYPE" "HELPFUL_COUNT" "CREATED_AT" "EDITED_AT" "UPDATED_AT"

정렬 필드 (ReviewOrderField)

direction
string
Default: "DESC"
Enum: "ASC" "DESC"

정렬 방향 (OrderDirection)

first
integer

조회할 개수 (기본값: 30, 최대값: 100)

after
string

조회할 시작 커서 (응답의 pageInfo.endCursor)

contentTypes
Array of strings
Items Enum: "VIDEO" "IMAGE" "TEXT"

콘텐츠 타입 (ReviewContentType)

ratings
Array of integers

평점

text
string

리뷰 내용

productOriginIds
Array of strings

상품 ID 목록

productName
string

상품 이름

orderOriginIds
Array of strings

주문 번호 목록

orderMemberOriginId
string

리뷰 작성자 ID

orderName
string

상품 구매자 또는 수령인 이름

orderPhone
string

상품 구매자 또는 수령인 연락처 (exact 검색)

isVisible
boolean

리뷰 노출 여부

isBlocked
boolean

리뷰 노출 제한 여부

isFixed
boolean

고정 리뷰 여부

isRewarded
boolean

적립금 지급 여부

isCommented
boolean

관리자 댓글 존재 여부

isReported
boolean

신고 여부

uploadFroms
Array of strings
Items Enum: "CHATBOT" "WEB" "INGEST" "SPRAY" "ADMIN" "DEMO"

리뷰 작성 경로 (ReviewUploadFrom)

createdAtStart
string

리뷰 작성일 시작 일시 (ISO-8601)

createdAtEnd
string

리뷰 작성일 종료 일시 (ISO-8601)

editedAtStart
string

리뷰 작성일 시작 일시 (ISO-8601)

editedAtEnd
string

리뷰 작성일 종료 일시 (ISO-8601)

updatedAtStart
string

리뷰 작성일 시작 일시 (ISO-8601)

updatedAtEnd
string

리뷰 작성일 종료 일시 (ISO-8601)

header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "data": [
    ],
  • "pageInfo": {
    }
}

베스트 리뷰 설정

Authorizations:
HTTPBasic
header Parameters
authorization
required
string
Request Body schema: application/json
required
ids
required
Array of strings

베스트 리뷰 ID 목록

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

리뷰 신고

전체 리뷰 신고 목록 조회

Authorizations:
HTTPBasic
query Parameters
first
integer

조회할 개수 (기본값: 30, 최대값: 100)

after
string

조회할 시작 커서 (응답의 pageInfo.endCursor)

reasons
Array of strings
Items Enum: "ILLEGAL" "PERSONAL_INFO" "SPAM" "IRRELEVANT" "MISLEADING" "INAPPROPRIATE" "DUPLICATED" "ETC"

신고 사유 (ReviewReportReason)

isChecked
boolean

신고 처리 여부

createdAtStart
string

리뷰 신고 생성일시 시작 (ISO-8601)

createdAtEnd
string

리뷰 신고 생성일시 종료 (ISO-8601)

updatedAtStart
string

리뷰 신고 수정일시 시작 (ISO-8601)

updatedAtEnd
string

리뷰 신고 수정일시 종료 (ISO-8601)

header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "data": [
    ],
  • "pageInfo": {
    }
}

리뷰 신고 수정

Authorizations:
HTTPBasic
path Parameters
reviewReportId
required
string
header Parameters
authorization
required
string
Request Body schema: application/json
required
isChecked
boolean

신고 처리 여부

Responses

Request samples

Content type
application/json
{
  • "isChecked": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "reason": "ILLEGAL",
  • "text": "string",
  • "isChecked": true,
  • "review": {
    },
  • "createdAt": "string",
  • "updatedAt": "string"
}

개별 리뷰 신고 목록 조회

Authorizations:
HTTPBasic
path Parameters
reviewId
required
string
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "data": [
    ],
  • "pageInfo": {
    }
}

관리자 댓글

관리자 댓글 목록 조회

Authorizations:
HTTPBasic
path Parameters
reviewId
required
string
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "data": [
    ],
  • "pageInfo": {
    }
}

관리자 댓글 생성

Authorizations:
HTTPBasic
path Parameters
reviewId
required
string
header Parameters
authorization
required
string
Request Body schema: application/json
required
text
required
string

댓글 내용

Responses

Request samples

Content type
application/json
{
  • "text": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "text": "string",
  • "createdAt": "string",
  • "updatedAt": "string"
}

관리자 댓글 삭제

Authorizations:
HTTPBasic
path Parameters
commentId
required
string
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

관리자 댓글 수정

Authorizations:
HTTPBasic
path Parameters
commentId
required
string
header Parameters
authorization
required
string
Request Body schema: application/json
required
text
string

댓글 내용

Responses

Request samples

Content type
application/json
{
  • "text": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "text": "string",
  • "createdAt": "string",
  • "updatedAt": "string"
}

관리자 댓글 일괄 생성 🚧

출시 예정입니다.

Authorizations:
HTTPBasic
path Parameters
reviewId
required
string
header Parameters
authorization
required
string
Request Body schema: application/json
required
Array
text
required
string

댓글 내용

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

질문

질문 목록 조회

Authorizations:
HTTPBasic
query Parameters
first
integer

조회할 개수 (기본값: 30, 최대값: 100)

after
string

조회할 시작 커서 (응답의 pageInfo.endCursor)

type
string
Enum: "statistical" "userinfo"
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "data": [
    ],
  • "pageInfo": {
    }
}

질문 조회

Authorizations:
HTTPBasic
path Parameters
questionId
required
string
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "questionType": "STATISTICAL",
  • "title": "string",
  • "text": "string",
  • "options": [
    ],
  • "createdAt": "string"
}

질문 삭제

Authorizations:
HTTPBasic
path Parameters
questionId
required
any
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

질문 수정

Authorizations:
HTTPBasic
path Parameters
questionId
required
string
header Parameters
authorization
required
string
Request Body schema: application/json
required
type
string
Enum: "statistical" "userinfo"
title
string

질문 제목 (위젯에서 노출)

text
string

질문 내용 (챗봇에서 노출)

options
Array of strings

질문 옵션

Responses

Request samples

Content type
application/json
{
  • "type": "statistical",
  • "title": "string",
  • "text": "string",
  • "options": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "questionType": "STATISTICAL",
  • "title": "string",
  • "text": "string",
  • "options": [
    ],
  • "createdAt": "string"
}

질문 생성

Authorizations:
HTTPBasic
header Parameters
authorization
required
string
Request Body schema: application/json
required
type
required
string
Enum: "statistical" "userinfo"
title
required
string

질문 제목 (위젯에서 노출)

text
required
string

질문 내용 (챗봇에서 노출)

options
required
Array of strings

질문 옵션

Responses

Request samples

Content type
application/json
{
  • "type": "statistical",
  • "title": "string",
  • "text": "string",
  • "options": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "questionType": "STATISTICAL",
  • "title": "string",
  • "text": "string",
  • "options": [
    ],
  • "createdAt": "string"
}

상품 연결

연결된 상품 목록 조회

Authorizations:
HTTPBasic
path Parameters
questionId
required
string
query Parameters
first
integer

조회할 개수 (기본값: 30, 최대값: 100)

after
string

조회할 시작 커서 (응답의 pageInfo.endCursor)

header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "data": [
    ],
  • "pageInfo": {
    }
}

연결 가능 상품 목록 조회

Authorizations:
HTTPBasic
path Parameters
questionId
required
string
query Parameters
first
integer

조회할 개수 (기본값: 30, 최대값: 100)

after
string

조회할 시작 커서 (응답의 pageInfo.endCursor)

header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "data": [
    ],
  • "pageInfo": {
    }
}

상품 연결

Authorizations:
HTTPBasic
path Parameters
questionId
required
string
productId
required
string
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

상품 연결 해제

Authorizations:
HTTPBasic
path Parameters
questionId
required
string
productId
required
string
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

카테고리 연결

연결된 카테고리 목록 조회

Authorizations:
HTTPBasic
path Parameters
questionId
required
string
query Parameters
first
integer

조회할 개수 (기본값: 30, 최대값: 100)

after
string

조회할 시작 커서 (응답의 pageInfo.endCursor)

header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "data": [
    ],
  • "pageInfo": {
    }
}

카테고리 연결

Authorizations:
HTTPBasic
path Parameters
questionId
required
string
categoryId
required
string
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

카테고리 연결 해제

Authorizations:
HTTPBasic
path Parameters
questionId
required
string
categoryId
required
string
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

리워드

리워드 목록 조회

Authorizations:
HTTPBasic
query Parameters
first
integer

조회할 개수 (기본값: 30, 최대값: 100)

after
string

조회할 시작 커서 (응답의 pageInfo.endCursor)

status
string
Enum: "QUEUED" "SENDING" "SUCCESS" "FAILURE" "CANCELLED" "INVALID" "UNAPPROVED"
reviewCategories
Array of strings
Items Enum: "video" "image" "text"

리뷰 종류

createdAtStart
string

리뷰 작성일 시작 일시 (ISO-8601)

createdAtEnd
string

리뷰 작성일 종료 일시 (ISO-8601)

updatedAtStart
string

리뷰 작성일 시작 일시 (ISO-8601)

updatedAtEnd
string

리뷰 작성일 종료 일시 (ISO-8601)

header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "data": [
    ],
  • "pageInfo": {
    }
}

리워드 조회

Authorizations:
HTTPBasic
path Parameters
rewardId
required
string
header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "amount": 0,
  • "reviewCategory": "string",
  • "status": "QUEUED",
  • "review": {
    },
  • "order": {
    },
  • "orderItem": {
    },
  • "createdAt": "string"
}

리워드 정보 수정

Authorizations:
HTTPBasic
path Parameters
rewardId
required
string
header Parameters
authorization
required
string
Request Body schema: application/json
required
status
string
Enum: "QUEUED" "SENDING" "SUCCESS" "FAILURE" "CANCELLED" "INVALID" "UNAPPROVED"

리워드 지급 상태 (RewardRequestStatus)

Responses

Request samples

Content type
application/json
{
  • "status": "QUEUED"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "amount": 0,
  • "reviewCategory": "string",
  • "status": "QUEUED",
  • "review": {
    },
  • "order": {
    },
  • "orderItem": {
    },
  • "createdAt": "string"
}

작업

일괄 생성 작업 조회

일괄 생성 API로 요청 응답으로 받은 jobId 목록을 가지고 작업 상태를 조회합니다. 생성에 성공한 경우 successObjectId 필드에 생성된 오브젝트의 ID가 반환됩니다. 이 값을 사용해서 오브젝트를 조회할 수 있습니다.

Authorizations:
HTTPBasic
query Parameters
ids
required
Array of strings

작업 ID 목록 (콤마 구분)

header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

개인정보

탈퇴한 사용자 개인정보 삭제

Authorizations:
HTTPBasic
path Parameters
memberOriginId
required
string
query Parameters
keepReviews
string
Default: "true"

리뷰를 삭제하지 않고 남겨둘지 여부

authorNamePlaceholder
string
Default: "탈퇴한 회원"

리뷰를 남길 경우 대체할 작성자 이름

header Parameters
authorization
required
string

Responses

Response samples

Content type
application/json
null

BlockReason

string
Enum: "DUPLICATE_VIDEO" "DUPLICATE_IMAGE" "POTENTIAL_ADULT" "POTENTIAL_VIOLENCE" "ADULT" "VIOLENCE"

An enumeration.

"DUPLICATE_VIDEO"

Brand

id
required
string

고유 식별자

originId
required
string
name
required
string
{
  • "id": "string",
  • "originId": "string",
  • "name": "string"
}

BulkJob

jobId
required
string
status
required
string
Enum: "PENDING" "SUCCESS" "FAILURE"

An enumeration.

entryOriginId
string
successObjectId
string
failureReason
string
createdAt
required
string <date-time>
startedAt
string <date-time>
endedAt
string <date-time>
{
  • "jobId": "string",
  • "status": "PENDING",
  • "entryOriginId": "string",
  • "successObjectId": "string",
  • "failureReason": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "startedAt": "2019-08-24T14:15:22Z",
  • "endedAt": "2019-08-24T14:15:22Z"
}

Category

id
required
string

고유 식별자

originId
required
string
name
required
string
isVisible
required
boolean
{
  • "id": "string",
  • "originId": "string",
  • "name": "string",
  • "isVisible": true
}

ChangePasswordBody

password
required
string

새 비밀번호

{
  • "password": "string"
}

CreateCategoryBody

originId
required
string

고객사 카테고리 ID

name
required
string

카테고리 이름

isVisible
boolean
Default: true

카테고리 노출 여부

position
integer
Default: 0

카테고리 노출 순서

parentOriginId
string

부모 카테고리 고유 ID

{
  • "originId": "string",
  • "name": "string",
  • "isVisible": true,
  • "position": 0,
  • "parentOriginId": "string"
}

CreateCommentBody

text
required
string

댓글 내용

{
  • "text": "string"
}

CreateOrderBody

originId
required
string

고객사 주문 ID

memberOriginId
string

고객사 회원 ID

orderedAt
required
string <date-time>

주문 일시

object

주문 구매자 정보 (OrderBuyerInput)

object

주문 수령인 정보 (OrderRecipientInput)

alimtalkTemplateCode
string

챗봇 템플릿 코드 - 브이리뷰 팀에서 안내받은 템플릿이 없다면 null을 입력해주세요.

required
Array of objects

주문 아이템 목록 (CreateOrderBodyOrderItem)

{
  • "originId": "string",
  • "memberOriginId": "string",
  • "orderedAt": "2019-08-24T14:15:22Z",
  • "buyer": {
    },
  • "recipient": {
    },
  • "alimtalkTemplateCode": "string",
  • "items": [
    ]
}

CreateOrderBodyOrderItem

originId
required
string

고객사 주문 아이템 ID

productOriginId
required
string

고객사 상품 ID

status
string
Enum: "DELIVERED" "RETURN" "CANCEL" "FAIL" "EXCHANGE"

주문 아이템 상태 (OrderItemStatus)

Array of objects

주문한 옵션 목록 (SelectedOptionInput)

object
{
  • "originId": "string",
  • "productOriginId": "string",
  • "status": "DELIVERED",
  • "selectedOptions": [
    ],
  • "shipment": {
    }
}

CreateOrderBodyOrderItemShipment

companyCode
required
string
Enum: "self" "kr.chunilps" "kr.cjlogistics" "kr.cupost" "kr.cvsnet" "kr.cway" "kr.daesin" "kr.epost" "kr.hanips" "kr.hanjin" "kr.hdexp" "kr.homepick" "kr.honamlogis" "kr.ilyanglogis" "kr.kdexp" "kr.kunyoung" "kr.logen" "kr.lotte" "kr.pingpong" "kr.slx" "kr.swgexp" "kr.todaypickup" "us.fedex" "us.ups" "us.usps" "jp.sagawa" "jp.yamato" "jp.yuubin" "de.dhl" "nl.tnt" "un.upu.ems"

택배사 코드 (ShipmentCompanyCode)

trackingNumber
required
string

송장번호

deliveredAt
string <date-time>

배송 완료 일시

{
  • "companyCode": "self",
  • "trackingNumber": "string",
  • "deliveredAt": "2019-08-24T14:15:22Z"
}

CreateProductBody

originId
required
string

고객사 상품 ID

name
required
string

상품 이름

imageUrl
string

상품 이미지 URL

Array of objects

카테고리 목록 (CreateProductBodyCategory)

groupId
string

상품 그룹 ID. 존재하지 않는 ID를 입력한 경우 경우 실패합니다.

groupName
string

상품 그룹 이름. 존재하지 않는 이름을 입력한 경우 자동으로 상품 그룹을 생성합니다.

isAlimtalkEnabled
boolean
Default: true

알림톡 활성화 여부

{
  • "originId": "string",
  • "name": "string",
  • "imageUrl": "string",
  • "categories": [
    ],
  • "groupId": "string",
  • "groupName": "string",
  • "isAlimtalkEnabled": true
}

CreateProductBodyCategory

originId
required
string

고객사 카테고리 ID

isPrimary
boolean
Default: false

주요 카테고리 여부. 여러 카테고리가 설정된 상품의 경우, 사용자에게 여러 개의 질문이 출력될 수 있으므로 주요 카테고리를 등록해 주세요.

{
  • "originId": "string",
  • "isPrimary": false
}

CreateProductGroupBody

name
required
string

상품 그룹 이름

{
  • "name": "string"
}

CreateQuestionBody

type
required
string
Enum: "statistical" "userinfo"
title
required
string

질문 제목 (위젯에서 노출)

text
required
string

질문 내용 (챗봇에서 노출)

options
required
Array of strings

질문 옵션

{
  • "type": "statistical",
  • "title": "string",
  • "text": "string",
  • "options": [
    ]
}

CreateReviewBody

originId
required
string

고객사 리뷰 ID

productOriginId
required
string

고객사 상품 ID

authorName
string <= 255 characters

작성자 이름

title
string <= 255 characters

리뷰 제목

videoUrls
Array of strings

리뷰 비디오 URL 목록

imageUrls
Array of strings

리뷰 이미지 URL 목록

text
string

리뷰 본문

rating
integer

리뷰 평점 (1-5)

Array of objects

질문 답변 목록 (CreateReviewBodyQuestionAnswer)

orderItemOriginId
string

고객사 주문 아이템 ID

createdAt
string <date-time>

리뷰 생성 일시

isVisible
boolean
Default: true

리뷰 노출 여부

{
  • "originId": "string",
  • "productOriginId": "string",
  • "authorName": "string",
  • "title": "string",
  • "videoUrls": [
    ],
  • "imageUrls": [
    ],
  • "text": "string",
  • "rating": 0,
  • "questionAnswers": [
    ],
  • "orderItemOriginId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "isVisible": true
}

CreateReviewBodyQuestionAnswer

question
required
string

질문 내용

answer
required
string

질문 답변

{
  • "question": "string",
  • "answer": "string"
}

CreateShipmentBody

companyCode
required
string
Enum: "self" "kr.chunilps" "kr.cjlogistics" "kr.cupost" "kr.cvsnet" "kr.cway" "kr.daesin" "kr.epost" "kr.hanips" "kr.hanjin" "kr.hdexp" "kr.homepick" "kr.honamlogis" "kr.ilyanglogis" "kr.kdexp" "kr.kunyoung" "kr.logen" "kr.lotte" "kr.pingpong" "kr.slx" "kr.swgexp" "kr.todaypickup" "us.fedex" "us.ups" "us.usps" "jp.sagawa" "jp.yamato" "jp.yuubin" "de.dhl" "nl.tnt" "un.upu.ems"

택배사 코드 (ShipmentCompanyCode)

trackingNumber
required
string

송장번호

deliveredAt
string <date-time>

배송 완료 일시

{
  • "companyCode": "self",
  • "trackingNumber": "string",
  • "deliveredAt": "2019-08-24T14:15:22Z"
}

HTTPValidationError

Array of objects
Array
required
Array of strings or integers
msg
required
string
type
required
string
{
  • "detail": [
    ]
}

IngestJobStatus

string
Enum: "PENDING" "SUCCESS" "FAILURE"

An enumeration.

"PENDING"

Mall

id
required
string

고유 식별자

uuid
required
string
name
required
string
{
  • "id": "string",
  • "uuid": "string",
  • "name": "string"
}

MallSettings

isDeliveryAlimtalkEnabled
required
boolean

배송 완료 알림톡 활성화 여부

isThanksAlimtalkEnabled
required
boolean

감사톡 활성화 여부

isMonthlyAlimtalkEnabled
required
boolean

한달톡 활성화 여부

thanksAlimtalkDelayDays
required
integer

배송 완료일 기준 감사톡 발송 지연 일수

rewardName
required
string

리워드 이름

rewardUnit
required
string

리워드 단위

isAutomaticRewardEnabled
required
boolean

리워드 자동 지급 여부

videoReviewRewardAmount
required
integer

비디오 리뷰 리워드 수량

imageReviewRewardAmount
required
integer

이미지 리뷰 리워드 수량

textReviewRewardAmount
required
integer

텍스트 리뷰 리워드 수량

textReviewRewardCondition
required
integer

텍스트 리뷰 최소 글자수 조건

reviewAllowedDays
integer

리뷰 작성 기한 일수

languageFilterSubstitutions
required
Array of strings

리뷰 텍스트에 포함된 특정 단어를 다른 단어로 치환합니다. 필터링 단어와 대체어는 '/' 로 구분됩니다. 만약 '/'가 없다면 대체어는 사용되지 않습니다. 예) '금지어/대체어', '금지어'

idleTimeoutMinutes
required
integer

Idle timeout 시간 (분)

twoFactorAuthPhoneNumber
string

2FA 인증 코드를 수신할 연락처 (E164 포맷)

{
  • "isDeliveryAlimtalkEnabled": true,
  • "isThanksAlimtalkEnabled": true,
  • "isMonthlyAlimtalkEnabled": true,
  • "thanksAlimtalkDelayDays": 0,
  • "rewardName": "string",
  • "rewardUnit": "string",
  • "isAutomaticRewardEnabled": true,
  • "videoReviewRewardAmount": 0,
  • "imageReviewRewardAmount": 0,
  • "textReviewRewardAmount": 0,
  • "textReviewRewardCondition": 0,
  • "reviewAllowedDays": 0,
  • "languageFilterSubstitutions": [
    ],
  • "idleTimeoutMinutes": 0,
  • "twoFactorAuthPhoneNumber": "string"
}

Order

id
required
string

고유 식별자

originId
required
string

주문 번호

orderedAt
required
string

주문 일시

memberOriginId
string

고객사 회원 ID

alimtalkTemplateCode
string

알림톡 템플릿 코드

required
object

주문 구매자 정보 (OrderBuyer)

required
object

주문 수령인 정보 (OrderRecipient)

required
Array of objects
{
  • "id": "string",
  • "originId": "string",
  • "orderedAt": "string",
  • "memberOriginId": "string",
  • "alimtalkTemplateCode": "string",
  • "buyer": {
    },
  • "recipient": {
    },
  • "items": [
    ]
}

OrderBuyer

name
required
string

이름

phone
string

연락처

email
string

이메일

{
  • "name": "string",
  • "phone": "string",
  • "email": "string"
}

OrderBuyerInput

name
required
string
phone
string
email
string
{
  • "name": "string",
  • "phone": "string",
  • "email": "string"
}

OrderDirection

string
Enum: "ASC" "DESC"

An enumeration.

"ASC"

OrderItem

id
required
string

고유 식별자

originId
required
string

주문 아이템 번호

status
string
Enum: "DELIVERED" "RETURN" "CANCEL" "FAIL" "EXCHANGE"

주문 아이템 상태 (OrderItemStatus)

object

주문 상품 정보 (Product)

required
Array of objects

주문한 옵션 목록 (OrderItemSelectedoptions)

object

주문 상품 정보 (Shipment)

{
  • "id": "string",
  • "originId": "string",
  • "status": "DELIVERED",
  • "product": {
    },
  • "selectedOptions": [
    ],
  • "shipment": {
    }
}

OrderItemSelectedoptions

name
required
string

옵션 이름

value
required
string

옵션 값

{
  • "name": "string",
  • "value": "string"
}

OrderItemStatus

string
Enum: "DELIVERED" "RETURN" "CANCEL" "FAIL" "EXCHANGE"

An enumeration.

"DELIVERED"

OrderRecipient

name
required
string

이름

phone
string

연락처

{
  • "name": "string",
  • "phone": "string"
}

OrderRecipientInput

name
required
string
phone
string
{
  • "name": "string",
  • "phone": "string"
}

PageInfo

hasNextPage
required
boolean

When paginating forwards, are there more items?

endCursor
string

When paginating forwards, the cursor to continue.

{
  • "hasNextPage": true,
  • "endCursor": "string"
}

Product

id
required
string

고유 식별자

originId
required
string

고객사 상품 ID

name
required
string

상품 이름

object

상품 이미지 (ProductImage)

url
string

상품 URL

required
Array of objects

카테고리 목록 (ProductCategory)

object

상품 그룹 (ProductGroupIdOnly)

object

브랜드 (Brand)

isAlimtalkEnabled
required
string

알림톡 활성화 여부

reviewCount
required
integer

리뷰 개수

reviewRatingAverage
required
number

리뷰 평점

{
  • "id": "string",
  • "originId": "string",
  • "name": "string",
  • "image": {
    },
  • "url": "string",
  • "categories": [
    ],
  • "group": {
    },
  • "brand": {
    },
  • "isAlimtalkEnabled": "string",
  • "reviewCount": 0,
  • "reviewRatingAverage": 0
}

ProductCategory

isPrimary
required
boolean
required
object
{
  • "isPrimary": true,
  • "category": {
    }
}

ProductGroup

id
required
string

고유 식별자

name
required
string

상품 그룹 이름

object

상품 그룹 썸네일 (Not Implemented) (ProductGroupImage)

productCount
required
integer

상품 개수 (Not Implemented)

reviewCount
required
integer

리뷰 개수 (Not Implemented)

reviewRatingAverage
required
number

리뷰 평점 (Not Implemented)

createdAt
required
string

생성 일시

updatedAt
required
string

수정 일시

{
  • "id": "string",
  • "name": "string",
  • "image": {
    },
  • "productCount": 0,
  • "reviewCount": 0,
  • "reviewRatingAverage": 0,
  • "createdAt": "string",
  • "updatedAt": "string"
}

ProductGroupIdOnly

id
required
string

고유 식별자

{
  • "id": "string"
}

ProductGroupImage

url
required
string

이미지 URL

{
  • "url": "string"
}

ProductGroupOrdering

string
Enum: "name" "review_count" "created_at" "-created_at"

An enumeration.

"name"

ProductImage

url
required
string

이미지 URL

{
  • "url": "string"
}

ProductOrderField

string
Enum: "ID" "NAME" "REVIEW_COUNT"

An enumeration.

"ID"

Question

id
required
string

고유 식별자

questionType
required
string
Enum: "STATISTICAL" "USERINFO"
title
required
string

질문 제목

text
required
string

질문 내용

required
Array of objects
createdAt
required
string

생성 일시

{
  • "id": "string",
  • "questionType": "STATISTICAL",
  • "title": "string",
  • "text": "string",
  • "options": [
    ],
  • "createdAt": "string"
}

QuestionOptions

id
required
string

고유 식별자

text
required
string
{
  • "id": "string",
  • "text": "string"
}

Review

id
required
string

고유 식별자

originId
string

이관된 리뷰의 경우 고객사 리뷰 ID

userNickname
string

리뷰 작성자 이름

title
string

리뷰 제목

text
string

리뷰 본문

rating
integer

리뷰 평점 (1-5)

uploadFrom
string
Enum: "CHATBOT" "WEB" "INGEST" "SPRAY" "ADMIN" "DEMO"

리뷰 생성 경로 (ReviewUploadFrom)

required
Array of objects

리뷰 비디오 목록 (ReviewVideos)

required
Array of objects

리뷰 이미지 목록 (ReviewImages)

object

리뷰 상품 정보 (Product)

object

리뷰 주문 정보 (Order)

object

리뷰 주문 아이템 정보 (OrderItem)

required
Array of objects

질문 답변 목록 (ReviewQuestionanswers)

isVisible
boolean

리뷰 노출 여부

isBlocked
boolean

리뷰 노출 제한 여부

blockReason
string
Enum: "DUPLICATE_VIDEO" "DUPLICATE_IMAGE" "POTENTIAL_ADULT" "POTENTIAL_VIOLENCE" "ADULT" "VIOLENCE"

리뷰 노출 제한 사유 (BlockReason)

helpfulCount
required
integer

유용해요 개수

reportStatus
string
Enum: "PENDING" "CHECKED"

리뷰 신고 처리 상태 (ReviewReportStatus)

createdAt
required
string

작성 일시

updatedAt
required
string

수정 일시

{
  • "id": "string",
  • "originId": "string",
  • "userNickname": "string",
  • "title": "string",
  • "text": "string",
  • "rating": 0,
  • "uploadFrom": "CHATBOT",
  • "videos": [
    ],
  • "images": [
    ],
  • "product": {
    },
  • "order": {
    },
  • "orderItem": {
    },
  • "questionAnswers": [
    ],
  • "isVisible": true,
  • "isBlocked": true,
  • "blockReason": "DUPLICATE_VIDEO",
  • "helpfulCount": 0,
  • "reportStatus": "PENDING",
  • "createdAt": "string",
  • "updatedAt": "string"
}

ReviewComment

id
required
string

고유 식별자

text
required
string

댓글 본문

createdAt
required
string

작성 일시

updatedAt
required
string

수정 일시

{
  • "id": "string",
  • "text": "string",
  • "createdAt": "string",
  • "updatedAt": "string"
}

ReviewContentType

string
Enum: "VIDEO" "IMAGE" "TEXT"

An enumeration.

"VIDEO"

ReviewIdOnly

id
required
string

고유 식별자

{
  • "id": "string"
}

ReviewImages

required
object
thumbnail
required
string
large
required
string
{
  • "urls": {
    }
}

ReviewImagesUrls

thumbnail
required
string
large
required
string
{
  • "thumbnail": "string",
  • "large": "string"
}

ReviewOrderField

string
Enum: "REVIEW_TYPE" "HELPFUL_COUNT" "CREATED_AT" "EDITED_AT" "UPDATED_AT"

An enumeration.

"REVIEW_TYPE"

ReviewQuestionanswers

required
object
required
object
{
  • "question": {
    },
  • "answer": {
    }
}

ReviewQuestionanswersAnswer

text
required
string
{
  • "text": "string"
}

ReviewQuestionanswersQuestion

text
required
string

질문 내용

{
  • "text": "string"
}

ReviewReport

id
required
string

고유 식별자

reason
required
string
Enum: "ILLEGAL" "PERSONAL_INFO" "SPAM" "IRRELEVANT" "MISLEADING" "INAPPROPRIATE" "DUPLICATED" "ETC"

신고 사유 (ReviewReportReason)

text
required
string

신고 내용

isChecked
required
boolean

신고 처리 여부

required
object

리뷰 (ReviewIdOnly)

createdAt
required
string

작성 일시

updatedAt
required
string

수정 일시

{
  • "id": "string",
  • "reason": "ILLEGAL",
  • "text": "string",
  • "isChecked": true,
  • "review": {
    },
  • "createdAt": "string",
  • "updatedAt": "string"
}

ReviewReportReason

string
Enum: "ILLEGAL" "PERSONAL_INFO" "SPAM" "IRRELEVANT" "MISLEADING" "INAPPROPRIATE" "DUPLICATED" "ETC"

An enumeration.

"ILLEGAL"

ReviewReportStatus

string
Enum: "PENDING" "CHECKED"

An enumeration.

"PENDING"

ReviewUploadFrom

string
Enum: "CHATBOT" "WEB" "INGEST" "SPRAY" "ADMIN" "DEMO"

An enumeration.

"CHATBOT"

ReviewVideos

required
object
thumbnail
required
string
large
required
string
{
  • "urls": {
    }
}

ReviewVideosUrls

thumbnail
required
string
large
required
string
{
  • "thumbnail": "string",
  • "large": "string"
}

RewardOrder

id
required
string

고유 식별자

originId
required
string

주문 번호

memberOriginId
string

고객사 회원 ID

{
  • "id": "string",
  • "originId": "string",
  • "memberOriginId": "string"
}

RewardOrderItem

id
required
string

고유 식별자

originId
required
string

주문 아이템 번호

{
  • "id": "string",
  • "originId": "string"
}

RewardRequest

id
required
string

고유 식별자

amount
required
integer

적립금 지급액

reviewCategory
required
string

리뷰 카테고리

status
required
string
Enum: "QUEUED" "SENDING" "SUCCESS" "FAILURE" "CANCELLED" "INVALID" "UNAPPROVED"

적립금 요청 상태 (RewardRequestStatus)

required
object

리뷰 (RewardReview)

object

주문 (RewardOrder)

object

주문 아이템 (RewardOrderItem)

createdAt
required
string

작성 일시

{
  • "id": "string",
  • "amount": 0,
  • "reviewCategory": "string",
  • "status": "QUEUED",
  • "review": {
    },
  • "order": {
    },
  • "orderItem": {
    },
  • "createdAt": "string"
}

RewardRequestStatus

string
Enum: "QUEUED" "SENDING" "SUCCESS" "FAILURE" "CANCELLED" "INVALID" "UNAPPROVED"

An enumeration.

"QUEUED"

RewardReview

id
required
string

고유 식별자

createdAt
required
string

작성 일시

updatedAt
required
string

수정 일시

{
  • "id": "string",
  • "createdAt": "string",
  • "updatedAt": "string"
}

SelectedOptionInput

name
required
string
value
required
string
{
  • "name": "string",
  • "value": "string"
}

Shipment

companyCode
required
string

택배사 코드

trackingNumber
required
string

송장번호

deliveredAt
string

배송 완료 일시

{
  • "companyCode": "string",
  • "trackingNumber": "string",
  • "deliveredAt": "string"
}

ShipmentCompanyCode

string
Enum: "self" "kr.chunilps" "kr.cjlogistics" "kr.cupost" "kr.cvsnet" "kr.cway" "kr.daesin" "kr.epost" "kr.hanips" "kr.hanjin" "kr.hdexp" "kr.homepick" "kr.honamlogis" "kr.ilyanglogis" "kr.kdexp" "kr.kunyoung" "kr.logen" "kr.lotte" "kr.pingpong" "kr.slx" "kr.swgexp" "kr.todaypickup" "us.fedex" "us.ups" "us.usps" "jp.sagawa" "jp.yamato" "jp.yuubin" "de.dhl" "nl.tnt" "un.upu.ems"
코드 택배사
self 자체배송
kr.chunilps 천일택배
kr.cjlogistics CJ대한통운
kr.cupost CU 편의점택배
kr.cvsnet GS Postbox 택배
kr.cway CWAY (Woori Express)
kr.daesin 대신택배
kr.epost 우체국 택배
kr.hanips 한의사랑택배
kr.hanjin 한진택배
kr.hdexp 합동택배
kr.homepick 홈픽
kr.honamlogis 한서호남택배
kr.ilyanglogis 일양로지스
kr.kdexp 경동택배
kr.kunyoung 건영택배
kr.logen 로젠택배
kr.lotte 롯데택배
kr.pingpong 핑퐁
kr.slx SLX
kr.swgexp 성원글로벌카고
kr.todaypickup 오늘의픽업
us.fedex Fedex
us.ups UPS
us.usps USPS
jp.sagawa Sagawa
jp.yamato Kuroneko Yamato
jp.yuubin Japan Post
de.dhl DHL
nl.tnt TNT
un.upu.ems EMS
"self"

UpdateBestReviewsBody

ids
required
Array of strings

베스트 리뷰 ID 목록

{
  • "ids": [
    ]
}

UpdateCategoryBody

name
string

카테고리 이름

isVisible
boolean
Default: true

카테고리 노출 여부

position
integer

카테고리 노출 순서

parentOriginId
string

부모 카테고리 고유 ID

{
  • "name": "string",
  • "isVisible": true,
  • "position": 0,
  • "parentOriginId": "string"
}

UpdateFixedReviewsBody

ids
required
Array of strings

고정할 리뷰 ID 목록

{
  • "ids": [
    ]
}

UpdateMallBody

name
string
{
  • "name": "string"
}

UpdateMallSettingsBody

isDeliveryAlimtalkEnabled
boolean

배송 완료 알림톡 활성화 여부

isThanksAlimtalkEnabled
boolean

감사톡 활성화 여부

isMonthlyAlimtalkEnabled
boolean

한달톡 활성화 여부

thanksAlimtalkDelayDays
integer

배송 완료일 기준 감사톡 발송 지연 일수

rewardName
string

리워드 이름

rewardUnit
string

리워드 단위

isAutomaticRewardEnabled
boolean

리워드 자동 지급 여부

videoReviewRewardAmount
integer

비디오 리뷰 리워드 수량

imageReviewRewardAmount
integer

이미지 리뷰 리워드 수량

textReviewRewardAmount
integer

텍스트 리뷰 리워드 수량

textReviewRewardCondition
integer

텍스트 리뷰 최소 글자수 조건

reviewAllowedDays
integer

리뷰 작성 기한 일수

reviewTextProhibitedWords
Array of strings

리뷰 금칙어 목록

idleTimeoutMinutes
integer

Idle timeout 시간 (분)

twoFactorAuthPhoneNumber
string

2FA 인증 코드를 수신할 연락처 (E164 포맷)

{
  • "isDeliveryAlimtalkEnabled": true,
  • "isThanksAlimtalkEnabled": true,
  • "isMonthlyAlimtalkEnabled": true,
  • "thanksAlimtalkDelayDays": 0,
  • "rewardName": "string",
  • "rewardUnit": "string",
  • "isAutomaticRewardEnabled": true,
  • "videoReviewRewardAmount": 0,
  • "imageReviewRewardAmount": 0,
  • "textReviewRewardAmount": 0,
  • "textReviewRewardCondition": 0,
  • "reviewAllowedDays": 0,
  • "reviewTextProhibitedWords": [
    ],
  • "idleTimeoutMinutes": 0,
  • "twoFactorAuthPhoneNumber": "string"
}

UpdateOrderBody

memberOriginId
string

고객사 회원 ID

orderedAt
string <date-time>

주문 일시

object

주문 구매자 정보 (OrderBuyerInput)

object

주문 수령인 정보 (OrderRecipientInput)

alimtalkTemplateCode
string

챗봇 템플릿 코드 - 브이리뷰 팀에서 안내받은 템플릿이 없다면 null을 입력해주세요.

Array of objects

주문 아이템 목록 (CreateOrderBodyOrderItem)

{
  • "memberOriginId": "string",
  • "orderedAt": "2019-08-24T14:15:22Z",
  • "buyer": {
    },
  • "recipient": {
    },
  • "alimtalkTemplateCode": "string",
  • "items": [
    ]
}

UpdateOrderItemBody

productOriginId
required
string

고객사 상품 ID

status
string
Enum: "DELIVERED" "RETURN" "CANCEL" "FAIL" "EXCHANGE"

주문 아이템 상태 (OrderItemStatus)

Array of objects

주문한 옵션 목록 (SelectedOptionInput)

object

배송 정보 (CreateShipmentBody)

{
  • "productOriginId": "string",
  • "status": "DELIVERED",
  • "selectedOptions": [
    ],
  • "shipment": {
    }
}

UpdateProductBody

name
string

상품 이름

imageUrl
string

상품 이미지 URL

Array of objects

카테고리 목록 (CreateProductBodyCategory)

groupId
string

상품 그룹 ID

isAlimtalkEnabled
boolean
Default: true

알림톡 활성화 여부

{
  • "name": "string",
  • "imageUrl": "string",
  • "categories": [
    ],
  • "groupId": "string",
  • "isAlimtalkEnabled": true
}

UpdateProductGroupBody

name
string

상품 그룹 이름

{
  • "name": "string"
}

UpdateQuestionBody

type
string
Enum: "statistical" "userinfo"
title
string

질문 제목 (위젯에서 노출)

text
string

질문 내용 (챗봇에서 노출)

options
Array of strings

질문 옵션

{
  • "type": "statistical",
  • "title": "string",
  • "text": "string",
  • "options": [
    ]
}

UpdateReviewBody

isVisible
boolean

리뷰 노출 여부

{
  • "isVisible": true
}

UpdateReviewCommentBody

text
string

댓글 내용

{
  • "text": "string"
}

UpdateReviewReportBody

isChecked
boolean

신고 처리 여부

{
  • "isChecked": true
}

UpdateRewardBody

status
string
Enum: "QUEUED" "SENDING" "SUCCESS" "FAILURE" "CANCELLED" "INVALID" "UNAPPROVED"

리워드 지급 상태 (RewardRequestStatus)

{
  • "status": "QUEUED"
}

UpdateUserBody

username
string

로그인 아이디

name
string

이름

phoneNumber
string

연락처

email
string

이메일

{
  • "username": "string",
  • "name": "string",
  • "phoneNumber": "string",
  • "email": "string"
}

User

id
required
string

고유 식별자

username
required
string

로그인 아이디

name
string

이름

phoneNumber
string

연락처

email
string

이메일

passwordChangedAt
string

비밀번호 변경 일시

{
  • "id": "string",
  • "username": "string",
  • "name": "string",
  • "phoneNumber": "string",
  • "email": "string",
  • "passwordChangedAt": "string"
}

ValidationError

required
Array of strings or integers
msg
required
string
type
required
string
{
  • "loc": [
    ],
  • "msg": "string",
  • "type": "string"
}

QuestionType

string
Enum: "STATISTICAL" "USERINFO"

An enumeration.

"STATISTICAL"

QuestionType

string
Enum: "statistical" "userinfo"

질문 종류를 표현합니다.

  • statistical: 만족도 질문
  • userinfo: 고객 정보 질문
"statistical"