API docs by Redocly

クチコAPI (1.0.0)

Download OpenAPI specification:

クチコのAPI仕様書

会員

会員管理API

トークン取得

会員関連APIのトークンを取得する

Request Body schema: application/x-www-form-urlencoded
required
login_id
required
string

クチコ店舗ログインID

password
required
string

クチコ店舗ログインパスワード

Responses

Response samples

Content type
application/json
{
  • "contractor_id": 121,
  • "contractor_account_id": 149,
  • "token": "e3f9e2cd5d865f0bf7346e1cb6e11ea8",
  • "limit_datetime": "2024-02-02 21:48:51"
}

会員作成

会員を新規作成する

Authorizations:
BearerAuth
Request Body schema: application/x-www-form-urlencoded
required
shop_id
required
integer

店舗ID

name
string <= 256 characters

氏名

name_kana
string <= 20 characters

氏名（カナ）

email
string <email> <= 256 characters

メールアドレス

username
required
string <= 100 characters

ユニークキー

password
string <password> <= 256 characters

パスワード

birthday
string <= 8 characters

生年月日（YYYYMMDD形式）

gender
integer <int8>

性別（0:未設定, 1:男性, 2:女性）

invite_code
string

招待コード

zipcode
string <= 8 characters

郵便番号

pref
integer

都道府県No

short_url
string

短縮URL

address1
string <= 256 characters

住所1（市区町村）

address2
string <= 256 characters

住所2（町名・番地）

address3
string <= 256 characters

住所3（建物名・部屋番号）

tel
string <= 15 characters

電話番号

memo
string

メモ

total_point
integer

合計ポイント

delete_flag
integer <int8>
Default: 0

削除フラグ（0:未削除, 1:削除済み）

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "status": 1,
  • "msg": "successfull."
}

会員情報更新

会員情報を更新する

Authorizations:
BearerAuth
Request Body schema: application/x-www-form-urlencoded
required
subscriber_id
required
string

会員ID

subscriber_hash_id
string <= 32 characters

ハッシュ化ID

contractor_id
integer

契約者ID

shop_id
integer

店舗ID

name
string <= 256 characters

氏名

name_kana
string <= 20 characters

氏名（カナ）

email
string <email> <= 256 characters

メールアドレス

username
string <= 100 characters

ユーザー名

password
string <password> <= 256 characters

パスワード

birthday
string <= 8 characters

生年月日（YYYYMMDD形式）

gender
integer <int8>

性別（0:未設定, 1:男性, 2:女性）

invite_code
string

招待コード

sns_invite_code
string <= 1000 characters

SNS招待コード

zipcode
string <= 8 characters

郵便番号

pref
integer

都道府県No

short_url
string

短縮URL

referral_media
integer

紹介メディア

address1
string <= 256 characters

住所1（市区町村）

address2
string <= 256 characters

住所2（町名・番地）

address3
string <= 256 characters

住所3（建物名・部屋番号）

lat
string <= 255 characters

緯度

lon
string <= 255 characters

経度

tel
string <= 15 characters

電話番号

memo
string

メモ

total_point
integer

合計ポイント

line_uid
string <= 64 characters

LINE ユーザーID

line_unfollow_flag
integer <int8>
Default: 0

LINE友達アカウントフォロー解除フラグ（0:フォロー中, 1:解除）

login_type
string <= 50 characters

ログインタイプ

temp_reg_flag
integer <int8>
Default: 0

仮登録フラグ（0:本登録, 1:仮登録）

profile_image
string <= 2000 characters

プロフィール画像URL

delivery_flag
integer <int8>
Default: 1

配信フラグ（0:配信しない, 1:配信する）

referral_subscriber_id
integer

紹介購読者ID

ip_address
string <= 128 characters

IPアドレス

referrer
string

リファラ（参照元URL）

user_agent
string <= 256 characters

ユーザーエージェント

utm_source
string <= 256 characters

UTMパラメータ utm_source

utm_medium
string <= 256 characters

UTMパラメータ utm_medium

utm_campaign
string <= 256 characters

UTMパラメータ utm_campaign

utm_term
string <= 256 characters

UTMパラメータ utm_term

utm_content
string <= 256 characters

UTMパラメータ utm_content

show_flag
integer <int8>
Default: 1

表示フラグ（0:非表示, 1:表示）

delete_flag
integer <int8>
Default: 0

削除フラグ（0:未削除, 1:削除済み）

update_datetime
string <date-time>

更新日時

create_datetime
string <date-time>

作成日時

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "status": 1,
  • "msg": "successfull."
}

会員検索

会員を検索する

Authorizations:
BearerAuth
Request Body schema: application/x-www-form-urlencoded
required
name
string <= 256 characters

氏名

name_kana
string <= 20 characters

氏名（カナ）

email
string <email> <= 256 characters

メールアドレス

gender
integer <int8>

性別（0:未設定, 1:男性, 2:女性）

pref
integer

都道府県No

address1
string <= 256 characters

住所1（市区町村）

address2
string <= 256 characters

住所2（町名・番地）

address3
string <= 256 characters

住所3（建物名・部屋番号）

tel
string <= 15 characters

電話番号

limit
object

1ページあたりの取得件数

offset
object

取得開始位置

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "status": 1,
  • "msg": "Successful operation.",
  • "data": [
    ]
}

会員詳細取得

会員の詳細情報を取得する

Authorizations:
BearerAuth
Request Body schema: application/x-www-form-urlencoded
required
subscriber_id
required
string

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "status": 1,
  • "msg": "Successful operation.",
  • "data": {
    }
}

会員特典

会員に関連する特典を取得する

Authorizations:
BearerAuth
Request Body schema: application/x-www-form-urlencoded
required
subscriber_id
required
string

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "status": 1,
  • "msg": "Successful operation.",
  • "data": [
    ]
}

会員削除

会員を削除する

Authorizations:
BearerAuth
Request Body schema: application/x-www-form-urlencoded
required
subscriber_id
required
string

会員ID

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "status": 1,
  • "msg": "successfull."
}

店舗会員一覧

店舗に所属する会員一覧を取得する

Authorizations:
BearerAuth
Request Body schema: application/x-www-form-urlencoded
required
shop_id
required
integer
limit
object

1ページあたりの取得件数

offset
object

取得開始位置

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "status": 1,
  • "msg": "Successful operation.",
  • "data": [
    ]
}

店舗会員CSVダウンロード

店舗に所属する会員一覧をCSV形式でダウンロードする

Authorizations:
BearerAuth
Request Body schema: application/x-www-form-urlencoded
required
shop_id
required
string

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "status": 1,
  • "msg": "Successful operation.",
  • "data": "contractor_id,shop_id,name,name_kana,email,username,address1,tel,address2,address3,line_uid,birthday,gender,invite_code,pref,short_url,zipcode,memo,login_type,profile_image,referral_subscriber_id,show_flag,delete_flag,total_point\n1001,2001,\"山田太郎\",\"ヤマダタロウ\",\"yamada@example.com\",\"user001\",\"新宿区\",\"09012345678\",\"西新宿1-1-1\",\"新宿ビル101号室\",\"U1234567890abcdef1234567890abcdef\",\"19900415\",1,\"INVITE123\",13,\"https://short.ly/abc123\",\"1234567\",\"特記事項など\",\"web\",\"https://example.com/images/profile/user123.jpg\",10001,1,0,1500\n1001,2001,\"佐藤花子\",\"サトウハナコ\",\"sato@example.com\",\"user002\",\"渋谷区\",\"09087654321\",\"渋谷1-2-3\",\"渋谷マンション202号室\",\"U9876543210fedcba9876543210fedcba\",\"19850720\",1,\"INVITE456\",13,\"https://short.ly/def456\",\"1500001\",\"VIP会員\",\"app\",\"https://example.com/images/profile/user456.jpg\",,1,0,2800\n"
}

特典

特典管理API

トークン取得

特典関連APIのトークンを取得する

Authorizations:
BearerAuth
Request Body schema: application/x-www-form-urlencoded
required
login_id
required
string

クチコ店舗ログインID

password
required
string

クチコ店舗ログインパスワード

Responses

Response samples

Content type
application/json
{
  • "contractor_id": 121,
  • "contractor_account_id": 149,
  • "token": "e3f9e2cd5d865f0bf7346e1cb6e11ea8",
  • "limit_datetime": "2024-02-02 21:48:51"
}

特典申請作成

特典申請を新規作成する

Authorizations:
BearerAuth
Request Body schema: application/x-www-form-urlencoded
required
contractor_id
required
integer
Default: 0

契約者ID

shop_id
required
integer
Default: 0

店舗ID

campaign_id
required
integer
Default: 0

キャンペーンID

subscriber_id
required
integer
Default: 0

会員ID

item_id
required
integer
Default: 0

商品ID

code
string or null <= 50 characters
Default: ""

コード

quopay_amount
integer
Default: 0

QuoPay金額

shipping_company_id
integer
Default: 0

配送会社ID

status
integer
Default: 0
Enum: 0 1 2 3 4 5

ステータス

newcomer_flag
integer
Default: 0

新規フラグ

email
string <email> <= 256 characters
Default: ""

メールアドレス

name
string <= 256 characters
Default: ""

氏名

name_kana
string <= 256 characters
Default: ""

氏名（カナ）

zipcode
string <= 8 characters ^\d{7}$|^\d{3}-\d{4}$
Default: ""

郵便番号

pref
string
Default: ""

都道府県

address1
string <= 256 characters
Default: ""

住所1（市区町村）

address2
string <= 256 characters
Default: ""

住所2（町域・番地）

address3
string <= 255 characters
Default: ""

住所3（建物名・部屋番号）

access_key
string <= 128 characters
Default: "自動生成されるMD5ハッシュ値"

アクセスキー（md5(uniqid(rand(),1))で自動生成）

tel
string <= 15 characters ^\d{10,14}$|^\d{2,4}-\d{2,4}-\d{4}$
Default: ""

電話番号

newcomer
string <= 256 characters
Default: ""

新規者情報

newcomer_shop
string <= 20 characters
Default: ""

新規者店舗

memo
string
Default: ""

メモ

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "status": 1,
  • "msg": "successfull."
}

特典申請更新

特典申請情報を更新する

Authorizations:
BearerAuth
Request Body schema: application/x-www-form-urlencoded
required
prize_id
required
integer

特典ID

item_id
integer

商品ID

code
string or null <= 50 characters

コード

data_api
string or null

データAPI情報

quopay_amount
integer

QuoPay金額

shipping_company_id
integer

配送会社ID

status
integer
Enum: 0 1 2 3 4 8 9 11

ステータス 0: 受取申請（未承認） 1: 申請承認済 2: 配送処理中 3: 配送済 4: 配送保留 8: キャンセル 9: 申請却下 11: 直接付与

coupon_can_use_flag
integer
Default: 0
Enum: 0 1

クーポン利用可能フラグ（0:利用不可, 1:利用可能）

newcomer_flag
integer
Default: 0

新規フラグ

email
string <email> <= 256 characters

メールアドレス

name
string <= 256 characters

氏名

name_kana
string <= 256 characters

氏名（カナ）

zipcode
string <= 8 characters ^\d{7}$|^\d{3}-\d{4}$

郵便番号

pref
integer

都道府県コード

address1
string <= 256 characters

住所1（市区町村）

address2
string <= 256 characters

住所2（町域・番地）

address3
string <= 255 characters

住所3（建物名・部屋番号）

tel
string <= 15 characters ^\d{10,14}$|^\d{2,4}-\d{2,4}-\d{4}$

電話番号

newcomer
string <= 256 characters

新規者情報

newcomer_shop
string <= 20 characters

新規者店舗

newcomer_subscriber_id
integer

新規者会員ID

referral_subscriber_id
integer

紹介者会員ID

refer_prize
integer
Default: 0

紹介特典

memo
string

メモ

lottery_entered
integer
Default: 0

抽選参加フラグ

approval_date
string <date>

承認日

access_key
string <= 128 characters

アクセスキー

contractor_status
integer

契約者ステータス

trans_company
integer

運送会社

tracking_number
string <= 255 characters

追跡番号

shipping_date
string <date>

配送日

arrival_date
string <date>

到着日

delete_flag
integer
Default: 0
Enum: 0 1

削除フラグ（0:有効, 1:削除済み）

update_datetime
string <date-time>

更新日時

create_datetime
string <date-time>

作成日時

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "status": 1,
  • "msg": "successfull."
}

特典申請ステータス更新

特典申請のステータスを更新する

Authorizations:
BearerAuth
Request Body schema: application/x-www-form-urlencoded
required
prize_id
required
integer

特典ID

status
required
integer
Enum: 0 1 2 3 4 8 9 11

ステータス 0: 受取申請（未承認） 1: 申請承認済 2: 配送処理中 3: 配送済 4: 配送保留 8: キャンセル 9: 申請却下 11: 直接付与

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "status": 1,
  • "msg": "successfull."
}

特典申請検索

特典申請を検索する

Authorizations:
BearerAuth
Request Body schema: application/x-www-form-urlencoded
required
offset
string

オフセット

limit
string

取得件数制限

contractor_name
string

契約者名

shop_name
string

店舗名

shipping_company_id
string

配送会社ID

name
string <= 256 characters

氏名

name_kana
string <= 256 characters

氏名（カナ）

status
string
Enum: 0 1 2 3 4 8 9 11

ステータス 0: 受取申請（未承認） 1: 申請承認済 2: 配送処理中 3: 配送済 4: 配送保留 8: キャンセル 9: 申請却下 11: 直接付与

pref
string

都道府県

address1
string <= 256 characters

住所1（市区町村）

address2
string <= 256 characters

住所2（町域・番地）

address3
string <= 255 characters

住所3（建物名・部屋番号）

tel
string <= 15 characters

電話番号

email
string <email> <= 256 characters

メールアドレス

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "status": 1,
  • "msg": "Successful operation.",
  • "data": [
    ]
}

特典申請詳細取得

特典申請の詳細情報を取得する

Authorizations:
BearerAuth
Request Body schema: application/x-www-form-urlencoded
required
prize_id
required
integer

特典申請ID

Responses

Response samples

Content type
application/json
{
  • "prize_id": 1001,
  • "contractor_id": 1001,
  • "shop_id": 2001,
  • "campaign_id": 3001,
  • "subscriber_id": 12345,
  • "item_id": 5001,
  • "code": "PRIZE2023001",
  • "data_api": "{\"api_endpoint\": \"https://api.example.com\", \"token\": \"abc123\"}",
  • "quopay_amount": 1500,
  • "shipping_company_id": 101,
  • "status": 1,
  • "coupon_can_use_flag": 1,
  • "newcomer_flag": 0,
  • "email": "user@example.com",
  • "name": "山田太郎",
  • "name_kana": "ヤマダタロウ",
  • "zipcode": "1234567",
  • "pref": 13,
  • "address1": "新宿区",
  • "address2": "西新宿1-1-1",
  • "address3": "新宿ビル101号室",
  • "tel": "09012345678",
  • "newcomer": "初回登録特典",
  • "newcomer_shop": "SHOP001",
  • "newcomer_subscriber_id": 10001,
  • "referral_subscriber_id": 10002,
  • "refer_prize": 0,
  • "memo": "配送時の注意事項",
  • "lottery_entered": 1,
  • "approval_date": "2023-12-01",
  • "access_key": "ak_1234567890abcdef1234567890abcdef",
  • "contractor_status": 1,
  • "trans_company": 201,
  • "tracking_number": "1234567890123456",
  • "shipping_date": "2023-12-05",
  • "arrival_date": "2023-12-07",
  • "delete_flag": 0,
  • "update_datetime": "2023-12-01T10:30:00Z",
  • "create_datetime": "2023-11-01T09:15:00Z"
}

特典申請削除

特典申請を削除する

Authorizations:
BearerAuth
Request Body schema: application/x-www-form-urlencoded
required
prize_id
required
integer

特典申請ID

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "status": 1,
  • "msg": "successfull."
}

特典申請一覧取得

特典申請一覧を取得する

Authorizations:
BearerAuth
Request Body schema: application/x-www-form-urlencoded
offset
string

オフセット

limit
string

取得件数制限

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "status": 1,
  • "msg": "Successful operation.",
  • "data": [
    ]
}

特典申請ダウンロード

特典申請一覧をダウンロードする

Authorizations:
BearerAuth
Request Body schema: application/x-www-form-urlencoded
required
shop_id
required
integer

店舗ID

offset
string

オフセット

limit
string

取得件数制限

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "status": 1,
  • "msg": "Successful operation.",
  • "data": "contractor_id,shop_id,campaign_id,subscriber_id,item_id,code,quopay_amount,shipping_company_id,status,newcomer_flag,email,name,name_kana,zipcode,pref,address1,address2,address3,access_key,tel,newcomer,newcomer_shop,memo\n1001,2001,3001,12345,5001,\"PRIZE2023001\",1500,101,1,0,\"yamada@example.com\",\"山田太郎\",\"ヤマダタロウ\",\"1234567\",\"東京都\",\"新宿区\",\"西新宿1-1-1\",\"新宿ビル101号室\",\"ak_1234567890abcdef1234567890abcdef\",\"09012345678\",\"初回登録特典\",\"SHOP001\",\"配送時注意事項\"\n1001,2001,3002,12346,5002,\"PRIZE2023002\",2000,102,2,1,\"sato@example.com\",\"佐藤花子\",\"サトウハナコ\",\"1500001\",\"東京都\",\"渋谷区\",\"渋谷1-2-3\",\"渋谷マンション202号室\",\"ak_abcdef1234567890abcdef1234567890\",\"09087654321\",\"紹介特典\",\"SHOP002\",\"午前中配送希望\"\n"
}

カスタム項目

カスタム項目管理API

トークン取得

カスタム項目関連APIのトークンを取得する

Authorizations:
BearerAuth
Request Body schema: application/x-www-form-urlencoded
required
login_id
required
string

クチコ店舗ログインID

password
required
string

クチコ店舗ログインパスワード

Responses

Response samples

Content type
application/json
{
  • "contractor_id": 121,
  • "contractor_account_id": 149,
  • "token": "e3f9e2cd5d865f0bf7346e1cb6e11ea8",
  • "limit_datetime": "2024-02-02 21:48:51"
}

カスタム項目作成

カスタム項目を新規作成する

Authorizations:
BearerAuth
Request Body schema: application/x-www-form-urlencoded
required
shop_id
required
integer

店舗ID

subscriber_id
required
integer

会員ID

custom_field_id
required
integer

カスタムフィールドID

value
required
string

カスタムフィールドの値

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "status": 1,
  • "msg": "successfull."
}

カスタム項目更新

カスタム項目を更新する

Authorizations:
BearerAuth
Request Body schema: application/x-www-form-urlencoded
required
custom_field_value_id
required
integer

カスタムフィールド値ID

shop_id
required
integer

店舗ID

value
required
string

カスタムフィールドの値

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "status": 1,
  • "msg": "successfull."
}

カスタム項目検索

カスタム項目を検索する

Authorizations:
BearerAuth
Request Body schema: application/x-www-form-urlencoded
required
shop_id
integer

店舗ID

subscriber_id
required
integer
value
integer
offset
string

オフセット

limit
string

取得件数制限

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "status": 1,
  • "msg": "Successful operation.",
  • "data": [
    ]
}

カスタム項目削除

カスタム項目を削除する

Authorizations:
BearerAuth
Request Body schema: application/x-www-form-urlencoded
required
custom_field_value_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "status": 1,
  • "msg": "successfull."
}

カスタム項目一覧取得

カスタム項目の一覧を取得する

Authorizations:
BearerAuth
Request Body schema: application/x-www-form-urlencoded
required
shop_id
integer

店舗ID

subscriber_id
required
integer
offset
string

オフセット

limit
string

取得件数制限

Responses

Response samples

Content type
application/json
{
  • "code": 200,
  • "status": 1,
  • "msg": "Successful operation.",
  • "data": [
    ]
}