ポイント削除API

指定したポイント情報を削除します。

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

調整ポイント登録API、ポイント利用APIで操作したポイント情報の「apiId」を元に削除するAPIです。
指定した「apiId」を1件ずつ削除できます。
調整ポイント登録API、ポイント利用APIといったAPIにて操作したポイントは、会員ポイント履歴にて、一覧で確認できますが、本APIを利用し削除した場合、操作した履歴自体が削除され（消え）ます。（付与履歴、利用履歴、削除履歴共に一覧に残りません。）
調整ポイント登録APIにて「調整ポイント」を登録した結果、「有効期限」が延長された後、本APIで該当の「調整ポイント」を削除した場合、延長された「有効期限」は元に戻りません（延長されたままとなります）。

＜目次＞

URLにapiIdを指定してリクエストを行って下さい。

※「apiId」とは：調整ポイント登録API、ポイント利用APIで処理が成功した場合に出力されるIDです。

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

DELETE

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

なし

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

コード	メッセージ	説明
NotFound	リソースが存在しません	登録されていないAPI IDを指定した場合に返却されます。
PointsNotAvailable	ポイントオプションを利用されていません	ポイントオプションをお申し込み頂いていない場合に返却されます。
NotAvailableOnOmniChannel	omni-channelご利用店舗では使用できません	futureshop omni-channelをご利用頂いている場合に返却されます。

サンプル（エラー時）

{
    "status": "failed",
    "errors": [
        {
            "code": "NotFound",
            "message": "リソースが存在しません"
        }
    ]
}

サンプル（成功時）

{
    "status": "success"
}