Config Script Data リファレンス
Plugin に渡す JSON データの全プロパティ仕様
Plugin に渡す Config Script Data の全プロパティを説明します。 設置方法やコード例は Pluginの設置 を参照してください。
全体構造
Config Script Data は以下のトップレベルプロパティを持つ JSON オブジェクトです。
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
item | object | 必須 | Fitting で利用するアイテム（商品）情報。詳細は item を参照 |
userId | 文字列 | 任意 | 埋め込みサイト側で管理しているユーザーの一意な ID |
userToken | 文字列 | 任意 | ユーザー認証用の JWT。詳細は userToken の利用ガイド を参照 |
{
"item": { ... },
"userId": "user_33DvAnN9G2tgvwVJc9rNJmtk5Yq",
"userToken": "eyJhbGciOiJIUzI1NiIs..."
}item
Fitting 対象のアイテム（商品）情報です。
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
id | 文字列 | 推奨 | アイテムを一意に識別する ID |
name | 文字列 | 推奨 | アイテムの表示名（例: "Shirt"） |
available | 真偽値 (true / false) | 任意 | アイテムが現在購入可能（在庫あり）かどうか |
images | 配列 | 必須 | アイテムの画像一覧。詳細は images を参照 |
inventory_quantity | 数値 | 任意 | 参考情報としての在庫数 |
variants | 配列 | 任意 | バリエーション（サイズ・カラー等）の一覧。詳細は variants を参照 |
{
"item": {
"id": "item-unique-id-001",
"name": "Shirt",
"available": true,
"images": [ ... ],
"inventory_quantity": 50,
"variants": [ ... ]
}
}images
Fitting に利用するアイテム画像の一覧です。1 つ以上の画像オブジェクトを配列で渡します。
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
id | 文字列 | 推奨 | 画像を一意に識別する ID。詳しくは images の id について を参照 |
imageUrl | 文字列 | 必須 | 画像の URL |
"images": [
{ "id": "look1", "imageUrl": "https://example.com/images/look1.png" },
{ "id": "look2", "imageUrl": "https://example.com/images/look2.png" }
]variants
アイテムのバリエーション（サイズ・カラー等）の一覧です。
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
id | 文字列 | 推奨 | バリエーションを一意に識別する ID |
name | 文字列 | 推奨 | バリエーションの表示名（例: "Mサイズ / ブラック"） |
sku | 文字列 | 任意 | SKU（在庫管理単位）コード |
available | 真偽値 (true / false) | 任意 | このバリエーションが現在購入可能（在庫あり）かどうか |
inventory_quantity | 数値 | 任意 | 参考情報としての在庫数 |
"variants": [
{
"id": "variant-001",
"name": "Mサイズ / ブラック",
"sku": "SHIRT-M-BLK",
"available": true,
"inventory_quantity": 12
},
{
"id": "variant-002",
"name": "Lサイズ / ホワイト",
"sku": "SHIRT-L-WHT",
"available": false,
"inventory_quantity": 0
}
]完全な例
すべてのプロパティを含む Config Script Data の例です。
<script type="application/json" id="reselfit-plugin-script-config">
{
"item": {
"id": "item-unique-id-001",
"name": "Shirt",
"available": true,
"images": [
{ "id": "look1", "imageUrl": "https://example.com/images/look1.png" },
{ "id": "look2", "imageUrl": "https://example.com/images/look2.png" }
],
"inventory_quantity": 50,
"variants": [
{
"id": "variant-001",
"name": "Mサイズ / ブラック",
"sku": "SHIRT-M-BLK",
"available": true,
"inventory_quantity": 12
}
]
},
"userId": "user_33DvAnN9G2tgvwVJc9rNJmtk5Yq",
"userToken": "eyJhbGciOiJIUzI1NiIs..."
}
</script>