メーカー・店舗向け

顧客・CRM API

顧客属性・購買傾向・LTVを取得し、セグメントマーケティングに活用できます。顧客プロフィールの管理と購買履歴の取得が可能です。

api/v1/store/customers APIリファレンスで確認

エンドポイント一覧

メソッド パス 説明 レスポンス
GET /api/v1/store/customers/{id} 顧客プロフィールを取得
デモグラフィック情報、ロイヤルティ情報、購買統計を含む顧客プロフィールを取得します。
200 404
GET /api/v1/store/customers/ 顧客を検索
デモグラフィック、ロイヤルティランク、行動属性でフィルタリングして検索します。
200
POST /api/v1/store/customers/ 顧客を作成・更新(Upsert)
新しい顧客を作成するか、顧客IDに基づいて既存レコードを更新します。
200
GET /api/v1/store/customers/{id}/purchases 顧客の購買履歴を取得
顧客に紐づく最近のレシート一覧を返します。
200
DELETE /api/v1/store/customers/{id} 顧客プロフィールを削除
CRMシステムから顧客レコードを削除します。
204 404

エンドポイント詳細

デモグラフィック情報、ロイヤルティ情報、購買統計を含む顧客プロフィールを取得します。

完全パス: GET /api/v1/store/customers/{id}
レスポンスコード: 200 404

デモグラフィック、ロイヤルティランク、行動属性でフィルタリングして検索します。

完全パス: GET /api/v1/store/customers/
レスポンスコード: 200

新しい顧客を作成するか、顧客IDに基づいて既存レコードを更新します。

完全パス: POST /api/v1/store/customers/
レスポンスコード: 200

顧客に紐づく最近のレシート一覧を返します。

完全パス: GET /api/v1/store/customers/{id}/purchases
レスポンスコード: 200

CRMシステムから顧客レコードを削除します。

完全パス: DELETE /api/v1/store/customers/{id}
レスポンスコード: 204 404

リクエスト例

リクエスト
GET /api/v1/store/customers/{id}
Authorization: Bearer {access_token}
レスポンス
{
  "id": "cust-001",
  "name": "田中 太郎",
  "email": "tanaka@example.com",
  "rank": "Gold",
  "totalSpend": 156000,
  "visitCount": 42,
  "lastVisit": "2025-03-15"
}
認証について

このAPIを利用するには、Authorization: Bearer {access_token} ヘッダーが必要です。 トークンの取得方法は認証ガイドをご確認ください。

認証・アクセスAPIを見る