店舗向け

購買データAPI

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


エンドポイント一覧

メソッド パス 説明 レスポンス
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

エンドポイント詳細

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

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

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

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

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

完全パス: POST /api/v1/transactions/{id}/claim-token
レスポンスコード: 200 400 404

リクエスト例

リクエスト
GET /api/v1/transactions?storeId={storeId}
Authorization: Bearer {access_token}
レスポンス
{
  "count": 1,
  "transactions": [
    {
      "id": "3f9c…",
      "storeId": "21cc…",
      "totalAmount": 842,
      "transactionDateTime": "2026-08-26T01:32:45Z"
    }
  ]
}
認証について

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

認証・アクセスAPIを見る