アップデートのお知らせ(会員エンドポイントへのプロパティの追加)

BカートAPIのアップデートに伴い、新たに下記のエンドポイントにおけるプロパティの追加を行いました。 これらのプロパティは、APIでのデータ取得、検索パラメータの指定、および、一部のプロパティにおいて登録・更新が可能となります。

追加内容

影響のある既存のエンドポイント

新しく追加されたプロパティ

プロパティ名 説明
email_verified_at メールアドレス認証日時
tsa_is_used 二段階認証設定
is_invalid_email メールアドレス無効設定

会員のGET, PATCH, POSTのレスポンスに上記の3プロパティが追加されました。

例)会員参照(GET customers/:id)のレスポンス

{
    "customer": {
       // 〜 省略
        "email": "guest@dai.co.jp",
        "is_invalid_email": 1, // ← 追加
        "email_cc": "",
       // 〜 省略 〜
        "hidden_price": 0,
        "email_verified_at": "2025-12-01 10:00:00", // ← 追加
        "tsa_is_used": 1, // ← 追加
        "status": null,
       // 省略 〜
    }
}

詳しくはAPIドキュメントをご確認ください。

登録(POST)・更新(PATCH)における制限

「email_verified_at」 と 「tsa_is_used」は、二段階認証に関連する設定情報であるため、登録・更新には以下の制限があります。

  • 「email_verified_at」は、APIからの登録(POST)・更新(PATCH)では指定できません(Bカートの一般画面にて、会員自身でのメール認証手続きが必要であるため)。
  • 「tsa_is_used」 は、登録(POST)では指定できません。また、「email_verified_at」が登録されていない(nullである)場合は「有効」に更新できません。

※ 尚、「email」が変更されると再認証が必要になるため、「email_verified_at」は null、「tsa_is_used」は「無効」に自動的にリセットされます。