Skip to navigation

查詢規格(SKU)庫存

View as Markdown

依 id 查詢單一規格目前的庫存,同時回傳兩個數字,務必分清楚:inventoryQuantity 是實際在庫的物理數量,availableQuantity 是扣掉已保留/已成立訂單佔用後、目前還能被賣出的可售數量。

回應也帶 isNegativeStockAllowed,表示這顆規格是否允許負庫存。

id 不存在、屬於其他租戶,或指向組合 SKU 時,一律回傳 404 not_found;組合品的庫存請改查 GET /v1/bundles/{id}/stock。

Authentication

X-Signaturestring

每個 /v1 請求都必須帶 X-Client-Id、X-Timestamp、X-Nonce 與 X-Signature 四個標頭。X-Signature 是以 client secret 對 canonical string 做 HMAC-SHA256 後的 Base64。

canonical string 的組成、可複製的簽章範例與 401 排查步驟,請參閱「驗證與簽章」。

Path parameters

idlongRequired

要查詢庫存的規格序號。不存在、屬於其他租戶,或指向組合 SKU 時,一律回傳 404 not_found。

Response

OK
skuIdlongOptional

規格序號。

inventoryQuantitydoubleOptional

實際在庫的物理數量,尚未扣除任何保留或已成立訂單的佔用。

availableQuantitydoubleOptional

可售數量,等於 inventoryQuantity 扣掉已保留/已成立訂單佔用的部分,是目前真正還能被賣出的數量。

isNegativeStockAllowedbooleanOptional

是否允許負庫存:true 時超出現貨的部分仍可下單(記為預購)。

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error