クーポン履歴取得API
{coupon_id}
で指定したクーポンの獲得/使用履歴を100件ずつ取得します。
全ての履歴データを取得するには{page}
を1から{lastPage}
まで順に指定して必要な回数リクエストして下さい。
前回取得した続きのデータを取得する場合、前回取得時のページ番号と取得済み履歴データの{history_id}
を保持しておき、
前回取得したページ番号から取得を開始し、既に取得済みの{history_id}
のデータを除外するなどの処理を行なって下さい。
エンドポイント
URL |
https://poster.ooo/api/v1/coupon/{coupon_id}/history/{page} |
Method |
GET |
Header
X-POSTER-CLIENT-ID |
Posterから発行された40文字の文字列
(Poster管理画面から確認して下さい。) |
X-POSTER-CLIENT-SECRET |
Posterから発行された80文字の文字列
(Poster管理画面から確認して下さい。) |
Request
パラメータ名 |
型 |
説明 |
URLの{poster_id}部分にセット |
数字 |
作成済みクーポンのID |
URLの{page}部分にセット |
数字 |
取得するデータのページ番号(省略した場合は1) |
ResponseBody (JSON)
※右にスクロールできます。
Responseデータサンプル
{
"coupon_id": 9999999999,
"coupon_title": "割引クーポン",
"total": 130,
"currentPage": 1,
"lastPage": 2,
"nextPage": 2,
"count": 100,
"data": [
{
"history_id": 1234567890,
"user_id": 1111111111,
"status": "used",
"entried_at": "2021-10-01 09:50:45",
"used_at": "2021-10-10 13:40:20",
"use_branch_id": 2222222222,
},
{
"history_id": 8888888888,
"user_id": 2222222222,
"status": "lose",
"entried_at": "2021-10-03 18:22:30",
"used_at": null,
"use_branch_id": null,
},
{…}
]
}