Product

API Resources #

Product #

Product #

Column Name Type RW/RO Required Note
id Int32 RO Product ID (SKU)
name String RO Product name
partNo String RO Part Number
listingIdList Int32[] RO Listing ID list, if the product has been used for listings
sku Int32 RO 商品 ID
stock Int32 RO 商品庫存
cost String RO 商品成本
images ProductImage[] RO 商品圖片
structuredData StructuredData RO 商品規格表
spec Attribute RO 單層屬性商品的屬性名稱與項目 / 雙層屬性商品的第 2 層屬性名稱與項目
parentSpec Attribute RO 雙層屬性商品的第 1 層屬性名稱與項目，單層及無屬性商品無此欄位。
isExpiringItem Boolean RO 是否為即期品
isInstallRequired Boolean RO 是否需要安裝
isNeedRecycle Boolean RO 是否屬於廢四機
minPackingCount Int32 RO 最小包裝數
taxable Boolean RO 商品是否應稅
msrp String RO 廠商建議價
brand String RO 品牌
length Int32 RO 包裝完成後的商品長度
width Int32 RO 包裝完成後的商品寬度
height Int32 RO 包裝完成後的商品高度
weight Int32 RO 包裝完成後的商品重量
preserveDays Int32 RO 商品保存期限
catId String RO 商品目前的分類父類 ID, e.g. cat1610
catItemId String RO 商品目前的分類子類 ID, e.g. catItem21704
isSoftGame Boolean RO 是否為遊戲軟體
gameContents String[] RO 遊戲情節內容，若 isSoftGame = false 則此欄位為空
shipType ShipType RO 配送方式
availableCount Int32 RO 商品可售數量

ProductImage 商品圖片 #

Column Name Type RW/RO Required [註1] Note
url String RW POST: Y
PUT: Y		 圖檔 URL
width Int32 RW POST: ?
PUT: ?		 Width of the image in pixels.
Options:
  • 1000
  • 400
  • 250
  • 135
  • 80
height Int32 RW POST: ?
PUT: ?		 Height of the image in pixels.
Options:
  • 1000
  • 400
  • 250
  • 135
  • 80
order Int32 RW POST: Y
PUT: Y		 Order, starts from 1

ProductVideo 商品影片 #

Column Name Type RW/RO Required [註1] Note
url String RW POST: Y
PUT: Y		 影片 URL
此內容必須是 FQDN 為 {s|ct}.yimg.com 的連結或賣場使用的影片 URL，且此欄位必需為 https 協定
目前支援的 Video Codecs 請見列表
duration Int32 RO Duration of the video in millisecond. It’s only present for the output preset.
width Int32 RO Width of the video in pixels.
height Int32 RO Height of the video in pixels.
thumbnail ProductImage RO 預覽圖
order Int32 RW POST: Y
PUT: Y		 Order, starts from 1

Products #

Column Name Type RW/RO Required Note
products Product[] RO Product list
pagination Pagination RO Pagination

ProductWarranty 商品保證 #

Column Name Type RW/RO Required [註1] Note
period String RW POST: Y
PUT: N		 保固期限
長度限制：最長 20 個字
格式：不允許大小於符號和換行
Default: 無保固
如果內容值為無保固則保固範圍及保固來源可不填，反之若為其他值則必填
scope String RW POST: ?
PUT: ?		 保固範圍
長度限制：最長 20 個字
格式：不允許大小於符號和換行
若保固期限為無保固，自動填入無保固
handler String RW POST: ?
PUT: ?		 保固來源
Options:
  • none: 無保固
  • official: 原廠保固
  • retailer: 經銷保固
若保固期限為無保固，只能為none (若有輸入會被取代)
若保固期限不為無保固，預設為official
productStatus String RW POST: ?
PUT: ?		 商品狀態資訊
Options:
  • new: 全新產品
  • welfare: 福利產品
  • refurbished: 整新產品
Default: new
description String RW POST: N
PUT: N		 保固說明
長度限制：最長 800 個字
格式：不允許大小於符號