新增一般賣場提案 #
查詢新增一般賣場提案單 #
查詢已建立並符合條件的 新增一般賣場提案單。
Endpoint URL: https://tw.supplier.yahoo.com/api/spa/v1/proposals
HTTP Method: GET
- 若因分類變動導致無法以
proposal.{product|listing}.catItemId導回完整分類路徑， 則proposal.{product|listing}.{zoneId|zoneName|subStationId|subStationName|catId|catName|catItemId|catItemName}將不再回傳。- 若
proposal.product.subStationId與proposal.subStationId不一致，表示目前 product 的子類已不屬於提案當下的子站，需請供應商重新選擇分類。- 編輯或複製提案時，使用者可先記住原本的
proposal.product.catItemId，若新選擇的catItemId仍為同一個，則原本填寫的proposal.product.{models|attributes}可繼續沿用。
Request Parameters #
type #
提案單類型。
資料型態: String
必填: 是
欄位說明: 輸入 newListing，可查詢新增一般賣場
id #
提案單號。
資料型態: Integer
必填: 否
欄位說明: 查詢多筆提案單號以 , 連接
subStationId #
提案站別 ID。
資料型態: String
必填: 否
欄位說明: 只允許查詢供應商有簽約的子站，查詢多個子站以 , 連接
範例:
- 查詢單個子站 ex.
sub1 - 查詢多個子站 ex.
sub1,sub2,sub3
reviewStatus #
審核結果。
資料型態: String
必填: 否
欄位說明: 查詢多個審核狀態以 , 連接
欄位內容:
- composing: 尚未提案
- draft: 儲存暫不提案
- pendingReview: 待審核
- approved: 審核已通過
- declined: 審核不通過
- expired: 已過審核期限
範例: composing,draft
executeStatus #
執行結果。
資料型態: String
必填: 否
欄位說明: 查詢多個執行狀態以 , 連接
欄位內容:
- idle: 未執行
- running: 執行中
- finished: 已執行
- failed: 執行失敗
範例: idle,failed
createdTs #
建檔時間。
資料型態: String
必填: 否
格式: ISO-8601
範例: 2019-03-20T00:00:00+08:00
appliedTs #
申請時間。
資料型態: String
必填: 否
格式: ISO-8601
範例: 2019-03-20T00:00:00+08:00
sort #
結果排序條件。
資料型態: String
必填: 否
欄位說明: 可使用的條件包括以下欄位內容，前方加上 + 表示升幂排序 - 表示降冪排序。多種排序條件使用 , 串接。
欄位內容:
- id: 提案單號
- appliedTs: 申請時間
- expiredTs: 建檔時間
- reviewedTs: 審核時間
- executedTs: 執行時間
- modifiedTs: 修改時間
預設值: -id
範例: +executedTs,+id
fields #
於取得的同時要求過濾回傳欄位，newListing 目前支援的欄位包括:
-product.copy過濾欄位 product.copy 中的資訊
資料型態: String
必填: 否
預設值: -product.copy
欄位說明: 若需回傳 product.copy 的資訊，請填寫 fields= 於 Request parameter
offset #
用於搜尋結果分頁，表示從搜尋結果的第幾筆開始回傳。
資料型態: Integer
必填: 否
預設值: 0
最小值: 0
limit #
用於搜尋結果分頁，表示一次回傳幾筆搜尋結果。
資料型態: Integer
必填: 否
預設值: 10
最小值: 0
最大值: 50
Response Syntax #
{
"pagination": {
"nextOffset": number,
"resultsTotal": number
},
"proposals": [
{
"applicant": string,
"product": {
"eVoucherAttributes": [
{
"dataType": "string",
"name": "string",
"value": "string"
}
],
"eVoucherType": "string",
"attributeDisplayMode": string,
"attributes": [
{
"name": string,
"values": [
string
]
}
],
"catItemId": string,
"contentRating": string,
"cost": string,
"isExpiringItem": boolean,
"isInstallRequired": boolean,
"isLargeVolume": boolean,
"isLargeVolumnProductGift": boolean,
"isNeedRecycle": boolean,
"isOutrightPurchase": boolean,
"minPackingCount": number,
"models": [
{
"items": [
{
"partNo": string,
"barcode": string,
"warehouseBarcode": string,
"warehouseProductName": string,
"spec": {
"name": string,
"values": [
string,
]
},
"displayName": string
}
],
"videos": [
{
"url": string,
"order": number
}
],
"images": [
{
"url": string,
"order": number
}
],
"spec": {
"name": string,
"values": [
string
]
},
"displayName": string
}
],
"msrp": string,
"name": string,
"partNo": string,
"shipType": {
"id": number,
"model": number
},
"shortDescription": [
string,
string
],
"struDataAttrClusterId": string,
"warranty": {
"period": string,
"description": string,
"handler": string,
"scope": string,
"productStatus": string
},
"copy": string,
"brand": string,
"brandId": string,
"brandName": string,
"height": number,
"length": number,
"model": string,
"preserveDays": number,
"weight": number,
"width": number
},
"reviewStatus": string,
"subStationId": string,
"type": string,
"note": string,
"listing": {
"catItemId": string,
"deliveryType": string,
"featureTitle": string,
"price": string,
"seoUrl": string
}
}
]
}
Response Elements #
pagination #
搜尋結果的分頁資訊，若有未回傳資料，會提供 nextOffset 表示下一次請求時可從何 offset 開始，而 resultsTotal 表示符合該條件的結果總數。
資料型態: Pagination
proposals #
符合搜尋條件的提案單物件。
資料型態: Proposal
Errors #
Bad Request #
輸入的參數不符合 API 定義的 Pattern。
HTTP Status Code: 400
| Error Code | Description |
|---|---|
| Invalid input | |
| 40000001 | Wrong timestamp format |
| 40000005 | Contains illegal character(s) |
Unauthorized #
身分認證不通過，請檢查您的 Cookie 或 wssid。
HTTP Status Code: 401
| Error Code | Description |
|---|---|
| 40100001 | Missing or bad authentication |
| 40100002 | Invalid cookie |
| 40100003 | Missing or bad authentication |
| 40100004 | Check wssid failed |
| 40100006 | Cookie has expired |
Internal Server Error #
API 端發生錯誤，若持續發生請洽您的業務窗口。
Examples #
取得提案單號類別為 newListing 的新增一般賣場提案單
GET /api/spa/v1/proposals?type=newListing&fields%3D-product.copy HTTP/1.1
HOST: tw.supplier.yahoo.com
Content-Type: application/json; charset=UTF-8
因為 fields 加上了 -product.copy，故 product 中不會有 copy 的資料。
{
"pagination": {
"resultsTotal": 1
},
"proposals": [
{
"applicant": "申請人",
"appliedTs": "2019-03-05T15:37:56+08:00",
"contactWindow": "contact-windows-id",
"createdTs": "2019-03-05T15:34:58+08:00",
"creator": "creator-Id",
"executeStatus": "idle",
"expiredTs": "2019-03-20T00:00:00+08:00",
"id": 76527,
"listing": {
"applyLowGpm": false,
"catId": "cat430",
"catItemId": "catItem10070",
"catItemName": "新迅馳Sonoma",
"catName": "加值功能NB推薦",
"cvsPurchaseQtyLimit": 1,
"deliveryType": "appointment",
"featureTitle": "我是特色標題",
"isDisplay": true,
"offShelvedTs": "2020-03-04T15:37:56+08:00",
"onShelvedTs": "2019-03-05T15:37:56+08:00",
"price": "100.00",
"purchaseQtyLimit": 12,
"seoUrl": "我是商品名稱",
"subStationId": "sub1",
"subStationName": "筆記型電腦超過十一個字test",
"zoneId": "z3",
"zoneName": "電腦 / 週邊 / 軟體"
},
"modifiedTimes": 2,
"modifiedTs": "2019-03-05T15:37:56+08:00",
"modifier": "mwu02",
"note": "我是備註",
"product": {
"attributeDisplayMode": "table",
"attributes": [
{
"name": "中央處理器品牌",
"values": [
"Intel"
]
},
{
"name": "中央處理器型號",
"values": [
"G870"
]
},
{
"name": "型號",
"values": [
"Trey-Super-PC"
]
},
{
"name": "晶片組",
"values": [
"B75"
]
},
{
"name": "硬碟機容量",
"values": [
"250GB"
]
},
{
"name": "硬碟機轉速",
"values": [
"5400轉"
]
},
{
"name": "固態硬碟",
"values": [
"無"
]
},
{
"name": "光碟機",
"values": [
"無"
]
},
{
"name": "作業系統",
"values": [
"無"
]
},
{
"name": "記憶體容量(GB)",
"values": [
"2G"
]
},
{
"name": "記憶體類型",
"values": [
"DDR2"
]
},
{
"name": "記憶體工作頻率(MHz)",
"values": [
"333"
]
},
{
"name": "記憶體插槽數",
"values": [
"1"
]
},
{
"name": "記憶體最高支援容量",
"values": [
"2G以下"
]
},
{
"name": "顯示卡類型",
"values": [
"獨立顯卡"
]
},
{
"name": "螢幕尺吋",
"values": [
"無"
]
},
{
"name": "觸控",
"values": [
"無"
]
},
{
"name": "顯示晶片型號",
"values": [
"3dfx-voodoo-1"
]
},
{
"name": "顯示卡記憶體類型",
"values": [
"高速記憶體"
]
},
{
"name": "顯示卡記憶體容量(GB)",
"values": [
"12MB"
]
},
{
"name": "尺寸(長x寬x高)(mm)",
"values": [
"2400x900x30000"
]
},
{
"name": "區域網路",
"values": [
"64kbps"
]
},
{
"name": "原廠保固",
"values": [
"none"
]
},
{
"name": "音效",
"values": [
"mono"
]
},
{
"name": "前面板連接埠",
"values": [
"極致簡約沒有任何連接埠"
]
},
{
"name": "後面板連接埠",
"values": [
"只有電源插孔"
]
},
{
"name": "後面板視訊埠",
"values": [
"HDMI"
]
},
{
"name": "電源供應器瓦數(W)",
"values": [
"150kW"
]
},
{
"name": "重量(kg)",
"values": [
"27t"
]
}
],
"brand": "我是品牌",
"brandId": "41166484",
"brandName": "2M2",
"catId": "cat430",
"catItemId": "catItem10070",
"catItemName": "新迅馳Sonoma",
"catName": "加值功能NB推薦",
"contentRating": "G",
"cost": "50.00",
"height": 77,
"isExpiringItem": true,
"isInstallRequired": true,
"isLargeVolume": true,
"isLargeVolumnProductGift": true,
"isNeedRecycle": true,
"isOutrightPurchase": true,
"length": 55,
"minPackingCount": 10,
"model": "我是商品型號",
"models": [
{
"displayName": "極致簡約Dell2019",
"images": [
{
"height": 1000,
"order": 1,
"url": "https://s.yimg.com/cl/api/res/1.2/kJ4Ky2.DoD4nLYOGFTqXTA--/YXBwaWQ9dHdzcG1hbGw7dz0xMDAwO2g9MTAwMA--/https://s.yimg.com/bp/Files/ba0b8bf005bab4e7cc8821afea217e342a1dfca3.png.cf.jpg",
"width": 1000
},
{
"height": 400,
"order": 1,
"url": "https://s.yimg.com/cl/api/res/1.2/2HOPhPCqFkyRlFFLB8CfPA--/YXBwaWQ9dHdzcG1hbGw7dz00MDA7aD00MDA-/https://s.yimg.com/bp/Files/ba0b8bf005bab4e7cc8821afea217e342a1dfca3.png.cf.jpg",
"width": 400
},
{
"height": 250,
"order": 1,
"url": "https://s.yimg.com/cl/api/res/1.2/E1bLiYjDz.y2HapecwWuuA--/YXBwaWQ9dHdzcG1hbGw7dz0yNTA7aD0yNTA-/https://s.yimg.com/bp/Files/ba0b8bf005bab4e7cc8821afea217e342a1dfca3.png.cf.jpg",
"width": 250
},
{
"height": 135,
"order": 1,
"url": "https://s.yimg.com/cl/api/res/1.2/hXTTZZzlR_4dZQzRes8jvA--/YXBwaWQ9dHdzcG1hbGw7dz0xMzU7aD0xMzU-/https://s.yimg.com/bp/Files/ba0b8bf005bab4e7cc8821afea217e342a1dfca3.png.cf.jpg",
"width": 135
},
{
"height": 80,
"order": 1,
"url": "https://s.yimg.com/cl/api/res/1.2/2sA9R61mn7u247ThP5oLZg--/YXBwaWQ9dHdzcG1hbGw7dz04MDtoPTgw/https://s.yimg.com/bp/Files/ba0b8bf005bab4e7cc8821afea217e342a1dfca3.png.cf.jpg",
"width": 80
},
{
"height": 1000,
"order": 2,
"url": "https://s.yimg.com/cl/api/res/1.2/Sbb2nlG7hogM7ZvZWLjeSg--/YXBwaWQ9dHdzcG1hbGw7dz0xMDAwO2g9MTAwMA--/https://s.yimg.com/bp/Files/3b0bc05cf3c5af7cd17b878edce05eab7d0b97d0.jpg.cf.jpg",
"width": 1000
},
{
"height": 400,
"order": 2,
"url": "https://s.yimg.com/cl/api/res/1.2/VoPZQZRgpO0r9QA14r.J3w--/YXBwaWQ9dHdzcG1hbGw7dz00MDA7aD00MDA-/https://s.yimg.com/bp/Files/3b0bc05cf3c5af7cd17b878edce05eab7d0b97d0.jpg.cf.jpg",
"width": 400
},
{
"height": 250,
"order": 2,
"url": "https://s.yimg.com/cl/api/res/1.2/TV3WuVDlY2mALfaRSG4gJg--/YXBwaWQ9dHdzcG1hbGw7dz0yNTA7aD0yNTA-/https://s.yimg.com/bp/Files/3b0bc05cf3c5af7cd17b878edce05eab7d0b97d0.jpg.cf.jpg",
"width": 250
},
{
"height": 135,
"order": 2,
"url": "https://s.yimg.com/cl/api/res/1.2/gMiKlCD0nMaVE7OWhXaC_w--/YXBwaWQ9dHdzcG1hbGw7dz0xMzU7aD0xMzU-/https://s.yimg.com/bp/Files/3b0bc05cf3c5af7cd17b878edce05eab7d0b97d0.jpg.cf.jpg",
"width": 135
},
{
"height": 80,
"order": 2,
"url": "https://s.yimg.com/cl/api/res/1.2/Z8J5QCrRyGe3vr.ZCTpS1g--/YXBwaWQ9dHdzcG1hbGw7dz04MDtoPTgw/https://s.yimg.com/bp/Files/3b0bc05cf3c5af7cd17b878edce05eab7d0b97d0.jpg.cf.jpg",
"width": 80
}
],
"items": [
{
"barcode": "725272730706",
"displayName": "卡其色",
"partNo": "5566",
"spec": {
"name": "顏色",
"values": [
"卡其"
]
},
"stock": 0,
"warehouseBarcode": "9785109946480"
},
{
"displayName": "灰色",
"partNo": "5567",
"spec": {
"name": "顏色",
"values": [
"灰色系"
]
},
"stock": 0
}
],
"spec": {
"name": "品牌",
"values": [
"Dell戴爾"
]
},
"videos": [
{
"order": 1,
"url": "https://s.yimg.com/bp/Files/374d9974ab2cbce382e42724fede7aa07313cae6.qt"
}
]
},
{
"displayName": "低調奢華hp讚",
"images": [
{
"height": 1000,
"order": 1,
"url": "https://s.yimg.com/cl/api/res/1.2/uya1s18B8jL0Dg7yN5C3xg--/YXBwaWQ9dHdzcG1hbGw7dz0xMDAwO2g9MTAwMA--/https://s.yimg.com/bp/Files/945b996a1bada1ccb966b8b0215875447024324c.jpg.cf.jpg",
"width": 1000
},
{
"height": 400,
"order": 1,
"url": "https://s.yimg.com/cl/api/res/1.2/1MoK56czcApqZcNIfPNCLw--/YXBwaWQ9dHdzcG1hbGw7dz00MDA7aD00MDA-/https://s.yimg.com/bp/Files/945b996a1bada1ccb966b8b0215875447024324c.jpg.cf.jpg",
"width": 400
},
{
"height": 250,
"order": 1,
"url": "https://s.yimg.com/cl/api/res/1.2/cKy9xhin4MKGqFIKEHp86Q--/YXBwaWQ9dHdzcG1hbGw7dz0yNTA7aD0yNTA-/https://s.yimg.com/bp/Files/945b996a1bada1ccb966b8b0215875447024324c.jpg.cf.jpg",
"width": 250
},
{
"height": 135,
"order": 1,
"url": "https://s.yimg.com/cl/api/res/1.2/7olgICbNuYEbDxp1GD8aIw--/YXBwaWQ9dHdzcG1hbGw7dz0xMzU7aD0xMzU-/https://s.yimg.com/bp/Files/945b996a1bada1ccb966b8b0215875447024324c.jpg.cf.jpg",
"width": 135
},
{
"height": 80,
"order": 1,
"url": "https://s.yimg.com/cl/api/res/1.2/4kce4XnvtfQsa4mtwLWJHg--/YXBwaWQ9dHdzcG1hbGw7dz04MDtoPTgw/https://s.yimg.com/bp/Files/945b996a1bada1ccb966b8b0215875447024324c.jpg.cf.jpg",
"width": 80
},
{
"height": 1000,
"order": 2,
"url": "https://s.yimg.com/cl/api/res/1.2/rn0UVm7EbURJfMwdhTAZzw--/YXBwaWQ9dHdzcG1hbGw7dz0xMDAwO2g9MTAwMA--/https://s.yimg.com/mm/Files/404603c25b19d075109b44255707b89d49b96347_1000x1000.jpg.cf.jpg",
"width": 1000
},
{
"height": 400,
"order": 2,
"url": "https://s.yimg.com/cl/api/res/1.2/oF0TcLQYzmhyasPmptwMJg--/YXBwaWQ9dHdzcG1hbGw7dz00MDA7aD00MDA-/https://s.yimg.com/mm/Files/404603c25b19d075109b44255707b89d49b96347_1000x1000.jpg.cf.jpg",
"width": 400
},
{
"height": 250,
"order": 2,
"url": "https://s.yimg.com/cl/api/res/1.2/.khlxRR.bvyubEJo2KztkQ--/YXBwaWQ9dHdzcG1hbGw7dz0yNTA7aD0yNTA-/https://s.yimg.com/mm/Files/404603c25b19d075109b44255707b89d49b96347_1000x1000.jpg.cf.jpg",
"width": 250
},
{
"height": 135,
"order": 2,
"url": "https://s.yimg.com/cl/api/res/1.2/F0BjdKuJZNCesGr6K9ySMA--/YXBwaWQ9dHdzcG1hbGw7dz0xMzU7aD0xMzU-/https://s.yimg.com/mm/Files/404603c25b19d075109b44255707b89d49b96347_1000x1000.jpg.cf.jpg",
"width": 135
},
{
"height": 80,
"order": 2,
"url": "https://s.yimg.com/cl/api/res/1.2/sPuDvt1rQAiW6SnQEH.WsQ--/YXBwaWQ9dHdzcG1hbGw7dz04MDtoPTgw/https://s.yimg.com/mm/Files/404603c25b19d075109b44255707b89d49b96347_1000x1000.jpg.cf.jpg",
"width": 80
}
],
"items": [
{
"displayName": "卡其色",
"partNo": "5568",
"spec": {
"name": "顏色",
"values": [
"卡其"
]
},
"stock": 0
},
{
"displayName": "灰色",
"partNo": "5569",
"spec": {
"name": "顏色",
"values": [
"灰色系"
]
},
"stock": 0
}
],
"spec": {
"name": "品牌",
"values": [
"hp惠普"
]
},
"videos": [
{
"order": 1,
"url": "https://s.yimg.com/bp/Files/374d9974ab2cbce382e42724fede7aa07313cae6.qt"
}
]
}
],
"msrp": "100.00",
"name": "(即期品)我是商品名稱",
"preserveDays": 56,
"safeStockQty": 1,
"shareMediaBetweenModels": false,
"shipType": {
"id": 61,
"name": "Express24HR"
},
"shortDescription": [
"我是簡短說明",
"我是簡短說明2"
],
"specs": [
{
"level": 1,
"name": "品牌"
},
{
"level": 2,
"name": "顏色"
}
],
"struDataAttrClusterId": "000003326689",
"struDataAttrClusterName": "品牌桌上型電腦",
"subStationId": "sub1",
"subStationName": "筆記型電腦超過十一個字test",
"warranty": {
"description": "保固說明文字",
"handler": "official",
"period": "一個月",
"scope": "新品瑕疵",
"productStatus": "new"
},
"weight": 88,
"width": 66,
"zoneId": "z3",
"zoneName": "電腦 / 週邊 / 軟體"
},
"reviewStatus": "pendingReview",
"subStationId": "sub1",
"subStationName": "筆記型電腦超過十一個字test",
"supplierId": 99999,
"supplierName": "雅虎測試",
"type": "newListing"
}
]
}