ポイント履歴API

指定した会員のポイント情報の取得を行います。

まずはじめに、「概要」「共通仕様」について、futureshop APIv2についてをご覧ください。

ご注意事項

futureshop omni-channelご利用店舗様はご利用いただけません。
ポイントオプションご利用店舗様のみご利用いただけます。
「future Review」にて付与されたレビューポイントは、調整ポイント登録APIで付与されたポイントとなりますので、「type：ADJUSTED」として出力されます。

基本仕様

指定した会員のポイント履歴を最大100件まで取得できます。

＜目次＞

URL
HTTPメソッド
リクエストヘッダー
リクエストボディ
パラメータ
レスポンス
- nextUrlに関する補足
- サンプル（レスポンス）
エラーレスポンス
- エラーコード
サンプル

URL

https://{APIドメイン}/admin-api/v1/points

HTTPメソッド

GET

リクエストヘッダー

アクセストークンなどの詳細はアクセストークンによる認証を参照してください。

リクエストボディ

なし

パラメータ

key	項目名	必須	内容
memberId	会員ID	◯	カンマ区切りで複数指定可能
pointsDateStart	ポイント付与日時(start)		「yyyy-mm-ddThh:mm:ss」形式
pointsDateEnd	ポイント付与日時(end)		「yyyy-mm-ddThh:mm:ss」形式
pointsStatus	ポイントステータス		INVALID：無効 SUSPENDED：保留 EXPIRED：期限切れ USED：利用済 VALID：有効 PENDING：有効待ち

レスポンス

key		項目名	必須	型	byte	内容
nextUrl		ネクストURL		String	-	100件を超過する結果の場合、次のデータ取得のURLを返却（※）
pointList		ポイントリスト	◯	Array	-	ポイントごとに配列出力。最大100件
	memberId	会員ID		String	20
	pointId	ポイントID		String	8
	grantDate	付与日		String	19	「yyyy-mm-ddThh:mm:ss」形式
	type	種別		String	8	MEMBER：会員登録 PURCHASE：購入 SPECIAL：特別 ADJUSTED：調整（※ 「future Review」にて付与されたレビューポイントを含む） REVIEW：レビュー
	action	履歴区分		String	8	EARNED：付与 USED：利用 RETURNED：返還
	status	ステータス		String	9	INVALID：無効 SUSPENDED：保留 EXPIRED：期限切れ USED：利用済み VALID：有効 PENDING：有効待ち
	count	ポイント数		Number	9
	activationDate	利用開始日		String	19	「yyyy-mm-ddThh:mm:ss」形式
	expirationDate	有効期限		String	19	「yyyy-mm-ddThh:mm:ss」形式
	specialPointId	特別ポイントID		String	15
	orderNo	受注番号		String	12
	adjustPointId	調整ポイントID		String	15
	adjustPointContents	調整ポイント内容		String	200
	reviewId	レビューID		String	18	※ 「future Review」にて付与されたレビューポイントには「レビューID」はありません。「空」となります。
	productId	商品ID		String	18
	apiId	API ID		String	16	※ 「future Review」にて付与されたレビューポイントには「API ID」が出力されます。
	dateLastUpdated	最終更新日時		String	19	「yyyy-mm-ddThh:mm:ss」形式

nextUrlに関する補足

「/v1/points」の後に次のデータを取得するためのパラメータが付与されたURLが返却されます。
URLに替えて、nextUrlをGETしていただければ、次の100件のデータを取得できます。

サンプル（レスポンス）

{
    "pointList": [
        {
            "memberId": "9",
            "pointId": "220",
            "grantDate": "2021-11-10T13:00:27",
            "type": "ADJUSTED",
            "action": "EARNED",
            "status": "VALID",
            "count": 1000,
            "activationDate": "2021-11-10T00:00:00",
            "expirationDate": "2022-12-17T23:59:59",
            "specialPointId": "",
            "orderNo": "",
            "adjustPointId": "AD2111100000019",
            "adjustPointContents": "調整ポイント",
            "reviewId": "",
            "productId": "",
            "apiId": "",
            "dateLastUpdated": "2021-12-17T16:02:51"
        },
        {
            "memberId": "9",
            "pointId": "221",
            "grantDate": "2021-11-12T13:34:02",
            "type": "PURCHASE",
            "action": "USED",
            "status": "VALID",
            "count": -1000,
            "activationDate": "2021-11-12T00:00:00",
            "expirationDate": "2022-12-17T23:59:59",
            "specialPointId": "",
            "orderNo": "100000045718",
            "adjustPointId": "",
            "adjustPointContents": "",
            "reviewId": "",
            "productId": "",
            "apiId": "",
            "dateLastUpdated": "2021-12-17T16:02:51"
        },
        {
            "memberId": "9",
            "pointId": "222",
            "grantDate": "2021-11-12T13:34:02",
            "type": "PURCHASE",
            "action": "EARNED",
            "status": "VALID",
            "count": 10,
            "activationDate": "2021-11-12T00:00:00",
            "expirationDate": "2022-12-17T23:59:59",
            "specialPointId": "",
            "orderNo": "100000045718",
            "adjustPointId": "",
            "adjustPointContents": "",
            "reviewId": "",
            "productId": "",
            "apiId": "",
            "dateLastUpdated": "2021-12-17T16:02:51"
        },
    ]
}

エラーレスポンス

エラー発生時に以下のレスポンスが返却されます。

key		項目名	必須	型	byte	内容
status		ステータス	○	String	-
errors		エラーリスト	○	Array	-
	code	コード	○	String	-
	path	パス	○	String	-	エラーが発生したパラメータ名が出力されます
	message	メッセージ	○	String	-

エラーコード

コード	メッセージ	説明
Required	memberIdを指定してください	memberIdのパラメータが設定されていない場合に返却されます。
InvalidFormat	memberIdの形式に誤りがあります	数値が正しく指定されてない場合に返却されます。
InvalidDateFormat	pointsDateStartの日付フォーマットを正しく指定してください	「yyyy-mm-ddThh:mm:ss」形式ではない場合に返却されます。
InvalidDateRange	pointsDateStartはpointsDateEndより前の日時を指定してください	ポイント付与日時の開始日時が終了日時よりも未来日付の場合に返却されます。
InvalidDateFormat	pointsDateEndの日付フォーマットを正しく指定してください	「yyyy-mm-ddThh:mm:ss」形式ではない場合に返却されます。
InvalidValue	pointsStatusの指定が不正です	下記以外のステータスコードを指定をした場合に返却されます。 INVALID SUSPENDED EXPIRED USED VALID PENDING
PointsNotAvailable	ポイントオプションを利用されていません	ポイントオプションをお申し込み頂いていない場合に返却されます。
NotAvailableOnOmniChannel	omni-channelご利用店舗では使用できません	futureshop omni-channelをご利用頂いている場合に返却されます。

サンプル

{
    "status": "failed",
    "errors": [
        {
            "code": "Required",
            "path": "memberId",
            "message": "memberIdを指定してください"
        }
    ]
}