English

Kinchaku API(日本語) (1.4.0)

Download OpenAPI specification:

Kinchakuヘルプデスク: help@kinchaku.com Terms of Service

Kinchaku API v1

Kinchaku REST APIのエンドポイントはリソースタイプごとに整理されています。 アプリの要件に応じて、対象となるエンドポイントをご利用ください。

1. 顧客・利用者情報

Contact Resource は、顧客またはパス保持者の情報、連絡先の詳細、統計データ、およびメールマーケティングを受け取るための同意状態を管理します。

2. プロジェクト

Project Resource は、プロジェクトのタイプや詳細情報、発行されたパスの数等、配布ページ訪問者の数に関する情報を管理します。

利用可能なプロジェクトタイプ

  • 入場券
  • 搭乗券
  • 予約券
  • クーポン
  • 会員証(ポイントカード)
  • スタンプカード
  • サブスクパス
  • 引換券

3. パス

Pass Resource は、パスのタイプ、デザインとパスの状態に関する情報を管理します。


制限

APIは1分あたり1000リクエストのレート制限があります。x-ratelimit-limit と x-ratelimit-remaining ヘッダーを監視してください。

同じリクエストを2秒以内に重複して行うと、429 エラーが返されます。

制限事項

Kinchaku APIは一括更新(バッチ処理)をサポートしていません。リクエストごとに1つのオブジェクトのみを操作できます。

Contacts

Create contact

新規顧客記録を作成します。

Authorizations:
Bearer
Request Body schema: application/json

新規顧客記録を作成するためのAPIに必要なフィールドを送信してください。

accepts_marketing
boolean
Default: false

顧客がマーケティングメールを受け取るかどうかを示します。

birthday
string or null <date> non-empty

顧客の誕生日

department
string or null [ 1 .. 255 ] characters

顧客の所属部署

email
string or null <email> (Email) non-empty

顧客のメールアドレス

external_id
string or null non-empty

外部システムで割当てられたID

first_name
string or null non-empty

顧客の名

gender
string or null non-empty

顧客の性別

language
string non-empty

顧客の言語

last_name
string or null non-empty

顧客の姓

meta
object or null

顧客の追加情報

name
string or null non-empty

顧客のフルネーム

name_katakana
string or null non-empty

顧客のフルネーム(カタカナ)

phone
string or null [ 1 .. 255 ] characters

顧客の電話番号

tags
Array of strings or null

顧客に関連付けられたタグ

website
string or null

顧客のウェブサイト

Responses

Request samples

Content type
application/json
Example
{
  • "first_name": "Rebecca"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get all contacts

顧客記録の一覧を取得します。

Authorizations:
Bearer
query Parameters
limit
integer <= 100
Default: 15

ページあたりの最大アイテム数

page
integer
Default: 1

ページ番号

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Get contact by ID

IDが一致する顧客情報を取得します。

Authorizations:
Bearer
path Parameters
id
required
string

Kinchakuシステムが発行したID

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update contact

既存の顧客記録を更新します。

Authorizations:
Bearer
path Parameters
id
required
string

Kinchakuシステムが発行したID

Request Body schema: application/json

顧客記録を更新するために必要なフィールドをパッチします。

accepts_marketing
boolean
Default: false

顧客がマーケティングメールを受け取るかどうかを示します。

birthday
string or null <date> non-empty

顧客の誕生日

department
string or null [ 1 .. 255 ] characters

顧客の所属部署

email
string or null <email> (Email) non-empty

顧客のメールアドレス

external_id
string or null non-empty

外部システムで割当てられたID

first_name
string or null non-empty

顧客の名

gender
string or null non-empty

顧客の性別

language
string non-empty

顧客の言語

last_name
string or null non-empty

顧客の姓

meta
object or null

顧客の追加情報

name
string or null non-empty

顧客のフルネーム

name_katakana
string or null non-empty

顧客のフルネーム(カタカナ)

phone
string or null [ 1 .. 255 ] characters

顧客の電話番号

tags
Array of strings or null

顧客に関連付けられたタグ

website
string or null

顧客のウェブサイト

Responses

Request samples

Content type
application/json
Example
{
  • "first_name": "Rebecca"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete contact

顧客記録を削除します。

Authorizations:
Bearer
path Parameters
id
required
string

Kinchakuシステムが発行したID

Responses

Response samples

Content type
application/json
{
  • "error": "Unauthenticated."
}

Get contact by External ID

顧客記録のexternal_idが一致する記録を取得します。

Authorizations:
Bearer
path Parameters
external_id
required
string

外部システムで割当てられたID

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete contact by External ID

リクエストパラメータのexternal_idと一致する顧客記録を削除します。

Authorizations:
Bearer
path Parameters
external_id
required
string

外部システムで割当てられたID

Responses

Response samples

Content type
application/json
{
  • "error": "Unauthenticated."
}

Get contact passes

顧客記録のIDが一致するパス一覧を取得します。

Authorizations:
Bearer
path Parameters
id
required
string

Kinchakuシステムが発行したID

query Parameters
limit
integer <= 100
Default: 15

ページあたりの最大アイテム数

page
integer
Default: 1

ページ番号

is_expired
boolean

パスの有効期限切れステータスでフィルタリング

is_used
boolean

パスの使用ステータスでフィルタリング

is_voided
boolean

パスの無効ステータスでフィルタリング

venue
string <uuid>

パスが発行されたまたは利用された店舗のUUID

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Get contact passes by external ID

顧客記録のexternal_idが一致するパス一覧を取得します。

Authorizations:
Bearer
path Parameters
external_id
required
string

外部システムで割当てられたID

query Parameters
limit
integer <= 100
Default: 15

ページあたりの最大アイテム数

page
integer
Default: 1

ページ番号

is_expired
boolean

パスの有効期限切れステータスでフィルタリング

is_used
boolean

パスの使用ステータスでフィルタリング

is_voided
boolean

パスの無効ステータスでフィルタリング

venue
string <uuid>

パスが発行されたまたは利用された店舗のUUID

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Get pass activity by contact ID

指定された顧客IDのパスアクティビティ一覧を取得します。

Authorizations:
Bearer
path Parameters
id
required
string

Kinchakuシステムが発行したID

query Parameters
operation
string
Enum: "punch" "redeem" "checkin" "reward"

操作タイプでアクティビティを絞り込みます。

  • スタンプカードにスタンプをする場合:punch
  • スタンプカード、ポイントカード、バウチャーなどのバリューや特典を消し込む場合:redeem
  • チケット、会員証、またはサブスクリプションパスの場合:checkin を使ってください。
valid
boolean

期限切れのアクティビティを除外するフィルターです、ポイントに期限切れ条件が設定されているポイントカードに使えるパラメタです。

with_deleted
boolean

レスポンスに削除済みのアクティビティを含めます。

start_date
string <date>

プロジェクト開始日からのアクティビティを表示します。

end_date
string <date>

プロジェクト開始日からのアクティビティを表示します。

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Get project contacts

プロジェクトに関連付けられた顧客データ一覧を取得します。

Authorizations:
Bearer
path Parameters
id
required
string

Kinchakuシステムが発行したID

query Parameters
limit
integer <= 100
Default: 15

ページあたりの最大アイテム数

page
integer
Default: 1

ページ番号

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Messages

Passes

Get all passes

パス一覧を取得します。

Authorizations:
Bearer
query Parameters
limit
integer <= 100
Default: 15

ページあたりの最大アイテム数

page
integer
Default: 1

ページ番号

is_expired
boolean

パスの有効期限切れステータスでフィルタリング

is_used
boolean

パスの使用ステータスでフィルタリング

is_voided
boolean

パスの無効ステータスでフィルタリング

venue
string <uuid>

パスが発行されたまたは利用された店舗のUUID

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Get pass by ID

パスのIDを使用して特定のパスを取得します。

Authorizations:
Bearer
path Parameters
id
required
string

Kinchakuシステムが発行したID

query Parameters
with_qr
string
Enum: "base64" "link"

レスポンスにQRコード情報が含まれます。パスを消し込む時に使用できます。

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Void pass

パスを無効にします。

このオペレーションを実行するには、パスIDが必要です。

注意: この操作は取り消しができません。オペレーション実行後にのパス復元が不可です。

Authorizations:
Bearer
path Parameters
id
required
string

Kinchakuシステムが発行したID

Responses

Response samples

Content type
application/json
{
  • "error": "Unauthenticated."
}

Update pass

既存のパス記録を更新します。

Authorizations:
Bearer
path Parameters
id
required
string

Kinchakuシステムが発行したID

Request Body schema: application/json

パス更新リクエストの内容

aux_field
string <= 30 characters

ウォレットパスの表面にある項目で、追加情報を表示するためのフィールドです。

object

パスの予約情報

expires_at
null or string <date-time>

パスの有効期限(ISO 8601形式)

external_id
null or string

外部システムで割当てられたID

smartlock_pin
integer

スマートロックのPINコード

smartlock_qr
string

スマートロックのQRコード

tier
null or integer

手動でロイヤルティパスの階層を変更するためのパラメータ

voided
null or boolean

パスの無効ステータスを更新するためのパラメータ

Responses

Request samples

Content type
application/json
{
  • "aux_field": "string",
  • "booking": {
    },
  • "expires_at": null,
  • "external_id": null,
  • "smartlock_pin": 0,
  • "smartlock_qr": "string",
  • "tier": null,
  • "voided": null
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get pass activity

特定のパスに関連するアクティビティ記録を取得します。

Authorizations:
Bearer
path Parameters
id
required
string

Kinchakuシステムが発行したID

query Parameters
operation
string
Enum: "checkin" "punch" "redeem" "reward"

操作タイプでアクティビティを絞り込みます。

  • スタンプカードにスタンプをする場合:punch
  • スタンプカード、ポイントカード、バウチャーなどのバリューや特典を消し込む場合:redeem
  • チケット、会員証、またはサブスクリプションパスの場合:checkin を使ってください。
valid
boolean

期限切れのアクティビティを除外するフィルターです、ポイントに期限切れ条件が設定されているポイントカードに使えるパラメタです。

with_deleted
boolean

レスポンスに削除済みのアクティビティを含めます。

start_date
string <date>

プロジェクト開始日からのアクティビティを表示します。

end_date
string <date>

プロジェクト終了日までのアクティビティを表示します。

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Get point history

パスに関連するロイヤルティポイントの取得・利用履歴を取得するためののオペレーションです。

Authorizations:
Bearer
path Parameters
id
required
string

Kinchakuシステムが発行したID

query Parameters
from
string <date>

指定された期日からのポイント履歴を取得します。

to
string <date>

指定された期日までのポイント履歴を表示します。

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Punch pass

スタンプカードにスタンプ付与するためのオペレーションです。

Authorizations:
Bearer
path Parameters
id
required
string

Kinchakuシステムが発行したID

Request Body schema: application/json
redeem
Array of strings or null

消し込み対象の特典

value
integer

スタンプまたはポイントの数

venue
null or string <uuid> (UUID)

スタンプが付与された店舗のUUID

Responses

Request samples

Content type
application/json
{
  • "redeem": [
    ],
  • "value": 0,
  • "venue": null
}

Response samples

Content type
application/json
{
  • "errors": {
    }
}

Redeem pass

クーポンや引換券のバリュー、またはロイヤルティプログラムの特典を消し込むオペレーションです。

Authorizations:
Bearer
path Parameters
id
required
string

Kinchakuシステムが発行したID

Request Body schema: application/json
aux_field
string or null

ウォレットパスの表面にある項目で、追加情報を表示するためのフィールドです。

redeem
Array of strings or null

消し込み可能な特典

rewards
Array of null or strings or null <uuid> (UUID) [ items <uuid > ]

消し込み対象の特典

venue
null or string <uuid> (UUID)

消し込みが行われた店舗のUUID

Responses

Request samples

Content type
application/json
{
  • "aux_field": "string",
  • "redeem": [
    ],
  • "rewards": [
    ],
  • "venue": null
}

Response samples

Content type
application/json
{
  • "errors": {
    }
}

Update pass value

パスに表示されているポイント数を更新するためのオペレーションです。

Authorizations:
Bearer
path Parameters
id
required
string

Kinchakuシステムが発行したID

Request Body schema: application/json
description
string or null <= 255 characters

このフィールドは、システム内のポイントに対する更新に伴う任意の説明の追加を可能にします。

pay_sum
integer or null

顧客がロイヤルティポイントを取得するために支払った金額

value
integer

ポイント数

venue
null or string <uuid> (UUID)

ポイントが付与された店舗のUUID

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "pay_sum": 0,
  • "value": 0,
  • "venue": null
}

Response samples

Content type
application/json
{
  • "errors": {
    }
}

Change pass's value_total

ポイントカードの累積ポイントを更新します。 ロイヤルティプログラムで発行されたパスを、新しいレベルへのアップグレードを強制するために使用できます。

Authorizations:
Bearer
path Parameters
id
required
string

Kinchakuシステムが発行したID

Request Body schema: application/json
description
string or null <= 255 characters

このフィールドは、システム内のポイントに対する更新に伴う任意の説明の追加を可能にします。

pay_sum
integer or null

顧客がロイヤルティポイントを取得するために支払った金額

value
integer

ポイント数

venue
null or string <uuid> (UUID)

ポイントが付与された店舗のUUID

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "pay_sum": 0,
  • "value": 0,
  • "venue": null
}

Response samples

Content type
application/json
{
  • "errors": {
    }
}

Check-in pass

パスをチェックインするためのオペレーションです。

Authorizations:
Bearer
path Parameters
id
required
string

Kinchakuシステムが発行したID

Request Body schema: application/json
aux_field
string or null

ウォレットパスの表面にある項目で、追加情報を表示するためのフィールドです。

venue
null or string <uuid> (UUID)

チェックインが行われた店舗のUUID

Responses

Request samples

Content type
application/json
{
  • "aux_field": "string",
  • "venue": null
}

Response samples

Content type
application/json
{
  • "errors": {
    }
}

Check-out pass

パスをチェックアウトするためのオペレーションです。

Authorizations:
Bearer
path Parameters
id
required
string

Kinchakuシステムが発行したID

Responses

Response samples

Content type
application/json
{
  • "errors": {
    }
}

Undo pass activity

パスアクティビティを取り消すためのオペレーションです。

Authorizations:
Bearer
path Parameters
id
required
string

Kinchakuシステムが発行したID

activity_id
required
integer

アクティビティ記録のID

Responses

Response samples

Content type
application/json
{
  • "errors": {
    }
}

Get project passes

プロジェクトに関連付けられたパス一覧を取得します。

Authorizations:
Bearer
path Parameters
id
required
string

Kinchakuシステムが発行したID

query Parameters
limit
integer <= 100
Default: 15

ページあたりの最大アイテム数

page
integer
Default: 1

ページ番号

start_date
string <date>

プロジェクトの開始日

end_date
string <date>

End date of a pass project.

is_expired
boolean

パスの有効期限切れステータスでフィルタリング

is_used
boolean

パスの使用ステータスでフィルタリング

is_voided
boolean

パスの無効ステータスでフィルタリング

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Issue pass

対象となるプロジェクトのパスを発行します。

Authorizations:
Bearer
path Parameters
id
required
string

Kinchakuシステムが発行したID

query Parameters
with_qr
string
Enum: "base64" "link"

レスポンスにパス消し込み用のQRコードを含みます。

Request Body schema: application/json

パス発行リクエストの内容

aux_field
string <= 30 characters

ウォレットパスの表面にある項目で、追加情報を表示するためのフィールドです。

object

パスの予約情報

object (Contact)

顧客情報モデル

値のないフィールドは null ではなく、レスポンスから省略されます。

expires_at
string or null <date-time> (DateTime)

パスの有効期限(ISO 8601形式)

external_id
null or string

外部システムで割当てられたID

fare_id
string <uuid>

運賃のuuidです。交通系のパスで使用されます。

plan_id
null or string <uuid> (UUID)

料金プランのuuidです。

send
boolean

顧客にパスリンクを含むメールを送信します。

smartlock_pin
integer

スマートロックのPINコード

smartlock_qr
string

スマートロックのQRコード

value
integer
venue
null or string <uuid> (UUID)

パスが発行された店舗のUUID

Responses

Request samples

Content type
application/json
{
  • "aux_field": "string",
  • "booking": {
    },
  • "contact": {
    },
  • "expires_at": "2019-08-24T14:15:22Z",
  • "external_id": null,
  • "fare_id": "1ed58791-3cac-4030-9cf0-4f9e1c25fc4b",
  • "plan_id": null,
  • "send": true,
  • "smartlock_pin": 0,
  • "smartlock_qr": "string",
  • "value": 0,
  • "venue": null
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get pass messages

特定のウォレットパスに関連付けられた通知一覧を取得します。

Authorizations:
Bearer
path Parameters
id
required
string

Kinchakuシステムが発行したID

query Parameters
limit
integer <= 100
Default: 15

ページあたりの最大アイテム数

page
integer
Default: 1

ページ番号

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Create pass message

新しいウォレットパス通知を作成します。

通知は、すぐに送信するか、特定の日時にスケジュールするか、またはドラフトとして保存することができます。

Authorizations:
Bearer
path Parameters
id
required
string

Kinchakuシステムが発行したID

Request Body schema: application/json

Send immediately, schedule or save draft message.

body
required
string [ 2 .. 80 ] characters
body_en
string or null [ 2 .. 80 ] characters
scheduled_at
string or null <date-time> (DateTime)

Date and time in ISO 8601 format.

is_draft
boolean

Responses

Request samples

Content type
application/json
{
  • "body": "Hello",
  • "scheduled_at": "2030-01-20T12:00:00+09:00",
  • "is_draft": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete pass message

送信される前に、スケジュールされていた通知をキューから削除します。

これは、配信される予定の通知を対象としており、通知が不要になったりした場合、送信をキャンセルできます。 スケジューリングシステムから通知を削除するためには、スケジュールされていた通知のIDをリクエストで送信してください。 通知が削除されると、復元することはできません。

Authorizations:
Bearer
path Parameters
id
required
string

Kinchakuシステムが発行したID

message_id
required
string

通知のID

Responses

Response samples

Content type
application/json
{
  • "error": "Unauthenticated."
}

Update pass message

スケジュールされた通知の内容やメタデータを変更したい場合、このオペレーションを使ってください。

Authorizations:
Bearer
path Parameters
id
required
string

Kinchakuシステムが発行したID

message_id
required
string

通知のID

Request Body schema: application/json
body
required
string [ 2 .. 80 ] characters
body_en
string or null [ 2 .. 80 ] characters
scheduled_at
string or null <date-time> (DateTime)

Date and time in ISO 8601 format.

is_draft
boolean

Responses

Request samples

Content type
application/json
{
  • "body": "string",
  • "body_en": "string",
  • "scheduled_at": "2019-08-24T14:15:22Z",
  • "is_draft": true
}

Response samples

Content type
application/json
{
  • "errors": {
    }
}

Projects

Get pass activity by project ID

指定されたプロジェクトで発行されたパスのアクティビティ一覧を取得します。

Authorizations:
Bearer
path Parameters
id
required
string

Kinchakuシステムが発行したID

query Parameters
operation
string
Enum: "punch" "redeem" "checkin" "reward"

操作タイプで絞り込めます。

valid
boolean

期限切れのアクティビティを除外するフィルターです、ポイントに期限切れ条件が設定されているポイントカードに使えるパラメタです。

with_deleted
boolean

レスポンスに削除済みのアクティビティを含めます。

start_date
string <date>

プロジェクトの開始日です。

end_date
string <date>

プロジェクトの終了日です。

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Get projects

このオペレーションは、ワークスペース内で現在管理されているすべてのプロジェクト一覧を取得します。

Authorizations:
Bearer
query Parameters
limit
integer <= 100
Default: 15

ページあたりの最大アイテム数

page
integer
Default: 1

ページ番号

tags
Array of strings

タグはプロジェクトをフィルタリングするために使用されます。デフォルトでは、提供されたタグのいずれかを含むプロジェクトを返します。

filter_logic
string
Default: "OR"
Enum: "OR" "AND"
Example: filter_logic=AND

タグフィルタリングのロジックを指定します。

venue
string <uuid>

パスが発行されたまたは利用された店舗のUUID

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Get project

Get Project information.

Authorizations:
Bearer
path Parameters
id
required
string

Kinchakuシステムが発行したID

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get pass activity

プロジェクトタイプ別にウォレットパスのアクティビティを取得します。

使用可能なタイプ:

  • coupon
  • voucher
  • ticket
  • member
  • stamp
  • transport
  • subscription
Authorizations:
Bearer
path Parameters
type
required
string

Type of the project.

query Parameters
start_date
string <date>

プロジェクトの開始日からのパスアクティビティを表示します。

end_date
string <date>

プロジェクトの終了日までのパスアクティビティを表示します。

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Get project contacts

プロジェクトに関連付けられた顧客データ一覧を取得します。

Authorizations:
Bearer
path Parameters
id
required
string

Kinchakuシステムが発行したID

query Parameters
limit
integer <= 100
Default: 15

ページあたりの最大アイテム数

page
integer
Default: 1

ページ番号

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Get project passes

プロジェクトに関連付けられたパス一覧を取得します。

Authorizations:
Bearer
path Parameters
id
required
string

Kinchakuシステムが発行したID

query Parameters
limit
integer <= 100
Default: 15

ページあたりの最大アイテム数

page
integer
Default: 1

ページ番号

start_date
string <date>

プロジェクトの開始日

end_date
string <date>

End date of a pass project.

is_expired
boolean

パスの有効期限切れステータスでフィルタリング

is_used
boolean

パスの使用ステータスでフィルタリング

is_voided
boolean

パスの無効ステータスでフィルタリング

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Issue pass

対象となるプロジェクトのパスを発行します。

Authorizations:
Bearer
path Parameters
id
required
string

Kinchakuシステムが発行したID

query Parameters
with_qr
string
Enum: "base64" "link"

レスポンスにパス消し込み用のQRコードを含みます。

Request Body schema: application/json

パス発行リクエストの内容

aux_field
string <= 30 characters

ウォレットパスの表面にある項目で、追加情報を表示するためのフィールドです。

object

パスの予約情報

object (Contact)

顧客情報モデル

値のないフィールドは null ではなく、レスポンスから省略されます。

expires_at
string or null <date-time> (DateTime)

パスの有効期限(ISO 8601形式)

external_id
null or string

外部システムで割当てられたID

fare_id
string <uuid>

運賃のuuidです。交通系のパスで使用されます。

plan_id
null or string <uuid> (UUID)

料金プランのuuidです。

send
boolean

顧客にパスリンクを含むメールを送信します。

smartlock_pin
integer

スマートロックのPINコード

smartlock_qr
string

スマートロックのQRコード

value
integer
venue
null or string <uuid> (UUID)

パスが発行された店舗のUUID

Responses

Request samples

Content type
application/json
{
  • "aux_field": "string",
  • "booking": {
    },
  • "contact": {
    },
  • "expires_at": "2019-08-24T14:15:22Z",
  • "external_id": null,
  • "fare_id": "1ed58791-3cac-4030-9cf0-4f9e1c25fc4b",
  • "plan_id": null,
  • "send": true,
  • "smartlock_pin": 0,
  • "smartlock_qr": "string",
  • "value": 0,
  • "venue": null
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get project messages

指定されたプロジェクトのパス通知一覧を取得します。

Authorizations:
Bearer
path Parameters
id
required
string

Kinchakuシステムが発行したID

query Parameters
limit
integer <= 100
Default: 15

ページあたりの最大アイテム数

page
integer
Default: 1

ページ番号

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Create pass message

パスメッセージを作成します。

Authorizations:
Bearer
path Parameters
id
required
string

Kinchakuシステムが発行したID

Request Body schema: application/json

即時送信、スケジュール送信、下書き保存のパス通知を作成します。

body
required
string [ 2 .. 80 ] characters
body_en
string or null [ 2 .. 80 ] characters
scheduled_at
string or null <date-time> (DateTime)

Date and time in ISO 8601 format.

is_draft
boolean

Responses

Request samples

Content type
application/json
{
  • "body": "Hello",
  • "scheduled_at": "2030-01-20T12:00:00+09:00",
  • "is_draft": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete pass message

送信前のスケジュールされたパス通知を削除します。

Authorizations:
Bearer
path Parameters
id
required
string

Kinchakuシステムが発行したID

message_id
required
string

パス通知のID

Responses

Response samples

Content type
application/json
{
  • "error": "Unauthenticated."
}

Update pass message

このエンドポイントは、ウォレットパスの通知を更新するために使用されます。 通知の内容、スケジュール、および下書きステータスを変更できます。

注: 本文テキストは2文字以上80文字以下である必要があります。

Authorizations:
Bearer
path Parameters
id
required
string

Kinchakuシステムが発行したID

message_id
required
string

パス通知のID

Request Body schema: application/json
body
required
string [ 2 .. 80 ] characters
body_en
string or null [ 2 .. 80 ] characters
scheduled_at
string or null <date-time> (DateTime)

Date and time in ISO 8601 format.

is_draft
boolean

Responses

Request samples

Content type
application/json
{
  • "body": "string",
  • "body_en": "string",
  • "scheduled_at": "2019-08-24T14:15:22Z",
  • "is_draft": true
}

Response samples

Content type
application/json
{
  • "errors": {
    }
}

Schemas

Activity

id
number
wallet_pass_id
string <uuid>

パスのID

project_id
string <uuid>

GET /projects/activity/{type} でのみ返されます。

project_title
string

プロジェクト名。GET /projects/activity/{type} でのみ返されます。

object (CompactContact)

パスを持つ顧客の簡易情報。Contact と同じく、値のないフィールドは省略されます。

operator_id
string <uuid>
object
Venue (object) or null
operation
string

記録の種類: punch、checkin、use、reward、redeem、bonus

value
number
used
number
description
null or string
amount
integer or null

ポイントを取得するために使われた金額。

redeemed_at
string or null <date-time> (DateTime)

Date and time in ISO 8601 format.

expires_at
string or null <date-time> (DateTime)

Date and time in ISO 8601 format.

created_at
string or null <date-time> (DateTime)

Date and time in ISO 8601 format.

updated_at
string or null <date-time> (DateTime)

Date and time in ISO 8601 format.

deleted_at
string or null <date-time> (DateTime)

記録が削除された日時。with_deleted で返される削除済みの記録にのみ含まれます。

{
  • "id": 0,
  • "wallet_pass_id": "655f900e-3575-419e-b898-da2b2a74f1ad",
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "project_title": "string",
  • "contact": {
    },
  • "operator_id": "fa9de6bb-1df8-4ba6-9e6d-1172fbf7e166",
  • "operator": {
    },
  • "venue": {
    },
  • "operation": "string",
  • "value": 0,
  • "used": 0,
  • "description": null,
  • "amount": 0,
  • "redeemed_at": "2019-08-24T14:15:22Z",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z"
}

Address

id
string <uuid>

Kinchakuシステムが発行したID

role
string non-empty
Default: "main"

住所の役割(自宅、職場等)

street
string or null

番地

other
string or null

マンション名、部屋番号等

city
string or null

市区町村

state
string or null

都道府県、または州

country
string or null

国

postcode
string or null

郵便番号

phone
string or null

電話番号

created_at
string or null <date-time> (DateTime)

Date and time in ISO 8601 format.

updated_at
string or null <date-time> (DateTime)

Date and time in ISO 8601 format.

{
  • "role": "main",
  • "street": "博多駅東",
  • "other": null,
  • "city": "福岡市博多区",
  • "state": "福岡県",
  • "country": "JP",
  • "postcode": "8120013"
}

Contact

id
string <uuid>

Kinchakuシステムが発行したID

external_id
string or null

外部システムで割当てられた顧客のID

shortuuid
string

パスやページのリンクに使われる顧客の短縮ID

email
string or null <email> (Email) non-empty

メールアドレス

phone
string

顧客の電話番号

name
string or null

フルネーム

first_name
string or null

名

last_name
string or null

姓

name_katakana
string or null

名前のカタカナ

birthday
string <date>

生年月日(旧フィールド名。birthdate と同じ値)

birthdate
string <date>

顧客の生年月日

contact_image
string or null <uri> (URL) non-empty

画像のURL

is_company
boolean

法人顧客かどうか

last_contact_at
string or null <date-time> (DateTime)

顧客のパスで最後にアクティビティ(チェックイン、スタンプ、利用など)が記録された日時

object (Venue)

最後に来店した店舗。visited_venues と一緒に返されます。

visited_venues
Array of objects or null

パスが使われた店舗や施設の一覧

Array of objects (Address) unique

住所情報

tags
Array of strings

顧客に関連付けられたタグ

object

人に関する追加情報

created_at
string or null <date-time> (DateTime)

Date and time in ISO 8601 format.

updated_at
string or null <date-time> (DateTime)

Date and time in ISO 8601 format.

{
  • "id": "94a6e034-f3b2-4164-9e0a-a28114d9474b",
  • "external_id": "e8a01cfbea59",
  • "email": "taro@kinchaku.com",
  • "name": "タロウ ヨウロウ",
  • "first_name": "ヨウロウ",
  • "last_name": "タロウ",
  • "name_katakana": "ヨウロウタロウ",
  • "visited_venues": [ ],
  • "addresses": [
    ],
  • "meta": {
    },
  • "created_at": "2021-10-17T04:21:10.000000Z",
  • "updated_at": "2021-10-17T04:21:22.000000Z"
}

CompactContact

id
string <uuid>

Kinchakuシステムが発行したID

external_id
string or null

外部システムで割当てられた顧客のID

shortuuid
string

パスやページのリンクに使われる顧客の短縮ID

email
string or null <email> non-empty

メールアドレス

phone
string

顧客の電話番号

name
string or null

フルネーム

first_name
string or null

名

last_name
string or null

姓

name_katakana
string or null

名前のカタカナ

contact_image
string or null <uri> non-empty

画像のURL

is_company
boolean

法人顧客かどうか

birthday
string <date>

生年月日(旧フィールド名。birthdate と同じ値)

object

人に関する追加情報

created_at
string or null <date-time>

Date and time in ISO 8601 format.

updated_at
string or null <date-time>

Date and time in ISO 8601 format.

deleted_at
string or null <date-time> (DateTime)

顧客が削除された日時。削除されていない場合は null です。

last_visit_at
string or null <date-time> (DateTime)

顧客が最後に来店した日時

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "external_id": "string",
  • "shortuuid": "string",
  • "email": "user@example.com",
  • "phone": "string",
  • "name": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "name_katakana": "string",
  • "contact_image": "http://example.com",
  • "is_company": true,
  • "birthday": "2019-08-24",
  • "meta": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "last_visit_at": "2019-08-24T14:15:22Z"
}

DateTime

string or null <date-time> (DateTime)

Date and time in ISO 8601 format.

"2019-08-24T14:15:22Z"

Email

string or null <email> (Email) non-empty

メールアドレス

"user@example.com"

Error

required
object
{
  • "errors": {
    }
}

Message

android_count
integer >= 0

パスがインストールされているAndroidデバイスの数。注: Apple WalletとGoogle Walletのパスに対するメッセージは異なる振る舞いをします。

body
string non-empty

パス通知の本文(日本語)。

body_en
string non-empty

英語のパス通知の本文(日本語以外の言語設定のデバイスに表示されます)。

created_at
string or null <date-time> (DateTime)

Date and time in ISO 8601 format.

header
null or string

パス通知のタイトル (androidのみ)

id
string <uuid>

Kinchakuシステムが発行したID

ios_count
integer >= 0

パスがインストールされているiOSデバイスの数。

注: Apple WalletとGoogle Walletのパスに配信されるメッセージは異なる振る舞いをします。

boolean or integer

パス通知が下書きかどうかを示します。真偽値または 0/1 で返されます。

object

パス通知を送信またはスケジュールしたユーザーの情報

operator_id
string <uuid>

パス通知を送信またはスケジュールしたユーザーのID

scheduled_at
string or null <date-time> (DateTime)

パス通知のスケジュール日時

sent_at
string or null <date-time> (DateTime)

パス通知が送信された日時

updated_at
string or null <date-time> (DateTime)

記録の更新日時

{
  • "id": "95584608-4291-4565-a5a6-ac32c443abf9",
  • "operator_id": "8ddb7a06-0a8f-46bd-a27e-d37adf4dc138",
  • "header": null,
  • "body": "hello",
  • "is_draft": 0,
  • "android_count": 0,
  • "ios_count": 0,
  • "sent_at": "2022-01-13T08:47:26.000000Z",
  • "scheduled_at": null,
  • "created_at": "2022-01-13T08:47:26.000000Z",
  • "updated_at": "2022-01-13T08:47:26.000000Z",
  • "operator": {
    }
}

Pagination

current_page
integer <int32>
Default: 1
from
integer <int32> >= 1
Default: 1
last_page
integer <int32>
per_page
integer <int32>
Default: 15
to
integer <int32>
total
integer <int32>
{
  • "current_page": 1,
  • "from": 1,
  • "last_page": 8,
  • "per_page": 15,
  • "to": 15,
  • "total": 115
}

Plan

archived_at
string or null <date-time> (DateTime)

記録がアーカイブされた日時(ISO 8601形式)

checkin_open
string

開始時刻のどれだけ前からチェックインできるかを示す期間(例: 1 hour)。未設定の場合は空文字で、予約があれば15分前、なければ開始の1時間前から受け付けます。

object or array <= 0 items

このプランのパスに適用される色の設定。未設定の場合は空の配列([])です。

created_at
string or null <date-time> (DateTime)

記録が作成された日時(ISO 8601形式)

description
string or null

料金プランの説明文(日本語)

description_en
string or null

料金プランの説明文(英語)

disable_cancel
boolean

キャンセルが可能かどうかを示します。

disable_refund
boolean

返金が可能かどうかを示します。

object
id
string <uuid>

Kinchakuシステムが発行したID

object
interval
string

このパラメータは、サブスクリプションパスの請求が行われる間隔を定義します。 使用可能な値は、day、week、month、またはyearです。

interval_count
integer

サブスクリプションの請求間隔の数。例えば、interval=monthおよびinterval_count=3は3ヶ月ごとに請求します。 サブスクリプションパスに使用されます。

link
string

配布ページのURL

max_redemptions
integer

パスが購入された料金プランで利用可能回数。

name
string

料金プラン名(日本語)

name_en
string or null

料金プラン名(英語)

pass_layout
string

ウォレットパスのレイアウト。branded_strip_image(既定)、no_image、client_picture_and_name、aux_in_primary などがあります。

price
integer

料金プランの価格

price_without_tax
integer

料金プランの税抜き価格

quantity
integer or null

プランで販売されるパスの最大数。

tax_amount
integer

税額

tax_included
boolean

税込み価格かどうかを示します。

trial_days
integer or null

サブスクリプションのトライアル期間(日数)

updated_at
string or null <date-time> (DateTime)

記録が更新された日時(ISO 8601形式)

sales_start
string or null <date-time>

販売開始日時(ISO 8601形式)

sales_end
string or null <date-time>

販売終了日時(ISO 8601形式)

{
  • "id": "9b8b64b9-d761-4d1d-ae96-fba25bef64c9",
  • "name": "Category 1",
  • "name_en": null,
  • "link": "/booking/9ab9f0d3-41f6-43b9-97f7-d875e7a64e50/categories/fba25bef64c9",
  • "interval": "once",
  • "quantity": null,
  • "max_redemptions": 1,
  • "interval_count": 1,
  • "trial_days": 0,
  • "tax_included": true,
  • "description": "",
  • "description_en": "",
  • "archived_at": null,
  • "created_at": "2024-03-12T07:52:06.000000Z",
  • "updated_at": "2024-04-04T02:17:18.000000Z",
  • "price": 1000,
  • "price_without_tax": 909,
  • "tax_amount": 91,
  • "disable_refund": false,
  • "disable_cancel": false,
  • "images": {},
  • "expiration": {
    },
  • "sales_end": "2024-06-26T14:59:00.000000Z",
  • "sales_start": "2024-06-24T15:00:00.000000Z"
}

Project

amount_off
integer or null

割引額(currency の単位)。クーポンのプロジェクトのみ。

archived_at
string or null <date-time> (DateTime)

プロジェクトがアーカイブされた日時

object

パスに表示されるバーコードの設定

booking_units
Array of any or null

プロジェクトに紐付けられた予約ユニットの一覧

Array of objects

バンドルに含まれる店舗と、店舗ごとの利用可能回数。バンドルのプロジェクトのみ。

contact_address
string or null

Support email address available to customers

cancelation
string or null

プロジェクトのキャンセルポリシー(日本語)

cancelation_en
string or null

プロジェクトのキャンセルポリシー(英語)

created_at
string or null <date-time> (DateTime)

プロジェクトが作成された日時

currency
string

amount_off の通貨(例: JPY)。クーポンのプロジェクトのみ。

description
string

プロジェクトの配布ページで表示される説明文(日本語)

description_en
string or null

プロジェクトの配布ページで表示される説明文(英語)

discount_terms
string

表示用の割引内容(例: 10% off)。voucher はバウチャーの文言、monetary は空文字を返します。クーポンのプロジェクトのみ。

discount_type
string or null

割引の種類(fixed、percent、voucher、monetary)。クーポンのプロジェクトのみ。

end_time
string

終了時刻(HH:MM)。未設定の場合は省略されます。

object

パスの有効期限設定

expire_points_end
integer or null

ポイントは獲得月からこの月数後の月末に失効します。expire_points_in が未設定の場合に使われます。ロイヤルティプログラムのプロジェクトのみ。

expire_points_in
integer or null

ポイントの有効期限(獲得日からの日数)。未設定の場合は null です。ロイヤルティプログラムのプロジェクトのみ。

external_id
string or null

外部システムで割当てられたプロジェクトID

has_activity
integer

指定されたプロジェクトで発行されたパスに何らかのアクティビティがあるかどうかを示します。

has_data_collection
boolean

プロジェクトが顧客から個人データを収集するかどうかを示します。

has_registration
boolean

指定されたプロジェクトで顧客アカウント登録機能が有効かどうかを示します。

hour_price
integer

1時間あたりの価格。未設定の場合は 0 です。ロイヤルティプログラムのプロジェクトのみ。

id
string <uuid>

Kinchakuシステムが発行したプロジェクトID

object
is_published
boolean
Default: false

プロジェクトが公開され、顧客がパス配布ページにアクセスできるかどうかを示します。

object or array <= 0 items

期間ごとにパスが獲得できるスタンプ数の上限(例: {"period": "day", "count": 1})。上限がない場合は空の配列([])です。ロイヤルティプログラムのプロジェクトのみ。

link
string

パス配布ページのURL

link_to_privacy
string or null <uri> (URL) non-empty

プライバシーポリシーのURL

max_redemptions
integer or null

指定されたプロジェクトで発行されたパスの最大利用回数

name
string

プロジェクト名(日本語)

name_en
string or null

プロジェクト名(英語)

order_limit
integer or null

一つの注文で取得が可能なパス数の制限

object

パスデザインの設定

percent_off
number

割引率(%)。未設定の場合は 0 です。クーポンのプロジェクトのみ。

Array of objects (Plan)
point_price
integer

1ポイントあたりの価格。未設定の場合は 0 です。ロイヤルティプログラムのプロジェクトのみ。

points_per_tier
integer or null

次の会員ランクに上がるのに必要なポイント数。会員ランクを使わない場合は null です。ロイヤルティプログラムのプロジェクトのみ。

privacy
string or null

プロジェクトのプライバシーポリシー(日本語)

privacy_en
string or null

プロジェクトのプライバシーポリシー(英語)

published_at
string or null <date-time> (DateTime)

プロジェクトが公開された日時(ISO 8601形式)

quantity
integer or null

このクーポンで発行できるパスの上限数。null は無制限です。クーポンのプロジェクトのみ。

redemption_price
integer or null

消し込み1回の単価

Array of objects

基本レベルの特典(stamps_required の昇順)。GET /projects/{id} で返されます。ロイヤルティプログラムのプロジェクトのみ。

stamp_price
integer

スタンプ1個あたりの価格。未設定の場合は 0 です。ロイヤルティプログラムのプロジェクトのみ。

start_date
string or null <date-time>

プロジェクトの開始日

start_time
string

開始時刻(HH:MM)。未設定の場合は省略されます。

object
subtype
any
Enum: "admission" "basic" "bundle" "commuter" "event" "fixed" "hotel_pass" "kaisuken" "lift" "meeting_pass" "member" "monetary" "multiride" "percent" "stamp" "voucher"
Array of objects (Tag)
object
total_stamps
integer

スタンプカードを満了するのに必要なスタンプ数。未設定の場合は 0 です。ロイヤルティプログラムのプロジェクトのみ。

transport_type
string
Enum: "PKTransitTypeAir" "PKTransitTypeBoat" "PKTransitTypeBus" "PKTransitTypeGeneric" "PKTransitTypeTrain"

Apple Wallet での交通系パスの種類。交通機関のプロジェクトのみ。

type
any
Enum: "booking" "coupon" "loyalty" "service" "ticket" "transport"
updated_at
string or null <date-time> (DateTime)

プロジェクトが更新された日時(ISO 8601形式)

Array of objects (Venue)

プロジェクトに紐付けられた店舗・施設の一覧

object or null
voucher
string or null

voucher タイプのクーポンの文言。クーポンのプロジェクトのみ。

{
  • "id": "9ab9f0d3-41f6-43b9-97f7-d875e7a64e50",
  • "external_id": null,
  • "name": "New hotel pass",
  • "name_en": null,
  • "type": "booking",
  • "subtype": "hotel_pass",
  • "link": "/booking/9ab9f0d3-41f6-43b9-97f7-d875e7a64e50",
  • "start_date": null,
  • "is_published": true,
  • "published_at": "2023-11-29T05:06:10.000000Z",
  • "archived_at": null,
  • "created_at": "2023-11-29T05:00:00.000000Z",
  • "updated_at": "2024-05-31T06:13:27.000000Z",
  • "contact_address": null,
  • "booking_units": [
    ],
  • "venues": [
    ],
  • "description": "Some description",
  • "description_en": null,
  • "terms": {
    },
  • "privacy": "sss",
  • "privacy_en": null,
  • "cancelation": null,
  • "cancelation_en": null,
  • "link_to_privacy": null,
  • "images": {},
  • "barcode": {
    },
  • "has_registration": true,
  • "has_data_collection": false,
  • "redemption_price": 0,
  • "pass_settings": {
    },
  • "order_limit": null,
  • "expiration": {
    },
  • "max_redemptions": null,
  • "has_activity": 0,
  • "tags": [
    ],
  • "stats": {
    },
  • "plans": [
    ],
  • "sales_settings": {
    }
}

Tag

name
string

タグ名

key
string

タグのキー部分

value
string

タグの値部分

{
  • "name": "genre:rock",
  • "key": "genre",
  • "value": "Rock"
}

Venue

id
string <uuid>

Kinchakuシステムが発行したID

title
string

店舗・施設名

tenant_code
string

店舗・施設のテナントコード

total
integer

顧客がこの店舗を訪れた回数。顧客の visited_venues にのみ含まれます。

address_string
string or null

ユーザーに表示される住所の文字列

object (Address)
{
  • "id": "92070da8-fcd2-4623-bf2b-5d182d8bfb65",
  • "title": "Tower venue",
  • "tenant_code": "tcode1",
  • "address": {
    },
  • "address_string": "Fukuoka Tower"
}

WalletPass

canceled_at
string or null <date-time> (DateTime)

パスが無効化された日時。有効なパスでは null です。

checkedin_at
string or null <date-time> (DateTime)

パスがチェックインされた日時(ISO 8601形式)

checkins_count
integer

パスのチェックイン回数

object (Contact)

パス所有者の情報

contact_id
null or string <uuid> (UUID)

パス所有者のID

created_at
string or null <date-time> (DateTime)

パスが作成された日時(ISO 8601形式)

is_valid
boolean

パスが現在利用できるかどうかを示します(未使用、有効期限内、無効化されていない、利用開始日を過ぎている)。

serial_number
string

プロジェクトの接頭辞とゼロ埋めの番号からなる、パスの通し番号。プロジェクトで通し番号を使わない場合は省略されます。

webpass_link
string or null <uri> (URL) non-empty

Webpassリンク.

download_link
string or null <uri> (URL) non-empty

パスのダウンロードリンク

expires_at
string or null <date-time> (DateTime)

パスの有効期限(ISO 8601形式)

external_id
string or null

外部システムで割当てられたID

has_android
boolean
Default: false

パスがAndroidデバイスにインストールされているかどうかを示します。

has_ios
boolean
Default: false

パスがiOSデバイスにインストールされているかどうかを示します。

id
string <uuid>

Kinchakuシステムが発行したID

installed_at
string or null <date-time> (DateTime)

パスがウオレットアプリにインストールされた日時(ISO 8601形式)

is_expired
boolean
Default: false

パスが有効期限切れかどうかを示します。

is_used
boolean
Default: false

パスが使用されたかどうかを示します。

is_voided
boolean
Default: false

パスが無効化されたかどうかを示します。

points_balance
number or null

現時点でのポイント残高

project_id
string <uuid>

パスが発行されたプロジェクトのID

plan_id
string or null

パスが発行されたプランのID

Plan (object) or null
qrcode
string or null

パスを取得すクエリのwith_qrパラメータがbase64に設定されている場合に利用可能。

qrcode_link
string or null <uri> (URL) non-empty

パスを取得すクエリのwith_qrパラメータがlinkに設定されている場合に利用可能。

redeemed_count
integer or null

パスの利用回数

redemptions_left
integer or null

パスの利用可能回数

Array of objects

ロイヤルティプログラムの特典。

shortuuid
string

パスの短縮UUID

smartlock_pin
string or null

スマートロックのPINコード

smartlock_qr
string or null

スマートロックのQRコード

パスに表示されるqrcodeで利用可能です。

start_date
null or string <date-time>
status
string
tier
null or integer >= 0

ロイヤルティプログラムの階層(例:会員ランク)

uninstalled_at
string or null <date-time> (DateTime)

パスがウオレットアプリからアンインストールされた日時(ISO 8601形式)

unlocked_count
null or integer

アンロック済みの特典数

updated_at
string or null <date-time> (DateTime)

パスが更新された日時(ISO 8601形式)

value_sum
integer or null
value_tier
integer or null
value_total
integer or null
{
  • "checkedin_at": "2020-11-13T04:31:14.000000Z",
  • "checkins_count": 1,
  • "contact": {
    },
  • "contact_id": "9454865a-0891-48e7-ae59-f6a82f822be1",
  • "created_at": "2020-11-13T04:31:14.000000Z",
  • "expires_at": "2021-09-30T14:59:59.000000Z",
  • "has_android": false,
  • "has_ios": true,
  • "id": "91fef32b-17df-4843-864a-6935aead2029",
  • "installed_at": "2020-12-25T07:59:13.000000Z",
  • "is_expired": false,
  • "is_used": false,
  • "is_voided": false,
  • "project_id": "91fef16c-cb9c-43a2-883d-dc837ef7d0d8",
  • "plan_id": "9b8b64b9-d761-4d1d-ae96-fba25bef64c9",
  • "redeemed_count": 2,
  • "redemptions_left": 1,
  • "rewards": [
    ],
  • "shortuuid": "geKkkmk65o8KiJG28qEdyT",
  • "smartlock_pin": "78293",
  • "smartlock_qr": "424434",
  • "start_date": "2020-11-13T04:31:14.000000Z",
  • "status": "installed",
  • "tier": 2,
  • "uninstalled_at": "2020-11-13T04:31:14.000000Z",
  • "unlocked_count": 0,
  • "updated_at": "2021-03-09T02:57:50.000000Z",
  • "value_sum": 17,
  • "value_tier": 5,
  • "value_total": 17,
}

URL

string or null <uri> (URL) non-empty

URL

UUID

null or string <uuid> (UUID)

Kinchakuシステムが発行した短縮UUID

null