指定した会員のポイントより、指定したポイント数を利用します。

futureshop omni-channelご利用店舗様はご利用いただけません。
ポイントオプションご利用店舗様のみご利用いただけます。

指定した会員の指定したポイント数を、1件ずつ利用処理（減算）できます。
有効期限が近いポイントより順に減算します。

API経由で利用操作したポイントは、会員ポイント履歴にて、一覧で確認できます。
該当ポイントには、API ID（「api」からはじまるポイント番号）が表示されます。
API経由で利用操作したポイントは管理画面からは削除（復活）できません。削除の際は、ポイント削除APIを利用してください。
ポイント削除APIで削除（復活）した場合は、利用した履歴自体が会員ポイント履歴から削除され（消え）ます。（利用履歴、削除履歴共に一覧に残りません。）

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

URL
HTTPメソッド
リクエストヘッダー
リクエストボディ
レスポンス
エラーコード

URL

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

HTTPメソッド

POST

リクエストヘッダー

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

リクエストボディ(json)

key	項目名	必須	型	byte	内容
memberId	会員ID	◯	String	20
points	ポイント数	◯	Number	9

サンプル

{
   "memberId": "1",
   "points": 1000
}

レスポンス

key		項目名	必須	型	byte	内容
status		ステータス	○	String	-	成功：success 失敗：failed ※一部更新失敗の場合、failedを出力
apiId		API ID		String	16	処理が成功した場合に出力
errors		エラーリスト		Array	-	リクエストのエラー発生時に出力
	code	コード	○	String	-
	path	パス		String	-	入力値エラーの場合、対象のjson位置を出力
	message	メッセージ	○	String	-	エラーの概要が出力されます。

エラーコード

errors
コード	メッセージ	説明
WrongFormat	リクエストデータがjson形式ではありません	json形式ではない場合に返却されます。
Required	memberIdを指定してください	memberIdのパラメータが設定されていない場合に返却されます。
InvalidValue	memberIdの指定が不正です	数値以外の値を指定した場合に返却されます。
Required	pointsを指定してください	pointsのパラメータが設定されていない場合に返却されます。
InvalidValue	pointsの指定が不正です	数値、もしくは0、マイナス値の有効な値ではない場合に返却されます。
TooLong	pointsは9文字以内で指定してください	9文字を超過した場合に返却されます。
MemberNotFound	指定された会員が登録されていません	指定した会員が登録されていない場合に返却されます。
NotEnoughPoints	ポイントが足りません	指定したポイントが会員の保持ポイント未満の場合に返却されます。
PointsNotAvailable	ポイントオプションを利用されていません	ポイントオプションをお申し込み頂いていない場合に返却されます。
NotAvailableOnOmniChannel	omni-channelご利用店舗では使用できません	futureshop omni-channelをご利用頂いている場合に返却されます。

サンプル（エラー時）

{
    "status": "failed",
    "errors": [
        {
            "code": "InvalidValue",
            "path": "points",
            "message": "pointsの指定が不正です"
        }
    ]
}

サンプル（成功時）

{
  "status": "success",
  "apiId": "api0000000000011"
}

ポイント利用API

指定した会員のポイントより、指定したポイント数を利用します。

URL

HTTPメソッド

リクエストヘッダー

リクエストボディ(json)

レスポンス

エラーコード

項目表示について