ポイントステータス変更API

指定したポイントのステータスを更新します。

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

ご注意事項

futureshop omni-channelご利用店舗様はご利用いただけません。
ポイントオプションご利用店舗様のみご利用いただけます。
「特別ポイント」「調整ポイント」「利用ポイント」「返還ポイント」のステータス変更にはご利用いただけません。
更新前と同じステータスでリクエストすると、エラーになりますのでご注意ください。

基本仕様

最大100件の「付与ポイント」のステータスを「有効」「有効取消」「無効」「無効取消」「保留」「保留取消」に更新できます。

＜目次＞

更新/更新予定

※日付が「予定日」のものは、更新内容が変わる可能性がございます。

更新日/予定日	更新内容		更新理由
2022.04.13	エラーコード	エラーコードを新規追加	「CannotUpdateAdjustedPoints」調整ポイント更新不可「CannotUpdateUsedPoints」利用ポイント更新不可「CannotUpdateReturnedPoints」返還ポイント更新不可	参照

更新履歴はAPI更新履歴一覧をご覧ください。

URL

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

HTTPメソッド

POST

リクエストヘッダー

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

リクエストボディ(json)

key		項目名	必須	型	byte	内容
pointList		ポイントリスト	◯	Array	-
	pointId	ポイントID	◯	String	8
	operation	操作	◯	String	16	VALID：有効 VALID_CANCEL：有効取消 INVALID：無効 INVALID_CANCEL：無効取消 SUSPENDED：保留 SUSPENDED_CANCEL：保留取消

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

  "pointList": [
      {
        "pointId": "223",
        "operation": "VALID"
      }
  ]
}

レスポンス

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

エラーコード

コード	メッセージ	説明
WrongFormat	リクエストデータがjson形式ではありません	json形式ではない場合に返却されます。
Required	pointListを指定してください	pointListのパラメータが設定されていない場合に返却されます。
TooMany	pointListの指定は100件までです	pointListの指定が100件を超過した場合に返却されます。
Required	pointIdを指定してください	pointIdのパラメータが設定されていない場合に返却されます。
InvalidValue	pointIdの指定が不正です	数値を正しく指定していない場合に返却されます。
DuplicatedPointId	pointIdが重複しています	pointList内で同じpointIdを指定した場合に返却されます。
Required	operationを指定してください	operationのパラメータが設定されていない場合に返却されます。
InvalidValue	operationの指定が不正です	下記、以外の指定を行った場合に返却されます。 VALID VALID_CANCEL INVALID INVALID_CANCEL SUSPENDED SUSPENDED_CANCEL
PointNotFound	指定されたポイントが登録されていません	指定したポイントが登録されてない場合に返却されます。
CannotUpdateSpecialPoints	特別ポイントは更新出来ません	特別ポイントに対してリクエストした場合に返却されます。
CannotUpdateAdjustedPoints	調整ポイントは更新出来ません	調整ポイントに対してリクエストした場合に返却されます。
CannotUpdateUsedPoints	利用ポイントは更新出来ません	利用ポイントに対してリクエストした場合に返却されます。
CannotUpdateReturnedPoints	返還ポイントは更新出来ません	返還ポイントに対してリクエストした場合に返却されます。
CannotUpdatePointsStatus	指定されたポイントのステータス更新が出来ません	指定のステータスに変更不可の場合に返却されます。
PointsNotAvailable	ポイントオプションを利用されていません	ポイントオプションをお申し込み頂いていない場合に返却されます。
NotAvailableOnOmniChannel	omni-channelご利用店舗では使用できません	futureshop omni-channelをご利用頂いている場合に返却されます。

サンプル

サンプル（エラー時）

  "status": "failed",
  "errors": [
        {
            "code": "ErrorsPresent",
            "message": "エラーが発生しました"
        }
    ],
  "results": [
        {
            "status": "failed",
            "errors": [
                {
                    "code": "PointNotFound",
                    "message": "指定されたポイントが登録されていません"
                }
            ],
            "pointId": "223"
        }
    ]
}

サンプル（成功時）

{
  "status": "success",
  "results": [
    {
      "status": "success",
      "pointId": "224"
    },
    {
      "status": "success",
      "pointId": "226"
    }
  ]
}

サンプル（一部失敗/一部成功時）

{
    "status": "failed",
    "errors": [
        {
            "code": "ErrorsPresent",
            "message": "エラーが発生しました"
        }
    ],
    "results": [
        {
            "status": "failed",
            "errors": [
                {
                    "code": "CannotUpdatePointsStatus",
                    "message": "指定されたポイントのステータス更新が出来ません"
                }
            ],
            "pointId": "223"
        },
        {
            "status": "success",
            "pointId": "224"
        }
    ]
}