跳至内容
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"

附加字段: 否