API Resources #
Listing #
ListingComplimentaryGroup #
| Column Name | Type | RW/RO | Required | Note |
|---|---|---|---|---|
| groupSku | Int32 | RO | 贈品群組主商品 ID | |
| groupName | String | RO | 贈品群組主商品名稱 | |
| activityName | String | RO | 贈品活動名稱 | |
| images | ProductImage[] | RO | 贈品群組主商品圖片 |
ListingItem #
| Column Name | Type | RW/RO | Required | Note |
|---|---|---|---|---|
| sku | Int32 | RO | 第 2 層屬性商品 ID | |
| groupSku | Int32 | RO | 第 2 層屬性若為贈品,則表示贈品商品之所屬群組 | |
| name | String | RO | 第 2 層屬性商品名稱 其值為: ListingModel.name-spec.selectedValue |
|
| partNo | String | RO | 第 2 層屬性商品供應商商品料號 | |
| images | ProductImage[] | RO | 第 2 層屬性商品圖片 若為贈品群組裡面的贈品商品時為空 |
|
| spec | Attribute | RO | 第 2 層屬性商品型號 Spec | |
| cost | String | RO | 第 2 層屬性商品成本 | |
| availableCount | Int32 | RO | 第 2 層屬性商品可售數量 | |
| isVisible | Boolean | RO | 第 2 層屬性是否顯示於前台賣場 | |
| actualBarcode | String | RO | 雙層屬性商品實際國際條碼 | |
| stock | Int32 | RO | 雙層屬性商品備貨數量 | |
| price | String | RO | 商品售價 | |
| shortTitle | String | RO | 商品短標題 | |
| attributes | Attribute[] | RO | 雙層屬性商品規格表,內容包含和屬性名稱相同之規格 |
ListingModel #
| Column Name | Type | RW/RO | Required | Note |
|---|---|---|---|---|
| sku | Int32 | RO | 第 1 層屬性商品 ID | |
| name | String | RO | 第 1 層屬性商品名稱 其值為: Listing.name-spec.selectedValue |
|
| videos | ProductVideo[] | RO | 第 1 層屬性商品影片 | |
| items | ListingItem[] | RO | 第 1 層屬性商品型號 | |
| partNo | String | RO | 第 1 層屬性商品供應商商品料號 | |
| images | ProductImage[] | RO | 第 1 層屬性商品圖片 | |
| spec | Attribute | RO | 第 1 層屬性商品型號 Spec | |
| cost | String | RO | 第 1 層屬性商品成本 | |
| availableCount | Int32 | RO | 第 1 層屬性商品可售數量 | |
| isVisible | Boolean | RO | 第 1 層屬性是否顯示於前台賣場 | |
| actualBarcode | String | RO | 單層屬性商品實際國際條碼 | |
| stock | Int32 | RO | 單層屬性商品備貨數量 | |
| shortTitle | String | RO | 商品短標題 | |
| attributes | Attribute[] | RO | 單層屬性商品規格表,內容包含和屬性名稱相同之規格 |
SkuDetail #
| Column Name | Type | RW/RO | Required | Note |
|---|---|---|---|---|
| shipType | ShipType | RO | 配送方式 | |
| struDataAttrClusterId | String | RO | Structured data attribute cluster ID 若賣場 SKU 有規格表資料,則顯示此欄位 |
|
| name | String | RO | 商品名稱 | |
| eVoucherType | String | RO | 當配送方式為電子票券時,顯示電子票券類型 |
|
| eVoucherAttributes | VoucherAttribute[] | RO | 當配送方式為電子票券時,顯示電子票券資訊 |
Listing #
| Column Name | Type | RW/RO | Required | Note |
|---|---|---|---|---|
| id | Int32 | RO | Listing ID | |
| catItemId | String | RO | 子類 ID, e.g. catItem21704 | |
| catItemName | String | RO | 子類名稱 | |
| catId | String | RO | 父類 ID, e.g. cat1610 | |
| catName | String | RO | 父類名稱 | |
| subStationId | String | RO | 子站 ID, e.g. sub1 | |
| subStationName | String | RO | 子站名稱 | |
| zoneId | String | RO | 區 ID, e.g. z3 | |
| zoneName | String | RO | 區名稱 | |
| price | String | RO | 售價 | |
| availableCount | Int32 | RO | 無屬性賣場商品可售數量 | |
| copy | String | RO | 商品詳情 (文案),HTML content | |
| swCode | String | RO | 隱藏賣場 SW code | |
| name | String | RO | 賣場名稱 | |
| sku | Int32 | RO | 賣場 SKU | |
| skuSubStationId | String | RO | 賣場 SKU 商品子站 ID | |
| models | ListingModel[] | RO | 屬性商品型號 | |
| videos | ProductVideo[] | RO | 賣場影片 | |
| partNo | String | RO | 供應商商品料號 | |
| images | ProductImage[] | RO | 無屬性賣場圖片 | |
| complimentarySkuList | Int32[] | RO | 買就送贈品商品 SKU 列表,不包含贈品群組裡面的贈品商品 | |
| complimentaryGroupSkuList | Int32[] | RO | 買就送贈品群組主商品 SKU 列表 | |
| selectComplimentarySkuList | Int32[] | RO | 任選贈品商品 SKU 列表,不包含贈品群組裡面的贈品商品 | |
| selectComplimentaryGroupSkuList | Int32[] | RO | 任選贈品群組主商品 SKU 列表 | |
| additionalPurchaseSkuList | Int32[] | RO | 加價購商品 SKU 列表 | |
| complimentaries | ListingItem[] | RO | 買就送商品列表,包含贈品群組裡面的贈品商品 | |
| complimentaryGroups | ListingComplimentaryGroup[] | RO | 買就送贈品群組主商品列表 | |
| selectComplimentaries | ListingItem[] | RO | 任選贈品商品列表,包含贈品群組裡面的贈品商品 | |
| selectComplimentaryGroups | ListingComplimentaryGroup[] | RO | 任選贈品贈品群組主商品列表 | |
| additionalPurchases | ListingItem[] | RO | 加價購商品列表 | |
| selectComplimentaryMinQty | Int32 | RO | 任選贈品必選數量 | |
| shareMediaBetweenModels | Boolean | RO | 是否共用同一組商品圖/影片 | |
| type | String | RO | Listing type
|
|
| attributeDisplayMode | String | RO | 商品規格顯示方式
|
|
| productStructuredDataList | StructuredData[] | RO | 商品規格列表 | |
| cost | String | RO | 無屬性商品成本 | |
| returnedAmount | String | RO | Returned amount of the listing This field will be returned only in the endpoint GET /spa/v1/stats/returnReasons/{id}/listings |
|
| returnedQuantity | Int32 | RO | Returned quantity of the listing This field will be returned only in the endpoint GET /spa/v1/stats/returnReasons/{id}/listings |
|
| warranty | ProductWarranty | RO | 商品保證 | |
| skuDetail | SkuDetail | RO | 賣場 SKU 商品資料 | |
| model | String | RO | 商品型號 | |
| featureTitle | String | RO | 特色標題 | |
| shortDescription | String[] | RO | 商品特色 | |
| seoUrl | String | RO | 賣場網址 | |
| preOrderExpectedShipDate | String | RO | 預購型商品預定出貨日 | |
| customizedOrderShipDateAfterPlaced | Int32 | RO | 客製化商品完成訂單後出貨天數 | |
| purchaseQtyLimit | Int32 | RO | 單次限購數量(宅配) | |
| cvsPurchaseQtyLimit | Int32 | RO | 單次限購數量(超取) | |
| isThresholdFreebie | Boolean | RO | 是否為滿額贈贈品賣場 | |
| contentRating | String | RO | 內容級別,定義表 | |
| actualBarcode | String | RO | 實際國際條碼 | |
| stock | Int32 | RO | 無屬性商品備貨數量 | |
| marketPrice | String | RO | 市價 | |
| deliveryType | String | RO | 交貨期限,定義表 | |
| startTs | String | RO | 開始時間 格式: ISO-8601 |
|
| endTs | String | RO | 結束時間 格式: ISO-8601 |
|
| status | String | RO | 賣場狀態
|
|
| allowedDiscounts | String[] | RO | 可使用折扣方式
|
|
| brandId | String | RO | 品牌 ID | |
| brandName | String | RO | 品牌名稱 |
Listings #
| Column Name | Type | RW/RO | Required | Note |
|---|---|---|---|---|
| listings | Listing[] | RO | Listing list | |
| pagination | Pagination | RO | Pagination |