コンテンツにスキップ
ShopentlyLearn

データスキーマ: 属性と値

データスキーマ: 属性と値. API が受け取る、または返すデータのフィールド、型、制約。

データスキーマ

取得 — 属性と値 — レスポンス

ApiResponse_FeatureData_ · API が受け取る、または返すデータのフィールド、型、制約。
dataFeatureData 必須

レスポンス例 · FeatureData.

例: {"created_at":"2026-01-01T12:00:00Z","id":"example","name":"Example","number":"example","position":1,"updated_at":"2026-01-01T12:00:00Z","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta 必須

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

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

追加フィールド: いいえ

取得 · 値 — 属性と値 — レスポンス

ApiResponse_FeatureValueData_ · API が受け取る、または返すデータのフィールド、型、制約。
dataFeatureValueData 必須

レスポンス例 · FeatureValueData.

例: {"created_at":"2026-01-01T12:00:00Z","feature_id":"example","id":"example","number":"example","position":1,"updated_at":"2026-01-01T12:00:00Z","value":"example","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta 必須

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

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

追加フィールド: いいえ

一覧取得 — 属性と値 — レスポンス

ApiResponse_list_FeatureData__ · API が受け取る、または返すデータのフィールド、型、制約。
data配列 <FeatureData > 必須

レスポンス例 · ApiResponse_list_FeatureData__.

例: [{"created_at":"2026-01-01T12:00:00Z","id":"example","name":"Example","number":"example","position":1,"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"}

追加フィールド: いいえ

一覧取得 · 値 — 属性と値 — レスポンス

ApiResponse_list_FeatureValueData__ · API が受け取る、または返すデータのフィールド、型、制約。
data配列 <FeatureValueData > 必須

レスポンス例 · ApiResponse_list_FeatureValueData__.

例: [{"created_at":"2026-01-01T12:00:00Z","feature_id":"example","id":"example","number":"example","position":1,"updated_at":"2026-01-01T12:00:00Z","value":"example","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"}

追加フィールド: いいえ

作成 — 属性と値 — リクエスト本文

FeatureCreate · API が受け取る、または返すデータのフィールド、型、制約。
name文字列必須

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

minLength: 1maxLength: 120
制約
pattern
"^[^\\x00]*$"
例: "Example"
position整数任意

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

minimum: 0maximum: 2147483647

追加フィールド: いいえ

取得 — 属性と値 — レスポンス

FeatureData · API が受け取る、または返すデータのフィールド、型、制約。
created_at文字列必須

作成時刻。

format: "date-time"
例: "2026-01-01T12:00:00Z"
id文字列必須

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

例: "example"
name文字列 null必須

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

例: "Example"
number文字列必須

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

例: "example"
position整数必須

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

例: 1
updated_at文字列必須

最終更新時刻。

format: "date-time"
例: "2026-01-01T12:00:00Z"
version整数必須

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

例: 1

追加フィールド: いいえ

商品の属性

FeatureSelectionData · スキーマ · データスキーマ: 属性と値
feature_id文字列必須

属性識別子。

例: "example"
feature_name文字列 null必須

属性名。

例: "example"
value文字列 null必須

周囲のスキーマで説明される値。

例: "example"
value_id文字列必須

辞書の値識別子。

例: "example"

追加フィールド: いいえ

更新 — 属性と値 — リクエスト本文

FeatureUpdate · API が受け取る、または返すデータのフィールド、型、制約。
expected_version整数必須

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

minimum: 1maximum: 9223372036854775807
例: 1
name文字列 null任意

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

文字列:minLength: 1maxLength: 120
制約 · 文字列 1
pattern
"^[^\\x00]*$"
例: "Example"
position整数任意

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

minimum: 0maximum: 2147483647

追加フィールド: いいえ

作成 · 値 — 属性と値 — リクエスト本文

FeatureValueCreate · API が受け取る、または返すデータのフィールド、型、制約。
expected_version整数必須

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

minimum: 1maximum: 9223372036854775807
例: 1
position整数任意

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

minimum: 0maximum: 2147483647
value文字列必須

周囲のスキーマで説明される値。

minLength: 1maxLength: 180
制約
pattern
"^[^\\x00]*$"
例: "Example"

追加フィールド: いいえ

取得 · 値 — 属性と値 — レスポンス

FeatureValueData · API が受け取る、または返すデータのフィールド、型、制約。
created_at文字列必須

作成時刻。

format: "date-time"
例: "2026-01-01T12:00:00Z"
feature_id文字列必須

属性識別子。

例: "example"
id文字列必須

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

例: "example"
number文字列必須

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

例: "example"
position整数必須

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

例: 1
updated_at文字列必須

最終更新時刻。

format: "date-time"
例: "2026-01-01T12:00:00Z"
value文字列 null必須

周囲のスキーマで説明される値。

例: "example"
version整数必須

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

例: 1

追加フィールド: いいえ

更新 · 値 — 属性と値 — リクエスト本文

FeatureValueUpdate · API が受け取る、または返すデータのフィールド、型、制約。
expected_version整数必須

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

minimum: 1maximum: 9223372036854775807
例: 1
position整数任意

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

minimum: 0maximum: 2147483647
value文字列 null任意

周囲のスキーマで説明される値。

文字列:minLength: 1maxLength: 180
制約 · 文字列 1
pattern
"^[^\\x00]*$"
例: "Example"

追加フィールド: いいえ