クーポン履歴情報取得


クーポン履歴取得API

{coupon_id}で指定したクーポンの獲得/使用履歴を100件ずつ取得します。
全ての履歴データを取得するには{page}を1から{lastPage}まで順に指定して必要な回数リクエストして下さい。

前回取得した続きのデータを取得する場合、前回取得時のページ番号と取得済み履歴データの{history_id}を保持しておき、 前回取得したページ番号から取得を開始し、既に取得済みの{history_id}のデータを除外するなどの処理を行なって下さい。

エンドポイント

URLhttps://poster.ooo/api/v1/coupon/{coupon_id}/history/{page}
MethodGET

Header

X-POSTER-CLIENT-IDPosterから発行された40文字の文字列 (Poster管理画面から確認して下さい。)
X-POSTER-CLIENT-SECRETPosterから発行された80文字の文字列 (Poster管理画面から確認して下さい。)

Request

パラメータ名説明
URLの{poster_id}部分にセット数字作成済みクーポンのID
URLの{page}部分にセット数字取得するデータのページ番号(省略した場合は1)

ResponseBody (JSON)

※右にスクロールできます。

パラメータ名説明
coupon_id数字クーポンID
coupon_title文字列クーポン名
total数字総履歴数
count数字data配列に含まれる履歴件数
currentPage数字取得した履歴データのページ番号
lastPage数字取得可能な履歴データの最終ページ番号
nextPage数字続きの履歴データを取得する際のページ番号
dataオブジェクトの配列履歴データオブジェクト
パラメータ名 説明
history_id 数字履歴ID
user_id 数字対象者のPoster上のユーザーID
status 文字列get(獲得)
used(使用済み)
disabled(獲得失敗)
entried_at 文字列(YYYY-mm-dd HH:ii:ss)獲得(または獲得失敗)日時
used_at 文字列(YYYY-mm-dd HH:ii:ss) or NULL使用日時
use_branch_id 数字 or NULL使用した拠点のID

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,
        },
        {…}
    ]
}

無料で始めるLINE公式アカウントの販促ツール!

今すぐ無料で始める

Posterについてのご質問・ご相談
画面右下のチャットまたは問合せフォームボタンより承ります。

お問合せフォームへ

受付時間:平日09:00〜17:00


※ LINE 及び LINE@ はLINE株式会社の商標または登録商標です。PosterはLINE株式会社が提供する LINE Messaging API を利用しています。