賣場資訊調整提案 #
查詢賣場資訊調整提案單 #
查詢已建立的 賣場資訊調整提案單。
Endpoint URL: https://tw.supplier.yahoo.com/api/spa/v1/proposal/updateListings
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
offset #
用於搜尋結果分頁，表示從搜尋結果的第幾筆開始回傳。
資料型態: Integer
必填: 否
預設值: 0
最小值: 0
limit #
用於搜尋結果分頁，表示一次回傳幾筆搜尋結果。
資料型態: Integer
必填: 否
預設值: 15
最小值: 0
最大值: 50
Response Syntax #
{
"pagination": {
"nextOffset": number,
"resultsTotal": number
},
"proposals": [
{
"applicant": string,
"contactWindow": string,
"createdTs": string,
"creator": string,
"executeStatus": string,
"expiredTs": string,
"id": number,
"listing": {
"attributeDisplayMode": string,
"attributes": [
{
"name": string,
"values": [
string
]
}
],
"brandId": string,
"brandName": string,
"copy": string,
"featureTitle": string,
"id": number,
"images": [
{
"height": number,
"order": number,
"url": string,
"width": number
}
],
"model": string,
"models": [
{
"sku": number,
"spec": {
"name": string,
"selectedValue": string
},
"items": [
{
"sku": number,
"spec": {
"name": string,
"selectedValue": string
},
"name": string,
"partNo": string
}
],
"images": [
{
"height": number,
"order": number,
"url": string,
"width": number
}
],
"videos": [
{
"url": string,
"order": number
}
]
}
],
"name": string,
"partNo": string,
"productName": string,
"shareMediaBetweenModels": boolean,
"shortDescription": [
string
],
"struDataAttrClusterId": string,
"syncProductImages": boolean,
"videos": [
{
"url": string,
"order": number
}
],
"warranty": {
"description": string,
"handler": string,
"period": string,
"scope": string,
"productStatus": string
}
},
"modifiedTimes": number,
"modifiedTs": string,
"modifier": string,
"note": string,
"reviewStatus": string,
"subProposals": [
{
"id": number,
"type": string,
"errors": [
"invalidValue": string,
"message": string,
"field": string
]
}
],
"subStationId": string,
"subStationName": string,
"supplierId": number
}
]
}
Response Elements #
若操作成功，API 會回傳 HTTP 200 response。下述資料會以 JSON 格式回傳。
pagination #
搜尋結果的分頁資訊，若有未回傳資料，會提供 nextOffset 表示下一次請求時可從何 offset 開始，而 resultsTotal 表示符合該條件的結果總數。
資料型態: Pagination
proposals #
符合搜尋條件的提案單物件。
資料型態: UpdateListingProposal[]
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 端發生錯誤，若持續發生請洽您的業務窗口。
HTTP Status Code: 500
Examples #
取得提案單號為 244077 與 244078 的提案單
GET /api/spa/v1/proposal/updateListings?id=244077,244078 HTTP/1.1
HOST: tw.supplier.yahoo.com
Content-Type: application/json; charset=UTF-8
{
"pagination": {
"resultsTotal": 2
},
"proposals": [
{
"applicant": "applicant-name",
"applicantRole": "supplier",
"contactWindow": "contact-windows-id",
"createdTs": "2019-12-23T10:27:41Z",
"creator": "creator-id",
"executeStatus": "idle",
"expiredTs": "2020-01-06T16:00:00Z",
"id": 244077,
"listing": {
"attributeDisplayMode": "table",
"attributes": [
{
"name": "品牌",
"values": [
"A3"
]
},
{
"name": "尺寸",
"values": [
"S",
"M",
"L"
]
},
{
"name": "透光度",
"values": [
"微透"
]
},
{
"name": "洗滌方式1",
"values": [
"一般1"
]
}
],
"featureTitle": "新的特色標題",
"id": 3378720,
"model": "新的商品型號",
"models": [
{
"sku": 6490415,
"spec": {
"name": "顏色",
"selectedValue": "白色系"
},
"items": [
{
"sku": 6490416,
"spec": {
"name": "尺寸",
"selectedValue": "M"
},
"name": "新的屬性商品名稱",
"partNo": "新的屬性商品料號"
},
{
"sku": 6490417,
"spec": {
"name": "尺寸",
"selectedValue": "L"
},
"name": "屬性商品名稱",
"partNo": "屬性商品料號"
}
],
"images": [
{
"height": 1000,
"order": 1,
"url": "https://s.yimg.com/bp/Files/fb1805887044f131efc68810cd42670f7923574c_1000x1000.jpg",
"width": 1000
},
{
"height": 400,
"order": 1,
"url": "https://s.yimg.com/bp/Files/683ad340890cb1757794c7f7691cb2d93d4319ee_1000x1000.jpg",
"width": 400
},
{
"height": 1000,
"order": 2,
"url": "https://s.yimg.com/bp/Files/fb1805887044f131efc68810cd42670f7923574c_1000x1000.jpg",
"width": 1000
}
],
"videos": [
{
"url": "https://s.yimg.com/bp/Files/8a1258ca99cef3d4955353d3503549b41e496fa9.qt",
"order": 1
}
]
}
],
"name": "新的賣場名稱",
"partNo": "新的主件商品料號",
"shareMediaBetweenModels": false,
"shortDescription": [
"新的商品特色",
"新的商品特色2"
],
"struDataAttrClusterId": "7925359",
"syncProductImages": true
},
"modifiedTimes": 1,
"modifiedTs": "2019-12-23T10:27:41Z",
"modifier": "modifier-id",
"note": "proposal-note",
"reviewStatus": "draft",
"subProposals": [
{
"id": 244079,
"type": "updateImageV2"
},
{
"id": 244080,
"type": "updateVideo"
},
{
"id": 244081,
"type": "updateCopy"
},
{
"id": 244082,
"type": "updateListingAttribute"
}
],
"subStationId": "sub1",
"subStationName": "sub-station-name",
"supplierId": 99999
},
{
"applicant": "applicant-name",
"applicantRole": "supplier",
"contactWindow": "contact-windows-id",
"createdTs": "2019-12-23T10:27:41Z",
"creator": "creator-id",
"executeStatus": "idle",
"expiredTs": "2020-01-06T16:00:00Z",
"id": 244078,
"listing": {
"copy": "<p>foo</p>",
"featureTitle": "新的特色標題",
"id": 3378721,
"model": "商品型號",
"models": [
{
"sku": 6490499,
"spec": {
"name": "顏色",
"selectedValue": "白色系"
},
"name": "新的屬性商品名稱",
"partNo": "新的屬性商品料號",
"videos": [
{
"url": "https://s.yimg.com/bp/Files/8a1258ca99cef3d4955353d3503549b41e496fa9.qt",
"order": 1
}
]
}
],
"name": "賣場名稱",
"partNo": "主件商品料號",
"shareMediaBetweenModels": true,
"shortDescription": [
"新的商品特色",
"新的商品特色2"
],
"syncProductImages": true,
"warranty": {
"description": "保固說明文字",
"handler": "official",
"period": "一個月",
"scope": "新品瑕疵",
"productStatus": "new"
}
},
"modifiedTimes": 1,
"modifiedTs": "2019-12-23T10:27:41Z",
"modifier": "modifier-id",
"note": "proposal-note",
"reviewStatus": "draft",
"subProposals": [
{
"id": 244080,
"type": "updateImageV2"
},
{
"id": 244081,
"type": "updateVideo"
},
{
"id": 244082,
"type": "updateCopy"
}
],
"subStationId": "sub",
"subStationName": "sub-station-name",
"supplierId": 99999
}
]
}