スクリプトタグ用カラーミーショップオブジェクト（購入完了後のsale）の仕様を変更します

2023/03/30

こちらの仕様変更は4月17日に行いました。（2023/04/17追記）

カラーミーショップでは、2023年4月17日に1件の受注を複数に自動分割できる「受注区分設定」の提供を予定しています。
これに伴い、以前お知らせしました「受注関連のAPIの仕様を変更します」に続き、「スクリプトタグ用カラーミーショップオブジェクト」の「カート（購入完了後）」に取得可能な情報も変更を予定しています。

恐れ入りますが、下記をご参考のうえ、各社様にて仕様の確認およびご対応をお願いいたします。

購入完了後のページで取得できるオブジェクト

受注区分設定によって、受注が分割された場合カラーミーショップオブジェクトを経由して取得できる情報は以下のようになります。

sale.id
- 親受注の ID を返します
items
- 受注に含まれる商品情報は、分割された受注全ての商品情報を含みます
受注の金額に関する項目(例: total_price 等)
- 分割された受注の金額を合算した値になります

{
  "page": "checkout-complete",
  "shop": {
    "account_id": "PA00000001"
  },
  "sale": {
    "id": 1, // 親受注の ID
    "delivery_total_charge": 200,
    "noshi_total_charge": 0,
    "card_total_charge": 0,
    "wrapping_total_charge": 0,
    "fee": 200,
    "point_discount": 0,
    "other_discount": 0,
    "gmo_point_discount": 0,
    "total_price": 2400,
    "items": [ // 一度の注文に含まれる商品情報全てが含まれる
      {
        "id": 1,
        "name": "通常商品"
        "price": 1000,
        "quantity": 1,
        "unit": null,
        "product_url": "https://sample.shop-pro.jp/?pid=1",
        "image_url": "https://img20.shop-pro.jp/PA00000/001/product/sample.jpg",
        "stock_quantity": null,
        "minimum_purchase_quantity": 1,
        "maximum_purchase_quantity": null,
        "giftable": true,
        "disable_to_bundle": false,
        "options": [
          {
            "name": "カラー",
            "value": "赤"
          }
        ]
      },
      {
        "id": 2,
        "name": "区分付き商品"
        "price": 1000,
        "quantity": 1,
        "unit": null,
        "product_url": "https://sample.shop-pro.jp/?pid=2",
        "image_url": "https://img20.shop-pro.jp/PA00000/001/product/sample.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": "sample@example.com",
    "phone_number": "0300000000",
    "logged_in": true,
    "receive_mail_magazine": false
  }
}

更新履歴

2023/04/17
- 提供開始日を追記