查詢提案

商品成本價格修改 #

查詢提案 #

查詢已建立的 商品成本價格修改提案單 列表，可依提案建檔日期、提案單編號、商品編號或賣場編號查詢。

  • 呼叫此 API 時，請在 Headers 中加入 api-version: 3。若使用 api-version: 1 或 api-version: 2，將回傳 "Code": "UnsupportedApiVersion" 的錯誤訊息。

Headers 範例

{
    "api-token": "Supplier_XXXX",
    "api-supplierid": "XXXX",
    "content-type": "application/json",
    "accept": "application/json",
    "api-version": "3"
}

Endpoint URL: https://tw.scm.yahooapis.com/scmapi/api/Proposal/Query
HTTP Method: POST

Request Body #

ProposalDate #

提案建檔日期區間。ProposalDate 的結構分別說明如下：

  • DateTimeStart：提案建檔日期起
  • DateTimeEnd：提案建檔日期迄

資料型態: Object
必填: 是
說明: 起迄區間不可超過 3 個月，且結束日期不可早於開始日期。時間格式為 ISO-8601，ex. 2026-04-01T00:00:00.000Z

DateTimeStart #

提案建檔日期起。
資料型態: dateTime
必填: 是

DateTimeEnd #

提案建檔日期迄。
資料型態: dateTime
必填: 是

QueryIdType #

查詢編號類型。
資料型態: Integer
必填: 否
預設值: 0
欄位內容:

  • 0: 提案單編號（預設）
  • 1: 商品編號
  • 2: 賣場編號

QueryIds #

查詢編號。
資料型態: Integer Array
必填: 否
說明: 對應 QueryIdType 的編號清單，最多輸入 20 筆；未填寫則查詢全部。

Request/Response Sample #

POST /scmapi/api/Proposal/Query

{
    "ProposalDate": {
        "DateTimeStart": "2026-05-19T14:00:00.000Z",
        "DateTimeEnd": "2026-05-19T17:08:00.000Z"
    },
    "QueryIdType": 1,
    "QueryIds": [
        7044770,
        6587517
    ]
}

{
    "Success": true,
    "ResponseCode": "0",
    "Message": "成功",
    "Data": [
        {
            "Id": 1526979,
            "SubNo": 2,
            "Applicant": "測試人員",
            "Type": "PriceCost",
            "ApplyDate": "2026-05-19T15:56:26.813",
            "EndDate": "2026-07-19T23:59:59",
            "VerifyDate": "2026-05-19T15:56:28.41",
            "VerifyStatus": 1,
            "ExecuteStatus": 0
        },
        {
            "Id": 1526980,
            "SubNo": 2,
            "Applicant": "測試人員",
            "Type": "PriceCost",
            "ApplyDate": "2026-05-19T15:58:32.983",
            "EndDate": "2026-07-19T23:59:59",
            "VerifyDate": "2026-05-19T15:58:35.04",
            "VerifyStatus": 1,
            "ExecuteStatus": 0
        },
        {
            "Id": 1526981,
            "SubNo": 2,
            "Applicant": "測試人員",
            "Type": "PriceCost",
            "ApplyDate": "2026-05-19T16:05:46.083",
            "EndDate": "2026-07-19T23:59:59",
            "VerifyDate": "2026-05-19T16:05:46.703",
            "VerifyStatus": 1,
            "ExecuteStatus": 0
        },
        {
            "Id": 1526982,
            "SubNo": 4,
            "Applicant": "測試人員",
            "Type": "PriceCost",
            "ApplyDate": "2026-05-19T16:23:34.887",
            "EndDate": "2026-07-19T23:59:59",
            "VerifyDate": "2026-05-19T16:23:36.29",
            "VerifyStatus": 1,
            "ExecuteStatus": 0
        }
    ]
}

Response Elements #

若操作成功，API 會回傳 HTTP 200 response，並以 JSON 格式回傳結果。回傳內容採用統一格式（Success、ResponseCode、Message、Data），其中 Data 為符合查詢條件的提案單陣列，各欄位說明如下：

Id #

提案編號。
資料型態: Integer

SubNo #

提案子站。
資料型態: Integer

Applicant #

提案人員。
資料型態: String

Type #

提案類型。
資料型態: String
說明: 成本價格提案固定回傳 PriceCost

ApplyDate #

提案日期。
資料型態: dateTime

EndDate #

提案有效日期。
資料型態: dateTime

VerifyDate #

審核日期。
資料型態: dateTime

VerifyStatus #

審核狀態。
資料型態: Integer
欄位內容:

  • 0: 待審核
  • 1: 已通過
  • 2: 不通過
  • 3: 已過期
  • 4: 尚未提案

ExecuteStatus #

執行狀態。
資料型態: Integer
欄位內容:

  • 0: 未執行
  • 1: 執行成功
  • 2: 執行失敗

Errors #

當 Success 為 false 時，ResponseCode 會回傳對應的錯誤代碼（代碼定義請參考 建立提案 的「執行結果代碼表」），Message 會以 \r\n 串接所有檢核失敗訊息。各欄位檢核項目如下：

檢核項目
檢核欄位 檢核內容 錯誤代碼 錯誤訊息
提案建檔日期起 必填 4001 提案建檔日期起為必填
提案建檔日期迄 必填 4001 提案建檔日期迄為必填
提案建檔日期 起迄區間不可超過 3 個月 4001 提案建檔日期起迄區間不可超過3個月
提案建檔日期 結束日期不可早於開始日期 4001 提案建檔結束日期不可早於開始日期
查詢編號類型 查詢編號類型非 0,1,2 4001 查詢編號類型無效
查詢編號 最多 20 筆 4001 查詢編號查詢上限為20筆

錯誤回傳範例 # 

{
    "Success": true,
    "ResponseCode": "4001",
    "Message": "參數錯誤：提案建檔日期起為必填\r\n提案建檔日期迄為必填\r\n",
    "Data": null
}