コンテンツにスキップ
スマレジ・プラットフォームAPI 仕様書

会員ポイント一括更新

PATCH
/customers/point/bulk

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

ポイントおよびマイルは、入力された値と同じになるよう更新します。

※ 会員ポイント情報の更新処理は非同期で実行されます。処理完了後、指定されたコールバックURLにWebhook通知されます。

※ 会員ポイント情報は1リクエストにつき100件まで更新できます。

対象プラン

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

Authorizations

Section titled “Authorizations ”

Request Body

Section titled “Request Body ”
object
customerPoints
required
会員ポイント情報
Array<object>
object
customerId
required
会員ID

ユニーク値

string format: int
>= 1 <= 9999999999
mile
マイル

マイル

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

ポイント

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

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

string format: date
callbackUrl
required
処理完了通知URL

処理が完了した際にその結果をWebhook通知するURL

string format: string
<= 511 characters /^https?://\S+$/
Example
{
  "customerPoints": [
    {
      "customerId": "1234567890",
      "mile": "123456789",
      "point": "123456789",
      "pointExpireDate": "2000-01-23"
    }
  ],
  "callbackUrl": "string"
}

Responses

Section titled “ Responses ”

202

Section titled “202 ”

処理受付完了

object
requestId

問い合わせ用ID：弊社への問い合わせの際にご利用ください

integer
callbackUrl

処理完了通知URL：処理が完了した際に、その結果をWebhook通知するURL

Webhook通知について ■ Request Header:
key value
Content-Type application/json;charset=UTF-8
■ Request Body (登録成功): Object
key value
requestId レスポンス時に返却したリクエストID (Integer)
result (Array) transactionHeadIds 取引IDリスト：ポイント・マイル更新により発生した、取引区分がポイント加算またはポイント減算、マイル加算、マイル減算の取引の取引ID (Array)
リクエスト例
  
  Content-Type: application/json;charset=UTF-8

  {

   "requestId":700,

   "result": {

    "transactionHeadIds": [

     "145",

     "146",

     "147",

     "148",

     "149",

     "150"

    ]

   }

  }

■ Request Body (登録失敗): Object
key value
requestId レスポンス時に返却したリクエストID (Integer)
message エラーメッセージ (String)
リクエスト例
    
    Content-Type: application/json;charset=UTF-8

    {

     "requestId":700,

     "message":"[customers][2行目]会員IDが存在しません。"

    }

■ 登録失敗時のエラーメッセージの詳細:
※ Webhook通知では、既存データを参照した上での結果を返します
※「 [ 大項目 ] [ 何番目のオブジェクトで発生したか ] エラーメッセージ 」の形式で返されます
※「何番目のオブジェクトで発生したか」は「〇〇行目」と表現されます
※「エラーメッセージ」の一覧は下記です
ケースエラーメッセージ
存在しない会員IDを指定した場合会員IDが存在しません。
string
Example
{
  "requestId": 700,
  "callbackUrl": "string"
}

400

Section titled “400 ”
  • 会員IDがリクエスト内で重複している場合
  • リクエスト上限数が超えている場合
  • 会員ポイント情報が1件も送られてこなかった場合
  • リクエスト内の全ての会員ポイント情報で指定しているフィールドが揃っていない場合
object
type
required
string
title
required
string
detail
string
status
integer
Examples
{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "指定された会員IDが重複しています。(会員ID-{会員ID})",
  "status": 400
}