跳至內容
ShopentlyLearn
繁體中文

資料架構: 庫存

資料架構: 庫存. API 接收或傳回的資料欄位、類型和限制。

資料架構

分配給倉庫庫位的數量

AllocationData · 架構 · 資料架構: 庫存
location_code字串必填

倉庫庫位代碼。

示例: "example"
location_id字串必填

倉庫庫位識別碼。

示例: "example"
location_name字串必填

倉庫庫位名稱。

示例: "example"
on_hand整數必填

實物庫存數量。

示例: 10

附加欄位: 否

取得清單 · 庫存 — 庫存 — 回應

ApiResponse_list_StockData__ · API 接收或傳回的資料欄位、類型和限制。
data陣列 <StockData > 必填

回應示例 · ApiResponse_list_StockData__.

示例: [{"active":true,"available":5,"id":"stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ","manual_reserved":2,"on_hand":10,"reserved":3,"sellable_limit":10,"target_id":"example","target_type":"product","total_reserved":5,"updated_at":"2026-01-01T12:00:00Z","version":1,"warehouse_id":"example"}]
metaContextPageMeta ContextMeta PageMeta RequestMeta 必填

回應元資料。

示例: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

附加欄位: 否

取得 · 庫存 — 庫存 — 回應

ApiResponse_StockDetailData_ · API 接收或傳回的資料欄位、類型和限制。
dataStockDetailData 必填

回應示例 · StockDetailData.

示例: {"active":true,"allocations":[{"location_code":"example","location_id":"example","location_name":"example","on_hand":10}],"available":5,"id":"stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ","manual_reserved":2,"on_hand":10,"reserved":3,"sellable_limit":10,"target_id":"example","target_type":"product","total_reserved":5,"updated_at":"2026-01-01T12:00:00Z","version":1,"warehouse_id":"example"}
metaContextPageMeta ContextMeta PageMeta RequestMeta 必填

回應元資料。

示例: {"request_id":"example"}

附加欄位: 否

更新 · 手動預留 — 庫存 — 請求本文

ManualReservationUpdate · API 接收或傳回的資料欄位、類型和限制。
expected_version整數必填

寫入前讀取的版本；不匹配時拒絕更新。

minimum: 1maximum: 9223372036854775807
示例: 1
manual_reserved整數必填

手動預留數量。

minimum: 0maximum: 2147483647
示例: 1
reason字串選填

記錄的變更原因。

maxLength: 500
預設值: ""

附加欄位: 否

更新 · 銷售上限 — 庫存 — 請求本文

SalesLimitUpdate · API 接收或傳回的資料欄位、類型和限制。
expected_version整數必填

寫入前讀取的版本；不匹配時拒絕更新。

minimum: 1maximum: 9223372036854775807
示例: 1
reason字串選填

記錄的變更原因。

maxLength: 500
預設值: ""
sellable_limit整數必填

銷售上限：-1 表示不限，0 表示不可銷售。

minimum: -1maximum: 2147483647
示例: 1

附加欄位: 否

建立 · 庫存調整 — 庫存 — 請求本文

StockAdjustmentCreate · API 接收或傳回的資料欄位、類型和限制。
expected_version整數必填

寫入前讀取的版本；不匹配時拒絕更新。

minimum: 0maximum: 9223372036854775807
示例: 0
locations陣列 <LocationQuantity > 必填

倉庫庫位。

minItems: 1maxItems: 100
示例: [{"location_id":"example","on_hand":1}]
reason字串必填

記錄的變更原因。

minLength: 1maxLength: 500
示例: "Example"
target_id字串必填

操作影響的產品或變體識別碼。

約束
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
示例: "example"
target_type字串必填

操作針對產品還是變體。

約束
enum
["product", "variant"]
示例: "product"
warehouse_id字串必填

倉庫識別碼。

約束
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
示例: "example"

附加欄位: 否

更新 · 庫存 — 庫存 — 請求本文

StockAdjustmentUpdate · API 接收或傳回的資料欄位、類型和限制。
expected_version整數必填

寫入前讀取的版本；不匹配時拒絕更新。

minimum: 1maximum: 9223372036854775807
示例: 1
locations陣列 <LocationQuantity > 必填

倉庫庫位。

minItems: 1maxItems: 100
示例: [{"location_id":"example","on_hand":1}]
reason字串必填

記錄的變更原因。

minLength: 1maxLength: 500
示例: "Example"

附加欄位: 否

取得清單 · 庫存 — 庫存 — 回應

StockData · API 接收或傳回的資料欄位、類型和限制。
active布林值必填

資源是否處於活動狀態。

示例: true
available整數 null必填

可售數量；null 表示數量不限。

示例: 5
id字串必填

資源識別碼；請保留回傳的原值。 (StockData).

示例: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"
manual_reserved整數必填

手動預留數量。

示例: 2
on_hand整數必填

實物庫存數量。

示例: 10
reserved整數必填

訂單預留數量。

示例: 3
sellable_limit整數必填

銷售上限：-1 表示不限，0 表示不可銷售。

示例: 10
target_id字串必填

操作影響的產品或變體識別碼。

示例: "example"
target_type字串必填

操作針對產品還是變體。

約束
enum
["product", "variant"]
示例: "product"
total_reserved整數必填

總預留數量。

示例: 5
updated_at字串必填

最近更新時間。

format: "date-time"
示例: "2026-01-01T12:00:00Z"
version整數必填

用於並行控制的資源版本。

示例: 1
warehouse_id字串必填

倉庫識別碼。

示例: "example"

附加欄位: 否

取得 · 庫存 — 庫存 — 回應

StockDetailData · API 接收或傳回的資料欄位、類型和限制。
active布林值必填

資源是否處於活動狀態。

示例: true
allocations陣列 <AllocationData > 必填

分配給倉庫庫位的數量。

示例: [{"location_code":"example","location_id":"example","location_name":"example","on_hand":10}]
available整數 null必填

可售數量；null 表示數量不限。

示例: 5
id字串必填

資源識別碼；請保留回傳的原值。 (StockDetailData).

示例: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"
manual_reserved整數必填

手動預留數量。

示例: 2
on_hand整數必填

實物庫存數量。

示例: 10
reserved整數必填

訂單預留數量。

示例: 3
sellable_limit整數必填

銷售上限：-1 表示不限，0 表示不可銷售。

示例: 10
target_id字串必填

操作影響的產品或變體識別碼。

示例: "example"
target_type字串必填

操作針對產品還是變體。

約束
enum
["product", "variant"]
示例: "product"
total_reserved整數必填

總預留數量。

示例: 5
updated_at字串必填

最近更新時間。

format: "date-time"
示例: "2026-01-01T12:00:00Z"
version整數必填

用於並行控制的資源版本。

示例: 1
warehouse_id字串必填

倉庫識別碼。

示例: "example"

附加欄位: 否