상품 관련 객체

Goods (REQUEST)

  • 상품 REQUEST 객체
NameTypeRequiredDescriptionNote
idint64X샵라이브에서 부여한 상품 고유의 ID상품 id를 이용한 상품 수정시에만 요구됩니다.
namestringO상품명
brandstringX상품 브랜드명
brandIdentifierstringX상품 ID브랜드명 외에 상품의 브랜드를 구분하기 위해 고객사가 직접 입력하는 브랜드 구분값입니다. 상품 클릭 시 호출되는 콜백에 포함되며 이 기능이 활성화된 고객사만 이용할 수 있는 값입니다.
descriptionstringX상품 설명
urlstringO상품 URLurl은 중복될 수 없습니다.
skustringX상품 코드sku는 중복될 수 없습니다.
mediaUrlstringX상품 이미지 URL해당 이미지를 SHOPLIVE 저장소에 복제하고 썸네일을 생성합니다.
originalPricedoubleO판매가
discountedPricedoubleX할인가값이 없을 경우 판매가와 동일하게 설정됩니다.
customOriginalPricestringX임의 표시 판매가임의의 문자열로 사용자가 보는 판매가를 설정할 수 있습니다.
미설정 시 originalPrice가 표시됩니다.
customDiscountedPricestringX임의 표시 할인가임의의 문자열로 사용자가 보는 할인가를 설정할 수 있습니다.
미설정 시 discountedPrice가 표시됩니다.
discountPercentagedoubleX할인율임의의 할인율을 백분율 단위로 입력할 수 있습니다 (0.0~100.0).

Goods (RESPONSE)

  • 상품 RESPONSE 객체
NameTypeDescriptionNote
idint64!샵라이브에서 부여한 상품 고유의 ID
customerIdint64!고객사 ID샵라이브에 등록된 고객사 ID
namestring!상품명
brandstring?상품 브랜드명
brandIdentifierstring?상품 브랜드ID
descriptionstring?상품 설명
urlstring!상품 URL
skustring?상품 코드
mediaUrlstring?상품의 원본 이미지 URL
mediaslist<GoodsMedia>?업로드한 상품의 이미지의 원본 및 썸네일 목록 정보가로 기준 120px, 240px, 480px의 썸네일 3종이 생성됩니다.
list형태이나 현재는 1개의 원본 이미지만 지원합니다.
originalPricedouble?판매가
discountedPricedouble?할인가
customOriginalPricestring?임의 표시 판매가임의의 문자열로 사용자가 보는 판매가를 설정할 수 있습니다.
미설정 시 originalPrice가 표시됩니다.
customDiscountedPricestring?임의 표시 할인가임의의 문자열로 사용자가 보는 할인가를 설정할 수 있습니다.
미설정 시 discountedPrice가 표시됩니다.
currencystring!통화KRW
discountPercentagedouble?할인율임의의 할인율을 백분율 단위로 입력할 수 있습니다 (0.0~100.0).
adminIdint64?관리자 ID상품을 등록한 관리자 ID
adminNamestring?관리자 이름
createdAttimestamp!생성 시각
updatedAttimestamp!수정 시각
lockedbool?삭제 가능 여부캠페인에 등록되어 있어 삭제가 불가능할 경우 true

UploadGoodsRowResult (extends Goods)

  • Goods (response) 객체에 row, status, message가 포함되어 있는 객체입니다.
NameTypeDescriptionNote
rowint32!행 번호
statusstring!처리 결과CREATE, UPDATE, FAIL
messagestring?에러 메시지

GoodsMedia

NameTypeDescriptionNote
idint64?샵라이브에서 부여한 이미지 고유의 ID
customerIdint64!고객사 ID
mediaTypestringIMAGE현재는 IMAGE type만 지원합니다.
namestring이미지 이름unused
descriptionstring이미지 설명unused
urlstring!원본 이미지 URL
checksumstring이미지 체크썸동일 이미지 여부 확인을 위한 체크썸
sizeint64원본 이미지 용량
widthint32원본 이미지 너비
heightint32원본 이미지 높이
historyIdint64unused
thumbnailslist<Image>썸네일 목록
createdAttimestamp생성 시각
updatedAttimestamp수정 시각

Image

NameTypeDescriptionNote
imageUrlstring!썸네일 이미지 URL
sizeint64썸네일 이미지 용량size 필드는 deprecate되었습니다.(삭제 예정)
widthint32썸네일 이미지 너비가로 기준 120px, 240px, 480px의 썸네일 3종이 생성됩니다.
heightint32썸네일 이미지 높이