データスキーマ: 在庫

location_code文字列必須

倉庫ロケーションのコード。

例: "example"

location_id文字列必須

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

例: "example"

location_name文字列必須

倉庫ロケーション名。

例: "example"

on_hand整数必須

実在庫数。

例: 10

追加フィールド: いいえ

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

追加フィールド: いいえ

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

追加フィールド: いいえ

expected_version整数必須

書き込み前に取得したバージョン。不一致の場合は更新を拒否します。

minimum: 1maximum: 9223372036854775807

例: 1

manual_reserved整数必須

手動で引き当てた数量。

minimum: 0maximum: 2147483647

例: 1

reason文字列任意

変更の記録理由。

maxLength: 500

既定値: ""

追加フィールド: いいえ

expected_version整数必須

書き込み前に取得したバージョン。不一致の場合は更新を拒否します。

minimum: 1maximum: 9223372036854775807

例: 1

reason文字列任意

変更の記録理由。

maxLength: 500

既定値: ""

sellable_limit整数必須

販売上限。-1 は無制限、0 は販売不可を表します。

minimum: -1maximum: 2147483647

例: 1

追加フィールド: いいえ

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"

追加フィールド: いいえ

expected_version整数必須

書き込み前に取得したバージョン。不一致の場合は更新を拒否します。

minimum: 1maximum: 9223372036854775807

例: 1

locations配列 <LocationQuantity > 必須

倉庫ロケーション。

minItems: 1maxItems: 100

例: [{"location_id":"example","on_hand":1}]

reason文字列必須

変更の記録理由。

minLength: 1maxLength: 500

例: "Example"

追加フィールド: いいえ

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"

追加フィールド: いいえ

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"

追加フィールド: いいえ