コンテンツにスキップ
ShopentlyLearn

データスキーマ: ブランド

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

データスキーマ

取得 — ブランド — レスポンス

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

レスポンス例 · BrandData.

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

追加フィールド: いいえ

一覧取得 — ブランド — レスポンス

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

レスポンス例 · ApiResponse_list_BrandData__.

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

追加フィールド: いいえ

作成 — ブランド — リクエスト本文

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

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

minLength: 1maxLength: 160
例: "Example"

追加フィールド: いいえ

取得 — ブランド — レスポンス

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

作成時刻。

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

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

例: "example"
name文字列必須

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

例: "Example"
number文字列必須

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

例: "example"
updated_at文字列必須

最終更新時刻。

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

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

例: 1

追加フィールド: いいえ

更新 — ブランド — リクエスト本文

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

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

minimum: 1maximum: 9223372036854775807
例: 1
name文字列必須

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

minLength: 1maxLength: 160
例: "Example"

追加フィールド: いいえ