Goods (REQUEST)
- 상품 REQUEST 객체
Name | Type | Required | Description | Note |
---|---|---|---|---|
id | int64 | X | 샵라이브에서 부여한 상품 고유의 ID | 상품 id를 이용한 상품 수정시에만 요구됩니다. |
name | string | O | 상품명 | |
brand | string | X | 상품 브랜드명 | |
brandIdentifier | string | X | 상품 ID | 브랜드명 외에 상품의 브랜드를 구분하기 위해 고객사가 직접 입력하는 브랜드 구분값입니다. 상품 클릭 시 호출되는 콜백에 포함되며 이 기능이 활성화된 고객사만 이용할 수 있는 값입니다. |
description | string | X | 상품 설명 | |
url | string | O | 상품 URL | url은 중복될 수 없습니다. |
sku | string | X | 상품 코드 | sku는 중복될 수 없습니다. |
mediaUrl | string | X | 상품 이미지 URL | 해당 이미지를 SHOPLIVE 저장소에 복제하고 썸네일을 생성합니다. |
originalPrice | double | O | 판매가 | |
discountedPrice | double | X | 할인가 | 값이 없을 경우 판매가와 동일하게 설정됩니다. |
customOriginalPrice | string | X | 임의 표시 판매가 | 임의의 문자열로 사용자가 보는 판매가 를 설정할 수 있습니다.미설정 시 originalPrice 가 표시됩니다. |
customDiscountedPrice | string | X | 임의 표시 할인가 | 임의의 문자열로 사용자가 보는 할인가 를 설정할 수 있습니다.미설정 시 discountedPrice 가 표시됩니다. |
discountPercentage | double | X | 할인율 | 임의의 할인율을 백분율 단위로 입력할 수 있습니다 (0.0~100.0). |
Goods (RESPONSE)
- 상품 RESPONSE 객체
Name | Type | Description | Note |
---|---|---|---|
id | int64! | 샵라이브에서 부여한 상품 고유의 ID | |
customerId | int64! | 고객사 ID | 샵라이브에 등록된 고객사 ID |
name | string! | 상품명 | |
brand | string? | 상품 브랜드명 | |
brandIdentifier | string? | 상품 브랜드ID | |
description | string? | 상품 설명 | |
url | string! | 상품 URL | |
sku | string? | 상품 코드 | |
mediaUrl | string? | 상품의 원본 이미지 URL | |
medias | list<GoodsMedia>? | 업로드한 상품의 이미지의 원본 및 썸네일 목록 정보 | 가로 기준 120px , 240px , 480px 의 썸네일 3종이 생성됩니다.list형태이나 현재는 1개의 원본 이미지만 지원합니다. |
originalPrice | double? | 판매가 | |
discountedPrice | double? | 할인가 | |
customOriginalPrice | string? | 임의 표시 판매가 | 임의의 문자열로 사용자가 보는 판매가 를 설정할 수 있습니다.미설정 시 originalPrice 가 표시됩니다. |
customDiscountedPrice | string? | 임의 표시 할인가 | 임의의 문자열로 사용자가 보는 할인가 를 설정할 수 있습니다.미설정 시 discountedPrice 가 표시됩니다. |
currency | string! | 통화 | KRW |
discountPercentage | double? | 할인율 | 임의의 할인율을 백분율 단위로 입력할 수 있습니다 (0.0~100.0). |
adminId | int64? | 관리자 ID | 상품을 등록한 관리자 ID |
adminName | string? | 관리자 이름 | |
createdAt | timestamp! | 생성 시각 | |
updatedAt | timestamp! | 수정 시각 | |
locked | bool? | 삭제 가능 여부 | 캠페인에 등록되어 있어 삭제가 불가능할 경우 true |
UploadGoodsRowResult (extends Goods)
- Goods (response) 객체에 row, status, message가 포함되어 있는 객체입니다.
Name | Type | Description | Note |
---|---|---|---|
row | int32! | 행 번호 | |
status | string! | 처리 결과 | CREATE , UPDATE , FAIL |
message | string? | 에러 메시지 |
GoodsMedia
Name | Type | Description | Note |
---|---|---|---|
id | int64? | 샵라이브에서 부여한 이미지 고유의 ID | |
customerId | int64! | 고객사 ID | |
mediaType | string | IMAGE | 현재는 IMAGE type만 지원합니다. |
name | string | 이미지 이름 | unused |
description | string | 이미지 설명 | unused |
url | string! | 원본 이미지 URL | |
checksum | string | 이미지 체크썸 | 동일 이미지 여부 확인을 위한 체크썸 |
size | int64 | 원본 이미지 용량 | |
width | int32 | 원본 이미지 너비 | |
height | int32 | 원본 이미지 높이 | |
historyId | int64 | unused | |
thumbnails | list<Image> | 썸네일 목록 | |
createdAt | timestamp | 생성 시각 | |
updatedAt | timestamp | 수정 시각 |
Image
Name | Type | Description | Note |
---|---|---|---|
imageUrl | string! | 썸네일 이미지 URL | |
size | int64 | 썸네일 이미지 용량 | size 필드는 deprecate 되었습니다.(삭제 예정) |
width | int32 | 썸네일 이미지 너비 | 가로 기준 120px , 240px , 480px 의 썸네일 3종이 생성됩니다. |
height | int32 | 썸네일 이미지 높이 |