賣場屬性調整提案 #
查詢賣場屬性調整提案單 #
查詢已建立的 賣場屬性調整提案單。
Endpoint URL: https://tw.supplier.yahoo.com/api/spa/v1/proposal/updateListingModels
HTTP Method: GET
Request Parameters #
id #
提案單號，可以使用 , 分隔多個提案單號一次取得多筆資料。
資料型態: String
必填: 否
subStationId #
提案單所屬子站 ID，可以使用 , 分隔多個子站 ID 一次取得多筆資料。
資料型態: String
必填: 否
reviewStatus #
提案單審核狀態，可以使用 , 分隔多個審核狀態一次取得多筆資料。詳見 ProposalReviewStatus 取得審核狀態列表。
資料型態: String
必填: 否
executeStatus #
提案單執行狀態，可以使用 , 分隔多個執行狀態一次取得多筆資料。詳見 ProposalReviewStatus 取得執行狀態列表。
資料型態: String
必填: 否
sort #
結果排序條件，可使用的條件包括 id, appliedTs, expiredTs, reviewedTs, executedTs, modifiedTs。前方加上 - 表示降冪排序、+ 表示升幂排序。
資料型態: String
必填: 否
預設值: -id
fields #
於查詢時同時要求回傳附加欄位，目前支援的欄位包括:
+products回傳欄位 xxx, yyy 中相關的商品資訊
資料型態: String
必填: 否
offset #
用於搜尋結果分頁，表示從搜尋結果的第幾筆開始回傳。
資料型態: Integer
必填: 否
預設值: 0
最小值: 0
limit #
用於搜尋結果分頁，表示一次回傳幾筆搜尋結果。
資料型態: Integer
必填: 否
預設值: 15
最小值: 0
最大值: 50
Response Syntax #
{
"pagination": {
"nextOffset": number,
"resultsTotal": number
},
"proposals": [
{
"applicant": string,
"contactWindow": string,
"creator": string,
"createdTs": string,
"executeStatus": string,
"executedTs": string,
"expiredTs": string,
"modifiedTimes": number,
"modifiedTs": string,
"modifier": string,
"reviewStatus": string,
"supplierId": number,
"note": string,
"id": number,
"listing": {
"id": number,
"origLayer": number
},
"complimentary": {
"models": [
{
"items": [
{
"id": number,
"sku": number,
"spec": {
"name": string,
"selectedValue": string
},
"shortTitle": string
}
],
"sku": number,
"spec": {
"name": string,
"selectedValue": string
},
"shortTitle": string
}
]
},
"complimentaryDiff": {
"added": [
{
"items": [
{
"id": number,
"sku": number,
"spec": {
"name": string,
"selectedValue": string
},
"shortTitle": string
}
],
"sku": number,
"spec": {
"name": string,
"selectedValue": string
},
"shortTitle": string
}
],
"updated": [
{
"origin": {
"spec": {
"name": string,
"selectedValue": string
},
"parentSku": number,
"shortTitle": string
},
"outcome": {
"spec": {
"name": string,
"selectedValue": string
},
"partentSku": number,
"shortTitle": string
},
"sku": number
}
],
"removed": [
{
"sku": number,
"spec": {
"name": string,
"selectedValue": string
},
"items": [
{
"sku": number,
"spec": {
"name": string,
"selectedValue": string
},
"shortTitle": string
}
],
"shortTitle": string
}
]
},
"selectComplimentary": {
"selectedMinQty": number,
"models": [
{
"items": [
{
"id": number,
"sku": number,
"spec": {
"name": string,
"selectedValue": string
},
"shortTitle": string
}
],
"sku": number,
"spec": {
"name": string,
"selectedValue": string
},
"shortTitle": string
}
]
},
"selectComplimentaryDiff": {
"added": [
{
"items": [
{
"id": number,
"sku": number,
"spec": {
"name": string,
"selectedValue": string
},
"shortTitle": string
}
],
"sku": number,
"spec": {
"name": string,
"selectedValue": string
},
"shortTitle": string
}
],
"updated": [
{
"origin": {
"spec": {
"name": string,
"selectedValue": string
},
"parentSku": number,
"shortTitle": string
},
"outcome": {
"spec": {
"name": string,
"selectedValue": string
},
"partentSku": number,
"shortTitle": string
},
"sku": number
}
],
"removed": [
{
"sku": number,
"spec": {
"name": string,
"selectedValue": string
},
"items": [
{
"sku": number,
"spec": {
"name": string,
"selectedValue": string
},
"shortTitle": string
}
],
"shortTitle": string
}
],
"updatedField": [
{
"field": string,
"origin": string,
"outcome": string
}
]
},
"additionalPurchases": [
{
"sku": number,
"spec": {
"name": string,
"selectedValue": string
},
"price": string
}
],
"additionalPurchasesDiff": {
"added": [
{
"sku": number,
"spec": {
"name": string,
"selectedValue": string
},
"price": string
}
],
"updated": [
{
"sku": number,
"origin": {
"spec": {
"name": string,
"selectedValue": string
},
"price": string
},
"outcome": {
"spec": {
"name": string,
"selectedValue": string
},
"price": string
}
}
],
"removed": [
{
"sku": number,
"spec": {
"name": string,
"selectedValue": string
}
}
]
},
"models": [
{
"spec": {
"name": string,
"selectedValue": string
},
"sku": number,
"items": [
{
"id": number,
"spec": {
"name": string,
"selectedValue": string
},
"isVisible": boolean,
"images": [
{
"order": number,
"url": string
}
],
"attributes": [
{
"name": string,
"values": [
string
]
}
],
"partNo": string,
"barcode": string,
"stock": number,
"name": string
}
],
"isVisible": boolean,
"images": [
{
"order": number,
"url": string
}
],
"attributes": [
{
"name": string,
"values": [
string
]
}
],
"partNo": string,
"barcode": string,
"stock": number,
"name": string
}
],
"diff": {
"added": [
{
"spec": {
"name": string,
"selectedValue": string
},
"sku": number,
"items": [
{
"id": number,
"sku": number,
"spec": {
"name": string,
"selectedValue": string
},
"isVisible": boolean,
"images": [
{
"order": number,
"url": string
}
],
"attributes": [
{
"name": string,
"values": [
string
]
}
],
"partNo": string,
"barcode": string,
"stock": number,
"name": string
}
],
"isVisible": boolean,
"images": [
{
"order": number,
"url": string
}
],
"attributes": [
{
"name": string,
"values": [
string
]
}
],
"partNo": string,
"barcode": string,
"stock": number,
"name": string
}
],
"removed": [
{
"sku": number,
"spec": {
"name": string,
"selectedValue": string
},
"items": [
{
"sku": number,
"spec": {
"name": string,
"selectedValue": string
},
"isVisible": boolean,
"name": string,
"attributes": [
{
"name": string,
"values": [
string
]
}
]
}
],
"isVisible": boolean,
"name": string,
"attributes": [
{
"name": string,
"values": [
string
]
}
]
}
],
"updated": [
{
"origin": {
"spec": {
"name": string,
"selectedValue": string
},
"parentSku": number,
"name": string,
"attributes": [
{
"name": string,
"values": [
string
]
}
]
},
"sku": number,
"outcome": {
"spec": {
"name": string,
"selectedValue": string
},
"parentSpec": {
"name": string,
"selectedValue": string
},
"parentSku": number,
"name": string,
"attributes": [
{
"name": string,
"values": [
string
]
}
]
}
}
]
},
"products": [
{
"id": number,
"sku": number,
"supplierId": number,
"name": string,
"cost": string,
"stock": number,
"availableCount": number,
"images": [
{
"url": string,
"width": number,
"height": number,
"order": number
}
],
"structuredData": {
"attributes": [
{
"name": string,
"values": [
string
]
}
],
"struDataAttrClusterId": string
},
"spec": {
"name": string,
"selectedValue": string
},
"parentSpec": {
"name": string,
"selectedValue": string
}
},
"isExpiringItem": boolean,
"isInstallRequired": boolean,
"isNeedRecycle": boolean,
"minPackingCount": number,
"taxable": boolean,
"msrp": string,
"brand": string,
"length": number,
"width": number,
"height": number,
"weight": number,
"preserveDays": number,
"catId": string,
"catItemId": string,
"isSoftGame": boolean,
"gameContents": [
string
],
"shipType": {
"id": number,
"type": string
}
]
}
]
}
Response Elements #
若操作成功，API 會回傳 HTTP 200 response。下述資料會以 JSON 格式回傳。
pagination #
搜尋結果的分頁資訊，若有未回傳資料，會提供 nextOffset 表示下一次請求時可從何 offset 開始，而 resultsTotal 表示符合該條件的結果總數。
資料型態: Pagination
proposals #
符合搜尋條件的提案單物件。
資料型態: UpdateListingModelProposal
Errors #
Bad Request #
輸入的參數不符合 API 定義的 Pattern。
HTTP Status Code: 400
| Error Code | Description |
|---|---|
| 0 | 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 #
取得提案單號為 427984 與 427985 的提案單
GET /api/spa/v1/proposal/updateListingModels?id=427984,427985 HTTP/1.1
HOST: tw.supplier.yahoo.com
Content-Type: application/json; charset=UTF-8
{
"pagination": {
"resultsTotal": 2
},
"proposals": [
{
"applicant": "applicant-name",
"contactWindow": "contact-windows-id",
"creator": "creator-id",
"createdTs": "2020-09-18T11:31:53Z",
"executeStatus": "idle",
"executedTs": "2020-09-18T11:32:00Z",
"expiredTs": "2020-10-02T16:00:00Z",
"modifiedTimes": 1,
"modifiedTs": "2020-09-18T11:32:00Z",
"modifier": "modifier-id",
"reviewStatus": "draft",
"supplierId": 99999,
"note": "proposal-note",
"id": 427984,
"listing": {
"id": 3401834,
"origLayer": 1
},
"models": [
{
"sku": 6645988,
"spec": {
"name": "商品尺寸",
"selectedValue": "S號"
},
"isVisible": true,
"name": "S",
"attributes": [
{
"name": "商品尺寸",
"values": [
"S"
]
}
]
},
{
"sku": 6645989,
"spec": {
"name": "商品尺寸",
"selectedValue": "M號"
},
"isVisible": true,
"name": "M",
"attributes": [
{
"name": "商品尺寸",
"values": [
"M"
]
}
]
},
{
"sku": 6645990,
"spec": {
"name": "商品尺寸",
"selectedValue": "L號"
},
"isVisible": true,
"name": "L",
"attributes": [
{
"name": "商品尺寸",
"values": [
"L"
]
}
]
}
],
"diff": {
"removed": [
{
"sku": 6645991,
"spec": {
"name": "商品尺寸",
"selectedValue": "XL號"
},
"isVisible": true,
"name": "XL",
"attributes": [
{
"name": "商品尺寸",
"values": [
"XL"
]
}
]
}
]
}
},
{
"applicant": "applicant-name",
"contactWindow": "contact-windows-id",
"creator": "creator-id",
"createdTs": "2020-09-18T11:31:53Z",
"executeStatus": "idle",
"executedTs": "2020-09-18T11:32:00Z",
"expiredTs": "2020-10-02T16:00:00Z",
"modifiedTimes": 1,
"modifiedTs": "2020-09-18T11:32:00Z",
"modifier": "modifier-id",
"reviewStatus": "draft",
"supplierId": 99999,
"note": "proposal-note",
"id": 427985,
"listing": {
"id": 3401835,
"origLayer": 2
},
"models": [
{
"spec": {
"name": "顏色",
"selectedValue": "白色系"
},
"sku": 6645992,
"items": [
{
"id": 6645985,
"sku": 6645985,
"spec": {
"name": "商品尺寸",
"selectedValue": "S"
},
"isVisible": true,
"name": "白色S",
"attributes": [
{
"name": "顏色",
"values": [
"白色"
]
},
{
"name": "商品尺寸",
"values": [
"S"
]
}
]
},
{
"id": 6645986,
"sku": 6645986,
"spec": {
"name": "商品尺寸",
"selectedValue": "M"
},
"isVisible": true,
"name": "白色M",
"attributes": [
{
"name": "顏色",
"values": [
"白色"
]
},
{
"name": "商品尺寸",
"values": [
"M"
]
}
]
},
{
"id": 6645987,
"sku": 6645987,
"spec": {
"name": "商品尺寸",
"selectedValue": "L"
},
"isVisible": true,
"name": "白色L",
"attributes": [
{
"name": "顏色",
"values": [
"白色"
]
},
{
"name": "商品尺寸",
"values": [
"L"
]
}
]
}
],
"isVisible": true
},
{
"spec": {
"name": "顏色",
"selectedValue": "灰色"
},
"sku": 6645993,
"items": [
{
"id": 6645988,
"sku": 6645988,
"spec": {
"name": "商品尺寸",
"selectedValue": "S"
},
"isVisible": true,
"name": "灰色S",
"attributes": [
{
"name": "顏色",
"values": [
"灰色"
]
},
{
"name": "商品尺寸",
"values": [
"S"
]
}
]
},
{
"id": 6645989,
"sku": 6645989,
"spec": {
"name": "商品尺寸",
"selectedValue": "M"
},
"isVisible": true,
"name": "灰色M",
"attributes": [
{
"name": "顏色",
"values": [
"灰色"
]
},
{
"name": "商品尺寸",
"values": [
"M"
]
}
]
},
{
"id": 6645990,
"sku": 6645990,
"spec": {
"name": "商品尺寸",
"selectedValue": "L"
},
"isVisible": true,
"name": "灰色L",
"attributes": [
{
"name": "顏色",
"values": [
"灰色"
]
},
{
"name": "商品尺寸",
"values": [
"L"
]
}
]
}
],
"isVisible": true
}
],
"diff": {
"added": [
{
"sku": 6645993,
"spec": {
"name": "顏色",
"selectedValue": "灰色"
},
"items": [
{
"id": 6645990,
"sku": 6645990,
"spec": {
"name": "商品尺寸",
"selectedValue": "L"
},
"isVisible": true,
"name": "灰色L",
"attributes": [
{
"name": "顏色",
"values": [
"灰色"
]
},
{
"name": "商品尺寸",
"values": [
"L"
]
}
]
}
],
"isVisible": true
}
],
"removed": [
{
"spec": {
"name": "顏色",
"selectedValue": "白色"
},
"sku": 6645992,
"items": [
{
"sku": 6645984,
"spec": {
"name": "商品尺寸",
"selectedValue": "XS"
},
"isVisible": true,
"name": "白色XS",
"attributes": [
{
"name": "顏色",
"values": [
"白色"
]
},
{
"name": "商品尺寸",
"values": [
"XS"
]
}
]
}
],
"isVisible": true
}
],
"updated": [
{
"origin": {
"spec": {
"name": "顏色",
"selectedValue": "白色"
}
},
"outcome": {
"spec": {
"name": "顏色",
"selectedValue": "白色系"
}
},
"sku": 6645992
},
{
"origin": {
"spec": {
"name": "商品尺寸",
"selectedValue": "L號"
},
"parentSku": 6645993,
"name": "灰色L",
"attributes": [
{
"name": "顏色",
"values": [
"灰色"
]
},
{
"name": "商品尺寸",
"values": [
"L"
]
}
]
},
"outcome": {
"spec": {
"name": "商品尺寸",
"selectedValue": "L"
},
"parentSku": 6645992,
"name": "白色L",
"attributes": [
{
"name": "顏色",
"values": [
"白色"
]
},
{
"name": "商品尺寸",
"values": [
"L"
]
}
]
},
"sku": 6645987
},
{
"origin": {
"parentSku": 6645992
},
"outcome": {
"parentSpec": {
"name": "顏色",
"selectedValue": "灰色"
}
},
"sku": 6645988
}
]
}
}
]
}
取得提案單號為 427984 的提案單，並且取得提案單的額外欄位 products
GET /api/spa/v1/proposal/updateListingModels?id=427987&fields=+products HTTP/1.1
HOST: tw.supplier.yahoo.com
Content-Type: application/json; charset=UTF-8
{
"pagination": {
"resultsTotal": 1
},
"proposals": [
{
"applicant": "applicant-name",
"contactWindow": "contact-windows-id",
"creator": "creator-id",
"createdTs": "2020-09-18T11:31:53Z",
"executeStatus": "idle",
"executedTs": "2020-09-18T11:32:00Z",
"expiredTs": "2020-10-02T16:00:00Z",
"modifiedTimes": 1,
"modifiedTs": "2020-09-18T11:32:00Z",
"modifier": "modifier-id",
"reviewStatus": "draft",
"supplierId": 99999,
"note": "proposal-note",
"id": 427987,
"listing": {
"id": 3401834,
"origLayer": 1
},
"models": [
{
"sku": 6645988,
"spec": {
"name": "商品尺寸",
"selectedValue": "S號"
},
"isVisible": true,
"name": "白色S",
"attributes": [
{
"name": "顏色",
"values": [
"白色"
]
},
{
"name": "商品尺寸",
"values": [
"S"
]
}
]
}
],
"diff": {
"removed": [
{
"sku": 6645991,
"spec": {
"name": "商品尺寸",
"selectedValue": "XL號"
},
"isVisible": true,
"name": "product-name",
"attributes": [
{
"name": "顏色",
"values": [
"灰色系"
]
},
{
"name": "商品尺寸",
"values": [
"XL號"
]
}
]
}
]
},
"products": [
{
"cost": "10.00",
"id": 6645988,
"images": [
{
"height": 1000,
"order": 1,
"url": "https://s.yimg.com/zo/MerchandiseImages/9f87c829b5-Product-6677150.jpg",
"width": 1000
},
{
"height": 400,
"order": 1,
"url": "https://s.yimg.com/zo/MerchandiseImages/a5d0648705-Product-6677150.jpg",
"width": 400
},
{
"height": 250,
"order": 1,
"url": "https://s.yimg.com/zo/MerchandiseImages/5617007e8c-Product-6677150.jpg",
"width": 250
},
{
"height": 135,
"order": 1,
"url": "https://s.yimg.com/zo/MerchandiseImages/5d4a126e16-Product-6677150.jpg",
"width": 135
},
{
"height": 80,
"order": 1,
"url": "https://s.yimg.com/zo/MerchandiseImages/e643d566b5-Product-6677150.jpg",
"width": 80
},
{
"height": 1000,
"order": 2,
"url": "https://s.yimg.com/zo/MerchandiseImages/dc76470f8b-Product-6677150.jpg",
"width": 1000
},
{
"height": 400,
"order": 2,
"url": "https://s.yimg.com/zo/MerchandiseImages/caa5d48015-Product-6677150.jpg",
"width": 400
}
],
"name": "product-name",
"sku": 6645988,
"spec": {
"name": "商品尺寸",
"selectedValue": "S號"
},
"stock": 10,
"availableCount": 10,
"structuredData": {
"attributes": [
{
"name": "顏色",
"values": [
"白色系"
]
},
{
"name": "產地",
"values": [
"台灣"
]
},
{
"name": "商品尺寸",
"values": [
"S"
]
}
],
"struDataAttrClusterId": "000003414671"
},
"isExpiringItem": false,
"isInstallRequired": false,
"isNeedRecycle": false,
"minPackingCount": 1,
"taxable": true,
"msrp": "100.00",
"brand": "品牌",
"catId": "cat430",
"catItemId": "catItem10070",
"isSoftGame": false,
"shipType": {
"id": 1,
"type": "Home"
}
},
{
"cost": "10.00",
"id": 6645991,
"images": [
{
"height": 1000,
"order": 1,
"url": "https://s.yimg.com/zo/MerchandiseImages/52CE0DA2A8-SP-481564.jpg",
"width": 1000
},
{
"height": 400,
"order": 1,
"url": "https://s.yimg.com/zo/MerchandiseImages/4CD8E44971-SP-481564.jpg",
"width": 400
},
{
"height": 250,
"order": 1,
"url": "https://s.yimg.com/zo/MerchandiseImages/DDBBF0A9E2-SP-481564.jpg",
"width": 250
},
{
"height": 135,
"order": 1,
"url": "https://s.yimg.com/zo/MerchandiseImages/CFD4959487-SP-481564.jpg",
"width": 135
},
{
"height": 80,
"order": 1,
"url": "https://s.yimg.com/zo/MerchandiseImages/8A0FB65D9C-SP-481564.jpg",
"width": 80
},
{
"height": 1000,
"order": 2,
"url": "https://s.yimg.com/zo/MerchandiseImages/AD48DF0C11-SP-481564.jpg",
"width": 1000
},
{
"height": 400,
"order": 2,
"url": "https://s.yimg.com/zo/MerchandiseImages/95A9155AFD-SP-481564.jpg",
"width": 400
}
],
"name": "product-name",
"sku": 6645991,
"spec": {
"name": "商品尺寸",
"selectedValue": "XL號"
},
"stock": 10,
"availableCount": 10,
"structuredData": {
"attributes": [
{
"name": "顏色",
"values": [
"灰色系"
]
},
{
"name": "產地",
"values": [
"台灣"
]
},
{
"name": "商品尺寸",
"values": [
"XL號"
]
}
],
"struDataAttrClusterId": "000003414671"
},
"isExpiringItem": false,
"isInstallRequired": false,
"isNeedRecycle": false,
"minPackingCount": 1,
"taxable": true,
"msrp": "100.00",
"brand": "品牌",
"catId": "cat430",
"catItemId": "catItem10070",
"isSoftGame": false,
"shipType": {
"id": 1,
"type": "Home"
}
}
]
}
]
}