コンテンツにスキップ

会員ポイント相対値更新

POST
/customers/{customer_id}/point/add

会員ポイント情報を更新します。

ポイントおよびマイルは、現在の値に対し、入力された値を加算(入力値が負の場合は減算)した値に更新します。

現在値参照にあたりポイント有効期限を参照し、ポイント残高がありかつ期限が切れていれば期限切れ分のポイント失効処理を行ってから加算を行います(失効で0になっているので減算はエラー)。

対象プラン

  • プレミアムプラス
  • フードビジネス
  • リテールビジネス
customer_id
required
string

会員ID

object
mile
マイル

マイル

string format: int
>= -999999999 <= 999999999
point
ポイント

ポイント

string format: int
>= -999999999 <= 999999999
pointExpireDate
ポイント失効予定日

ポイント失効予定日:指定しない場合ポイント失効日は更新されません。

string format: date
Example
{
"mile": "123456789",
"point": "123456789",
"pointExpireDate": "2000-01-23"
}

取得成功

object
customerId

会員ID:

string
mile

マイル:

string
point

ポイント:

string
pointExpireDate

ポイント失効予定日:会員必須項目設定で必須項目に設定されている場合必須

string
updDateTime

更新日時:登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

string
transactionHeadIds

取引IDリスト:ポイント・マイル更新により発生した、取引区分がポイント加算またはポイント減算、ポイント失効、マイル加算、マイル減算の取引の取引ID

Array<string>
Example
{
"customerId": "string",
"mile": "string",
"point": "string",
"pointExpireDate": "string",
"updDateTime": "string",
"transactionHeadIds": [
"10",
"11"
]
}
  • 加算後のポイントが入力可能な値の範囲を上回る場合。
  • 減算後のポイントが0を下回る場合。
  • 加算後のマイルが入力可能な値の範囲を上回る場合。
  • 減算後のマイルが0を下回る場合。
object
type
required
string
title
required
string
detail
string
status
integer
Examples
{
"type": "about:blank",
"title": "Bad Request",
"detail": "加算後のポイントは999999999を上回ることはできません。",
"status": 400
}
  • URI指定の会員IDが存在しない場合
object
type
required
string
title
required
string
detail
string
status
integer
Examples
{
"type": "about:blank",
"title": "NotFound",
"detail": "指定されたIDのリソースが見つかりません",
"status": 404
}