数据架构: 仓库与库位

数据架构: 仓库与库位. API 接收或返回的数据字段、类型和约束。

数据架构

获取列表 · 库位 — 仓库与库位 — 响应

ApiResponse_list_LocationData__ · API 接收或返回的数据字段、类型和约束。

data数组 <LocationData > 必填: 响应示例 · ApiResponse_list_LocationData__.

示例: [{"code":"example","created_at":"2026-01-01T12:00:00Z","id":"example","is_leaf":true,"location_type":"zone","name":"Example","parent_id":null,"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_list_WarehouseData__ · API 接收或返回的数据字段、类型和约束。

data数组 <WarehouseData > 必填: 响应示例 · ApiResponse_list_WarehouseData__.

示例: [{"active":true,"address_line":"example","city":"example","code":"example","country_code":"PL","created_at":"2026-01-01T12:00:00Z","customer_visible":false,"id":"example","name":"Example","postal_code":"example","updated_at":"2026-01-01T12:00:00Z","version":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta 必填: 响应元数据。

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

附加字段: 否

获取 — 仓库与库位 — 响应

ApiResponse_WarehouseData_ · API 接收或返回的数据字段、类型和约束。

dataWarehouseData 必填: 响应示例 · WarehouseData.

示例: {"active":true,"address_line":"example","city":"example","code":"example","country_code":"PL","created_at":"2026-01-01T12:00:00Z","customer_visible":false,"id":"example","name":"Example","postal_code":"example","updated_at":"2026-01-01T12:00:00Z","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta 必填: 响应元数据。

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

附加字段: 否

获取列表 · 库位 — 仓库与库位 — 响应

LocationData · API 接收或返回的数据字段、类型和约束。

code字符串必填

稳定的机器可读代码。

示例: "example"

created_at字符串必填

创建时间。

format: "date-time"

示例: "2026-01-01T12:00:00Z"

id字符串必填

资源标识符；请保留返回的原值。 (LocationData).

示例: "example"

is_leaf布尔值必填

分类是否没有子分类。

示例: true

location_type字符串必填

仓库库位类型。

约束

enum: ["zone", "rack", "shelf", "bin"]

示例: "zone"

name字符串必填

对应上下文中的资源名称。

示例: "Example"

parent_id字符串 null必填

父分类标识符。

示例: null

updated_at字符串必填

仓库库位

LocationQuantity · 架构 · 数据架构: 仓库与库位

location_id字符串必填

仓库库位标识符。

约束

pattern: "^[a-z0-9][a-z0-9_-]{0,62}$"

示例: "example"

on_hand整数必填

实物库存数量。

minimum: 0maximum: 2147483647

示例: 1

附加字段: 否

获取 — 仓库与库位 — 响应

WarehouseData · API 接收或返回的数据字段、类型和约束。

active布尔值必填: 资源是否处于活动状态。

示例: true
address_line字符串 null必填: 地址行。

示例: "example"
city字符串 null必填: 城市或地方。

示例: "example"
code字符串必填: 稳定的机器可读代码。

示例: "example"
country_code字符串必填: 国家代码。

示例: "PL"
created_at字符串必填: 创建时间。

format: "date-time"

示例: "2026-01-01T12:00:00Z"
customer_visible布尔值必填: 客户是否可见此状态。

示例: false
id字符串必填: 资源标识符；请保留返回的原值。 (WarehouseData).

示例: "example"
name字符串必填: 对应上下文中的资源名称。

示例: "Example"
postal_code字符串 null必填: 邮政编码。

示例: "example"
updated_at字符串必填: 最近更新时间。

format: "date-time"

示例: "2026-01-01T12:00:00Z"
version整数必填: 用于并发控制的资源版本。

示例: 1

附加字段: 否