브이리뷰 Admin API
브이리뷰 어드민 기능을 API로 활용할 수 있습니다.
관리자 정보 수정 🚧
출시 예정입니다.
Authorizations:
header Parameters
authorization required | string |
Request Body schema: application/json
username | string 로그인 아이디 |
name | string 이름 |
phoneNumber | string 연락처 |
string 이메일 |
Responses
Request samples
- Payload
{- "username": "string",
- "name": "string",
- "phoneNumber": "string",
- "email": "string"
}
Response samples
- 200
- 422
{- "id": "string",
- "username": "string",
- "name": "string",
- "phoneNumber": "string",
- "email": "string",
- "passwordChangedAt": "string"
}
관리자 비밀번호 변경
Authorizations:
header Parameters
authorization required | string |
Request Body schema: application/json
password required | string 새 비밀번호 |
Responses
Request samples
- Payload
{- "password": "string"
}
Response samples
- 200
- 422
{- "id": "string",
- "username": "string",
- "name": "string",
- "phoneNumber": "string",
- "email": "string",
- "passwordChangedAt": "string"
}
쇼핑몰 정보 수정
Authorizations:
header Parameters
authorization required | string |
Request Body schema: application/json
name | string |
Responses
Request samples
- Payload
{- "name": "string"
}
Response samples
- 200
- 422
{- "id": "string",
- "uuid": "string",
- "name": "string"
}
Response samples
- 200
- 422
{- "isDeliveryAlimtalkEnabled": true,
- "isThanksAlimtalkEnabled": true,
- "isMonthlyAlimtalkEnabled": true,
- "thanksAlimtalkDelayDays": 0,
- "rewardName": "string",
- "rewardUnit": "string",
- "isAutomaticRewardEnabled": true,
- "videoReviewRewardAmount": 0,
- "imageReviewRewardAmount": 0,
- "textReviewRewardAmount": 0,
- "textReviewRewardCondition": 0,
- "reviewAllowedDays": 0,
- "isWidgetEnabled": true,
- "isSummaryWidgetVideoOnly": true,
- "summaryWidgetVideoThumbnailSize": "THUMBNAIL_90",
- "isBestReviewWidgetInstalled": true,
- "isBestReviewWidgetEnabled": true,
- "bestReviewType": "SINGLE",
- "isReviewCollectionWidgetInstalled": true,
- "isReviewCollectionWidgetEnabled": true,
- "isProductDetailReviewTabCountWidgetInstalled": true,
- "isProductDetailReviewTabCountWidgetEnabled": true,
- "isProductDetailReviewTabPopupWidgetInstalled": true,
- "isProductDetailReviewTabPopupWidgetEnabled": true,
- "languageFilterSubstitutions": [
- "string"
], - "reviewDefaultOrdering": "CREATED",
- "idleTimeoutMinutes": 0,
- "twoFactorAuthPhoneNumber": "string"
}
쇼핑몰 설정 수정
Authorizations:
header Parameters
authorization required | string |
Request Body schema: application/json
isDeliveryAlimtalkEnabled | boolean 배송 완료 알림톡 활성화 여부 |
isThanksAlimtalkEnabled | boolean 감사톡 활성화 여부 |
isMonthlyAlimtalkEnabled | boolean 한달톡 활성화 여부 |
thanksAlimtalkDelayDays | integer 배송 완료일 기준 감사톡 발송 지연 일수 |
rewardName | string 리워드 이름 |
rewardUnit | string 리워드 단위 |
isAutomaticRewardEnabled | boolean 리워드 자동 지급 여부 |
videoReviewRewardAmount | integer 비디오 리뷰 리워드 수량 |
imageReviewRewardAmount | integer 이미지 리뷰 리워드 수량 |
textReviewRewardAmount | integer 텍스트 리뷰 리워드 수량 |
textReviewRewardCondition | integer 텍스트 리뷰 최소 글자수 조건 |
reviewAllowedDays | integer 리뷰 작성 기한 일수 |
isWidgetEnabled | boolean 위젯 활성화 여부 |
isSummaryWidgetVideoOnly | boolean 써머리 위젯에서 비디오 리뷰만 노출할지 여부 |
summaryWidgetVideoThumbnailSize | string Enum: "THUMBNAIL_90" "THUMBNAIL_128" "THUMBNAIL_164" "THUMBNAIL_210" 써머리 위젯 비디오 썸네일 크기 ( |
isBestReviewWidgetInstalled | boolean 베스트 리뷰 위젯 설치 여부 |
isBestReviewWidgetEnabled | boolean 베스트 리뷰 위젯 활성화 여부 |
bestReviewType | |
isReviewCollectionWidgetInstalled | boolean 리뷰 모아보기 위젯 설치 여부 |
isReviewCollectionWidgetEnabled | boolean 리뷰 모아보기 위젯 활성화 여부 |
isProductDetailReviewTabCountWidgetInstalled | boolean 상품 상세 페이지 리뷰 탭 개수 위젯 설치 여부 |
isProductDetailReviewTabCountWidgetEnabled | boolean 상품 상세 페이지 리뷰 탭 개수 위젯 활성화 여부 |
isProductDetailReviewTabPopupWidgetInstalled | boolean 상품 상세 페이지 리뷰 탭 팝업 위젯 설치 여부 |
isProductDetailReviewTabPopupWidgetEnabled | boolean 상품 상세 페이지 리뷰 탭 팝업 위젯 활성화 여부 |
reviewTextProhibitedWords | Array of strings 리뷰 금칙어 목록 |
reviewDefaultOrdering | |
idleTimeoutMinutes | integer Idle timeout 시간 (분) |
twoFactorAuthPhoneNumber | string 2FA 인증 코드를 수신할 연락처 (E164 포맷) |
Responses
Request samples
- Payload
{- "isDeliveryAlimtalkEnabled": true,
- "isThanksAlimtalkEnabled": true,
- "isMonthlyAlimtalkEnabled": true,
- "thanksAlimtalkDelayDays": 0,
- "rewardName": "string",
- "rewardUnit": "string",
- "isAutomaticRewardEnabled": true,
- "videoReviewRewardAmount": 0,
- "imageReviewRewardAmount": 0,
- "textReviewRewardAmount": 0,
- "textReviewRewardCondition": 0,
- "reviewAllowedDays": 0,
- "isWidgetEnabled": true,
- "isSummaryWidgetVideoOnly": true,
- "summaryWidgetVideoThumbnailSize": "THUMBNAIL_90",
- "isBestReviewWidgetInstalled": true,
- "isBestReviewWidgetEnabled": true,
- "bestReviewType": "SINGLE",
- "isReviewCollectionWidgetInstalled": true,
- "isReviewCollectionWidgetEnabled": true,
- "isProductDetailReviewTabCountWidgetInstalled": true,
- "isProductDetailReviewTabCountWidgetEnabled": true,
- "isProductDetailReviewTabPopupWidgetInstalled": true,
- "isProductDetailReviewTabPopupWidgetEnabled": true,
- "reviewTextProhibitedWords": [
- "string"
], - "reviewDefaultOrdering": "CREATED",
- "idleTimeoutMinutes": 0,
- "twoFactorAuthPhoneNumber": "string"
}
Response samples
- 200
- 422
{- "isDeliveryAlimtalkEnabled": true,
- "isThanksAlimtalkEnabled": true,
- "isMonthlyAlimtalkEnabled": true,
- "thanksAlimtalkDelayDays": 0,
- "rewardName": "string",
- "rewardUnit": "string",
- "isAutomaticRewardEnabled": true,
- "videoReviewRewardAmount": 0,
- "imageReviewRewardAmount": 0,
- "textReviewRewardAmount": 0,
- "textReviewRewardCondition": 0,
- "reviewAllowedDays": 0,
- "isWidgetEnabled": true,
- "isSummaryWidgetVideoOnly": true,
- "summaryWidgetVideoThumbnailSize": "THUMBNAIL_90",
- "isBestReviewWidgetInstalled": true,
- "isBestReviewWidgetEnabled": true,
- "bestReviewType": "SINGLE",
- "isReviewCollectionWidgetInstalled": true,
- "isReviewCollectionWidgetEnabled": true,
- "isProductDetailReviewTabCountWidgetInstalled": true,
- "isProductDetailReviewTabCountWidgetEnabled": true,
- "isProductDetailReviewTabPopupWidgetInstalled": true,
- "isProductDetailReviewTabPopupWidgetEnabled": true,
- "languageFilterSubstitutions": [
- "string"
], - "reviewDefaultOrdering": "CREATED",
- "idleTimeoutMinutes": 0,
- "twoFactorAuthPhoneNumber": "string"
}
상품 목록 조회
Authorizations:
query Parameters
ordering | |
first | integer 조회할 개수 |
after | string 조회할 시작 커서 |
productGroupIds | Array of strings 상품 그룹 ID 목록 |
isAlimtalkEnabled | boolean 알림톡 활성화 여부 |
header Parameters
authorization required | string |
Responses
Response samples
- 200
- 422
{- "totalCount": 0,
- "data": [
- {
- "id": "string",
- "originId": "string",
- "name": "string",
- "image": {
- "url": "string"
}, - "url": "string",
- "categories": [
- {
- "isPrimary": true,
- "category": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "isVisible": true
}
}
], - "group": {
- "id": "string"
}, - "brand": {
- "id": "string",
- "originId": "string",
- "name": "string"
}, - "isAlimtalkEnabled": "string",
- "reviewCount": 0,
- "reviewRatingAverage": 0
}
], - "pageInfo": {
- "hasNextPage": true,
- "endCursor": "string"
}
}
상품 생성
Authorizations:
header Parameters
authorization required | string |
Request Body schema: application/json
originId required | string 고객사 상품 ID |
name required | string 상품 이름 |
imageUrl | string 상품 이미지 URL |
Array of objects 카테고리 목록 ( | |
groupId | string 상품 그룹 ID. 존재하지 않는 ID를 입력한 경우 경우 실패합니다. |
groupName | string 상품 그룹 이름. 존재하지 않는 이름을 입력한 경우 자동으로 상품 그룹을 생성합니다. |
isAlimtalkEnabled | boolean Default: true 알림톡 활성화 여부 |
Responses
Request samples
- Payload
{- "originId": "string",
- "name": "string",
- "imageUrl": "string",
- "categories": [
- {
- "originId": "string",
- "isPrimary": false
}
], - "groupId": "string",
- "groupName": "string",
- "isAlimtalkEnabled": true
}
Response samples
- 200
- 422
{- "id": "string",
- "originId": "string",
- "name": "string",
- "image": {
- "url": "string"
}, - "url": "string",
- "categories": [
- {
- "isPrimary": true,
- "category": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "isVisible": true
}
}
], - "group": {
- "id": "string"
}, - "brand": {
- "id": "string",
- "originId": "string",
- "name": "string"
}, - "isAlimtalkEnabled": "string",
- "reviewCount": 0,
- "reviewRatingAverage": 0
}
상품 조회
Authorizations:
path Parameters
productId required | string |
header Parameters
authorization required | string |
Responses
Response samples
- 200
- 422
{- "id": "string",
- "originId": "string",
- "name": "string",
- "image": {
- "url": "string"
}, - "url": "string",
- "categories": [
- {
- "isPrimary": true,
- "category": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "isVisible": true
}
}
], - "group": {
- "id": "string"
}, - "brand": {
- "id": "string",
- "originId": "string",
- "name": "string"
}, - "isAlimtalkEnabled": "string",
- "reviewCount": 0,
- "reviewRatingAverage": 0
}
상품 수정
Authorizations:
path Parameters
productId required | string |
header Parameters
authorization required | string |
Request Body schema: application/json
name | string 상품 이름 |
imageUrl | string 상품 이미지 URL |
Array of objects 카테고리 목록 ( | |
groupId | string 상품 그룹 ID |
isAlimtalkEnabled | boolean Default: true 알림톡 활성화 여부 |
Responses
Request samples
- Payload
{- "name": "string",
- "imageUrl": "string",
- "categories": [
- {
- "originId": "string",
- "isPrimary": false
}
], - "groupId": "string",
- "isAlimtalkEnabled": true
}
Response samples
- 200
- 422
{- "id": "string",
- "originId": "string",
- "name": "string",
- "image": {
- "url": "string"
}, - "url": "string",
- "categories": [
- {
- "isPrimary": true,
- "category": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "isVisible": true
}
}
], - "group": {
- "id": "string"
}, - "brand": {
- "id": "string",
- "originId": "string",
- "name": "string"
}, - "isAlimtalkEnabled": "string",
- "reviewCount": 0,
- "reviewRatingAverage": 0
}
상품 일괄 생성
상품을 일괄 생성합니다. 한 번에 최대 100개까지 요청할 수 있습니다. 요청한 즉시 비동기 작업이 생성되며, 비동기 작업 상태를 조회할 수 있는 jobId가 요청한 데이터 순서대로 반환됩니다. 이 값을 일괄 생성 작업 조회 API에 사용해서 작업 상태를 조회할 수 있습니다.
Authorizations:
header Parameters
authorization required | string |
Request Body schema: application/json
originId required | string 고객사 상품 ID |
name required | string 상품 이름 |
imageUrl | string 상품 이미지 URL |
Array of objects 카테고리 목록 ( | |
groupId | string 상품 그룹 ID. 존재하지 않는 ID를 입력한 경우 경우 실패합니다. |
groupName | string 상품 그룹 이름. 존재하지 않는 이름을 입력한 경우 자동으로 상품 그룹을 생성합니다. |
isAlimtalkEnabled | boolean Default: true 알림톡 활성화 여부 |
Responses
Request samples
- Payload
[- {
- "originId": "string",
- "name": "string",
- "imageUrl": "string",
- "categories": [
- {
- "originId": "string",
- "isPrimary": false
}
], - "groupId": "string",
- "groupName": "string",
- "isAlimtalkEnabled": true
}
]
Response samples
- 207
- 422
[- {
- "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"
}
]
상품 그룹 목록 조회
Authorizations:
query Parameters
ordering | string Default: "-created_at" Enum: "name" "review_count" "created_at" "-created_at" 정렬 방식 ( |
first | integer 조회할 개수 |
after | string 조회할 시작 커서 |
name | string 상품 그룹 이름 |
header Parameters
authorization required | string |
Responses
Response samples
- 200
- 422
{- "totalCount": 0,
- "data": [
- {
- "id": "string",
- "name": "string",
- "image": {
- "url": "string"
}, - "productCount": 0,
- "reviewCount": 0,
- "reviewRatingAverage": 0,
- "createdAt": "string",
- "updatedAt": "string"
}
], - "pageInfo": {
- "hasNextPage": true,
- "endCursor": "string"
}
}
상품 그룹 조회
Authorizations:
path Parameters
productGroupId required | string |
header Parameters
authorization required | string |
Responses
Response samples
- 200
- 422
{- "id": "string",
- "name": "string",
- "image": {
- "url": "string"
}, - "productCount": 0,
- "reviewCount": 0,
- "reviewRatingAverage": 0,
- "createdAt": "string",
- "updatedAt": "string"
}
상품 그룹 수정
Authorizations:
path Parameters
productGroupId required | string |
header Parameters
authorization required | string |
Request Body schema: application/json
name | string 상품 그룹 이름 |
Responses
Request samples
- Payload
{- "name": "string"
}
Response samples
- 200
- 422
{- "id": "string",
- "name": "string",
- "image": {
- "url": "string"
}, - "productCount": 0,
- "reviewCount": 0,
- "reviewRatingAverage": 0,
- "createdAt": "string",
- "updatedAt": "string"
}
상품 그룹 생성
Authorizations:
header Parameters
authorization required | string |
Request Body schema: application/json
name required | string 상품 그룹 이름 |
Responses
Request samples
- Payload
{- "name": "string"
}
Response samples
- 201
- 422
{- "id": "string",
- "name": "string",
- "image": {
- "url": "string"
}, - "productCount": 0,
- "reviewCount": 0,
- "reviewRatingAverage": 0,
- "createdAt": "string",
- "updatedAt": "string"
}
상품 그룹에 상품 추가
Authorizations:
path Parameters
productGroupId required | string |
productId required | string |
header Parameters
authorization required | string |
Responses
Response samples
- 200
- 422
{- "id": "string",
- "name": "string",
- "image": {
- "url": "string"
}, - "productCount": 0,
- "reviewCount": 0,
- "reviewRatingAverage": 0,
- "createdAt": "string",
- "updatedAt": "string"
}
카테고리 생성
Authorizations:
header Parameters
authorization required | string |
Request Body schema: application/json
originId required | string 고객사 카테고리 ID |
name required | string 카테고리 이름 |
isVisible | boolean Default: true 카테고리 노출 여부 |
position | integer Default: 0 카테고리 노출 순서 |
parentOriginId | string 부모 카테고리 고유 ID |
Responses
Request samples
- Payload
{- "originId": "string",
- "name": "string",
- "isVisible": true,
- "position": 0,
- "parentOriginId": "string"
}
Response samples
- 200
- 422
{- "id": "string",
- "originId": "string",
- "name": "string",
- "isVisible": true
}
카테고리 수정
Authorizations:
path Parameters
categoryId required | string |
header Parameters
authorization required | string |
Request Body schema: application/json
name | string 카테고리 이름 |
isVisible | boolean Default: true 카테고리 노출 여부 |
position | integer 카테고리 노출 순서 |
parentOriginId | integer 부모 카테고리 고유 ID |
Responses
Request samples
- Payload
{- "name": "string",
- "isVisible": true,
- "position": 0,
- "parentOriginId": 0
}
Response samples
- 200
- 422
{- "id": "string",
- "originId": "string",
- "name": "string",
- "isVisible": true
}
카테고리 일괄 생성
Authorizations:
header Parameters
authorization required | string |
Request Body schema: application/json
originId required | string 고객사 카테고리 ID |
name required | string 카테고리 이름 |
isVisible | boolean Default: true 카테고리 노출 여부 |
position | integer Default: 0 카테고리 노출 순서 |
parentOriginId | string 부모 카테고리 고유 ID |
Responses
Request samples
- Payload
[- {
- "originId": "string",
- "name": "string",
- "isVisible": true,
- "position": 0,
- "parentOriginId": "string"
}
]
Response samples
- 207
- 422
[- {
- "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"
}
]
주문 생성
Authorizations:
header Parameters
authorization required | string |
Request Body schema: application/json
originId required | string 고객사 주문 ID |
memberOriginId | string 고객사 회원 ID |
orderedAt required | string <date-time> 주문 일시 |
required | object 주문 수령인 정보 ( |
alimtalkTemplateCode | string 챗봇 템플릿 코드 - 브이리뷰 팀에서 안내받은 템플릿이 없다면 null을 입력해주세요. |
required | Array of objects 주문 아이템 목록 ( |
Responses
Request samples
- Payload
{- "originId": "string",
- "memberOriginId": "string",
- "orderedAt": "2019-08-24T14:15:22Z",
- "recipient": {
- "name": "string",
- "phone": "string"
}, - "alimtalkTemplateCode": "string",
- "items": [
- {
- "originId": "string",
- "productOriginId": "string",
- "status": "DELIVERED",
- "selectedOptions": [
- {
- "name": "string",
- "value": "string"
}
], - "shipment": {
- "companyCode": "self",
- "trackingNumber": "string",
- "deliveredAt": "2019-08-24T14:15:22Z"
}
}
]
}
Response samples
- 200
- 422
{- "id": "string",
- "originId": "string",
- "orderedAt": "string",
- "memberOriginId": "string",
- "alimtalkTemplateCode": "string",
- "recipient": {
- "name": "string",
- "phone": "string"
}, - "items": [
- {
- "id": "string",
- "originId": "string",
- "status": "DELIVERED",
- "product": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "image": {
- "url": "string"
}, - "url": "string",
- "categories": [
- {
- "isPrimary": true,
- "category": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "isVisible": true
}
}
], - "group": {
- "id": "string"
}, - "brand": {
- "id": "string",
- "originId": "string",
- "name": "string"
}, - "isAlimtalkEnabled": "string",
- "reviewCount": 0,
- "reviewRatingAverage": 0
}, - "selectedOptions": [
- {
- "name": "string",
- "value": "string"
}
], - "shipment": {
- "companyCode": "string",
- "trackingNumber": "string",
- "deliveredAt": "string"
}
}
]
}
주문 조회
Authorizations:
path Parameters
orderId required | string |
header Parameters
authorization required | string |
Responses
Response samples
- 200
- 422
{- "id": "string",
- "originId": "string",
- "orderedAt": "string",
- "memberOriginId": "string",
- "alimtalkTemplateCode": "string",
- "recipient": {
- "name": "string",
- "phone": "string"
}, - "items": [
- {
- "id": "string",
- "originId": "string",
- "status": "DELIVERED",
- "product": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "image": {
- "url": "string"
}, - "url": "string",
- "categories": [
- {
- "isPrimary": true,
- "category": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "isVisible": true
}
}
], - "group": {
- "id": "string"
}, - "brand": {
- "id": "string",
- "originId": "string",
- "name": "string"
}, - "isAlimtalkEnabled": "string",
- "reviewCount": 0,
- "reviewRatingAverage": 0
}, - "selectedOptions": [
- {
- "name": "string",
- "value": "string"
}
], - "shipment": {
- "companyCode": "string",
- "trackingNumber": "string",
- "deliveredAt": "string"
}
}
]
}
주문 수정
Authorizations:
path Parameters
orderId required | string |
header Parameters
authorization required | string |
Request Body schema: application/json
memberOriginId | string 고객사 회원 ID |
orderedAt | string <date-time> 주문 일시 |
object 주문 수령인 정보 ( | |
alimtalkTemplateCode | string 챗봇 템플릿 코드 - 브이리뷰 팀에서 안내받은 템플릿이 없다면 null을 입력해주세요. |
Array of objects 주문 아이템 목록 ( |
Responses
Request samples
- Payload
{- "memberOriginId": "string",
- "orderedAt": "2019-08-24T14:15:22Z",
- "recipient": {
- "name": "string",
- "phone": "string"
}, - "alimtalkTemplateCode": "string",
- "items": [
- {
- "originId": "string",
- "productOriginId": "string",
- "status": "DELIVERED",
- "selectedOptions": [
- {
- "name": "string",
- "value": "string"
}
], - "shipment": {
- "companyCode": "self",
- "trackingNumber": "string",
- "deliveredAt": "2019-08-24T14:15:22Z"
}
}
]
}
Response samples
- 200
- 422
{- "id": "string",
- "originId": "string",
- "orderedAt": "string",
- "memberOriginId": "string",
- "alimtalkTemplateCode": "string",
- "recipient": {
- "name": "string",
- "phone": "string"
}, - "items": [
- {
- "id": "string",
- "originId": "string",
- "status": "DELIVERED",
- "product": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "image": {
- "url": "string"
}, - "url": "string",
- "categories": [
- {
- "isPrimary": true,
- "category": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "isVisible": true
}
}
], - "group": {
- "id": "string"
}, - "brand": {
- "id": "string",
- "originId": "string",
- "name": "string"
}, - "isAlimtalkEnabled": "string",
- "reviewCount": 0,
- "reviewRatingAverage": 0
}, - "selectedOptions": [
- {
- "name": "string",
- "value": "string"
}
], - "shipment": {
- "companyCode": "string",
- "trackingNumber": "string",
- "deliveredAt": "string"
}
}
]
}
주문 일괄 생성
주문을 일괄 생성합니다. 한 번에 최대 100개까지 요청할 수 있습니다. 요청한 즉시 비동기 작업이 생성되며, 비동기 작업 상태를 조회할 수 있는 jobId가 요청한 데이터 순서대로 반환됩니다. 이 값을 일괄 생성 작업 조회 API에 사용해서 작업 상태를 조회할 수 있습니다.
Authorizations:
header Parameters
authorization required | string |
Request Body schema: application/json
originId required | string 고객사 주문 ID |
memberOriginId | string 고객사 회원 ID |
orderedAt required | string <date-time> 주문 일시 |
required | object 주문 수령인 정보 ( |
alimtalkTemplateCode | string 챗봇 템플릿 코드 - 브이리뷰 팀에서 안내받은 템플릿이 없다면 null을 입력해주세요. |
required | Array of objects 주문 아이템 목록 ( |
Responses
Request samples
- Payload
[- {
- "originId": "string",
- "memberOriginId": "string",
- "orderedAt": "2019-08-24T14:15:22Z",
- "recipient": {
- "name": "string",
- "phone": "string"
}, - "alimtalkTemplateCode": "string",
- "items": [
- {
- "originId": "string",
- "productOriginId": "string",
- "status": "DELIVERED",
- "selectedOptions": [
- {
- "name": "string",
- "value": "string"
}
], - "shipment": {
- "companyCode": "self",
- "trackingNumber": "string",
- "deliveredAt": "2019-08-24T14:15:22Z"
}
}
]
}
]
Response samples
- 207
- 422
[- {
- "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"
}
]
주문 아이템 조회
Authorizations:
path Parameters
orderItemId required | string |
header Parameters
authorization required | string |
Responses
Response samples
- 200
- 422
{- "id": "string",
- "originId": "string",
- "status": "DELIVERED",
- "product": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "image": {
- "url": "string"
}, - "url": "string",
- "categories": [
- {
- "isPrimary": true,
- "category": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "isVisible": true
}
}
], - "group": {
- "id": "string"
}, - "brand": {
- "id": "string",
- "originId": "string",
- "name": "string"
}, - "isAlimtalkEnabled": "string",
- "reviewCount": 0,
- "reviewRatingAverage": 0
}, - "selectedOptions": [
- {
- "name": "string",
- "value": "string"
}
], - "shipment": {
- "companyCode": "string",
- "trackingNumber": "string",
- "deliveredAt": "string"
}
}
주문 아이템 수정
Authorizations:
path Parameters
orderItemId required | string |
header Parameters
authorization required | string |
Request Body schema: application/json
productOriginId required | string 고객사 상품 ID |
status | |
Array of objects 주문한 옵션 목록 ( | |
object 배송 정보 ( |
Responses
Request samples
- Payload
{- "productOriginId": "string",
- "status": "DELIVERED",
- "selectedOptions": [
- {
- "name": "string",
- "value": "string"
}
], - "shipment": {
- "companyCode": "self",
- "trackingNumber": "string",
- "deliveredAt": "2019-08-24T14:15:22Z"
}
}
Response samples
- 200
- 422
{- "id": "string",
- "originId": "string",
- "status": "DELIVERED",
- "product": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "image": {
- "url": "string"
}, - "url": "string",
- "categories": [
- {
- "isPrimary": true,
- "category": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "isVisible": true
}
}
], - "group": {
- "id": "string"
}, - "brand": {
- "id": "string",
- "originId": "string",
- "name": "string"
}, - "isAlimtalkEnabled": "string",
- "reviewCount": 0,
- "reviewRatingAverage": 0
}, - "selectedOptions": [
- {
- "name": "string",
- "value": "string"
}
], - "shipment": {
- "companyCode": "string",
- "trackingNumber": "string",
- "deliveredAt": "string"
}
}
리뷰 목록 조회
Authorizations:
query Parameters
sort | string Default: "CREATED_AT" Enum: "REVIEW_TYPE" "HELPFUL_COUNT" "CREATED_AT" "EDITED_AT" "UPDATED_AT" 정렬 필드 ( |
direction | |
first | integer 조회할 개수 |
after | string 조회할 시작 커서 |
contentTypes | |
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 신고 여부 |
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
- 200
- 422
{- "totalCount": 0,
- "data": [
- {
- "id": "string",
- "originId": "string",
- "userNickname": "string",
- "title": "string",
- "text": "string",
- "rating": 0,
- "uploadFrom": "CHATBOT",
- "videos": [
- {
- "urls": {
- "thumbnail": "string",
- "large": "string"
}
}
], - "images": [
- {
- "urls": {
- "thumbnail": "string",
- "large": "string"
}
}
], - "product": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "image": {
- "url": "string"
}, - "url": "string",
- "categories": [
- {
- "isPrimary": true,
- "category": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "isVisible": true
}
}
], - "group": {
- "id": "string"
}, - "brand": {
- "id": "string",
- "originId": "string",
- "name": "string"
}, - "isAlimtalkEnabled": "string",
- "reviewCount": 0,
- "reviewRatingAverage": 0
}, - "order": {
- "id": "string",
- "originId": "string",
- "orderedAt": "string",
- "memberOriginId": "string",
- "alimtalkTemplateCode": "string",
- "recipient": {
- "name": "string",
- "phone": "string"
}, - "items": [
- {
- "id": "string",
- "originId": "string",
- "status": "DELIVERED",
- "product": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "image": {
- "url": "string"
}, - "url": "string",
- "categories": [
- {
- "isPrimary": true,
- "category": {
- "id": null,
- "originId": null,
- "name": null,
- "isVisible": null
}
}
], - "group": {
- "id": "string"
}, - "brand": {
- "id": "string",
- "originId": "string",
- "name": "string"
}, - "isAlimtalkEnabled": "string",
- "reviewCount": 0,
- "reviewRatingAverage": 0
}, - "selectedOptions": [
- {
- "name": "string",
- "value": "string"
}
], - "shipment": {
- "companyCode": "string",
- "trackingNumber": "string",
- "deliveredAt": "string"
}
}
]
}, - "questionAnswers": [
- {
- "question": {
- "text": "string"
}, - "answer": {
- "text": "string"
}
}
], - "isVisible": true,
- "isBlocked": true,
- "blockReason": "DUPLICATE_VIDEO",
- "helpfulCount": 0,
- "reportStatus": "PENDING",
- "mabScore": 0,
- "sentimentScore": 0,
- "sentimentKeywords": [
- {
- "text": "string",
- "startIndex": 0,
- "endIndex": 0
}
], - "productRelativenessScore": 0,
- "createdAt": "string",
- "updatedAt": "string"
}
], - "pageInfo": {
- "hasNextPage": true,
- "endCursor": "string"
}
}
리뷰 조회
Authorizations:
path Parameters
reviewId required | string |
header Parameters
authorization required | string |
Responses
Response samples
- 200
- 422
{- "id": "string",
- "originId": "string",
- "userNickname": "string",
- "title": "string",
- "text": "string",
- "rating": 0,
- "uploadFrom": "CHATBOT",
- "videos": [
- {
- "urls": {
- "thumbnail": "string",
- "large": "string"
}
}
], - "images": [
- {
- "urls": {
- "thumbnail": "string",
- "large": "string"
}
}
], - "product": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "image": {
- "url": "string"
}, - "url": "string",
- "categories": [
- {
- "isPrimary": true,
- "category": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "isVisible": true
}
}
], - "group": {
- "id": "string"
}, - "brand": {
- "id": "string",
- "originId": "string",
- "name": "string"
}, - "isAlimtalkEnabled": "string",
- "reviewCount": 0,
- "reviewRatingAverage": 0
}, - "order": {
- "id": "string",
- "originId": "string",
- "orderedAt": "string",
- "memberOriginId": "string",
- "alimtalkTemplateCode": "string",
- "recipient": {
- "name": "string",
- "phone": "string"
}, - "items": [
- {
- "id": "string",
- "originId": "string",
- "status": "DELIVERED",
- "product": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "image": {
- "url": "string"
}, - "url": "string",
- "categories": [
- {
- "isPrimary": true,
- "category": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "isVisible": true
}
}
], - "group": {
- "id": "string"
}, - "brand": {
- "id": "string",
- "originId": "string",
- "name": "string"
}, - "isAlimtalkEnabled": "string",
- "reviewCount": 0,
- "reviewRatingAverage": 0
}, - "selectedOptions": [
- {
- "name": "string",
- "value": "string"
}
], - "shipment": {
- "companyCode": "string",
- "trackingNumber": "string",
- "deliveredAt": "string"
}
}
]
}, - "questionAnswers": [
- {
- "question": {
- "text": "string"
}, - "answer": {
- "text": "string"
}
}
], - "isVisible": true,
- "isBlocked": true,
- "blockReason": "DUPLICATE_VIDEO",
- "helpfulCount": 0,
- "reportStatus": "PENDING",
- "mabScore": 0,
- "sentimentScore": 0,
- "sentimentKeywords": [
- {
- "text": "string",
- "startIndex": 0,
- "endIndex": 0
}
], - "productRelativenessScore": 0,
- "createdAt": "string",
- "updatedAt": "string"
}
리뷰 정보 수정
Authorizations:
path Parameters
reviewId required | string |
header Parameters
authorization required | string |
Request Body schema: application/json
isVisible | boolean 리뷰 노출 여부 |
Responses
Request samples
- Payload
{- "isVisible": true
}
Response samples
- 200
- 422
{- "id": "string",
- "originId": "string",
- "userNickname": "string",
- "title": "string",
- "text": "string",
- "rating": 0,
- "uploadFrom": "CHATBOT",
- "videos": [
- {
- "urls": {
- "thumbnail": "string",
- "large": "string"
}
}
], - "images": [
- {
- "urls": {
- "thumbnail": "string",
- "large": "string"
}
}
], - "product": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "image": {
- "url": "string"
}, - "url": "string",
- "categories": [
- {
- "isPrimary": true,
- "category": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "isVisible": true
}
}
], - "group": {
- "id": "string"
}, - "brand": {
- "id": "string",
- "originId": "string",
- "name": "string"
}, - "isAlimtalkEnabled": "string",
- "reviewCount": 0,
- "reviewRatingAverage": 0
}, - "order": {
- "id": "string",
- "originId": "string",
- "orderedAt": "string",
- "memberOriginId": "string",
- "alimtalkTemplateCode": "string",
- "recipient": {
- "name": "string",
- "phone": "string"
}, - "items": [
- {
- "id": "string",
- "originId": "string",
- "status": "DELIVERED",
- "product": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "image": {
- "url": "string"
}, - "url": "string",
- "categories": [
- {
- "isPrimary": true,
- "category": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "isVisible": true
}
}
], - "group": {
- "id": "string"
}, - "brand": {
- "id": "string",
- "originId": "string",
- "name": "string"
}, - "isAlimtalkEnabled": "string",
- "reviewCount": 0,
- "reviewRatingAverage": 0
}, - "selectedOptions": [
- {
- "name": "string",
- "value": "string"
}
], - "shipment": {
- "companyCode": "string",
- "trackingNumber": "string",
- "deliveredAt": "string"
}
}
]
}, - "questionAnswers": [
- {
- "question": {
- "text": "string"
}, - "answer": {
- "text": "string"
}
}
], - "isVisible": true,
- "isBlocked": true,
- "blockReason": "DUPLICATE_VIDEO",
- "helpfulCount": 0,
- "reportStatus": "PENDING",
- "mabScore": 0,
- "sentimentScore": 0,
- "sentimentKeywords": [
- {
- "text": "string",
- "startIndex": 0,
- "endIndex": 0
}
], - "productRelativenessScore": 0,
- "createdAt": "string",
- "updatedAt": "string"
}
리뷰 일괄 생성
리뷰를 일괄 생성합니다. 한 번에 최대 100개까지 요청할 수 있습니다. 요청한 즉시 비동기 작업이 생성되며, 비동기 작업 상태를 조회할 수 있는 jobId가 요청한 데이터 순서대로 반환됩니다. 이 값을 일괄 생성 작업 조회 API에 사용해서 작업 상태를 조회할 수 있습니다.
Authorizations:
header Parameters
authorization required | string |
Request Body schema: application/json
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 질문 답변 목록 ( | |
orderItemOriginId | string 고객사 주문 아이템 ID |
createdAt | string <date-time> 리뷰 생성 일시 |
isVisible | boolean Default: true 리뷰 노출 여부 |
Responses
Request samples
- Payload
[- {
- "originId": "string",
- "productOriginId": "string",
- "authorName": "string",
- "title": "string",
- "videoUrls": [
- "string"
], - "imageUrls": [
- "string"
], - "text": "string",
- "rating": 0,
- "questionAnswers": [
- {
- "question": "string",
- "answer": "string"
}
], - "orderItemOriginId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "isVisible": true
}
]
Response samples
- 207
- 422
[- {
- "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"
}
]
상품별 고정 리뷰 조회
Authorizations:
path Parameters
productId required | string |
header Parameters
authorization required | string |
Responses
Response samples
- 200
- 422
[- {
- "id": "string",
- "originId": "string",
- "userNickname": "string",
- "title": "string",
- "text": "string",
- "rating": 0,
- "uploadFrom": "CHATBOT",
- "videos": [
- {
- "urls": {
- "thumbnail": "string",
- "large": "string"
}
}
], - "images": [
- {
- "urls": {
- "thumbnail": "string",
- "large": "string"
}
}
], - "product": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "image": {
- "url": "string"
}, - "url": "string",
- "categories": [
- {
- "isPrimary": true,
- "category": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "isVisible": true
}
}
], - "group": {
- "id": "string"
}, - "brand": {
- "id": "string",
- "originId": "string",
- "name": "string"
}, - "isAlimtalkEnabled": "string",
- "reviewCount": 0,
- "reviewRatingAverage": 0
}, - "order": {
- "id": "string",
- "originId": "string",
- "orderedAt": "string",
- "memberOriginId": "string",
- "alimtalkTemplateCode": "string",
- "recipient": {
- "name": "string",
- "phone": "string"
}, - "items": [
- {
- "id": "string",
- "originId": "string",
- "status": "DELIVERED",
- "product": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "image": {
- "url": "string"
}, - "url": "string",
- "categories": [
- {
- "isPrimary": true,
- "category": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "isVisible": true
}
}
], - "group": {
- "id": "string"
}, - "brand": {
- "id": "string",
- "originId": "string",
- "name": "string"
}, - "isAlimtalkEnabled": "string",
- "reviewCount": 0,
- "reviewRatingAverage": 0
}, - "selectedOptions": [
- {
- "name": "string",
- "value": "string"
}
], - "shipment": {
- "companyCode": "string",
- "trackingNumber": "string",
- "deliveredAt": "string"
}
}
]
}, - "questionAnswers": [
- {
- "question": {
- "text": "string"
}, - "answer": {
- "text": "string"
}
}
], - "isVisible": true,
- "isBlocked": true,
- "blockReason": "DUPLICATE_VIDEO",
- "helpfulCount": 0,
- "reportStatus": "PENDING",
- "mabScore": 0,
- "sentimentScore": 0,
- "sentimentKeywords": [
- {
- "text": "string",
- "startIndex": 0,
- "endIndex": 0
}
], - "productRelativenessScore": 0,
- "createdAt": "string",
- "updatedAt": "string"
}
]
상품별 고정 리뷰 설정
Authorizations:
path Parameters
productId required | string |
header Parameters
authorization required | string |
Request Body schema: application/json
ids required | Array of strings 고정할 리뷰 ID 목록 |
Responses
Request samples
- Payload
{- "ids": [
- "string"
]
}
Response samples
- 200
- 422
[- {
- "id": "string",
- "originId": "string",
- "userNickname": "string",
- "title": "string",
- "text": "string",
- "rating": 0,
- "uploadFrom": "CHATBOT",
- "videos": [
- {
- "urls": {
- "thumbnail": "string",
- "large": "string"
}
}
], - "images": [
- {
- "urls": {
- "thumbnail": "string",
- "large": "string"
}
}
], - "product": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "image": {
- "url": "string"
}, - "url": "string",
- "categories": [
- {
- "isPrimary": true,
- "category": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "isVisible": true
}
}
], - "group": {
- "id": "string"
}, - "brand": {
- "id": "string",
- "originId": "string",
- "name": "string"
}, - "isAlimtalkEnabled": "string",
- "reviewCount": 0,
- "reviewRatingAverage": 0
}, - "order": {
- "id": "string",
- "originId": "string",
- "orderedAt": "string",
- "memberOriginId": "string",
- "alimtalkTemplateCode": "string",
- "recipient": {
- "name": "string",
- "phone": "string"
}, - "items": [
- {
- "id": "string",
- "originId": "string",
- "status": "DELIVERED",
- "product": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "image": {
- "url": "string"
}, - "url": "string",
- "categories": [
- {
- "isPrimary": true,
- "category": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "isVisible": true
}
}
], - "group": {
- "id": "string"
}, - "brand": {
- "id": "string",
- "originId": "string",
- "name": "string"
}, - "isAlimtalkEnabled": "string",
- "reviewCount": 0,
- "reviewRatingAverage": 0
}, - "selectedOptions": [
- {
- "name": "string",
- "value": "string"
}
], - "shipment": {
- "companyCode": "string",
- "trackingNumber": "string",
- "deliveredAt": "string"
}
}
]
}, - "questionAnswers": [
- {
- "question": {
- "text": "string"
}, - "answer": {
- "text": "string"
}
}
], - "isVisible": true,
- "isBlocked": true,
- "blockReason": "DUPLICATE_VIDEO",
- "helpfulCount": 0,
- "reportStatus": "PENDING",
- "mabScore": 0,
- "sentimentScore": 0,
- "sentimentKeywords": [
- {
- "text": "string",
- "startIndex": 0,
- "endIndex": 0
}
], - "productRelativenessScore": 0,
- "createdAt": "string",
- "updatedAt": "string"
}
]
상품 그룹별 고정 리뷰 설정
Authorizations:
path Parameters
productGroupId required | string |
header Parameters
authorization required | string |
Request Body schema: application/json
ids required | Array of strings 고정할 리뷰 ID 목록 |
Responses
Request samples
- Payload
{- "ids": [
- "string"
]
}
Response samples
- 200
- 422
[- {
- "id": "string",
- "originId": "string",
- "userNickname": "string",
- "title": "string",
- "text": "string",
- "rating": 0,
- "uploadFrom": "CHATBOT",
- "videos": [
- {
- "urls": {
- "thumbnail": "string",
- "large": "string"
}
}
], - "images": [
- {
- "urls": {
- "thumbnail": "string",
- "large": "string"
}
}
], - "product": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "image": {
- "url": "string"
}, - "url": "string",
- "categories": [
- {
- "isPrimary": true,
- "category": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "isVisible": true
}
}
], - "group": {
- "id": "string"
}, - "brand": {
- "id": "string",
- "originId": "string",
- "name": "string"
}, - "isAlimtalkEnabled": "string",
- "reviewCount": 0,
- "reviewRatingAverage": 0
}, - "order": {
- "id": "string",
- "originId": "string",
- "orderedAt": "string",
- "memberOriginId": "string",
- "alimtalkTemplateCode": "string",
- "recipient": {
- "name": "string",
- "phone": "string"
}, - "items": [
- {
- "id": "string",
- "originId": "string",
- "status": "DELIVERED",
- "product": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "image": {
- "url": "string"
}, - "url": "string",
- "categories": [
- {
- "isPrimary": true,
- "category": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "isVisible": true
}
}
], - "group": {
- "id": "string"
}, - "brand": {
- "id": "string",
- "originId": "string",
- "name": "string"
}, - "isAlimtalkEnabled": "string",
- "reviewCount": 0,
- "reviewRatingAverage": 0
}, - "selectedOptions": [
- {
- "name": "string",
- "value": "string"
}
], - "shipment": {
- "companyCode": "string",
- "trackingNumber": "string",
- "deliveredAt": "string"
}
}
]
}, - "questionAnswers": [
- {
- "question": {
- "text": "string"
}, - "answer": {
- "text": "string"
}
}
], - "isVisible": true,
- "isBlocked": true,
- "blockReason": "DUPLICATE_VIDEO",
- "helpfulCount": 0,
- "reportStatus": "PENDING",
- "mabScore": 0,
- "sentimentScore": 0,
- "sentimentKeywords": [
- {
- "text": "string",
- "startIndex": 0,
- "endIndex": 0
}
], - "productRelativenessScore": 0,
- "createdAt": "string",
- "updatedAt": "string"
}
]
베스트 리뷰 목록 조회
Authorizations:
query Parameters
sort | string Default: "CREATED_AT" Enum: "REVIEW_TYPE" "HELPFUL_COUNT" "CREATED_AT" "EDITED_AT" "UPDATED_AT" 정렬 필드 ( |
direction | |
first | integer 조회할 개수 |
after | string 조회할 시작 커서 |
contentTypes | |
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 신고 여부 |
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
- 200
- 422
{- "totalCount": 0,
- "data": [
- {
- "id": "string",
- "originId": "string",
- "userNickname": "string",
- "title": "string",
- "text": "string",
- "rating": 0,
- "uploadFrom": "CHATBOT",
- "videos": [
- {
- "urls": {
- "thumbnail": "string",
- "large": "string"
}
}
], - "images": [
- {
- "urls": {
- "thumbnail": "string",
- "large": "string"
}
}
], - "product": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "image": {
- "url": "string"
}, - "url": "string",
- "categories": [
- {
- "isPrimary": true,
- "category": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "isVisible": true
}
}
], - "group": {
- "id": "string"
}, - "brand": {
- "id": "string",
- "originId": "string",
- "name": "string"
}, - "isAlimtalkEnabled": "string",
- "reviewCount": 0,
- "reviewRatingAverage": 0
}, - "order": {
- "id": "string",
- "originId": "string",
- "orderedAt": "string",
- "memberOriginId": "string",
- "alimtalkTemplateCode": "string",
- "recipient": {
- "name": "string",
- "phone": "string"
}, - "items": [
- {
- "id": "string",
- "originId": "string",
- "status": "DELIVERED",
- "product": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "image": {
- "url": "string"
}, - "url": "string",
- "categories": [
- {
- "isPrimary": true,
- "category": {
- "id": null,
- "originId": null,
- "name": null,
- "isVisible": null
}
}
], - "group": {
- "id": "string"
}, - "brand": {
- "id": "string",
- "originId": "string",
- "name": "string"
}, - "isAlimtalkEnabled": "string",
- "reviewCount": 0,
- "reviewRatingAverage": 0
}, - "selectedOptions": [
- {
- "name": "string",
- "value": "string"
}
], - "shipment": {
- "companyCode": "string",
- "trackingNumber": "string",
- "deliveredAt": "string"
}
}
]
}, - "questionAnswers": [
- {
- "question": {
- "text": "string"
}, - "answer": {
- "text": "string"
}
}
], - "isVisible": true,
- "isBlocked": true,
- "blockReason": "DUPLICATE_VIDEO",
- "helpfulCount": 0,
- "reportStatus": "PENDING",
- "mabScore": 0,
- "sentimentScore": 0,
- "sentimentKeywords": [
- {
- "text": "string",
- "startIndex": 0,
- "endIndex": 0
}
], - "productRelativenessScore": 0,
- "createdAt": "string",
- "updatedAt": "string"
}
], - "pageInfo": {
- "hasNextPage": true,
- "endCursor": "string"
}
}
베스트 리뷰 설정
Authorizations:
header Parameters
authorization required | string |
Request Body schema: application/json
ids required | Array of strings 베스트 리뷰 ID 목록 |
Responses
Request samples
- Payload
{- "ids": [
- "string"
]
}
Response samples
- 200
- 422
[- {
- "id": "string",
- "originId": "string",
- "userNickname": "string",
- "title": "string",
- "text": "string",
- "rating": 0,
- "uploadFrom": "CHATBOT",
- "videos": [
- {
- "urls": {
- "thumbnail": "string",
- "large": "string"
}
}
], - "images": [
- {
- "urls": {
- "thumbnail": "string",
- "large": "string"
}
}
], - "product": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "image": {
- "url": "string"
}, - "url": "string",
- "categories": [
- {
- "isPrimary": true,
- "category": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "isVisible": true
}
}
], - "group": {
- "id": "string"
}, - "brand": {
- "id": "string",
- "originId": "string",
- "name": "string"
}, - "isAlimtalkEnabled": "string",
- "reviewCount": 0,
- "reviewRatingAverage": 0
}, - "order": {
- "id": "string",
- "originId": "string",
- "orderedAt": "string",
- "memberOriginId": "string",
- "alimtalkTemplateCode": "string",
- "recipient": {
- "name": "string",
- "phone": "string"
}, - "items": [
- {
- "id": "string",
- "originId": "string",
- "status": "DELIVERED",
- "product": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "image": {
- "url": "string"
}, - "url": "string",
- "categories": [
- {
- "isPrimary": true,
- "category": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "isVisible": true
}
}
], - "group": {
- "id": "string"
}, - "brand": {
- "id": "string",
- "originId": "string",
- "name": "string"
}, - "isAlimtalkEnabled": "string",
- "reviewCount": 0,
- "reviewRatingAverage": 0
}, - "selectedOptions": [
- {
- "name": "string",
- "value": "string"
}
], - "shipment": {
- "companyCode": "string",
- "trackingNumber": "string",
- "deliveredAt": "string"
}
}
]
}, - "questionAnswers": [
- {
- "question": {
- "text": "string"
}, - "answer": {
- "text": "string"
}
}
], - "isVisible": true,
- "isBlocked": true,
- "blockReason": "DUPLICATE_VIDEO",
- "helpfulCount": 0,
- "reportStatus": "PENDING",
- "mabScore": 0,
- "sentimentScore": 0,
- "sentimentKeywords": [
- {
- "text": "string",
- "startIndex": 0,
- "endIndex": 0
}
], - "productRelativenessScore": 0,
- "createdAt": "string",
- "updatedAt": "string"
}
]
전체 리뷰 신고 목록 조회
Authorizations:
query Parameters
first | integer 조회할 개수 |
after | string 조회할 시작 커서 |
reasons | Array of strings Items Enum: "ILLEGAL" "PERSONAL_INFO" "SPAM" "IRRELEVANT" "MISLEADING" "INAPPROPRIATE" "DUPLICATED" "ETC" 신고 사유 ( |
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
- 200
- 422
{- "totalCount": 0,
- "data": [
- {
- "id": "string",
- "reason": "ILLEGAL",
- "text": "string",
- "isChecked": true,
- "review": {
- "id": "string"
}, - "createdAt": "string",
- "updatedAt": "string"
}
], - "pageInfo": {
- "hasNextPage": true,
- "endCursor": "string"
}
}
리뷰 신고 수정
Authorizations:
path Parameters
reviewReportId required | string |
header Parameters
authorization required | string |
Request Body schema: application/json
isChecked | boolean 신고 처리 여부 |
Responses
Request samples
- Payload
{- "isChecked": true
}
Response samples
- 200
- 422
{- "id": "string",
- "reason": "ILLEGAL",
- "text": "string",
- "isChecked": true,
- "review": {
- "id": "string"
}, - "createdAt": "string",
- "updatedAt": "string"
}
개별 리뷰 신고 목록 조회
Authorizations:
path Parameters
reviewId required | string |
header Parameters
authorization required | string |
Responses
Response samples
- 200
- 422
{- "totalCount": 0,
- "data": [
- {
- "id": "string",
- "reason": "ILLEGAL",
- "text": "string",
- "isChecked": true,
- "review": {
- "id": "string"
}, - "createdAt": "string",
- "updatedAt": "string"
}
], - "pageInfo": {
- "hasNextPage": true,
- "endCursor": "string"
}
}
관리자 댓글 목록 조회
Authorizations:
path Parameters
reviewId required | string |
header Parameters
authorization required | string |
Responses
Response samples
- 201
- 422
{- "totalCount": 0,
- "data": [
- {
- "id": "string",
- "text": "string",
- "createdAt": "string",
- "updatedAt": "string"
}
], - "pageInfo": {
- "hasNextPage": true,
- "endCursor": "string"
}
}
관리자 댓글 생성
Authorizations:
path Parameters
reviewId required | string |
header Parameters
authorization required | string |
Request Body schema: application/json
text required | string 댓글 내용 |
Responses
Request samples
- Payload
{- "text": "string"
}
Response samples
- 201
- 422
{- "id": "string",
- "text": "string",
- "createdAt": "string",
- "updatedAt": "string"
}
관리자 댓글 수정
Authorizations:
path Parameters
commentId required | string |
header Parameters
authorization required | string |
Request Body schema: application/json
text | string 댓글 내용 |
Responses
Request samples
- Payload
{- "text": "string"
}
Response samples
- 200
- 422
{- "id": "string",
- "text": "string",
- "createdAt": "string",
- "updatedAt": "string"
}
관리자 댓글 일괄 생성 🚧
출시 예정입니다.
Authorizations:
path Parameters
reviewId required | string |
header Parameters
authorization required | string |
Request Body schema: application/json
text required | string 댓글 내용 |
Responses
Request samples
- Payload
[- {
- "text": "string"
}
]
Response samples
- 207
- 422
[- {
- "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"
}
]
메트릭 일괄 생성
메트릭을 일괄 생성합니다. 한 번에 최대 100개까지 요청할 수 있습니다. 요청한 즉시 비동기 작업이 생성되며, 비동기 작업 상태를 조회할 수 있는 jobId가 요청한 데이터 순서대로 반환됩니다. 이 값을 일괄 생성 작업 조회 API에 사용해서 작업 상태를 조회할 수 있습니다.
Authorizations:
header Parameters
authorization required | string |
Request Body schema: application/json
name required | string 메트릭 이름. 브이리뷰 팀에서 안내받은 값을 입력해주세요. (예시: review.view_review) |
date required | string 메트릭 일시 (예시: 2023-01-01T00:00:00+09:00)) |
key required | string 메트릭 키. 브이리뷰 팀에서 안내받은 값을 입력해주세요. (예시: product-12345) |
interval required | string 메트릭 기간 (day, hour) |
value required | number 메트릭 값 |
Responses
Request samples
- Payload
[- {
- "name": "string",
- "date": "string",
- "key": "string",
- "interval": "string",
- "value": 0
}
]
Response samples
- 207
- 422
[- {
- "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"
}
]
Response samples
- 200
- 422
{- "totalCount": 0,
- "data": [
- {
- "name": "string",
- "date": "string",
- "key": "string",
- "interval": "string",
- "value": 0
}
], - "pageInfo": {
- "hasNextPage": true,
- "endCursor": "string"
}
}
질문 목록 조회
Authorizations:
query Parameters
first | integer 조회할 개수 |
after | string 조회할 시작 커서 |
type |
header Parameters
authorization required | string |
Responses
Response samples
- 200
- 422
{- "totalCount": 0,
- "data": [
- {
- "id": "string",
- "questionType": "STATISTICAL",
- "title": "string",
- "text": "string",
- "options": [
- {
- "id": "string",
- "text": "string"
}
], - "createdAt": "string"
}
], - "pageInfo": {
- "hasNextPage": true,
- "endCursor": "string"
}
}
질문 조회
Authorizations:
path Parameters
questionId required | string |
header Parameters
authorization required | string |
Responses
Response samples
- 200
- 422
{- "id": "string",
- "questionType": "STATISTICAL",
- "title": "string",
- "text": "string",
- "options": [
- {
- "id": "string",
- "text": "string"
}
], - "createdAt": "string"
}
질문 수정
Authorizations:
path Parameters
questionId required | string |
header Parameters
authorization required | string |
Request Body schema: application/json
type | |
title | string 질문 제목 (위젯에서 노출) |
text | string 질문 내용 (챗봇에서 노출) |
options | Array of strings 질문 옵션 |
Responses
Request samples
- Payload
{- "type": "statistical",
- "title": "string",
- "text": "string",
- "options": [
- "string"
]
}
Response samples
- 200
- 422
{- "id": "string",
- "questionType": "STATISTICAL",
- "title": "string",
- "text": "string",
- "options": [
- {
- "id": "string",
- "text": "string"
}
], - "createdAt": "string"
}
질문 생성
Authorizations:
header Parameters
authorization required | string |
Request Body schema: application/json
type required | |
title required | string 질문 제목 (위젯에서 노출) |
text required | string 질문 내용 (챗봇에서 노출) |
options required | Array of strings 질문 옵션 |
Responses
Request samples
- Payload
{- "type": "statistical",
- "title": "string",
- "text": "string",
- "options": [
- "string"
]
}
Response samples
- 200
- 422
{- "id": "string",
- "questionType": "STATISTICAL",
- "title": "string",
- "text": "string",
- "options": [
- {
- "id": "string",
- "text": "string"
}
], - "createdAt": "string"
}
연결된 상품 목록 조회
Authorizations:
path Parameters
questionId required | string |
query Parameters
first | integer 조회할 개수 |
after | string 조회할 시작 커서 |
header Parameters
authorization required | string |
Responses
Response samples
- 200
- 422
{- "totalCount": 0,
- "data": [
- {
- "id": "string",
- "originId": "string",
- "name": "string",
- "image": {
- "url": "string"
}, - "url": "string",
- "categories": [
- {
- "isPrimary": true,
- "category": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "isVisible": true
}
}
], - "group": {
- "id": "string"
}, - "brand": {
- "id": "string",
- "originId": "string",
- "name": "string"
}, - "isAlimtalkEnabled": "string",
- "reviewCount": 0,
- "reviewRatingAverage": 0
}
], - "pageInfo": {
- "hasNextPage": true,
- "endCursor": "string"
}
}
연결 가능 상품 목록 조회
Authorizations:
path Parameters
questionId required | string |
query Parameters
first | integer 조회할 개수 |
after | string 조회할 시작 커서 |
header Parameters
authorization required | string |
Responses
Response samples
- 200
- 422
{- "totalCount": 0,
- "data": [
- {
- "id": "string",
- "originId": "string",
- "name": "string",
- "image": {
- "url": "string"
}, - "url": "string",
- "categories": [
- {
- "isPrimary": true,
- "category": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "isVisible": true
}
}
], - "group": {
- "id": "string"
}, - "brand": {
- "id": "string",
- "originId": "string",
- "name": "string"
}, - "isAlimtalkEnabled": "string",
- "reviewCount": 0,
- "reviewRatingAverage": 0
}
], - "pageInfo": {
- "hasNextPage": true,
- "endCursor": "string"
}
}
연결된 카테고리 목록 조회
Authorizations:
path Parameters
questionId required | string |
query Parameters
first | integer 조회할 개수 |
after | string 조회할 시작 커서 |
header Parameters
authorization required | string |
Responses
Response samples
- 200
- 422
{- "totalCount": 0,
- "data": [
- {
- "id": "string",
- "originId": "string",
- "name": "string",
- "isVisible": true
}
], - "pageInfo": {
- "hasNextPage": true,
- "endCursor": "string"
}
}
리워드 목록 조회
Authorizations:
query Parameters
first | integer 조회할 개수 |
after | string 조회할 시작 커서 |
status | |
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
- 200
- 422
{- "totalCount": 0,
- "data": [
- {
- "id": "string",
- "amount": 0,
- "reviewCategory": "string",
- "status": "QUEUED",
- "review": {
- "id": "string",
- "createdAt": "string",
- "updatedAt": "string"
}, - "order": {
- "id": "string",
- "originId": "string",
- "memberOriginId": "string"
}, - "orderItem": {
- "id": "string",
- "originId": "string"
}, - "createdAt": "string"
}
], - "pageInfo": {
- "hasNextPage": true,
- "endCursor": "string"
}
}
리워드 조회
Authorizations:
path Parameters
rewardId required | string |
header Parameters
authorization required | string |
Responses
Response samples
- 200
- 422
{- "id": "string",
- "amount": 0,
- "reviewCategory": "string",
- "status": "QUEUED",
- "review": {
- "id": "string",
- "createdAt": "string",
- "updatedAt": "string"
}, - "order": {
- "id": "string",
- "originId": "string",
- "memberOriginId": "string"
}, - "orderItem": {
- "id": "string",
- "originId": "string"
}, - "createdAt": "string"
}
리워드 정보 수정
Authorizations:
path Parameters
rewardId required | string |
header Parameters
authorization required | string |
Request Body schema: application/json
status |
Responses
Request samples
- Payload
{- "status": "QUEUED"
}
Response samples
- 200
- 422
{- "id": "string",
- "amount": 0,
- "reviewCategory": "string",
- "status": "QUEUED",
- "review": {
- "id": "string",
- "createdAt": "string",
- "updatedAt": "string"
}, - "order": {
- "id": "string",
- "originId": "string",
- "memberOriginId": "string"
}, - "orderItem": {
- "id": "string",
- "originId": "string"
}, - "createdAt": "string"
}
일괄 생성 작업 조회
일괄 생성 API로 요청 응답으로 받은 jobId 목록을 가지고 작업 상태를 조회합니다. 생성에 성공한 경우 successObjectId 필드에 생성된 오브젝트의 ID가 반환됩니다. 이 값을 사용해서 오브젝트를 조회할 수 있습니다.
Authorizations:
query Parameters
ids required | Array of strings 작업 ID 목록 (콤마 구분) |
header Parameters
authorization required | string |
Responses
Response samples
- 200
- 422
[- {
- "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"
}
]
An enumeration.
"DUPLICATE_VIDEO"
id required | string 고유 식별자 |
originId required | string |
name required | string |
{- "id": "string",
- "originId": "string",
- "name": "string"
}
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"
}
id required | string 고유 식별자 |
originId required | string |
name required | string |
isVisible required | boolean |
{- "id": "string",
- "originId": "string",
- "name": "string",
- "isVisible": true
}
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"
}
name required | string 메트릭 이름. 브이리뷰 팀에서 안내받은 값을 입력해주세요. (예시: review.view_review) |
date required | string 메트릭 일시 (예시: 2023-01-01T00:00:00+09:00)) |
key required | string 메트릭 키. 브이리뷰 팀에서 안내받은 값을 입력해주세요. (예시: product-12345) |
interval required | string 메트릭 기간 (day, hour) |
value required | number 메트릭 값 |
{- "name": "string",
- "date": "string",
- "key": "string",
- "interval": "string",
- "value": 0
}
originId required | string 고객사 주문 ID |
memberOriginId | string 고객사 회원 ID |
orderedAt required | string <date-time> 주문 일시 |
required | object 주문 수령인 정보 ( |
alimtalkTemplateCode | string 챗봇 템플릿 코드 - 브이리뷰 팀에서 안내받은 템플릿이 없다면 null을 입력해주세요. |
required | Array of objects 주문 아이템 목록 ( |
{- "originId": "string",
- "memberOriginId": "string",
- "orderedAt": "2019-08-24T14:15:22Z",
- "recipient": {
- "name": "string",
- "phone": "string"
}, - "alimtalkTemplateCode": "string",
- "items": [
- {
- "originId": "string",
- "productOriginId": "string",
- "status": "DELIVERED",
- "selectedOptions": [
- {
- "name": "string",
- "value": "string"
}
], - "shipment": {
- "companyCode": "self",
- "trackingNumber": "string",
- "deliveredAt": "2019-08-24T14:15:22Z"
}
}
]
}
originId required | string 고객사 주문 아이템 ID |
productOriginId required | string 고객사 상품 ID |
status | |
Array of objects 주문한 옵션 목록 ( | |
object 배송 정보 ( |
{- "originId": "string",
- "productOriginId": "string",
- "status": "DELIVERED",
- "selectedOptions": [
- {
- "name": "string",
- "value": "string"
}
], - "shipment": {
- "companyCode": "self",
- "trackingNumber": "string",
- "deliveredAt": "2019-08-24T14:15:22Z"
}
}
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" 택배사 코드 ( |
trackingNumber required | string 송장번호 |
deliveredAt | string <date-time> 배송 완료 일시 |
{- "companyCode": "self",
- "trackingNumber": "string",
- "deliveredAt": "2019-08-24T14:15:22Z"
}
originId required | string 고객사 상품 ID |
name required | string 상품 이름 |
imageUrl | string 상품 이미지 URL |
Array of objects 카테고리 목록 ( | |
groupId | string 상품 그룹 ID. 존재하지 않는 ID를 입력한 경우 경우 실패합니다. |
groupName | string 상품 그룹 이름. 존재하지 않는 이름을 입력한 경우 자동으로 상품 그룹을 생성합니다. |
isAlimtalkEnabled | boolean Default: true 알림톡 활성화 여부 |
{- "originId": "string",
- "name": "string",
- "imageUrl": "string",
- "categories": [
- {
- "originId": "string",
- "isPrimary": false
}
], - "groupId": "string",
- "groupName": "string",
- "isAlimtalkEnabled": true
}
originId required | string 고객사 카테고리 ID |
isPrimary | boolean Default: false 주요 카테고리 여부 |
{- "originId": "string",
- "isPrimary": false
}
type required | |
title required | string 질문 제목 (위젯에서 노출) |
text required | string 질문 내용 (챗봇에서 노출) |
options required | Array of strings 질문 옵션 |
{- "type": "statistical",
- "title": "string",
- "text": "string",
- "options": [
- "string"
]
}
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 질문 답변 목록 ( | |
orderItemOriginId | string 고객사 주문 아이템 ID |
createdAt | string <date-time> 리뷰 생성 일시 |
isVisible | boolean Default: true 리뷰 노출 여부 |
{- "originId": "string",
- "productOriginId": "string",
- "authorName": "string",
- "title": "string",
- "videoUrls": [
- "string"
], - "imageUrls": [
- "string"
], - "text": "string",
- "rating": 0,
- "questionAnswers": [
- {
- "question": "string",
- "answer": "string"
}
], - "orderItemOriginId": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "isVisible": true
}
question required | string 질문 내용 |
answer required | string 질문 답변 |
{- "question": "string",
- "answer": "string"
}
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" 택배사 코드 ( |
trackingNumber required | string 송장번호 |
deliveredAt | string <date-time> 배송 완료 일시 |
{- "companyCode": "self",
- "trackingNumber": "string",
- "deliveredAt": "2019-08-24T14:15:22Z"
}
Array of objects | |||||||
Array
|
{- "detail": [
- {
- "loc": [
- "string"
], - "msg": "string",
- "type": "string"
}
]
}
id required | string 고유 식별자 |
uuid required | string |
name required | string |
{- "id": "string",
- "uuid": "string",
- "name": "string"
}
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 리뷰 작성 기한 일수 |
isWidgetEnabled required | boolean 위젯 활성화 여부 |
isSummaryWidgetVideoOnly required | boolean 써머리 위젯에서 비디오 리뷰만 노출할지 여부 |
summaryWidgetVideoThumbnailSize required | string Enum: "THUMBNAIL_90" "THUMBNAIL_128" "THUMBNAIL_164" "THUMBNAIL_210" 써머리 위젯 비디오 썸네일 크기 ( |
isBestReviewWidgetInstalled required | boolean 베스트 리뷰 위젯 설치 여부 |
isBestReviewWidgetEnabled required | boolean 베스트 리뷰 위젯 활성화 여부 |
bestReviewType required | |
isReviewCollectionWidgetInstalled required | boolean 리뷰 모아보기 위젯 설치 여부 |
isReviewCollectionWidgetEnabled required | boolean 리뷰 모아보기 위젯 활성화 여부 |
isProductDetailReviewTabCountWidgetInstalled required | boolean 상품 상세 페이지 리뷰 탭 개수 위젯 설치 여부 |
isProductDetailReviewTabCountWidgetEnabled required | boolean 상품 상세 페이지 리뷰 탭 개수 위젯 활성화 여부 |
isProductDetailReviewTabPopupWidgetInstalled required | boolean 상품 상세 페이지 리뷰 탭 팝업 위젯 설치 여부 |
isProductDetailReviewTabPopupWidgetEnabled required | boolean 상품 상세 페이지 리뷰 탭 팝업 위젯 활성화 여부 |
languageFilterSubstitutions required | Array of strings 리뷰 텍스트에 포함된 특정 단어를 다른 단어로 치환합니다. 필터링 단어와 대체어는 '/' 로 구분됩니다. 만약 '/'가 없다면 대체어는 사용되지 않습니다. 예) '금지어/대체어', '금지어' |
reviewDefaultOrdering required | |
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,
- "isWidgetEnabled": true,
- "isSummaryWidgetVideoOnly": true,
- "summaryWidgetVideoThumbnailSize": "THUMBNAIL_90",
- "isBestReviewWidgetInstalled": true,
- "isBestReviewWidgetEnabled": true,
- "bestReviewType": "SINGLE",
- "isReviewCollectionWidgetInstalled": true,
- "isReviewCollectionWidgetEnabled": true,
- "isProductDetailReviewTabCountWidgetInstalled": true,
- "isProductDetailReviewTabCountWidgetEnabled": true,
- "isProductDetailReviewTabPopupWidgetInstalled": true,
- "isProductDetailReviewTabPopupWidgetEnabled": true,
- "languageFilterSubstitutions": [
- "string"
], - "reviewDefaultOrdering": "CREATED",
- "idleTimeoutMinutes": 0,
- "twoFactorAuthPhoneNumber": "string"
}
name required | string 메트릭 이름 |
date required | string 메트릭 일시 |
key required | string 메트릭 키 |
interval required | string 메트릭 기간 |
value required | number 메트릭 값 |
{- "name": "string",
- "date": "string",
- "key": "string",
- "interval": "string",
- "value": 0
}
id required | string 고유 식별자 |
originId required | string 주문 번호 |
orderedAt required | string 주문 일시 |
memberOriginId | string 고객사 회원 ID |
alimtalkTemplateCode | string 알림톡 템플릿 코드 |
required | object 주문 수령인 정보 ( |
required | Array of objects |
{- "id": "string",
- "originId": "string",
- "orderedAt": "string",
- "memberOriginId": "string",
- "alimtalkTemplateCode": "string",
- "recipient": {
- "name": "string",
- "phone": "string"
}, - "items": [
- {
- "id": "string",
- "originId": "string",
- "status": "DELIVERED",
- "product": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "image": {
- "url": "string"
}, - "url": "string",
- "categories": [
- {
- "isPrimary": true,
- "category": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "isVisible": true
}
}
], - "group": {
- "id": "string"
}, - "brand": {
- "id": "string",
- "originId": "string",
- "name": "string"
}, - "isAlimtalkEnabled": "string",
- "reviewCount": 0,
- "reviewRatingAverage": 0
}, - "selectedOptions": [
- {
- "name": "string",
- "value": "string"
}
], - "shipment": {
- "companyCode": "string",
- "trackingNumber": "string",
- "deliveredAt": "string"
}
}
]
}
id required | string 고유 식별자 |
originId required | string 주문 아이템 번호 |
status | |
object 주문 상품 정보 ( | |
required | Array of objects 주문한 옵션 목록 ( |
object 주문 상품 정보 ( |
{- "id": "string",
- "originId": "string",
- "status": "DELIVERED",
- "product": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "image": {
- "url": "string"
}, - "url": "string",
- "categories": [
- {
- "isPrimary": true,
- "category": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "isVisible": true
}
}
], - "group": {
- "id": "string"
}, - "brand": {
- "id": "string",
- "originId": "string",
- "name": "string"
}, - "isAlimtalkEnabled": "string",
- "reviewCount": 0,
- "reviewRatingAverage": 0
}, - "selectedOptions": [
- {
- "name": "string",
- "value": "string"
}
], - "shipment": {
- "companyCode": "string",
- "trackingNumber": "string",
- "deliveredAt": "string"
}
}
name required | string 옵션 이름 |
value required | string 옵션 값 |
{- "name": "string",
- "value": "string"
}
An enumeration.
"DELIVERED"
hasNextPage required | boolean When paginating forwards, are there more items? |
endCursor | string When paginating forwards, the cursor to continue. |
{- "hasNextPage": true,
- "endCursor": "string"
}
id required | string 고유 식별자 |
originId required | string 고객사 상품 ID |
name required | string 상품 이름 |
object 상품 이미지 ( | |
url | string 상품 URL |
required | Array of objects 카테고리 목록 ( |
object 상품 그룹 ( | |
object 브랜드 ( | |
isAlimtalkEnabled required | string 알림톡 활성화 여부 |
reviewCount required | integer 리뷰 개수 |
reviewRatingAverage required | number 리뷰 평점 |
{- "id": "string",
- "originId": "string",
- "name": "string",
- "image": {
- "url": "string"
}, - "url": "string",
- "categories": [
- {
- "isPrimary": true,
- "category": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "isVisible": true
}
}
], - "group": {
- "id": "string"
}, - "brand": {
- "id": "string",
- "originId": "string",
- "name": "string"
}, - "isAlimtalkEnabled": "string",
- "reviewCount": 0,
- "reviewRatingAverage": 0
}
isPrimary required | boolean |
required | object |
{- "isPrimary": true,
- "category": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "isVisible": true
}
}
id required | string 고유 식별자 |
name required | string 상품 그룹 이름 |
object 상품 그룹 썸네일 (Not Implemented) ( | |
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": {
- "url": "string"
}, - "productCount": 0,
- "reviewCount": 0,
- "reviewRatingAverage": 0,
- "createdAt": "string",
- "updatedAt": "string"
}
An enumeration.
"name"
id required | string 고유 식별자 |
questionType required | |
title required | string 질문 제목 |
text required | string 질문 내용 |
required | Array of objects |
createdAt required | string 생성 일시 |
{- "id": "string",
- "questionType": "STATISTICAL",
- "title": "string",
- "text": "string",
- "options": [
- {
- "id": "string",
- "text": "string"
}
], - "createdAt": "string"
}
id required | string 고유 식별자 |
originId | string 이관된 리뷰의 경우 고객사 리뷰 ID |
userNickname | string 리뷰 작성자 이름 |
title | string 리뷰 제목 |
text | string 리뷰 본문 |
rating | integer 리뷰 평점 (1-5) |
uploadFrom | |
required | Array of objects 리뷰 비디오 목록 ( |
required | Array of objects 리뷰 이미지 목록 ( |
object 리뷰 상품 정보 ( | |
object 리뷰 주문 정보 ( | |
required | Array of objects 질문 답변 목록 ( |
isVisible | boolean 리뷰 노출 여부 |
isBlocked | boolean 리뷰 노출 제한 여부 |
blockReason | string Enum: "DUPLICATE_VIDEO" "DUPLICATE_IMAGE" "POTENTIAL_ADULT" "POTENTIAL_VIOLENCE" "ADULT" "VIOLENCE" 리뷰 노출 제한 사유 ( |
helpfulCount required | integer 유용해요 개수 |
reportStatus | |
mabScore required | number 톰슨 샘플링 점수 |
sentimentScore required | number 리뷰 긍부정 점수 |
required | Array of objects 리뷰 긍부정 키워드 목록 ( |
productRelativenessScore required | number 상품 유무관 점수 (beta) |
createdAt required | string 작성 일시 |
updatedAt required | string 수정 일시 |
{- "id": "string",
- "originId": "string",
- "userNickname": "string",
- "title": "string",
- "text": "string",
- "rating": 0,
- "uploadFrom": "CHATBOT",
- "videos": [
- {
- "urls": {
- "thumbnail": "string",
- "large": "string"
}
}
], - "images": [
- {
- "urls": {
- "thumbnail": "string",
- "large": "string"
}
}
], - "product": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "image": {
- "url": "string"
}, - "url": "string",
- "categories": [
- {
- "isPrimary": true,
- "category": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "isVisible": true
}
}
], - "group": {
- "id": "string"
}, - "brand": {
- "id": "string",
- "originId": "string",
- "name": "string"
}, - "isAlimtalkEnabled": "string",
- "reviewCount": 0,
- "reviewRatingAverage": 0
}, - "order": {
- "id": "string",
- "originId": "string",
- "orderedAt": "string",
- "memberOriginId": "string",
- "alimtalkTemplateCode": "string",
- "recipient": {
- "name": "string",
- "phone": "string"
}, - "items": [
- {
- "id": "string",
- "originId": "string",
- "status": "DELIVERED",
- "product": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "image": {
- "url": "string"
}, - "url": "string",
- "categories": [
- {
- "isPrimary": true,
- "category": {
- "id": "string",
- "originId": "string",
- "name": "string",
- "isVisible": true
}
}
], - "group": {
- "id": "string"
}, - "brand": {
- "id": "string",
- "originId": "string",
- "name": "string"
}, - "isAlimtalkEnabled": "string",
- "reviewCount": 0,
- "reviewRatingAverage": 0
}, - "selectedOptions": [
- {
- "name": "string",
- "value": "string"
}
], - "shipment": {
- "companyCode": "string",
- "trackingNumber": "string",
- "deliveredAt": "string"
}
}
]
}, - "questionAnswers": [
- {
- "question": {
- "text": "string"
}, - "answer": {
- "text": "string"
}
}
], - "isVisible": true,
- "isBlocked": true,
- "blockReason": "DUPLICATE_VIDEO",
- "helpfulCount": 0,
- "reportStatus": "PENDING",
- "mabScore": 0,
- "sentimentScore": 0,
- "sentimentKeywords": [
- {
- "text": "string",
- "startIndex": 0,
- "endIndex": 0
}
], - "productRelativenessScore": 0,
- "createdAt": "string",
- "updatedAt": "string"
}
id required | string 고유 식별자 |
text required | string 댓글 본문 |
createdAt required | string 작성 일시 |
updatedAt required | string 수정 일시 |
{- "id": "string",
- "text": "string",
- "createdAt": "string",
- "updatedAt": "string"
}
required | object | ||||
|
{- "urls": {
- "thumbnail": "string",
- "large": "string"
}
}
thumbnail required | string |
large required | string |
{- "thumbnail": "string",
- "large": "string"
}
An enumeration.
"REVIEW_TYPE"
required | object |
required | object |
{- "question": {
- "text": "string"
}, - "answer": {
- "text": "string"
}
}
id required | string 고유 식별자 |
reason required | string Enum: "ILLEGAL" "PERSONAL_INFO" "SPAM" "IRRELEVANT" "MISLEADING" "INAPPROPRIATE" "DUPLICATED" "ETC" 신고 사유 ( |
text required | string 신고 내용 |
isChecked required | boolean 신고 처리 여부 |
required | object 리뷰 ( |
createdAt required | string 작성 일시 |
updatedAt required | string 수정 일시 |
{- "id": "string",
- "reason": "ILLEGAL",
- "text": "string",
- "isChecked": true,
- "review": {
- "id": "string"
}, - "createdAt": "string",
- "updatedAt": "string"
}
An enumeration.
"ILLEGAL"
text required | string 키워드 |
startIndex required | integer 문장 내 시작 인덱스 |
endIndex required | integer 문장 내 끝 인덱스 |
{- "text": "string",
- "startIndex": 0,
- "endIndex": 0
}
required | object | ||||
|
{- "urls": {
- "thumbnail": "string",
- "large": "string"
}
}
thumbnail required | string |
large required | string |
{- "thumbnail": "string",
- "large": "string"
}
id required | string 고유 식별자 |
originId required | string 주문 번호 |
memberOriginId | string 고객사 회원 ID |
{- "id": "string",
- "originId": "string",
- "memberOriginId": "string"
}
id required | string 고유 식별자 |
originId required | string 주문 아이템 번호 |
{- "id": "string",
- "originId": "string"
}
id required | string 고유 식별자 |
amount required | integer 적립금 지급액 |
reviewCategory required | string 리뷰 카테고리 |
status required | |
required | object 리뷰 ( |
object 주문 ( | |
object 주문 아이템 ( | |
createdAt required | string 작성 일시 |
{- "id": "string",
- "amount": 0,
- "reviewCategory": "string",
- "status": "QUEUED",
- "review": {
- "id": "string",
- "createdAt": "string",
- "updatedAt": "string"
}, - "order": {
- "id": "string",
- "originId": "string",
- "memberOriginId": "string"
}, - "orderItem": {
- "id": "string",
- "originId": "string"
}, - "createdAt": "string"
}
An enumeration.
"QUEUED"
id required | string 고유 식별자 |
createdAt required | string 작성 일시 |
updatedAt required | string 수정 일시 |
{- "id": "string",
- "createdAt": "string",
- "updatedAt": "string"
}
companyCode required | string 택배사 코드 |
trackingNumber required | string 송장번호 |
deliveredAt | string 배송 완료 일시 |
{- "companyCode": "string",
- "trackingNumber": "string",
- "deliveredAt": "string"
}
코드 | 택배사 |
---|---|
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"
name | string 카테고리 이름 |
isVisible | boolean Default: true 카테고리 노출 여부 |
position | integer 카테고리 노출 순서 |
parentOriginId | integer 부모 카테고리 고유 ID |
{- "name": "string",
- "isVisible": true,
- "position": 0,
- "parentOriginId": 0
}
isDeliveryAlimtalkEnabled | boolean 배송 완료 알림톡 활성화 여부 |
isThanksAlimtalkEnabled | boolean 감사톡 활성화 여부 |
isMonthlyAlimtalkEnabled | boolean 한달톡 활성화 여부 |
thanksAlimtalkDelayDays | integer 배송 완료일 기준 감사톡 발송 지연 일수 |
rewardName | string 리워드 이름 |
rewardUnit | string 리워드 단위 |
isAutomaticRewardEnabled | boolean 리워드 자동 지급 여부 |
videoReviewRewardAmount | integer 비디오 리뷰 리워드 수량 |
imageReviewRewardAmount | integer 이미지 리뷰 리워드 수량 |
textReviewRewardAmount | integer 텍스트 리뷰 리워드 수량 |
textReviewRewardCondition | integer 텍스트 리뷰 최소 글자수 조건 |
reviewAllowedDays | integer 리뷰 작성 기한 일수 |
isWidgetEnabled | boolean 위젯 활성화 여부 |
isSummaryWidgetVideoOnly | boolean 써머리 위젯에서 비디오 리뷰만 노출할지 여부 |
summaryWidgetVideoThumbnailSize | string Enum: "THUMBNAIL_90" "THUMBNAIL_128" "THUMBNAIL_164" "THUMBNAIL_210" 써머리 위젯 비디오 썸네일 크기 ( |
isBestReviewWidgetInstalled | boolean 베스트 리뷰 위젯 설치 여부 |
isBestReviewWidgetEnabled | boolean 베스트 리뷰 위젯 활성화 여부 |
bestReviewType | |
isReviewCollectionWidgetInstalled | boolean 리뷰 모아보기 위젯 설치 여부 |
isReviewCollectionWidgetEnabled | boolean 리뷰 모아보기 위젯 활성화 여부 |
isProductDetailReviewTabCountWidgetInstalled | boolean 상품 상세 페이지 리뷰 탭 개수 위젯 설치 여부 |
isProductDetailReviewTabCountWidgetEnabled | boolean 상품 상세 페이지 리뷰 탭 개수 위젯 활성화 여부 |
isProductDetailReviewTabPopupWidgetInstalled | boolean 상품 상세 페이지 리뷰 탭 팝업 위젯 설치 여부 |
isProductDetailReviewTabPopupWidgetEnabled | boolean 상품 상세 페이지 리뷰 탭 팝업 위젯 활성화 여부 |
reviewTextProhibitedWords | Array of strings 리뷰 금칙어 목록 |
reviewDefaultOrdering | |
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,
- "isWidgetEnabled": true,
- "isSummaryWidgetVideoOnly": true,
- "summaryWidgetVideoThumbnailSize": "THUMBNAIL_90",
- "isBestReviewWidgetInstalled": true,
- "isBestReviewWidgetEnabled": true,
- "bestReviewType": "SINGLE",
- "isReviewCollectionWidgetInstalled": true,
- "isReviewCollectionWidgetEnabled": true,
- "isProductDetailReviewTabCountWidgetInstalled": true,
- "isProductDetailReviewTabCountWidgetEnabled": true,
- "isProductDetailReviewTabPopupWidgetInstalled": true,
- "isProductDetailReviewTabPopupWidgetEnabled": true,
- "reviewTextProhibitedWords": [
- "string"
], - "reviewDefaultOrdering": "CREATED",
- "idleTimeoutMinutes": 0,
- "twoFactorAuthPhoneNumber": "string"
}
memberOriginId | string 고객사 회원 ID |
orderedAt | string <date-time> 주문 일시 |
object 주문 수령인 정보 ( | |
alimtalkTemplateCode | string 챗봇 템플릿 코드 - 브이리뷰 팀에서 안내받은 템플릿이 없다면 null을 입력해주세요. |
Array of objects 주문 아이템 목록 ( |
{- "memberOriginId": "string",
- "orderedAt": "2019-08-24T14:15:22Z",
- "recipient": {
- "name": "string",
- "phone": "string"
}, - "alimtalkTemplateCode": "string",
- "items": [
- {
- "originId": "string",
- "productOriginId": "string",
- "status": "DELIVERED",
- "selectedOptions": [
- {
- "name": "string",
- "value": "string"
}
], - "shipment": {
- "companyCode": "self",
- "trackingNumber": "string",
- "deliveredAt": "2019-08-24T14:15:22Z"
}
}
]
}
productOriginId required | string 고객사 상품 ID |
status | |
Array of objects 주문한 옵션 목록 ( | |
object 배송 정보 ( |
{- "productOriginId": "string",
- "status": "DELIVERED",
- "selectedOptions": [
- {
- "name": "string",
- "value": "string"
}
], - "shipment": {
- "companyCode": "self",
- "trackingNumber": "string",
- "deliveredAt": "2019-08-24T14:15:22Z"
}
}
name | string 상품 이름 |
imageUrl | string 상품 이미지 URL |
Array of objects 카테고리 목록 ( | |
groupId | string 상품 그룹 ID |
isAlimtalkEnabled | boolean Default: true 알림톡 활성화 여부 |
{- "name": "string",
- "imageUrl": "string",
- "categories": [
- {
- "originId": "string",
- "isPrimary": false
}
], - "groupId": "string",
- "isAlimtalkEnabled": true
}
type | |
title | string 질문 제목 (위젯에서 노출) |
text | string 질문 내용 (챗봇에서 노출) |
options | Array of strings 질문 옵션 |
{- "type": "statistical",
- "title": "string",
- "text": "string",
- "options": [
- "string"
]
}
status |
{- "status": "QUEUED"
}
username | string 로그인 아이디 |
name | string 이름 |
phoneNumber | string 연락처 |
string 이메일 |
{- "username": "string",
- "name": "string",
- "phoneNumber": "string",
- "email": "string"
}
id required | string 고유 식별자 |
username required | string 로그인 아이디 |
name | string 이름 |
phoneNumber | string 연락처 |
string 이메일 | |
passwordChangedAt | string 비밀번호 변경 일시 |
{- "id": "string",
- "username": "string",
- "name": "string",
- "phoneNumber": "string",
- "email": "string",
- "passwordChangedAt": "string"
}
required | Array of strings or integers |
msg required | string |
type required | string |
{- "loc": [
- "string"
], - "msg": "string",
- "type": "string"
}
An enumeration.
"THUMBNAIL_90"