データスキーマ: 商品

data配列 <ProductSummaryData > 必須

レスポンス例 · ApiResponse_list_ProductSummaryData__.

例: [{"availability":{"available_from":null,"available_until":null,"is_available":true},"brand_id":null,"condition":"new","created_at":"2026-01-01T12:00:00Z","id":"example","name":"Example","number":"example","price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"price_version":1,"primary_category_id":"example","primary_media_id":"example","published":false,"sku":"example","slug":"example","tax_category_id":"example","updated_at":"2026-01-01T12:00:00Z","variants_enabled":false,"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"}

追加フィールド: いいえ

dataProductDetailData 必須

レスポンス例 · ProductDetailData.

例: {"availability":{"available_from":null,"available_until":null,"is_available":true},"brand_id":null,"condition":"new","created_at":"2026-01-01T12:00:00Z","description":"example","features":[{"feature_id":"example","feature_name":"example","value":"example","value_id":"example"}],"id":"example","identifiers":{},"media":[{"alt_text":"example","id":"example","is_primary":true,"kind":"image","mime_type":"image/jpeg","position":1,"url":"https://example.invalid/product.jpg"}],"meta_description":"example","meta_keywords":["example"],"meta_title":"example","name":"Example","number":"example","price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"price_version":1,"primary_category_id":"example","primary_media_id":"example","published":false,"sku":"example","slug":"example","tax_category_id":"example","updated_at":"2026-01-01T12:00:00Z","variants_enabled":false,"version":1}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta 必須

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

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

追加フィールド: いいえ

available_from文字列 | null必須

利用可能期間の開始。

文字列:format: "date-time"

例: null

available_until文字列 | null必須

利用可能期間の終了。

文字列:format: "date-time"

例: null

is_available真偽値必須

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

例: true

追加フィールド: いいえ

amount文字列必須

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

例: "0.00"

currency文字列必須

金額の通貨コード。

制約

pattern

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

例: "PLN"

minor_units整数必須

通貨で使用する小数桁数。

minimum: 0maximum: 4

例: 2

tax_included真偽値必須

送信した価格が税込みかどうか。

例: true

追加フィールド: いいえ

currency文字列必須

金額の通貨コード。

id文字列必須

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

tax_included真偽値必須

送信した価格が税込みかどうか。

version整数必須

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

追加フィールド: いいえ

brand_id文字列 | null任意

ブランド識別子。

文字列:minLength: 1maxLength: 63

condition文字列任意

商品の状態。

制約

enum

["new", "refurbished", "used", "returned", "display", "damaged"]

既定値: "new"

description文字列 | null任意

選択した言語での説明。

文字列:maxLength: 100000

feature_value_ids配列 <文字列> 任意

選択した属性値の識別子。

maxItems: 1000

配列:minLength: 1maxLength: 63

identifiersProductIdentifiers | null任意

商品識別コード。

market_ids配列 <文字列> 任意

選択した市場の識別子。

maxItems: 1000

配列:minLength: 1maxLength: 63

media_ids配列 <文字列> 任意

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

maxItems: 20

配列:minLength: 1maxLength: 63

meta_description文字列 | null任意

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

文字列:maxLength: 160

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

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

配列:maxItems: 20

配列 / 配列:maxLength: 50

meta_title文字列 | null任意

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

文字列:maxLength: 70

name文字列必須

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

minLength: 1maxLength: 300

例: "Example"

pricingProductPrice 任意

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

primary_category_id文字列 | null任意

主要カテゴリー識別子。

文字列:minLength: 1maxLength: 63

published真偽値任意

リソースが公開済みかどうか。

既定値: false

sku文字列必須

在庫管理単位のコード。

minLength: 1maxLength: 100

制約

pattern

"^\\S+$"

例: "example"

slug文字列 | null任意

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

文字列:maxLength: 160

tax_category_id文字列 | null任意

税カテゴリー識別子。

文字列:minLength: 1maxLength: 63

variant_value_ids配列 <文字列> 任意

選択したバリエーション値の識別子。

maxItems: 250

配列:minLength: 1maxLength: 63

variants_enabled真偽値任意

商品がバリエーションを使うかどうか。

既定値: false

追加フィールド: いいえ

availabilityAvailabilityData 必須

選択したコンテキストでの利用可能性。

例: {"available_from":null,"available_until":null,"is_available":true}

brand_id文字列 | null必須

ブランド識別子。

例: null

condition文字列必須

商品の状態。

制約

enum

["new", "refurbished", "used", "returned", "display", "damaged"]

例: "new"

created_at文字列必須

作成時刻。

format: "date-time"

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

description文字列 | null必須

選択した言語での説明。

例: "example"

features配列 <FeatureSelectionData > 必須

商品の属性。

例: [{"feature_id":"example","feature_name":"example","value":"example","value_id":"example"}]

id文字列必須

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

例: "example"

identifiersオブジェクト追加フィールド: 文字列必須

商品識別コード。

例: {}

media配列 <ProductMediaData > 必須

添付メディア情報。

例: [{"alt_text":"example","id":"example","is_primary":true,"kind":"image","mime_type":"image/jpeg","position":1,"url":"https://example.invalid/product.jpg"}]

meta_description文字列 | null必須

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

例: "example"

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

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

例: ["example"]

meta_title文字列 | null必須

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

例: "example"

name文字列 | null必須

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

例: "Example"

number文字列必須

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

例: "example"

pricePriceData | null必須

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

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

price_version整数必須

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

例: 1

primary_category_id文字列 | null必須

主要カテゴリー識別子。

例: "example"

primary_media_id文字列 | null必須

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

例: "example"

published真偽値必須

リソースが公開済みかどうか。

例: false

sku文字列必須

在庫管理単位のコード。

例: "example"

slug文字列 | null必須

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

例: "example"

tax_category_id文字列必須

税カテゴリー識別子。

例: "example"

updated_at文字列必須

最終更新時刻。

format: "date-time"

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

variants_enabled真偽値必須

商品がバリエーションを使うかどうか。

例: false

version整数必須

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

例: 1

追加フィールド: いいえ

ean文字列 | null任意

商品の EAN 識別子。

文字列:minLength: 1maxLength: 100

isbn文字列 | null任意

ISBN 識別子。

文字列:minLength: 1maxLength: 100

mpn文字列 | null任意

メーカー部品番号。

文字列:minLength: 1maxLength: 100

upc文字列 | null任意

商品の UPC 識別子。

文字列:minLength: 1maxLength: 100

追加フィールド: いいえ

alt_text文字列 | null必須

画像の代替テキスト。

例: "example"

id文字列必須

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

例: "example"

is_primary真偽値必須

主要な項目かどうか。

例: true

kind文字列必須

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

制約

enum

["image", "video", "model_3d"]

例: "image"

mime_type文字列必須

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

例: "image/jpeg"

position整数必須

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

例: 1

url文字列 | null必須

リソースの URL。

例: "https://example.invalid/product.jpg"

追加フィールド: いいえ

amount文字列 | null必須

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

文字列:maxLength: 19

制約 · 文字列 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_version整数必須

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

minimum: 0maximum: 9223372036854775807

例: 0

kind文字列必須

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

制約

enum

["base", "market_fixed"]

例: "base"

price_list_id文字列必須

価格表識別子。

minLength: 1maxLength: 63

例: "example"

tax_included真偽値必須

送信した価格が税込みかどうか。

例: true

追加フィールド: いいえ

availabilityAvailabilityData 必須

選択したコンテキストでの利用可能性。

例: {"available_from":null,"available_until":null,"is_available":true}

brand_id文字列 | null必須

ブランド識別子。

例: null

condition文字列必須

商品の状態。

制約

enum

["new", "refurbished", "used", "returned", "display", "damaged"]

例: "new"

created_at文字列必須

作成時刻。

format: "date-time"

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

id文字列必須

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

例: "example"

name文字列 | null必須

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

例: "Example"

number文字列必須

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

例: "example"

pricePriceData | null必須

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

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

price_version整数必須

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

例: 1

primary_category_id文字列 | null必須

主要カテゴリー識別子。

例: "example"

primary_media_id文字列 | null必須

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

例: "example"

published真偽値必須

リソースが公開済みかどうか。

例: false

sku文字列必須

在庫管理単位のコード。

例: "example"

slug文字列 | null必須

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

例: "example"

tax_category_id文字列必須

税カテゴリー識別子。

例: "example"

updated_at文字列必須

最終更新時刻。

format: "date-time"

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

variants_enabled真偽値必須

商品がバリエーションを使うかどうか。

例: false

version整数必須

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

例: 1

追加フィールド: いいえ

brand_id文字列 | null任意

ブランド識別子。

文字列:minLength: 1maxLength: 63

condition文字列任意

商品の状態。

制約

enum

["new", "refurbished", "used", "returned", "display", "damaged"]

description文字列 | null任意

選択した言語での説明。

文字列:maxLength: 100000

例: null

expected_variant_price_versionsオブジェクト追加フィールド: 整数

minimum: 0maximum: 9223372036854775807

任意

事前に取得した価格バージョン。キーはバリエーション識別子です。

maxProperties: 250

制約

propertyNames

{"maxLength": 63, "minLength": 1}

expected_version整数必須

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

minimum: 1maximum: 9223372036854775807

例: 1

feature_value_ids配列 <文字列> 任意

選択した属性値の識別子。

maxItems: 1000

配列:minLength: 1maxLength: 63

identifiersProductIdentifiers | null任意

商品識別コード。

market_ids配列 <文字列> 任意

選択した市場の識別子。

maxItems: 1000

配列:minLength: 1maxLength: 63

media_ids配列 <文字列> 任意

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

maxItems: 20

配列:minLength: 1maxLength: 63

meta_description文字列 | null任意

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

文字列:maxLength: 160

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

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

配列:maxItems: 20

配列 / 配列:maxLength: 50

meta_title文字列 | null任意

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

文字列:maxLength: 70

name文字列 | null任意

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

文字列:maxLength: 300

例: null

pricingProductPrice 任意

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

例: {"amount":"0.00","currency":"PLN","expected_price_list_version":1,"expected_version":0,"kind":"base","price_list_id":"example","tax_included":true}

primary_category_id文字列 | null任意

主要カテゴリー識別子。

文字列:minLength: 1maxLength: 63

published真偽値任意

リソースが公開済みかどうか。

sku文字列任意

在庫管理単位のコード。

minLength: 1maxLength: 100

制約

pattern

"^\\S+$"

例: "example"

slug文字列 | null任意

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

文字列:maxLength: 160

tax_category_id文字列 | null任意

税カテゴリー識別子。

文字列:minLength: 1maxLength: 63

variant_value_ids配列 <文字列> 任意

選択したバリエーション値の識別子。

maxItems: 250

配列:minLength: 1maxLength: 63

variants_enabled真偽値任意

商品がバリエーションを使うかどうか。

追加フィールド: いいえ