店舗向け

売上分析・予測API

売上の推移と予測、離反しやすい顧客、次に薦める商品を返します。店舗ダッシュボードが使っているものと同じ分析です。

api/v1/sales View in API Reference

Endpoints

Method Path Description Response
GET /api/v1/sales/kpis 主要指標を取得
売上・客数・客単価を期間で取得します。
 200
GET /api/v1/sales/trend 売上推移を取得
日次・週次・月次の推移を取得します。
 200
GET /api/v1/sales/forecast 売上を予測
直近の実績から今後の売上を予測します。
 200
GET /api/v1/sales/churn 離反リスクを取得
しばらく来店のない顧客を、離反しやすい順に返します。
 200
GET /api/v1/sales/recommendations 推奨商品を取得
顧客ごとの購買傾向から次に薦める商品を返します。
 200
GET /api/v1/sales/advice 改善アドバイスを取得
数字の変化を文章にして返します。
 200
GET /api/v1/sales/products 商品別売上を取得
売れ筋と死に筋を返します。
 200
GET /api/v1/sales/visitors 来店分析を取得
曜日・時間帯別の来店傾向を返します。
 200

Endpoint details

売上・客数・客単価を期間で取得します。

Full path: GET /api/v1/sales/kpis
Response codes: 200

日次・週次・月次の推移を取得します。

Full path: GET /api/v1/sales/trend
Response codes: 200

直近の実績から今後の売上を予測します。

Full path: GET /api/v1/sales/forecast
Response codes: 200

しばらく来店のない顧客を、離反しやすい順に返します。

Full path: GET /api/v1/sales/churn
Response codes: 200

顧客ごとの購買傾向から次に薦める商品を返します。

Full path: GET /api/v1/sales/recommendations
Response codes: 200

数字の変化を文章にして返します。

Full path: GET /api/v1/sales/advice
Response codes: 200

売れ筋と死に筋を返します。

Full path: GET /api/v1/sales/products
Response codes: 200

曜日・時間帯別の来店傾向を返します。

Full path: GET /api/v1/sales/visitors
Response codes: 200

Example request

Request 
GET /api/v1/sales/forecast?storeId={storeId}
Authorization: Bearer {access_token}
Response 
{
  "storeId": "21cc…",
  "horizonDays": 30,
  "points": [
    { "date": "2026-09-01", "predictedAmount": 128400 }
  ]
}
About authentication

To use this API, the Authorization: Bearer {access_token} header is required. See the authentication guide for how to obtain a token.

View the authentication & access API
To API Reference