調整ポイント登録API

指定した調整ポイントを登録します。

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

ご注意事項

futureshop omni-channelご利用店舗様はご利用いただけません。
ポイントオプションご利用店舗様のみご利用いただけます。
APIでは、「-（マイナス）」指定で登録（ポイント減算）することができません。
API経由で登録したポイントは管理画面からは削除できません。削除の際は、ポイント削除APIを利用してください。
ポイント削除APIで削除した場合は、付与した履歴自体が会員ポイント履歴から削除され（消え）ます。（付与履歴、削除履歴共に一覧に残りません。）
ポイントステータス変更APIを利用したステータス変更はできませんのでご注意ください。
本APIのリクエストボディにて、「expirationDateStatus」に「EXTEND（有効期限を伸ばす）」を指定した場合、他の有効化済みポイントの「有効期限」も延長されます。（管理画面からの登録は延長されません。）
詳しくは、ポイント有効期限の延長についてをご覧ください。

基本仕様

最大100件まで調整ポイントを登録できます。登録した調整ポイントは、1件ごとにAPI IDが付与されます。
API経由で登録したポイントは、会員ポイント履歴にて、一覧で確認できます。
該当ポイントには、API ID（「api」からはじまるポイント番号）が表示されます。
API経由で登録したポイントは、「有効」での付与となります。

＜目次＞

URL

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

HTTPメソッド

POST

リクエストヘッダー

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

リクエストボディ(json)

key		項目名	必須	型	byte	内容
expirationDateStatus		有効期限	◯	String		ポイントを付与した際に対象会員のポイント有効期限を延長する設定。延長のルールはポイント有効期限設定／【CC未利用・移行中】有効期限に従う。 ------------------------------------------------------ EXTEND：有効期限を伸ばす NOT_EXTEND：有効期限を伸ばさない
pointList		ポイントリスト	◯	Array	-
	memberId	会員ID	◯	String	20
	name	ポイント名	◯	String	200
	points	ポイント数	◯	Number	9

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

{
  "expirationDateStatus": "EXTEND",
  "pointList": [
      {
          "memberId": "9",
          "name": "梅田店　購入 No.12030101",
          "points": 112
      },
      {
          "memberId": "9",
          "name": "難波店　購入 No.13928273",
          "points": 111
      }
  ]
}

レスポンス

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

エラーコード

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

サンプル

サンプル（エラー時）

{
    "status": "failed",
    "errors":[
        {
            "code": "ErrorsPresent",
            "message": "エラーが発生しました"
        }
    ],
    "results": [
        {
            "status": "failed",
            "name": "難波店　購入 No.13928273",
            "memberId": "A",
            "code": "InvalidValue",
            "message": "memberIdの指定が不正です"
        }
    ]
}

サンプル（成功時）

{
  "status": "success",
  "results": [
        {
            "status": "success",
            "name": "梅田店　購入 No.12030101",
            "memberId": "9",
            "apiId": "api0000000000011"
        }
  ]
}

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

{
    "status": "failed",
    "errors": [
        {
            "code": "ErrorsPresent",
            "message": "エラーが発生しました"
        }
    ],
    "results": [
        {
            "status": "success",
            "name": "梅田店　購入 No.12030101",
            "memberId": "9",
            "apiId": "api0000000000011"
        },
        {
            "status": "failed",
            "name": "難波店　購入 No.13928273",
            "memberId": "1",
            "code": "MemberNotFound",
            "message": "指定された会員が登録されていません"
        }
    ]
}