データスキーマ: バリエーションとオプション

data配列 <ProductVariantData > 必須

レスポンス例 · ApiResponse_list_ProductVariantData__.

例: [{"active":true,"created_at":"2026-01-01T12:00:00Z","id":"example","is_default":true,"media_ids":["example"],"position":1,"pricing":{"base_adjustment":{"amount":"0.00","currency":"PLN","minor_units":2},"market_price":null,"price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"product_version":1,"version":1},"primary_media_id":"example","product_id":"example","sku":"example","updated_at":"2026-01-01T12:00:00Z","values":[{"option_id":"example","option_name":"example","value":"example","value_id":"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"}

追加フィールド: いいえ

data配列 <shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData > 必須

レスポンス例 · ApiResponse_list_VariantOptionData__.

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

追加フィールド: いいえ

data配列 <VariantValueData > 必須

レスポンス例 · ApiResponse_list_VariantValueData__.

例: [{"color_hex":"#008855","created_at":"2026-01-01T12:00:00Z","id":"example","image_media_id":null,"number":"example","option_id":"example","position":1,"sku_code":"example","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"}

追加フィールド: いいえ

dataProductVariantData 必須

レスポンス例 · ProductVariantData.

例: {"active":true,"created_at":"2026-01-01T12:00:00Z","id":"example","is_default":true,"media_ids":["example"],"position":1,"pricing":{"base_adjustment":{"amount":"0.00","currency":"PLN","minor_units":2},"market_price":null,"price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"product_version":1,"version":1},"primary_media_id":"example","product_id":"example","sku":"example","updated_at":"2026-01-01T12:00:00Z","values":[{"option_id":"example","option_name":"example","value":"example","value_id":"example"}],"version":1}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta 必須

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

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

追加フィールド: いいえ

datashopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData 必須

レスポンス例 · shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData.

例: {"created_at":"2026-01-01T12:00:00Z","id":"example","name":"Example","number":"example","position":1,"selection_type":"button","updated_at":"2026-01-01T12:00:00Z","value_presentation_type":"text","version":1}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta 必須

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

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

追加フィールド: いいえ

dataVariantValueData 必須

レスポンス例 · VariantValueData.

例: {"color_hex":"#008855","created_at":"2026-01-01T12:00:00Z","id":"example","image_media_id":null,"number":"example","option_id":"example","position":1,"sku_code":"example","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"}

追加フィールド: いいえ

created_at文字列必須

作成時刻。

format: "date-time"

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

id文字列必須

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

例: "example"

name文字列 | null必須

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

例: "Example"

number文字列必須

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

例: "example"

position整数必須

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

例: 1

selection_type文字列必須

許可された属性値の選択方式。

制約

enum

["button", "dropdown"]

例: "button"

updated_at文字列必須

最終更新時刻。

format: "date-time"

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

value_presentation_type文字列必須

辞書の値を表示する方法。

制約

enum

["text", "color", "image"]

例: "text"

version整数必須

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

例: 1

追加フィールド: いいえ

active真偽値必須

リソースが有効かどうか。

例: true

created_at文字列必須

作成時刻。

format: "date-time"

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

id文字列必須

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

例: "example"

is_default真偽値必須

既定の選択肢かどうか。

例: true

media_ids配列 <文字列> 必須

既存のメディアアセット識別子。

例: ["example"]

position整数必須

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

例: 1

pricingVariantPricingData 必須

価格設定と同時更新制御用のバージョン。

例: {"base_adjustment":{"amount":"0.00","currency":"PLN","minor_units":2},"market_price":null,"price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"product_version":1,"version":1}

primary_media_id文字列 | null必須

主要メディアアセット識別子。

例: "example"

product_id文字列必須

商品識別子。

例: "example"

sku文字列必須

在庫管理単位のコード。

例: "example"

updated_at文字列必須

最終更新時刻。

format: "date-time"

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

values配列 <VariantChoiceData > 必須

辞書の値。

例: [{"option_id":"example","option_name":"example","value":"example","value_id":"example"}]

version整数必須

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

例: 1

追加フィールド: いいえ

option_id文字列必須

バリエーションオプション識別子。

例: "example"

option_name文字列 | null必須

バリエーションオプション名。

例: "example"

value文字列 | null必須

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

例: "example"

value_id文字列必須

辞書の値識別子。

例: "example"

追加フィールド: いいえ

active真偽値任意

リソースが有効かどうか。

既定値: true

expected_version整数必須

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

minimum: 1maximum: 9223372036854775807

例: 1

is_default真偽値任意

既定の選択肢かどうか。

media_ids配列 <文字列> 任意

既存のメディアアセット識別子。

maxItems: 20

配列:minLength: 1maxLength: 63

pricingVariantPrice 任意

価格設定と同時更新制御用のバージョン。

sku文字列任意

在庫管理単位のコード。

minLength: 1maxLength: 100

制約

pattern

"^\\S+$"

value_ids配列 <文字列> 必須

辞書の値識別子の一覧。

minItems: 1maxItems: 250

配列:minLength: 1maxLength: 63

例: ["example"]

追加フィールド: いいえ

name文字列必須

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

minLength: 1maxLength: 120

制約

pattern

"^[^\\x00]*$"

例: "Example"

selection_type文字列任意

許可された属性値の選択方式。

制約

enum

["button", "dropdown"]

既定値: "button"

value_presentation_type文字列任意

辞書の値を表示する方法。

制約

enum

["text", "color", "image"]

既定値: "text"

追加フィールド: いいえ

expected_version整数必須

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

minimum: 1maximum: 9223372036854775807

例: 1

name文字列 | null任意

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

文字列:minLength: 1maxLength: 120

制約 · 文字列 1

pattern

"^[^\\x00]*$"

例: "Example"

selection_type文字列任意

許可された属性値の選択方式。

制約

enum

["button", "dropdown"]

value_presentation_type文字列任意

辞書の値を表示する方法。

制約

enum

["text", "color", "image"]

追加フィールド: いいえ

amount文字列 | null必須

JSON 文字列として表した10進数の金額。null は許可される場合のみ。

文字列:maxLength: 20

制約 · 文字列 1

pattern

"^-?(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"

例: "0.00"

currency文字列必須

金額の通貨コード。

制約

pattern

"^[A-Z]{3}$"

例: "PLN"

expected_price_list_version整数必須

この書き込みに必要な、事前に取得した価格表バージョン。

minimum: 1maximum: 9223372036854775807

例: 1

expected_product_version整数必須

この書き込みに必要な、事前に取得した商品バージョン。

minimum: 0maximum: 9223372036854775807

例: 1

expected_version整数必須

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

minimum: 0maximum: 9223372036854775807

例: 0

kind文字列必須

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

制約

enum

["base_adjustment", "market_fixed"]

例: "base_adjustment"

price_list_id文字列必須

価格表識別子。

minLength: 1maxLength: 63

例: "example"

追加フィールド: いいえ

base_adjustmentMoneyData 必須

基準価格に対する価格調整。

例: {"amount":"0.00","currency":"PLN","minor_units":2}

market_priceMoneyData | null必須

選択した市場の価格。

例: null

pricePriceData | null必須

選択したコンテキストでの価格情報。

例: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}

product_version整数必須

同時更新制御に使う現在の商品バージョン。

例: 1

version整数必須

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

例: 1

追加フィールド: いいえ

active真偽値任意

リソースが有効かどうか。

expected_version整数必須

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

minimum: 1maximum: 9223372036854775807

例: 1

is_default真偽値任意

既定の選択肢かどうか。

media_ids配列 <文字列> 任意

既存のメディアアセット識別子。

maxItems: 20

配列:minLength: 1maxLength: 63

pricingVariantPrice 任意

価格設定と同時更新制御用のバージョン。

例: {"amount":"0.00","currency":"PLN","expected_price_list_version":1,"expected_product_version":1,"expected_version":0,"kind":"base_adjustment","price_list_id":"example"}

sku文字列任意

在庫管理単位のコード。

minLength: 1maxLength: 100

制約

pattern

"^\\S+$"

例: "example"

追加フィールド: いいえ

color_hex文字列 | null任意

16進数コードで表した色。

制約 · 文字列 1

pattern

"^#[0-9A-Fa-f]{6}$"

expected_version整数必須

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

minimum: 1maximum: 9223372036854775807

例: 1

value文字列必須

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

minLength: 1maxLength: 180

制約

pattern

"^[^\\x00]*$"

例: "Example"

追加フィールド: いいえ

color_hex文字列 | null必須

16進数コードで表した色。

例: "#008855"

created_at文字列必須

作成時刻。

format: "date-time"

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

id文字列必須

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

例: "example"

image_media_id文字列 | null必須

選択した画像アセットの識別子。

例: null

number文字列必須

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

例: "example"

option_id文字列必須

バリエーションオプション識別子。

例: "example"

position整数必須

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

例: 1

sku_code文字列必須

在庫管理単位のコード。

例: "example"

updated_at文字列必須

最終更新時刻。

format: "date-time"

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

value文字列 | null必須

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

例: "example"

version整数必須

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

例: 1

追加フィールド: いいえ

color_hex文字列 | null任意

16進数コードで表した色。

制約 · 文字列 1

pattern

"^#[0-9A-Fa-f]{6}$"

expected_version整数必須

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

minimum: 1maximum: 9223372036854775807

例: 1

value文字列 | null任意

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

文字列:minLength: 1maxLength: 180

制約 · 文字列 1

pattern

"^[^\\x00]*$"

例: "Example"

追加フィールド: いいえ