顧客データの取得系(v1/customers)で顧客の会員ランクを追加しました

2025/12/17

v1/customers で提供している顧客データの取得系エンドポイントのレスポンスで顧客の会員ランクに関するオブジェクトを追加しました。

レスポンス

customer オブジェクト内に membership オブジェクトが含まれるようになり、下記の key / value が取得できます。

key value type
membership_id 会員ランクID
管理画面>顧客>会員ランクで確認できるID
文字列
name 会員ランク名 文字列

顧客の状態によるレスポンスの違い

パターンA) 会員ランクに所属している場合

{
  "customer": {
    "id": 1234567890,
    "account_id": "PA00000000",
    ...
    "membership": {
      "membership_id": "gold_member",
      "name": "ゴールド会員"
    }
    ...
  },
  ...
}

パターンB) 会員ランクに所属して"いない"顧客

{
  "customer": {
    "id": 1234567890,
    "account_id": "PA00000000",
    ...
    "membership": {
      null
    }
    ...
  },
  ...
}

備考

  • カラーミーショップ アプリストアで提供している「会員ランク」の利用状況にかかわらず、すべてのショップでレスポンスに含まれます
  • リクエスト時点で会員ランクを利用していない場合でも対象の顧客が会員ランクに所属しているとき、レスポンスは前述のパターンAになります
    • 会員ランクの仕様の仕様は、マニュアルを確認ください

詳細は以下のドキュメントを確認ください。