店舗向け

購買データAPI

POSレジで記録された取引を取得します。商品明細・支払い方法・店舗・端末を含み、販売分析やCRM連携の基盤になります。

api/v1/transactions View in API Reference

Endpoints

Method Path Description Response
GET /api/v1/transactions 取引を一覧取得
店舗・期間で取引を絞り込みます。ページングに対応しています。
 200
GET /api/v1/transactions/{id} 取引詳細を取得
商品明細を含む1件の取引を取得します。
 200 404
POST /api/v1/transactions/{id}/claim-token レシート受け取りリンクを発行
購入者がレシートを受け取るための一時トークンを発行します。有効期限はリクエストボディの ttlMinutes で指定します（既定1440分＝24時間、最大10080分＝7日）。返される claimUrl はパス部分がトークンそのものです。ログや解析ツールに出力しないでください。
 200 400 404

Endpoint details

店舗・期間で取引を絞り込みます。ページングに対応しています。

Full path: GET /api/v1/transactions
Response codes: 200

商品明細を含む1件の取引を取得します。

Full path: GET /api/v1/transactions/{id}
Response codes: 200 404

購入者がレシートを受け取るための一時トークンを発行します。有効期限はリクエストボディの ttlMinutes で指定します（既定1440分＝24時間、最大10080分＝7日）。返される claimUrl はパス部分がトークンそのものです。ログや解析ツールに出力しないでください。

Full path: POST /api/v1/transactions/{id}/claim-token
Response codes: 200 400 404

Example request

Request 
GET /api/v1/transactions?storeId={storeId}
Authorization: Bearer {access_token}
Response 
{
  "count": 1,
  "transactions": [
    {
      "id": "3f9c…",
      "storeId": "21cc…",
      "totalAmount": 842,
      "transactionDateTime": "2026-08-26T01:32:45Z"
    }
  ]
}
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