商品庫存查詢與更新 #
庫存單筆更新 #
更新 單筆商品庫存
。
Endpoint URL: https://tw.scm.yahooapis.com/scmapi/api/GdStock/UpdateQty
HTTP Method: POST
Request Body #
ProductId #
商品編號。
資料型態: Integer
必填: 是
說明: 需為正整數
Qty #
數量。
資料型態: Integer
必填: 是
說明:
- 加量:正整數
- 減量:負數
- 輸入0:顯示結果為
可銷售數量無異動
- 若更新數量為負數且大於可銷售數量時,則顯示結果為
更新成功
可銷售數量會更新至0
Request/Response Sample #
POST /scmapi/api/GdStock/UpdateQty
{
"ProductId": 6923827,
"Qty": 2
}
{
"UpdateQty": 2,
"IsAbstract": false,
"Message": "目前可銷售數量為:5, 欲增加數量為:2, 實際增加數量:2, 結果:更新成功"
}
Response Elements #
若操作成功,API 會回傳 HTTP 200 response。並以 JSON 格式回傳完整的更新後商品庫存。
UpdateQty #
庫存數量。
資料型態: Integer
說明:更新後的庫存數量
IsAbstract #
是否為虛主件。
資料型態: Boolean
說明:
- true: 虛主件,庫存數量固定為:32767
- false: 主件商品
Message #
訊息狀態。
資料型態: String
說明:顯示更新成功與否的訊息
Errors #
Bad Request #
輸入的參數不符合 API 定義的 Pattern。
HTTP Status Code: 403
Error
Error Code | Description |
---|---|
Invalid input | |
403 | 商品編號有誤,請查明後重新查詢 |