# スクリプトタグ用カラーミーショップオブジェクト
ページに関する情報を格納したグローバルオブジェクトを提供しています。 スクリプトタグAPI、インラインスクリプトタグAPIによって挿入されるJavaScriptで参照できます。
例えば以下のようなスクリプトで、カラーミーショップオブジェクトの中身を出力できます。
console.log(Colorme);
# ショップページ
ショップページで取得できる情報は以下の通りです。
| キー名 | 値 | 形式 |
|---|---|---|
| page | 現在表示されているページ | 文字列 |
| customer | ログインしている顧客情報 | オブジェクト |
| basket | かご | オブジェクト |
# 例
{
"page": "top",
"customer": {
"id": 12345678
},
"basket": {
"total_price": 1100,
"items": [
{
"id": 123,
"name":"りんご",
"price": 1100,
"quantity" :1,
"ng_delivery_ids": []
}
]
}
}
# Colorme.page
現在表示されているページを示す文字列を格納しています。取得できる page の値は以下の通りです。
| ページ名 | pageの値 |
|---|---|
| トップ | top |
| 商品一覧 | product_list |
| 商品詳細 | product |
| 商品検索結果 | product_srh |
| 特定商取引 | shopkeeper |
| プライバシーポリシー | privacy |
| フリーページ | free? ( ? の部分にページ番号が入ります) |
# Colorme.customer
ページを閲覧している顧客の情報を格納しています。
| キー名 | 値 | 形式 |
|---|---|---|
| id | 顧客id | 整数（ショップに未ログインの場合はnull） |
# Colorme.basket
ページを閲覧している顧客のかごの中身を格納しています。
| キー名 | 値 | 形式 |
|---|---|---|
| total_price | 合計金額(税込) ※商品価格と個数から計算される値です。配送料などは含みません | 整数 |
| items | かご内の商品情報 | 配列 |
items配列に含まれるオブジェクトは以下の通りです。
# Colorme.basket.items[i]
| キー名 | 値 | 形式 |
|---|---|---|
| id | 商品ID | 整数 |
| name | 商品名 | 文字列 |
| price | 商品単価（税込） | 整数 |
| quantity | 購入個数 | 整数 |
| ng_delivery_ids | 利用できない配送のID （配送ID一覧はカラーミーショップAPI (opens new window)でご確認いただけます） | 配列 |
# 商品詳細ページ
商品詳細ページで取得できる情報は以下の通りです。
| キー名 | 値 | 形式 |
|---|---|---|
| page | 現在表示されているページ | 文字列 |
| inventory_control | 在庫管理種別 | 文字列 |
| product | 商品情報 | オブジェクト |
| customer | ログインしている顧客情報 | オブジェクト |
| basket | かご | オブジェクト |
各キーのオブジェクトの内容は以下の通りです。
# Colorme.page
現在表示されているページを示す文字列を格納しています。取得できる page の値は以下の通りです。
| ページ名 | pageの値 |
|---|---|
| 商品詳細 | product |
# Colorme.inventory_control
在庫管理種別を格納しています。取得できる inventory_control の値は以下の通りです。
| オプション単位で在庫管理する | 商品単位で在庫管理する | 在庫管理しない | |
|---|---|---|---|
| オプションあり | option | product | none |
| オプションなし | product | none |
# Colorme.product
商品情報を格納しています。
| キー名 | 値 | 形式 |
|---|---|---|
| shop_uid | アカウントID | 文字列（PA+8桁の整数） |
| id | 商品id | 整数 |
| name | 商品名 | 文字列 |
| model_number | 型番 | 文字列（設定されていない場合はnull） |
| stock_num | 在庫数※1 | 整数（在庫数を管理しない場合はnull） |
| sales_price | 価格（税抜） | 整数 |
| sales_price_including_tax | 価格（税込） | 整数 |
| variants | オプション | 配列 |
| category | カテゴリー | オブジェクト |
| groups | グループ | 配列 |
※1: stock_num はオプション単位で在庫数を設定している場合、オプションの在庫数の合計値になります。
variants配列に含まれるオブジェクトは以下の通りです。
# Colorme.product.variants[i]
| キー名 | 値 | 形式 |
|---|---|---|
| id | オプションID | 整数 |
| option1_value | オプション1の値 | 文字列（設定されていない場合はnull） |
| option2_value | オプション2の値 | 文字列（設定されていない場合はnull） |
| title | 項目 | 文字列※2 |
| model_number | 型番 | 文字列（設定されていない場合はnull） |
| stock_num | 在庫数 | 整数（在庫数を管理しない場合や商品単位で在庫管理する場合はnull） |
| option_price | 価格（税抜） | 整数 |
| option_price_including_tax | 価格（税込） | 整数 |
※2: title はオプション1の値のみ設定している場合、オプション1の値が入ります。
オプション1の値とオプション2の値を設定している場合、 オプション1の値 × オプション2の値 のようになります。
categoryオブジェクトに含まれるオブジェクトは以下の通りです。
# Colorme.product.category
| キー名 | 値 | 形式 |
|---|---|---|
| id_big | 大カテゴリー | 整数 |
| id_small | 小カテゴリー | 整数 |
※3: id_small は大カテゴリーのみ設定している場合は 0 になります。
groups配列に含まれるオブジェクトは以下の通りです。
# Colorme.product.groups[i]
| キー名 | 値 | 形式 |
|---|---|---|
| id | グループID | 整数 |
# 例
{
"page": "product",
"inventory_control": "product",
"product": {
"shop_uid": "PA00000001",
"id": "1",
"name": "レトロなプラスチックカップ",
"model_number": "4000000000006",
"stock_num": 2,
"sales_price": 1000,
"sales_price_including_tax": 1080,
"variants": [
{
"id": "1",
"option1_value": "赤",
"option2_value": "XL",
"title": "赤 × XL",
"model_number": "4000000000013",
"stock_num": null,
"option_price": 1000,
"option_price_including_tax": 1080
}
],
"category": {
"id_big": 111,
"id_small": 222
},
"groups": [
{
"id": 123
}
]
},
"customer": {
"id": 12345678
}
}
# Colorme.customer
ショップページで取得できるcustomerと同じです。
# Colorme.basket
ショップページで取得できるbasketと同じです。
# カート（購入完了後）
カートの購入完了ページで取得できるカラーミーショップオブジェクトは以下の通りです。
| キー名 | 値 | 形式 |
|---|---|---|
| page | 現在表示されているページ | 文字列 |
| shop | ショップ情報 | オブジェクト |
| customer | 顧客情報 | オブジェクト |
| sale | 購入情報 | オブジェクト |
# Colorme.page
現在表示されているページを示す文字列を格納しています。取得できる page の値は以下の通りです。
# これまでのショッピングカートの場合
| ページ名 | pageの値 |
|---|---|
| 購入完了 | regi_step5 |
# 新しいショッピングカートの場合
| ページ名 | pageの値 |
|---|---|
| 購入完了 | checkout-complete |
# Colorme.shop
ショップの情報を格納しています。
| キー名 | 値 | 形式 |
|---|---|---|
| account_id | アカウントID | 文字列（PA+8桁の整数） |
# Colorme.customer
カートページに入力された顧客情報を格納しています。未入力の場合は各キーに対応する値にnullが代入されます。 カートに入力された顧客情報は、ページ遷移のタイミングでカラーミーショップオブジェクトに反映されます。
| キー名 | 値 | 形式 |
|---|---|---|
| id | 顧客id | 整数（未ログインの場合はnull） |
| name | 氏名 | 文字列 |
| postal_code | 郵便番号 | 文字列 |
| prefecture_name | 都道府県 | 文字列 |
| address1 | 住所1 | 文字列 |
| address2 | 住所2 | 文字列 |
| メールアドレス | 文字列 | |
| phone_number | 電話番号 | 文字列 |
| logged_in | ログイン済みか | 真偽値 |
| receive_mail_magazine | メルマガ受信可否 | 真偽値※3 |
※3: receive_mail_magazine は、ショッピングカートの種類によって出力される値が異なります。
# Colorme.sale
購入情報を格納しています。
| キー名 | 値 | 形式 |
|---|---|---|
| id | 受注id | 整数 |
| delivery_total_charge | 配送料 | 整数 |
| noshi_total_charge | 熨斗（のし）料 | 整数 |
| card_total_charge | メッセージカード料 | 整数 |
| wrapping_total_charge | ラッピング料 | 整数 |
| fee | 決済手数料 | 整数 |
| point_discount | ポイント割引 | 整数 |
| other_discount | クーポン値引 | 整数 |
| gmo_point_discount | GMOポイント割引 | 整数 |
| total_price | 総額（税込） | 整数 |
| items | 商品情報 | 配列 |
items配列に含まれるオブジェクトは以下の通りです。
# Colorme.sale.items[i]
購入された商品の情報を格納しています。
| キー名 | 値 | 形式 |
|---|---|---|
| id | 商品id | 整数 |
| name | 商品名 | 文字列 |
| price | 価格（税込） | 整数 |
| quantity | 個数 | 整数 |
| unit | 個数の単位 | 文字列（設定されていない場合はnull） |
| product_url | 商品URL | 文字列 |
| image_url | 商品画像URL | 文字列 |
| stock_quantity | 在庫数 | 整数（設定されていない場合はnull） |
| minimum_purchase_quantity | 購入数量:最小 | 整数 |
| maximum_purchase_quantity | 購入数量:最大 | 整数（設定されていない場合はnull） |
| giftable | ギフト可能か | 真偽値 |
| disable_to_bundle | 同梱可能か | 真偽値 |
| options | 選択されたオプション | 配列 |
options配列に含まれるオブジェクトは以下の通りです。
# Colorme.sale.items[i].options[n]
| キー名 | 値 | 形式 |
|---|---|---|
| name | オプション名 | 文字列 |
| value | オプション値 | 文字列 |
# 例
{
"page": "checkout-complete",
"shop": {
"account_id": "PA00000001"
},
"sale": {
"id": 97450559,
"delivery_total_charge": 108,
"noshi_total_charge": 0,
"card_total_charge": 0,
"wrapping_total_charge": 0,
"fee": 1000,
"point_discount": 0,
"other_discount": 0,
"gmo_point_discount": 0,
"total_price": 5908,
"items": [
{
"id": 122108817,
"name": "レトロなプラスチックカップ 4個セット",
"price": 4800,
"quantity": 1,
"unit": null,
"product_url": "https://hoge.shop-pro.jp/?pid=122108817",
"image_url": "https://img20.shop-pro.jp/PA00000/001/product/122108817_th.jpg",
"stock_quantity": null,
"minimum_purchase_quantity": 1,
"maximum_purchase_quantity": null,
"giftable": true,
"disable_to_bundle": false,
"options": [
{
"name": "カラー",
"value": "赤"
}
]
}
]
},
"customer": {
"id": 00000001,
"name": "カラーミー太郎",
"postal_code": "1508512",
"prefecture_name": "東京都",
"address1": "渋谷区桜丘町",
"address2": "セルリアンタワー",
"email": "hoge@example.com",
"phone_number": "0300000000",
"logged_in": true,
"receive_mail_magazine": false
}
}
注意
ページを遷移または更新することでカラーミーショップオブジェクトが更新されます。ページ内の入力値に応じて即座に値が更新されないことに注意してください。
← スクリプトタグAPI よくある質問 →