データスキーマ: 倉庫とロケーション

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"}

追加フィールド: いいえ

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"}

追加フィールド: いいえ

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"}

追加フィールド: いいえ

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文字列必須

最終更新時刻。

format: "date-time"

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

version整数必須

同時更新制御に使うリソースバージョン。

例: 1

warehouse_id文字列必須

倉庫識別子。

例: "example"

追加フィールド: いいえ

location_id文字列必須

倉庫ロケーション識別子。

制約

pattern

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

例: "example"

on_hand整数必須

実在庫数。

minimum: 0maximum: 2147483647

例: 1

追加フィールド: いいえ

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

追加フィールド: いいえ