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

会員更新

PATCH
/customers/{customer_id}
curl --request PATCH \
  --url https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/customers/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "customerCode": "string", "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", "pointExpireDate": "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", "customFields": [ { "no": 1, "value": "string" } ] }'

会員情報を更新します。

対象プラン

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

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
customer_id
required
string

会員ID

Request Body

Section titled “Request Body”
Media typeapplication/json
object
customerCode
会員コード

ユニーク値

string
<= 20 characters //^[ -~]+$//
customerNo
会員番号

ユニーク値

会員必須項目設定で必須項目に設定されている場合nullまたは空文字の指定不可

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

会員必須項目設定で必須項目に設定されている場合nullまたは空文字の指定不可

string
staffRank
社員ランク
string
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
pointExpireDate
ポイント失効予定日

会員必須項目設定で必須項目に設定されている場合nullまたは空文字の指定不可

string format: date
entryDate
入会日

会員必須項目設定で必須項目に設定されている場合nullまたは空文字の指定不可

string format: date
leaveDate
退会日
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
お気に入りリスト

APIからのみ登録可能。商品コードをカンマ区切りで設定可能。

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

APIからのみ登録可能。商品コードをカンマ区切りで設定可能。

string
status
会員状態区分

(0:利用可、1:利用停止、2:紛失、3:退会、4:名寄せ)

string
0
Allowed values: 0 1 2 3 4
storeId
対象店舗ID
string format: int
customFields
会員自由項目

会員自由項目

Array<object>
<= 99 items
object
no
required
項目番号

会員自由項目番号：会員自由項目に付与されている番号

integer
>= 1
value
値

会員自由項目の値

会員必須項目設定で必須項目に設定されている場合nullまたは空文字の指定不可

nullまたは空文字を指定した場合はnullに更新し、未設定の場合は値を更新しません。

string
nullable <= 85 characters
Example
{
  "customerCode": "string",
  "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",
  "pointExpireDate": "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",
  "customFields": [
    {
      "no": 1,
      "value": "string"
    }
  ]
}

Responses

Section titled “Responses”

200

Section titled “200”

更新成功

Media typeapplication/json
object
customerId

会員ID

string
customerCode

会員コード

string
customerNo

会員番号

string
rank

会員ランク

string
staffRank

社員ランク

string
firstName

名

string
lastName

姓

string
firstKana

フリガナ(名)

string
lastKana

フリガナ(姓)

string
postCode

郵便番号

string
address

住所

string
phoneNumber

電話番号

string
faxNumber

FAX番号

string
mobileNumber

携帯電話番号

string
mailAddress

メールアドレス

string
mailAddress2

メールアドレス2

string
mailAddress3

メールアドレス3

string
companyName

会社名

string
departmentName

部署名

string
managerialPosition

役職

string
sex

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

string
Allowed values: 0 1 2
birthDate

生年月日

string
pointExpireDate

ポイント失効予定日

string
lastComeDateTime

最終来店日時

string
entryDate

入会日

string
leaveDate

退会日

string
pointGivingUnitPrice

ポイント付与単位(金額)

string
pointGivingUnit

ポイント付与単位(ポイント)

string
pinCode

PINコード

string
passportNo

旅券番号

string
nationality

国籍

string
alphabetName

アルファベット氏名

string
mailReceiveFlag

案内メール受取許可フラグ（0:拒否、1:許可）

string
Allowed values: 0 1
note

備考

string
note2

備考2

string
favoriteList

お気に入りリスト

string
browsingList

閲覧履歴リスト

string
status

会員状態区分（0:利用可、1:利用停止、2:紛失、3:退会、4:名寄せ）

string
Allowed values: 0 1 2 3 4
storeId

対象店舗ID

string
insDateTime

登録日時：登録時の日時。[YYYY-MM-DDThh:mm:ssTZD]

string
updDateTime

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

string
customFields

会員自由項目

Array<object>
<= 99 items
object
no

会員自由項目番号

integer
>= 1
value

会員自由項目の値

string
nullable <= 85 characters
Example
{
  "customerId": "string",
  "customerCode": "string",
  "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": "string",
  "mailAddress2": "string",
  "mailAddress3": "string",
  "companyName": "string",
  "departmentName": "string",
  "managerialPosition": "string",
  "sex": "0",
  "birthDate": "string",
  "pointExpireDate": "string",
  "lastComeDateTime": "string",
  "entryDate": "string",
  "leaveDate": "string",
  "pointGivingUnitPrice": "string",
  "pointGivingUnit": "string",
  "pinCode": "string",
  "passportNo": "string",
  "nationality": "string",
  "alphabetName": "string",
  "mailReceiveFlag": "0",
  "note": "string",
  "note2": "string",
  "favoriteList": "string",
  "browsingList": "string",
  "status": "0",
  "storeId": "string",
  "insDateTime": "string",
  "updDateTime": "string",
  "customFields": [
    {
      "no": 1,
      "value": "string"
    }
  ]
}

400

Section titled “400”
  • 入力チェックエラーの場合
  • 指定した会員ランクが存在しない場合
  • 指定した社員ランクが存在しない場合
  • 会員コードが重複している場合
  • 対象店舗IDの店舗が存在しない場合
  • 対象店舗IDに倉庫の店舗IDが指定された場合
  • 会員自由項目番号が重複している場合
  • 存在しない会員自由項目番号を指定した場合
Media typeapplication/json
object
type
required
string
title
required
string
detail
string
status
integer
Examples
{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "request_json:[customerCode]は[20]文字以下である必要があります",
  "status": 400
}

404

Section titled “404”
  • レコードが見つからない場合
Media typeapplication/json
object
type
required
string
title
required
string
detail
string
status
integer
Examples
Exampleレコードが見つからない場合
{
  "type": "about:blank",
  "title": "NotFound",
  "detail": "指定されたIDのリソースが見つかりません",
  "status": 404
}