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

会員一括更新

PATCH
/customers/bulk

会員情報を一括更新します。

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

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

対象プラン

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

Authorizations

Section titled “Authorizations ”

Request Body

Section titled “Request Body ”
object
customers
required
会員情報
Array<object>
object
customerId
required
会員ID

会員ID
※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗に所属している会員か全店舗に所属している会員の会員IDを指定してください。

string format: int
customerNo
会員番号

会員必須項目設定で必須項目に設定されている場合null指定不可

string
<= 20 characters //^[ -~]+$//
rank
会員ランク

会員必須項目設定で必須項目に設定されている場合null指定不可

string
<= 20 characters
staffRank
社員ランク

※会員本部連携を行う契約の場合、リクエストで指定された値に関わらずnullが設定されます。

string
<= 20 characters
firstName
名
string
<= 85 characters
lastName
姓
string
<= 85 characters
firstKana
フリガナ(名)

会員必須項目設定で必須項目に設定されている場合null指定不可

string
<= 85 characters /^[ァ-ヶ　 -~ー－・]+$/
lastKana
フリガナ(姓)

会員必須項目設定で必須項目に設定されている場合null指定不可

string
<= 85 characters /^[ァ-ヶ　 -~ー－・]+$/
postCode
郵便番号

会員必須項目設定で必須項目に設定されている場合null指定不可

string
<= 10 characters
address
住所

会員必須項目設定で必須項目に設定されている場合null指定不可

string
<= 85 characters
phoneNumber
電話番号

会員必須項目設定で必須項目に設定されている場合null指定不可

string
/^[a-zA-Z0-9 -/:-@[-`{-~]{1,20}$/
faxNumber
FAX番号

会員必須項目設定で必須項目に設定されている場合null指定不可

string
/^[a-zA-Z0-9 -/:-@[-`{-~]{1,20}$/
mobileNumber
携帯電話番号

会員必須項目設定で必須項目に設定されている場合null指定不可

string
/^[a-zA-Z0-9 -/:-@[-`{-~]{1,20}$/
mailAddress
メールアドレス

会員必須項目設定で必須項目に設定されている場合null指定不可

string format: email
/(?:[_p{L}0-9][-_p{L}0-9]*.)*(?:[p{L}0-9][-p{L}0-9]{0,62}).(?:(?:[a-z]{2}.)?[a-z]{2,})$/ui/
mailAddress2
メールアドレス2
string format: email
/(?:[_p{L}0-9][-_p{L}0-9]*.)*(?:[p{L}0-9][-p{L}0-9]{0,62}).(?:(?:[a-z]{2}.)?[a-z]{2,})$/ui/
mailAddress3
メールアドレス3
string format: email
/(?:[_p{L}0-9][-_p{L}0-9]*.)*(?:[p{L}0-9][-p{L}0-9]{0,62}).(?:(?:[a-z]{2}.)?[a-z]{2,})$/ui/
companyName
会社名
string
<= 85 characters
departmentName
部署名
string
<= 85 characters
managerialPosition
役職
string
<= 85 characters
sex
性別

（0:不明、1:男、2:女）

string
0
Allowed values: 0 1 2
birthDate
生年月日

会員必須項目設定で必須項目に設定されている場合null指定不可

string format: date
entryDate
入会日

会員必須項目設定で必須項目に設定されている場合null指定不可

string format: date
leaveDate
退会日

※退会日が未設定の会員に対し会員状態区分に 3:退会 が指定された場合、現在日付が入ります。
※会員状態区分が 0:利用可 の会員に対し退会日にnull以外を指定した場合、エラーとなります。
※会員状態区分が 3:退会 の会員に対し退会日にnullを指定した場合、エラーとなります。

string format: date
pointGivingUnitPrice
ポイント付与単位(金額)

値を指定した場合、ポイント付与単位(ポイント)も必須

string format: int
>= 1 <= 99999
pointGivingUnit
ポイント付与単位(ポイント)

値を指定した場合、ポイント付与単位(金額)も必須

string format: decimal
<= 99999.99
pinCode
PINコード

会員必須項目設定で必須項目に設定されている場合null指定不可

string
<= 32 characters
passportNo
旅券番号
string
<= 32 characters //^[ -~]+$//
nationality
国籍
string
<= 85 characters
alphabetName
アルファベット氏名
string
<= 85 characters
mailReceiveFlag
案内メール受取許可フラグ

(0:拒否、1:許可)

string
default: 1
Allowed values: 0 1
note
備考
string
<= 1000 characters
note2
備考2
string
<= 1000 characters
favoriteList
お気に入りリスト

商品コードをカンマ区切りで設定可能。

string
<= 1000 characters
browsingList
閲覧履歴リスト

商品コードをカンマ区切りで設定可能。

string
<= 1000 characters
status
会員状態区分

(0:利用可、1:利用停止、2:紛失、3:退会、4:名寄せ)
退会日が設定されている会員に 0:利用可 を指定した場合、エラーとなります。

string
0
Allowed values: 0 1 2 3 4
storeId
対象店舗ID

Nullを指定した場合、全店舗となります。
※会員本部連携を行う契約の場合、リクエストで指定された値に関わらずnullが設定されます。
※倉庫、受注店舗の店舗IDは指定不可。

string format: int
callbackUrl
required
会員更新完了通知URL

会員の更新が完了した際に、更新結果をWebhook通知するURL

string
<= 511 characters
Example
{
  "customers": [
    {
      "customerId": "1",
      "customerNo": "string",
      "rank": "string",
      "staffRank": "string",
      "firstName": "string",
      "lastName": "string",
      "firstKana": "string",
      "lastKana": "string",
      "postCode": "string",
      "address": "string",
      "phoneNumber": "string",
      "faxNumber": "string",
      "mobileNumber": "string",
      "mailAddress": "test@example.com",
      "mailAddress2": "test@example.com",
      "mailAddress3": "test@example.com",
      "companyName": "string",
      "departmentName": "string",
      "managerialPosition": "string",
      "sex": "0",
      "birthDate": "2000-01-23",
      "entryDate": "2000-01-23",
      "leaveDate": "2000-01-23",
      "pointGivingUnitPrice": "12345",
      "pointGivingUnit": "99999.99",
      "pinCode": "string",
      "passportNo": "string",
      "nationality": "string",
      "alphabetName": "string",
      "mailReceiveFlag": "0",
      "note": "string",
      "note2": "string",
      "favoriteList": "string",
      "browsingList": "string",
      "status": "0",
      "storeId": "1"
    }
  ],
  "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 (更新成功): Array of Objects
key value
requestId レスポンス時に返却したリクエストID (Integer)
result 処理結果（Array)
customerId 会員ID：数字10桁以内 (String)
リクエスト例
  
  Content-Type: application/json;charset=UTF-8

  {

   "requestId":700,

   "result":[

    {

     "customerId":"123"

    },

    {

     "customerId":"456"

    }

   ]

  }

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

    {

     "requestId":700,

     "message":"[customers][2行目]会員状態区分が退会の会員の退会日にnullは指定できません。"

    }

■ 更新失敗時のエラーメッセージの詳細:
※ Webhook通知では、既存データを参照した上での結果を返します
※「 [ 大項目 ] [ 何番目のオブジェクトで発生したか ] エラーメッセージ 」の形式で返されます
※「何番目のオブジェクトで発生したか」は「〇〇行目」と表現されます
※「エラーメッセージ」の一覧は下記です
ケースエラーメッセージ
存在しない会員IDを指定した場合会員IDが存在しません。
存在しない会員ランクを指定した場合会員ランクが存在しません。
存在しない社員ランクを指定した場合社員ランクが存在しません。
会員状態区分が利用可の会員に退会日を指定した場合会員状態区分が利用可の会員に退会日は指定できません。
会員状態区分が退会の会員で、退会日にnullを指定した場合会員状態区分が退会の会員の退会日にnullは指定できません。
退会日が設定されている会員で、会員状態区分に利用可を指定した場合退会日が設定されている会員の会員状態区分に「利用可」は指定できません。
存在しない対象店舗IDを指定した場合対象店舗IDが存在しません。
対象店舗IDに倉庫や受注店舗を指定した場合会員の対象店舗に倉庫や受注店舗は指定できません。
string
Example
{
  "requestId": 700,
  "callbackUrl": "string"
}

400

Section titled “400 ”
  • 会員IDがリクエスト内で重複している場合
  • リクエスト上限数が超えている場合
  • 会員情報が1件も送られてこなかった場合
  • 会員状態区分が 0:利用可 であり、退会日を指定した場合
  • 会員状態区分が 3:退会 であり、退会日にnullを指定した場合
  • リクエスト内の全ての会員情報で指定しているフィールドが揃っていない場合
object
type
required
string
title
required
string
detail
string
status
integer
Examples
{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "指定された会員IDが重複しています。(会員ID-{会員ID})",
  "status": 400
}