データスキーマ: 在庫

location_code文字列必須

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

例: "example"

location_id文字列必須

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

例: "example"

location_name文字列必須

倉庫ロケーション名。

例: "example"

on_hand整数必須

実在庫数。

例: 10

追加フィールド: いいえ

dataCodeContentData 必須

成功レスポンスのデータ。

例: {"code":"DEMO-ONE","delivery_id":null,"kind":"code","payload_id":"00000000-0000-4000-8000-000000000004","unit_id":"00000000-0000-4000-8000-000000000003"}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta 必須

レスポンスのメタデータ。

例: {"request_id":"example-request"}

追加フィールド: いいえ

dataDigitalUploadData 必須

成功レスポンスのデータ。

例: {"consumer_id":"00000000-0000-4000-8000-000000000001","consumer_kind":"digital_import","expires_at":"2026-11-03T13:00:00Z","filename":"codes.txt","id":"00000000-0000-4000-8000-000000000002","product_id":"example","purpose":"digital_import","received_bytes":18,"sha256":"636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a","size_bytes":18,"status":"ready"}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta 必須

レスポンスのメタデータ。

例: {"request_id":"example-request"}

追加フィールド: いいえ

dataImportData 必須

成功レスポンスのデータ。

例: {"delivery_id":null,"delivery_status":null,"delivery_version":null,"expected_count":2,"expires_at":"2026-11-03T13:00:00Z","id":"00000000-0000-4000-8000-000000000001","kind":"code","product_id":"example","status":"validated","validated_count":2,"validation_digest":"bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb","version":2}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta 必須

レスポンスのメタデータ。

例: {"request_id":"example-request"}

追加フィールド: いいえ

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

追加フィールド: いいえ

dataPoolData 必須

成功レスポンスのデータ。

例: {"configured":true,"counts":{"available":1,"held":0,"issued":1,"planned":0,"retired":0,"staged":0},"email_mode":"order_link","enabled":true,"order_version":2,"product_id":"example","retention_days":null,"version":1}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta 必須

レスポンスのメタデータ。

例: {"request_id":"example-request"}

追加フィールド: いいえ

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

追加フィールド: いいえ

dataUnitsData 必須

成功レスポンスのデータ。

例: {"order_version":2,"total":1,"units":[{"content_state":"present","delivery_id":"delivery-example","filename":null,"id":"00000000-0000-4000-8000-000000000003","issued_at":null,"kind":"code","location_id":"location-digital","mime_type":null,"payload_id":"00000000-0000-4000-8000-000000000004","product_id":"example","size_bytes":null,"sort_order":1,"state":"available","version":1,"warehouse_id":"warehouse-main"}]}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta 必須

レスポンスのメタデータ。

例: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example-request"}

追加フィールド: いいえ

code文字列必須

デジタルコードの正確な内容。大文字・小文字と内部の空白をそのまま保持します。

minLength: 1maxLength: 512

例: "DEMO-ONE"

delivery_id文字列 | null任意

入荷または注文への割り当てのID。

文字列:format: "uuid"

例: null

kind文字列任意

許可された値で示されるデータ構造の種類。

const: "code"

既定値: "code"例: "code"

payload_id文字列必須

内容のID。公開ダウンロードURLではありません。

format: "uuid"

例: "00000000-0000-4000-8000-000000000004"

unit_id文字列必須

個別のコードまたはファイルのID。

format: "uuid"

例: "00000000-0000-4000-8000-000000000003"

追加フィールド: いいえ

consumer_id文字列必須

関連するインポートまたは在庫単位のID。

format: "uuid"

例: "00000000-0000-4000-8000-000000000001"

consumer_kind文字列必須

アップロード先の種類：digital_import / digital_unit。

制約

enum

["digital_import", "digital_unit"]

例: "digital_import"

filename文字列必須

ファイル

minLength: 1maxLength: 255

例: "codes.txt"

purpose文字列必須

digital_import：TXT/CSV。digital_unit：個別販売するファイル。

制約

enum

["digital_unit", "digital_import"]

例: "digital_import"

sha256文字列必須

SHA-256 (hex, 64)

制約

pattern

"^[0-9a-f]{64}$"

例: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"

size_bytes整数必須

サイズ（バイト）

minimum: 1maximum: 262144000

例: 18

追加フィールド: いいえ

consumer_id文字列必須

関連するインポートまたは在庫単位のID。

format: "uuid"

例: "00000000-0000-4000-8000-000000000001"

consumer_kind文字列必須

アップロード先の種類：digital_import / digital_unit。

制約

enum

["digital_import", "digital_unit"]

例: "digital_import"

expires_at文字列必須

このアップロードまたはインポートの有効期限。

format: "date-time"

例: "2026-11-03T13:00:00Z"

filename文字列必須

ファイル

例: "codes.txt"

id文字列必須

リソース識別子。返された値をそのまま保持してください。

format: "uuid"

例: "00000000-0000-4000-8000-000000000002"

product_id文字列必須

商品識別子。

例: "example"

purpose文字列必須

digital_import：TXT/CSV。digital_unit：個別販売するファイル。

制約

enum

["digital_unit", "digital_import"]

例: "digital_import"

received_bytes整数必須

アップロード中… · サイズ（バイト）

例: 18

sha256文字列必須

SHA-256 (hex, 64)

例: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"

size_bytes整数必須

サイズ（バイト）

例: 18

status文字列必須

この操作で受け付けるステータス。

例: "ready"

追加フィールド: いいえ

delivered_at文字列必須

配送日時。

format: "date-time"

例: "2026-11-03T12:00:00Z"

expected_delivery_version整数必須

入荷のバージョン。新規入荷は0。

minimum: 0maximum: 0

例: 0

expected_sales_limit_version整数 | null任意

販売上限のバージョン。publish_for_sale=trueの場合に必須。

整数:minimum: 0maximum: 9223372036854775807

例: 0

expected_version整数必須

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

minimum: 1maximum: 9223372036854775807

例: 2

location_id文字列必須

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

制約

pattern

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

例: "location-digital"

publish_for_sale真偽値任意

trueは有限の販売上限も増加させます。falseは変更しません。

既定値: false例: true

status文字列必須

この操作で受け付けるステータス。

制約

enum

["planned", "received"]

例: "received"

validation_digest文字列必須

検証のチェックサム。確定時に変更せず送信します。

制約

pattern

"^[0-9a-f]{64}$"

例: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"

warehouse_id文字列必須

倉庫識別子。

制約

pattern

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

例: "warehouse-main"

追加フィールド: いいえ

count整数必須

バッチに含まれる正確な件数。

minimum: 1maximum: 1000

例: 2

kind文字列必須

許可された値で示されるデータ構造の種類。

制約

enum

["code", "file"]

例: "code"

追加フィールド: いいえ

delivery_id文字列 | null必須

入荷または注文への割り当てのID。

例: null

delivery_status文字列 | null必須

入荷状態：planned / received。確定前はnull。

例: null

delivery_version整数 | null必須

入荷記録の現在のバージョン。

例: null

expected_count整数必須

予定件数。バッチ全体が検証に合格する必要があります。

例: 2

expires_at文字列必須

このアップロードまたはインポートの有効期限。

format: "date-time"

例: "2026-11-03T13:00:00Z"

id文字列必須

リソース識別子。返された値をそのまま保持してください。

format: "uuid"

例: "00000000-0000-4000-8000-000000000001"

kind文字列必須

許可された値で示されるデータ構造の種類。

制約

enum

["code", "file"]

例: "code"

product_id文字列必須

商品識別子。

例: "example"

status文字列必須

この操作で受け付けるステータス。

例: "validated"

validated_count整数必須

直近の成功した検証で受理された件数。

例: 2

validation_digest文字列 | null必須

検証のチェックサム。確定時に変更せず送信します。

例: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"

version整数必須

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

例: 2

追加フィールド: いいえ

expected_delivery_version整数必須

入荷のバージョン。新規入荷は0。

minimum: 1maximum: 9223372036854775807

例: 1

expected_sales_limit_version整数 | null任意

販売上限のバージョン。publish_for_sale=trueの場合に必須。

整数:minimum: 0maximum: 9223372036854775807

expected_version整数必須

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

minimum: 1maximum: 9223372036854775807

例: 3

publish_for_sale真偽値任意

trueは有限の販売上限も増加させます。falseは変更しません。

既定値: false

追加フィールド: いいえ

code_column文字列 | null任意

コードを含むCSV列。codeを指定します。

文字列:const: "code"

expected_version整数必須

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

minimum: 1maximum: 9223372036854775807

例: 1

format文字列 | null任意

コード一覧の形式：txt / csv。ファイルにはupload_idsを使用します。

制約 · 文字列 1

enum

["txt", "csv"]

例: "txt"

source_upload_id文字列 | null任意

このインポートに属する準備済みの非公開TXT/CSVアップロード。

文字列:format: "uuid"

例: "00000000-0000-4000-8000-000000000002"

upload_ids配列 <文字列> | null任意

このインポートに属する1–100件の準備済み非公開ファイルアップロード。

配列:minItems: 1maxItems: 100

配列 / 配列:format: "uuid"

追加フィールド: いいえ

expected_delivery_version整数必須

入荷のバージョン。新規入荷は0。

minimum: 1maximum: 9223372036854775807

例: 1

expected_order_version整数必須

割り当て順のバージョン。購入注文のバージョンではありません。

minimum: 0maximum: 9223372036854775807

例: 1

expected_version整数必須

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

minimum: 1maximum: 9223372036854775807

例: 3

reason文字列必須

変更の記録理由。

minLength: 1maxLength: 500

例: "Withdraw a revoked license"

追加フィールド: いいえ

expected_version整数必須

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

minimum: 1maximum: 9223372036854775807

例: 1

manual_reserved整数必須

手動で引き当てた数量。

minimum: 0maximum: 2147483647

例: 1

reason文字列任意

変更の記録理由。

maxLength: 500

既定値: ""

追加フィールド: いいえ

email_mode文字列任意

disabled：メールなし。order_link：注文リンク。code_text：コードも含められます。

制約

enum

["disabled", "order_link", "code_text"]

既定値: "disabled"例: "order_link"

enabled真偽値必須

この設定が有効かどうか。

例: true

expected_version整数必須

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

minimum: 0maximum: 9223372036854775807

例: 0

retention_days整数 | null任意

nullは無期限、1–3650は初回アクセスからの日数。コードは自動削除しません。

整数:minimum: 1maximum: 3650

例: null

追加フィールド: いいえ

available整数必須

予約も引き渡しもされていない空きユニット数。

例: 1

held整数必須

注文用に予約済みで、まだ引き渡していない在庫。

例: 0

issued整数必須

支払い済みの購入に既に引き渡した在庫。

例: 1

planned整数必須

確定済みで、まだ受け入れていない入荷の在庫。

例: 0

retired整数必須

取り下げ後も履歴に残る在庫。

例: 0

staged整数必須

未完了インポート内の在庫。まだ販売在庫ではありません。

例: 0

追加フィールド: いいえ

configured真偽値必須

在庫設定が保存済みかどうか。

例: true

countsPoolCounts 必須

在庫状態ごとの件数。

例: {"available":1,"held":0,"issued":1,"planned":0,"retired":0,"staged":0}

email_mode文字列必須

disabled：メールなし。order_link：注文リンク。code_text：コードも含められます。

制約

enum

["disabled", "order_link", "code_text"]

例: "order_link"

enabled真偽値必須

この設定が有効かどうか。

例: true

order_version整数必須

在庫の割り当て順のバージョン。

例: 2

product_id文字列必須

商品識別子。

例: "example"

retention_days整数 | null必須

nullは無期限、1–3650は初回アクセスからの日数。コードは自動削除しません。

例: null

version整数必須

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

例: 1

追加フィールド: いいえ

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"

追加フィールド: いいえ

content_state文字列必須

内容の状態：present / deleting / deleted。

例: "present"

delivery_id文字列 | null必須

入荷または注文への割り当てのID。

例: "delivery-example"

filename文字列 | null必須

ファイル

例: null

id文字列必須

リソース識別子。返された値をそのまま保持してください。

format: "uuid"

例: "00000000-0000-4000-8000-000000000003"

issued_at文字列 | null必須

初回引き渡し日時。それ以前はnull。

文字列:format: "date-time"

例: null

kind文字列必須

許可された値で示されるデータ構造の種類。

制約

enum

["file", "code"]

例: "code"

location_id文字列 | null必須

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

例: "location-digital"

mime_type文字列 | null必須

メディアのコンテンツタイプ。

例: null

payload_id文字列必須

内容のID。公開ダウンロードURLではありません。

format: "uuid"

例: "00000000-0000-4000-8000-000000000004"

product_id文字列必須

商品識別子。

例: "example"

size_bytes整数 | null必須

サイズ（バイト）

例: null

sort_order整数必須

順序付きコレクション内の位置。

例: 1

state文字列必須

ステータス

例: "available"

version整数必須

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

例: 1

warehouse_id文字列 | null必須

倉庫識別子。

例: "warehouse-main"

追加フィールド: いいえ

expected_version整数必須

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

minimum: 1

例: 1

reason文字列必須

変更の記録理由。

minLength: 1maxLength: 500

例: "Withdraw a revoked license"

追加フィールド: いいえ

expected_order_version整数必須

割り当て順のバージョン。購入注文のバージョンではありません。

minimum: 1

例: 1

unit_ids配列 <文字列> 必須

フィルターなしのページにある全単位を希望順に並べた一覧。

minItems: 2maxItems: 100

配列:format: "uuid"

例: ["00000000-0000-4000-8000-000000000008","00000000-0000-4000-8000-000000000003"]

window_cursor文字列 | null任意

フィルターなしのページのカーソル。最初のページはnull。

文字列:maxLength: 1024

追加フィールド: いいえ

code文字列 | null任意

デジタルコードの正確な内容。大文字・小文字と内部の空白をそのまま保持します。

文字列:minLength: 1maxLength: 512

例: "SYNTHETIC-REPLACEMENT"

expected_version整数必須

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

minimum: 1

例: 1

reason文字列必須

変更の記録理由。

minLength: 1maxLength: 500

例: "Replace an invalid activation code"

upload_id文字列 | null任意

リソース識別子。返された値をそのまま保持してください。 · upload_id

文字列:format: "uuid"

追加フィールド: いいえ

order_version整数必須

在庫の割り当て順のバージョン。

例: 2

total整数必須

合計金額。

例: 1

units配列 <UnitData > 必須

在庫のメタデータ。内容の取得には別の認証済みリクエストが必要です。

例: [{"content_state":"present","delivery_id":"delivery-example","filename":null,"id":"00000000-0000-4000-8000-000000000003","issued_at":null,"kind":"code","location_id":"location-digital","mime_type":null,"payload_id":"00000000-0000-4000-8000-000000000004","product_id":"example","size_bytes":null,"sort_order":1,"state":"available","version":1,"warehouse_id":"warehouse-main"}]

追加フィールド: はい