取得賣場資訊調整提案單

取得賣場資訊調整提案 #

取得賣場資訊調整提案單 #

取得已建立的 賣場資訊調整提案單

Endpoint URL: https://tw.supplier.yahoo.com/api/spa/v1/proposal/updateListings/{id}
HTTP Method: GET

Request Parameters #

id #

提案單號。
資料型態: Integer
必填: 是

Response Syntax #

{
  "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 格式回傳完整的 UpdateListingProposal 物件。

id #

提案編號。
資料型態: Integer

supplierId #

供應商編號。
資料型態: Integer

subProposals #

子提案申請類型。
資料型態: SubProposal[]
欄位內容:

  • id 新增賣場資訊調整提案單時所建立的子提案單號
  • type 子提案單號對應的提案類型

listing #

賣場資訊。
資料型態: ProposalListing

subStationId #

提案當下的提案子站編號, e.g. sub1
資料型態: String

subStationName #

提案當下的提案子站名稱。
資料型態: String

applicant #

提案人。
資料型態: String

appliedTs #

提案時間。
資料型態: String
格式: ISO-8601

expiredTs #

提案有效時間。
資料型態: String
格式: ISO-8601

contactWindow #

提案對象。
資料型態: String

createdTs #

建檔時間。
資料型態: String
格式: ISO-8601

creator #

建檔者。
資料型態: String

modifiedTimes #

更新次數。
資料型態: Integer

modifiedTs #

更新時間。
資料型態: String
格式: ISO-8601

modifier #

更新者。
資料型態: String

executeStatus #

執行狀態。
資料型態: String
有效值: 詳見 執行狀態

reviewStatus #

審核狀態。
資料型態: String
有效值: 詳見 審核狀態

note #

備註。
資料型態: String

suggestion #

改善或建議。
資料型態: String

Errors #

Bad Request #

輸入的參數不符合 API 定義的 Pattern。
HTTP Status Code: 400

Error Code Description
0 Invalid input
40000005 Contains illegal character(s)

Unauthorized #

身分認證不通過,請檢查您的 Cookiewssid
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

Forbidden #

身分認證不通過,請確認您擁有檢示提案單的權限。
HTTP Status Code: 403

Error Code Description
40304001 No permission

Not Found #

找不到提案單內容。
HTTP Status Code: 404

Error Code Description
40409000 Proposal not found

Internal Server Error #

API 端發生錯誤,若持續發生請洽您的業務窗口。

Examples #

取得提案單號為 244077 的提案單
GET /api/spa/v1/proposal/updateListings/244077 HTTP/1.1
HOST: tw.supplier.yahoo.com
Content-Type: application/json; charset=UTF-8
{
  "applicant": "applicant-name",
  "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"
        ]
      }
    ],
    "brandId": "41166484",
    "brandName": "2M2",
    "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": 244078,
      "type": "updateImageV2"
    },
    {
      "id": 244079,
      "type": "updateVideo"
    },
    {
      "id": 244080,
      "type": "updateCopy"
    },
    {
      "id": 244081,
      "type": "updateListingAttribute"
    }
  ],
  "subStationId": "sub-station-id",
  "subStationName": "sub-station-name",
  "supplierId": 99999
}