データスキーマ: カテゴリー

dataCategoryDetailData 必須

レスポンス例 · CategoryDetailData.

例: {"created_at":"2026-01-01T12:00:00Z","description":"example","id":"example","introduction":"example","is_available":true,"is_visible":false,"meta_description":"example","meta_keywords":["example"],"meta_title":"example","name":"Example","number":"example","parent_id":null,"slug":"example","updated_at":"2026-01-01T12:00:00Z","version":1}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta 必須

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

例: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

追加フィールド: いいえ

data配列 <CategorySummaryData > 必須

レスポンス例 · ApiResponse_list_CategorySummaryData__.

例: [{"created_at":"2026-01-01T12:00:00Z","id":"example","is_available":true,"is_visible":false,"name":"Example","number":"example","parent_id":null,"slug":"example","updated_at":"2026-01-01T12:00:00Z","version":1}]

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta 必須

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

例: {"locale":"en","market_code":"PL","market_id":"example","pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

追加フィールド: いいえ

description文字列 | null任意

選択した言語での説明。

文字列:maxLength: 50000

introduction文字列 | null任意

選択した言語での紹介文。

文字列:maxLength: 5000

is_visible真偽値任意

リソースを表示するかどうか。

既定値: false

market_ids配列 <文字列> 任意

選択した市場の識別子。

maxItems: 1000

配列:minLength: 1maxLength: 63

meta_description文字列 | null任意

選択した言語での検索エンジン向け説明。

文字列:maxLength: 160

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

選択した言語での検索エンジン向けキーワード。

配列:maxItems: 20

配列 / 配列:maxLength: 50

meta_title文字列 | null任意

選択した言語での検索エンジン向けタイトル。

文字列:maxLength: 70

name文字列必須

該当コンテキストでのリソース名。

minLength: 1maxLength: 200

例: "Example"

parent_id文字列 | null任意

親カテゴリー識別子。

文字列:minLength: 1maxLength: 63

slug文字列 | null任意

選択した言語での URL パス部分。

文字列:maxLength: 160

追加フィールド: いいえ

created_at文字列必須

作成時刻。

format: "date-time"

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

description文字列 | null必須

選択した言語での説明。

例: "example"

id文字列必須

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

例: "example"

introduction文字列 | null必須

選択した言語での紹介文。

例: "example"

is_available真偽値必須

このコンテキストで対象を利用できるかどうか。

例: true

is_visible真偽値必須

リソースを表示するかどうか。

例: false

meta_description文字列 | null必須

選択した言語での検索エンジン向け説明。

例: "example"

meta_keywords配列 <文字列> | null必須

選択した言語での検索エンジン向けキーワード。

例: ["example"]

meta_title文字列 | null必須

選択した言語での検索エンジン向けタイトル。

例: "example"

name文字列 | null必須

該当コンテキストでのリソース名。

例: "Example"

number文字列必須

人向けの注文番号または申請番号。

例: "example"

parent_id文字列 | null必須

親カテゴリー識別子。

例: null

slug文字列 | null必須

選択した言語での URL パス部分。

例: "example"

updated_at文字列必須

最終更新時刻。

format: "date-time"

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

version整数必須

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

例: 1

追加フィールド: いいえ

created_at文字列必須

作成時刻。

format: "date-time"

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

id文字列必須

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

例: "example"

is_available真偽値必須

このコンテキストで対象を利用できるかどうか。

例: true

is_visible真偽値必須

リソースを表示するかどうか。

例: false

name文字列 | null必須

該当コンテキストでのリソース名。

例: "Example"

number文字列必須

人向けの注文番号または申請番号。

例: "example"

parent_id文字列 | null必須

親カテゴリー識別子。

例: null

slug文字列 | null必須

選択した言語での URL パス部分。

例: "example"

updated_at文字列必須

最終更新時刻。

format: "date-time"

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

version整数必須

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

例: 1

追加フィールド: いいえ

description文字列 | null任意

選択した言語での説明。

文字列:maxLength: 50000

expected_version整数必須

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

minimum: 1maximum: 9223372036854775807

例: 1

introduction文字列 | null任意

選択した言語での紹介文。

文字列:maxLength: 5000

is_visible真偽値任意

リソースを表示するかどうか。

market_ids配列 <文字列> 任意

選択した市場の識別子。

maxItems: 1000

配列:minLength: 1maxLength: 63

meta_description文字列 | null任意

選択した言語での検索エンジン向け説明。

文字列:maxLength: 160

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

選択した言語での検索エンジン向けキーワード。

配列:maxItems: 20

配列 / 配列:maxLength: 50

meta_title文字列 | null任意

選択した言語での検索エンジン向けタイトル。

文字列:maxLength: 70

name文字列 | null任意

該当コンテキストでのリソース名。

文字列:maxLength: 200

例: "Example"

parent_id文字列 | null任意

親カテゴリー識別子。

文字列:minLength: 1maxLength: 63

slug文字列 | null任意

選択した言語での URL パス部分。

文字列:maxLength: 160

追加フィールド: いいえ