資料架構: 倉庫與庫位

資料架構: 倉庫與庫位. 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

附加欄位: 否