Skip to navigation

查詢單一規格

View as Markdown

依 id 查詢單一規格。若該 id 不存在、屬於其他租戶,或指向的是組合 SKU,一律回傳 404 not_found,這幾種情況無法從回應內容區分。

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
idlongOptional

規格序號。

productIdlongOptional

所屬的商品序號;未加入任何商品時為 0。

outerSysCodestring or nullOptional

ERP 端的規格代碼。

namestring or nullOptional

名稱。

barcodestring or nullOptional

條碼。

warehousestring or nullOptional

倉別。

unitstring or nullOptional

商品單位。

specstring or nullOptional

規格內容(例如「12入」「500g」)。

pricedoubleOptional

價格。

sellPricedoubleOptional

賣價。

quantityPrecisionintegerOptional

數量精度(0 為整數,1 至 4 為小數位數)。

statusstring or nullOptional

規格狀態,共三種:Active(上架)、Inactive(下架)、GiftOnly(僅供贈品)。與商品狀態不同,規格沒有「下架-顯示」(InactiveVisible)這個狀態。

可以透過建立或更新規格寫入;建立時省略為 Active。

inventoryQuantitydoubleOptional

目前的在庫數量,唯讀,規格主檔的寫入端點永遠不會異動這個值。這裡是實際在庫的物理數量,不含已保留/已成立訂單的扣抵;需要可售數請改查 GET /v1/skus/{id}/stock 的 availableQuantity。

Errors

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