ReCORE.co-api

会員

会員検索

概要

会員情報の検索を行う

基本情報

リクエストパス: GET /members
JWTスコープ: member:index
必須個別JWTパラメータ: なし
レートリミット: 5 rps

query

key	説明	制約など
ids	会員ID	整数のみ、カンマ区切りで複数指定可能
codes	会員コード	カンマ区切りで複数指定可能
alias_codes	代替会員コード	カンマ区切りで複数指定可能
statuses	ステータス	カンマ区切りで複数指定可能
keyword	キーワード (*1)	-
created_at_from	作成日から	2024-04-12 12:08:38 形式
created_at_to	作成日まで	同上
updated_at_from	更新日から	同上
updated_at_to	更新日まで	同上
page	ページ	整数のみ、デフォルト:1
limit	1ページあたりの件数	整数のみ、デフォルト:50、最大: 250
cursor	ページカーソル	-

*1) 会員コード、代替会員コード、氏名、会社名、電話番号、メールアドレスが対象

例

Request

GET /members?ids=219

Response

[
  {
    "id": 219,
    "code": "MB1ISH1TFC20",
    "alias_code": "testtest",
    "last_name": null,
    "last_kana": null,
    "first_name": null,
    "first_kana": null,
    "postal_code": "123-4567",
    "prefecture": null,
    "address1": null,
    "address2": null,
    "occupation": null,
    "tel": "0600001111",
    "sex": "MALE",
    "email": "test@example.com",
    "birthdate": "1991-02-23",
    "is_invoice_provider": false,
    "invoice_provider_number": null,
    "is_optout": false,
    "company_name": "テスト",
    "rank":{
      "id": 2,
      "name": "ランクA"
    },
    "status": "ACTIVE",
    "bank_code": "0033",
    "bank_branch_code": "105",
    "bank_account_number": "1234567",
    "bank_account_name": null,
    "line_user_id": null,
    "point": {
      "total": 1074,
      "expires_amount": 35,
      "expires_at": 1762095599,
      "details": [
        {
          "type": "DEFAULT",
          "title": "通常P",
          "total": 1074,
          "expires_amount": 35,
          "expires_at": 1762095599
        }
      ]
    },
    "photo_url": null,
    "created_at": 1708054490,
    "updated_at": 1708054490,
    "attachments": [
      {
        "id": 179,
        "file_key": "PdoJcUm1wtopvpX5goCSB36GR45FGuRJCrQAsvky.jpg",
        "tag": "PHOTO",
        "file_name": "photo.jpg",
        "url": "https://...",
        "mime_type": "image/jpeg"
      }
    ]
  }
]

key	type	説明
*	-	会員
*.id	int	会員ID
*.code	string	会員コード
*.alias_code	string \| null	代替会員コード
*.last_name	string \| null	姓
*.last_kana	string \| null	セイ
*.first_name	string \| null	名
*.first_kana	string \| null	メイ
*.postal_code	string \| null	郵便番号
*.prefecture	string \| null	都道府県
*.address1	string \| null	住所1
*.address2	string \| null	住所2
*.occupation	string \| null	職業
*.tel	string \| null	電話番号
*.sex	string \| null	性別
*.email	string \| null	メールアドレス
*.birthdate	string \| null	生年月日
*.is_invoice_provider	bool	適格事業者か
*.invoice_provider_number	string \| null	適格事業者番号
*.is_optout	bool	DMを希望しないか
*.company_name	string \| null	会社名
*.rank	object \| null	会員ランク
*.rank.id	int	会員ランクID
*.rank.name	string	会員ランク名
*.status	string	ステータス
*.bank_code	string \| null	銀行コード
*.bank_branch_code	string \| null	銀行支店コード
*.bank_account_number	string \| null	銀行口座番号
*.bank_account_name	string \| null	銀行口座名義
*.line_user_id	string \| null	LINEユーザーID
*.point	object \| null	ポイント (*1)
*.point.total	int	保有ポイント数
*.point.expires_amount	int	直近で失効するポイント数
*.point.expires_at	int	直近の失効日
*.point.details	array<object>	タイプ別内訳
.point.details..type	string	ポイントタイプ
.point.details..title	string	タイプ名
.point.details..total	int	保有ポイント数
.point.details..expires_amount	int	直近で失効するポイント数
.point.details..expires_at	int	直近の失効日
*.photo_url	string \| null	顔写真のURL
*.created_at	int \| null	会員作成日
*.updated_at	int \| null	会員更新日
*.attachments	array<object>	ファイル
.attachments..id	int	ファイルID
.attachments..file_key	string	ファイルキー
.attachments..tag	string	タグ
.attachments..file_name	string \| null	ファイル名
.attachments..url	string	一時URL (*2)
.attachments..mime_type	string	MIMEタイプ

*1) 0ポイントの場合はnull
*2) 一時的なURLなので保存等はしない
ステータス
- TENTATIVE 仮会員
- ACTIVE 有効
- LEAVE 退会
- MERGED 名寄せ済
ポイントタイプ
- DEFAULT 無償ポイント
- PAID 有償ポイント

会員取得

概要

会員情報を1件取得する

基本情報

リクエストパス: GET /members/{member_id}
JWTスコープ: member:show
必須個別JWTパラメータ: なし
レートリミット: 5 rps

例

Request

GET /members/219

Response

会員検索のresponse[0]と同様

会員作成

概要

会員情報を作成する

基本情報

リクエストパス: POST /members
JWTスコープ: member:store
必須個別JWTパラメータ: なし
レートリミット: 2 rps

body

key	type	説明	制約など
alias_code	?string \| null	代替会員コード	50文字まで
last_name	?string \| null	姓	50文字まで
last_kana	?string \| null	セイ	50文字まで
first_name	?string \| null	名	50文字まで
first_kana	?string \| null	メイ	50文字まで
postal_code	?string \| null	郵便番号	`/^[0-9]{3}-?[0-9]{4}$/`
prefecture	?string \| null	都道府県	10文字まで
address1	?string \| null	住所1	-
address2	?string \| null	住所2	-
occupation	?string \| null	職業	20文字まで
tel	?string \| null	電話番号	`/^0[0-9]{9,10}$/`または`/^0[0-9]{1,3}-[0-9]{2,4}-[0-9]{3,4}$/`
sex	?string \| null	性別	`MALE` `FEMALE` `OTHER` のいずれか
email	?string \| null	メールアドレス	256文字まで
birthdate	?string \| null	生年月日	`YYYY-MM-DD`
is_invoice_provider	?boolean	適格事業者か	-
invoice_provider_number	?string \| null	適格事業者番号	-
is_optout	?boolean	DMを希望しないか	-
company_name	?string \| null	会社名	50文字まで
member_rank_id	?integer \| null	会員ランクID	-
status	?string	ステータス	`TENTATIVE` `ACTIVE` `LEAVE` のいずれか
bank_code	?string \| null	銀行コード	4文字、数値のみ
bank_branch_code	?string \| null	銀行支店コード	3文字、数値のみ
bank_account_number	?string \| null	銀行口座番号	7文字、数値のみ
bank_account_name	?string \| null	銀行口座名義	30文字まで、ひらがなカタカナ英数字記号のみ
line_user_id	?string \| null	LINEユーザーID	`/^U[a-z0-9]{32}$/`

例

Request

POST /members

{
  "status": "ACTIVE"
}

Response

会員取得と同様

会員更新

概要

会員情報を更新する

基本情報

リクエストパス: PUT /members/{member_id}
JWTスコープ: member:update
必須個別JWTパラメータ: なし
レートリミット: 2 rps

body

会員作成と同様

例

Request

PUT /members/76369

{
  "status": "ACTIVE"
}

Response

会員取得と同様

会員一括作成

概要

会員情報を一括作成する

基本情報

リクエストパス: POST /members/bulk
JWTスコープ: member:bulk:store
必須個別JWTパラメータ: なし
レートリミット: 2 rps

body

key	type	説明	制約など
*	array<object>	-	1件以上 1000件まで
.	-	(以下会員作成と同様)	-

例

Request

POST /members/bulk

[
  {
    "status": "ACTIVE"
  }
]

Response

会員検索と同様

会員一括更新

概要

会員情報を一括更新する

基本情報

リクエストパス: PUT /members/bulk
JWTスコープ: member:bulk:update
必須個別JWTパラメータ: なし
レートリミット: 2 rps

body

key	type	説明	制約など
*	array<object>	-	1件以上 1000件まで
*.id	int	会員ID	-
.	-	(以下会員更新と同様)	-

例

Request

PUT /members/bulk

[
  {
    "id": 234,
    "status": "ACTIVE"
  }
]

Response

会員検索と同様

会員ポイント増減

概要

ポイントを増減する

基本情報

リクエストパス: PUT /members/point
JWTスコープ: member:point:update
必須個別JWTパラメータ: なし
レートリミット: 2 rps

body

key	type	説明	制約など
staff_id	?int \| null	スタッフID	-
amount	int	増減数	1以上
mode	string	増減モード	`ADD` `SUB`
type	?string \| null	ポイントタイプ	`DEFAULT` `PAID` (*1)
expires_on	?string \| null	失効日	YYYY-MM-DD 形式 (*2)
note	string	摘要	-
query	object	対象会員	(*3)
query.ids	?array<int>	会員ID	-
query.codes	?array<string>	会員コード	-
query.alias_codes	?array<string>	代替会員コード	-

*1) 指定しない場合、加算は無償へ、引当は有償,無償の順で処理
*2) 指定しない場合、ReCORE本部設定の値が適用される
*3) 空オブジェクトを指定すると全会員が対象となる

例

Request

PUT /members/point

{
  "staff_id": null,
  "amount": 123,
  "mode": "ADD",
  "note": "テスト付与",
  "query": {
    "ids": [1,2]
  }
}

Response

(なし)

会員メモ検索

概要

会員メモの検索を行う

基本情報

リクエストパス: GET /members/{member_id}/notes
JWTスコープ: member:note:index
必須個別JWTパラメータ: なし
レートリミット: 5 rps

query

key	説明	制約など
ids	会員ID	整数のみ、カンマ区切りで複数指定可能
created_at_from	作成日から	2024-04-12 12:08:38 形式
created_at_to	作成日まで	同上
page	ページ	整数のみ、デフォルト:1
limit	1ページあたりの件数	整数のみ、デフォルト:50、最大: 250

例

Request

GET /members/122/notes

Response

[
  {
    "id": 17,
    "staff": {
      "id": 1,
      "name": "デフォルト スタッフ"
    },
    "note": "会員メモ",
    "created_at": 1742536685
  }
]

key	type	説明
*	-	会員メモ
*.id	int	会員メモID
*.staff	object \| null	スタッフ
*.staff.id	int	スタッフID
*.staff.name	string	スタッフ名
*.note	string	メモ
*.created_at	int \| null	作成日時

会員メモ作成

概要

会員メモを作成する

基本情報

リクエストパス: POST /members/{member_id}/notes
JWTスコープ: member:note:store
必須個別JWTパラメータ: なし
レートリミット: 2 rps

body

key	type	説明	制約など
staff_id	?int \| null	スタッフID	-
note	string	メモ	-

例

Request

POST /members/122/notes

{
  "staff_id": null,
  "note": "会員メモ"
}

Response

会員メモ検索のresponse[0]と同様

会員メモ削除

概要

会員メモを削除する

基本情報

リクエストパス: DELETE /members/{member_id}/notes/{note_id}
JWTスコープ: member:note:destroy
必須個別JWTパラメータ: なし
レートリミット: 2 rps

例

Request

DELETE /members/122/notes/345

Response

(なし)

会員ファイル登録

概要

ファイルを登録する

基本情報

リクエストパス: POST /members/{member_id}/attachments
JWTスコープ: member:attachment:store
必須個別JWTパラメータ: なし
レートリミット: 2 rps

body

key	type	説明	制約など
file_key	string	ファイルキー (*1)	-
tag	string	タグ	(*2)
file_name	?string \| null	ファイル名	100文字まで

*1) ファイルアップロード(機密ファイル)で取得したファイルキーを使用
*2) 使用できるタグ
- GENERAL 一般ファイル
- PHOTO 会員顔写真

例

Request

POST /members/122/attachments

{
  "file_key": "PdoJcUm1wtopvpX5goCSB36GR45FGuRJCrQAsvky.jpg",
  "tag": "PHOTO",
  "file_name": "顔写真.jpg"
}

Response

会員取得のattachments[0]と同様

会員ファイル削除

概要

ファイルを削除する

基本情報

リクエストパス: DELETE /members/{member_id}/attachments/{attachment_id}
JWTスコープ: member:attachment:destroy
必須個別JWTパラメータ: なし
レートリミット: 2 rps

例

Request

DELETE /members/122/attachments/345

Response

(なし)