ポイント利用API

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

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

ご注意事項

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

基本仕様

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

＜目次＞

• URL
• HTTPメソッド
• リクエストヘッダー
• リクエストボディ(json)
  • サンプル（リクエストボディ）
• レスポンス
  • エラーコード
• サンプル

URL

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

HTTPメソッド

POST

リクエストヘッダー

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

リクエストボディ(json)

サンプル（リクエストボディ）

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

レスポンス

エラーコード

サンプル

サンプル（エラー時）

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

サンプル（成功時）

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