Square Business (独立発行者) (プレビュー)
Square は、安全なクレジット カード処理から販売時点管理ソリューションまで、何百万人もの販売担当者のビジネス遂行を支援します。 このコネクタには、ロイヤルティ、ギフトカード、予約、ビジネス、チーム、財務、オンライン、認証のエンドポイントに対するアクションが含まれています。
このコネクタは、次の製品および地域で利用可能です。
Service | クラス | 地域 |
---|---|---|
Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure 政府の地域 - Azure 中国の地域 - 国防総省 (DoD) |
Power Automate | プレミアム | 以下を除くすべての Power Automate 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 国防総省 (DoD) |
Power Apps | プレミアム | 以下を除くすべての Power Apps 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
お問い合わせ先 | |
---|---|
件名 | Troy Taylor |
[URL] | https://www.hitachisolutions.com |
メール | ttaylor@hitachisolutions.com |
Connector Metadata | |
---|---|
発行者 | Troy Taylor |
Web サイト | https://squareup.com/ |
プライバシー ポリシー | https://squareup.com/us/en/legal/general/privacy |
カテゴリ | コマース; 営業と CRM |
調整制限
名前 | 呼び出し | 更新期間 |
---|---|---|
接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
GAN からギフト カードを取得する (ベータ版) |
ギフト カード アカウント番号 (GAN) を使用してギフト カードを取得します。 |
nonce からギフト カードを取得する (ベータ版) |
ギフト カードを表す nonce (安全なトークン) を使用してギフト カードを取得します。 |
Upsert スニペット |
Square Online サイトにスニペットを追加するか、サイト上の既存のスニペットを更新します。 スニペット コードは、チェックアウト ページを除く、サイトのすべてのページの head 要素の最後に追加されます。 スニペット アプリケーションは、特定のサイトに 1 つのスニペットを追加できます。 |
V1 ID により銀行口座を取得 |
V1 BankAccount ID で識別されるの詳細を返します。 |
workweek 構成を更新する |
WorkweekConfig を更新します。 |
キャッシュ ドロワー シフト イベントを一覧表示する |
単一のキャッシュ ドロワー シフトのイベントのページ付けされたリストを提供します。 |
キャッシュ ドロワー シフトを一覧表示する |
日付範囲内の場所のすべてのキャッシュ ドロワー シフトの詳細を提供します。 |
キャッシュ ドロワー シフトを取得する |
単一のキャッシュ ドロワー シフトの概要の詳細を提供します。 |
ギフト カードの活動を一覧表示する (ベータ版) |
ギフト カードの活動を一覧表示します。 既定では、販売者のアカウントにあるすべてのギフト カードのギフト カード活動を取得します。 オプションで、クエリ パラメーターを指定してリストをフィルタリングできます。 たとえば、ギフト カード、特定の地域のすべてのギフト カード、または時間枠内の活動のギフト カード活動のリストを取得できます。 |
ギフト カードを取得する (ベータ版) |
ID を使用してギフト カードを取得します。 |
ギフト カード活動を作成する (ベータ版) |
ギフト カード活動を作成します。 |
サイトの一覧表示 |
販売者に属する Square Online サイトを一覧表示します。 |
シフトを作成する |
新しいシフトを作成します。 シフトは、1 人の従業員の完全な就業日を表します |
シフトを削除する |
シフトを削除する |
シフトを取得する |
id で指定された単一の Shift を返します。 |
シフトを更新する |
既存の Shift を更新します。 |
シフトを検索する |
ビジネスの Shift レコードのページ付けされたリストを返します。 |
スニペットを削除する |
Square Online サイトからスニペットを削除します。 |
スニペットを取得する |
Square Online サイトからスニペットを取得します。 サイトには、複数のスニペット アプリケーションからのスニペットを含めることができますが、取得できるのは、アプリケーションによって追加されたスニペットのみです。 |
チェックアウトを作成する |
支払い処理ワークフローを使用して支払い情報を提供するために、顧客がダイレクトされる checkout_page_url に checkoutId をリンクします。 |
チーム メンバーの予約プロファイルを一覧表示する (ベータ版) |
チーム メンバーの予約プロファイルを一覧表示します。 |
チーム メンバーの賃金を一覧表示する |
ビジネスの TeamMemberWage インスタンスのページ付けされたリストを返します。 |
チーム メンバーの賃金を取得する |
id で指定された単一の TeamMemberWage を返します。 |
チーム メンバーを一括作成する |
複数の TeamMember オブジェクトを作成します。 |
チーム メンバーを一括更新する |
複数の TeamMember オブジェクトを更新します。 |
チーム メンバーを作成する |
単一の TeamMember オブジェクトを作成します。 |
チーム メンバーを取得する |
指定された TeamMember ID の TeamMember オブジェクトを取得します。 |
チーム メンバーを更新する |
単一の TeamMember オブジェクトを更新します。 |
チーム メンバーを検索する |
ビジネスの TeamMember オブジェクトのページ付けされたリストを返します。 |
デバイス コードを一覧表示する |
マーチャントに関連付けられているすべての DeviceCode を一覧表示します。 |
デバイス コードを作成する |
Square Terminal デバイスにログインして接続ターミナル モードに入るのに使用できる DeviceCode を作成します。 |
デバイス コードを取得する |
関連付けられた ID を持つ DeviceCode を取得します。 |
ビジネス予約プロファイルを取得する (ベータ版) |
販売者の予約プロファイルを取得します。 |
マーチャントを一覧表示する |
指定されたアクセス トークンのマーチャント情報を返します。 |
マーチャントを取得する |
指定された merchant_id の Merchant オブジェクトを取得します。 |
モバイル認証コードを作成する |
モバイル アプリケーションが Square カード閲覧者に接続することを承認するコードを生成します。 認証コードは 1 回限りの使用で、発行後 60 分で有効期限が切れます。 |
ロイヤルティ アカウントを作成する |
ロイヤルティ アカウントを作成します。 |
ロイヤルティ アカウントを取得する |
ロイヤルティ アカウントを取得します。 |
ロイヤルティ アカウントを検索する |
ロイヤルティ プログラムでロイヤルティ アカウントを検索します。 |
ロイヤルティ イベントを検索する |
ロイヤルティ イベントを検索します。 Square ロイヤルティ プログラムは、購入者のロイヤルティ アカウントの存続期間中に発生するイベントの台帳を維持します。 ポイント残高の各変更 (たとえば、獲得したポイント、交換したポイント、期限切れしたポイント) は、台帳に記録されます。 このエンドポイントを使用して、イベントの台帳を検索できます。 |
ロイヤルティ プログラムを取得する |
プログラム ID またはキーワード メインで指定された、販売者のアカウントのロイヤルティ プログラムを取得します。 ロイヤルティ プログラムは、購入者がポイントを獲得し、ポイントをリワードと交換する方法を定義します。 |
ロイヤルティ ポイントを計算する |
購入により獲得するポイントを計算します。 アプリケーションはこれをエンドポイントと呼んで、購入者が特定の購入で獲得できるポイントを表示する場合があります。 |
ロイヤルティ ポイントを調整する |
購入者のアカウントにポイントを追加したり、ポイントを差し引いたりします。 このエンドポイントは、ポイントを手動で調整する必要がある場合にのみ使用してください。 |
ロイヤルティ ポイントを貯める |
ロイヤルティ アカウントにポイントを追加します。 |
ロイヤルティ リワードの引き換え |
ロイヤルティ リワードを引き換えます。 リワードが終末期状態に達した後は、削除できません。 つまり、リワードに使用したポイントをアカウントに戻すことはできません。 |
ロイヤルティ リワードを作成する |
ロイヤルティ リワードを作成します。 特典が作成されると、ポイントはロックされ、購入者は別のリワードを利用できなくなります。 |
ロイヤルティ リワードを削除する |
ロイヤルティ リワードを削除します。 ポイントをロイヤルティ アカウントに戻します。 終末期状態 (REDEEMED) に達したリワードは削除できません。 |
ロイヤルティ リワードを取得する |
ロイヤルティ リワードを取得します。 |
ロイヤルティ リワードを検索する |
ロイヤルティ アカウントでロイヤルティ リワードを検索します。 |
予約を作成する (ベータ版) |
予約を作成します。 |
休憩の種類を作成する |
新しい BreakType を作成します。 BreakType は、休憩オブジェクトを作成するためのテンプレートです。 |
休憩の種類を取得する |
id で指定された単一の BreakType を返します。 |
休憩の種類を更新する |
既存の BreakType を更新します。 |
休憩タイプを一覧表示する |
ビジネスの BreakType インスタンスのページ付けされたリストを返します。 |
休憩タイプを削除する |
既存の BreakType を削除します。 BreakType は、Shift から参照されている場合でも削除できます。 |
場所を一覧表示する |
ビジネスのすべての場所の情報を提供します。 |
場所を作成する (ベータ版) |
場所を作成します。 |
場所を取得する |
場所の詳細を取得します。 場所 ID として「main」を指定して、メイン場所の詳細を取得できます。 |
場所を更新する (ベータ版) |
場所を更新します。 |
平日構成の一覧表示 |
ビジネスの WorkweekConfig インスタンスのリストを返します。 |
空き時間の検索 (ベータ版) |
予約の空き状況を検索します。 |
賃金設定を取得する |
TeamMember id で指定されたチーム メンバーの WageSetting オブジェクトを取得します。 |
賃金設定を更新する |
WageSetting オブジェクトを作成または更新します。 |
銀行口座を一覧表示する |
Square アカウントにリンクされている BankAccount オブジェクトのリストを返します。 |
銀行口座を取得する |
Square アカウントにリンクされている BankAccount の詳細を返します。 |
顧客のリンクをギフト カードから解除する (ベータ版) |
顧客のリンクをギフト カードから解除します。 |
顧客をギフト カードにリンクする (ベータ版) |
顧客をギフト カードにリンクします |
GAN からギフト カードを取得する (ベータ版)
ギフト カード アカウント番号 (GAN) を使用してギフト カードを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
GaN
|
gan | string |
ギフト カードのアカウント番号。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
gift_card.id | string |
Square が発行した一意の識別子。 |
タイプ
|
gift_card.type | string |
このオブジェクトの種類。 |
GAN ソース
|
gift_card.gan_source | string |
ギフト カードのアカウント番号 (GAN) が Square によって生成されたものか、Square 以外のシステムからインポートされたものかを示します。 |
状態
|
gift_card.state | string |
現在の状態。 |
量
|
gift_card.balance_money.amount | integer |
金額。 |
通貨
|
gift_card.balance_money.currency | string |
通貨。 |
GaN
|
gift_card.gan | string |
ギフト カードのアカウント番号。 |
作成日時
|
gift_card.created_at | string |
このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
nonce からギフト カードを取得する (ベータ版)
ギフト カードを表す nonce (安全なトークン) を使用してギフト カードを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ナンス
|
nonce | string |
取得するギフト カードの nonce。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
gift_card.id | string |
Square が発行した一意の識別子。 |
タイプ
|
gift_card.type | string |
このオブジェクトの種類。 |
GAN ソース
|
gift_card.gan_source | string |
ギフト カードのアカウント番号 (GAN) が Square によって生成されたものか、Square 以外のシステムからインポートされたものかを示します。 |
状態
|
gift_card.state | string |
現在の状態。 |
量
|
gift_card.balance_money.amount | integer |
金額。 |
通貨
|
gift_card.balance_money.currency | string |
通貨。 |
GaN
|
gift_card.gan | string |
ギフト カードのアカウント番号。 |
作成日時
|
gift_card.created_at | string |
このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
Upsert スニペット
Square Online サイトにスニペットを追加するか、サイト上の既存のスニペットを更新します。 スニペット コードは、チェックアウト ページを除く、サイトのすべてのページの head 要素の最後に追加されます。 スニペット アプリケーションは、特定のサイトに 1 つのスニペットを追加できます。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
サイト ID
|
site_id | True | string |
サイトの識別子。 |
Content
|
content | string |
スニペット コード。有効な HTML、JavaScript、またはその両方を含めることができます。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
snippet.id | string |
Square が発行した一意の識別子。 |
サイト ID
|
snippet.site_id | string |
スニペットを含むサイトの ID。 |
Content
|
snippet.content | string |
スニペット コード。有効な HTML、JavaScript、またはその両方を含めることができます。 |
作成日時
|
snippet.created_at | string |
このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
更新日時
|
snippet.updated_at | string |
このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
V1 ID により銀行口座を取得
V1 BankAccount ID で識別されるの詳細を返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
V1 銀行口座 ID
|
v1_bank_account_id | True | string |
希望する BankAccount の Connect V1 ID。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
bank_account.id | string |
Square が発行した一意の識別子。 |
口座番号サフィックス
|
bank_account.account_number_suffix | string |
口座番号の末尾数桁。 |
Country
|
bank_account.country | string |
ISO 3166 Alpha-2 国コード。 |
通貨
|
bank_account.currency | string |
3 文字の ISO 4217 通貨コード。 |
口座の種類
|
bank_account.account_type | string |
口座の種類。 |
所有者の氏名
|
bank_account.holder_name | string |
アカウント所有者の名前。 |
プライマリ銀行 ID 番号
|
bank_account.primary_bank_identification_number | string |
銀行のプライマリ識別子。 |
場所 ID
|
bank_account.location_id | string |
場所の識別子。 |
Status
|
bank_account.status | string |
このオブジェクトの現在の検証状態。 |
貸方記入可能
|
bank_account.creditable | boolean |
Square がこの口座に送金できるかどうかを示します。 |
借方記入可能
|
bank_account.debitable | boolean |
Square がこの口座から金額を取得できるかどうかを示します。 |
[バージョン]
|
bank_account.version | integer |
このオブジェクトの現在のバージョン。 |
銀行名
|
bank_account.bank_name | string |
実際の金融機関の名前。 |
workweek 構成を更新する
WorkweekConfig を更新します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ID
|
id | True | string |
識別子。 |
週の開始日
|
start_of_week | string |
報酬目的で営業週が終了する曜日。 |
|
就業開始 (ローカル時刻)
|
start_of_day_local_time | string |
営業週が終了する現地時刻。 HH:MM 形式の文字列として表されます (HH:MM:SS も受け入れられますが、秒は切り捨てられます)。 |
|
[バージョン]
|
version | integer |
このオブジェクトの現在のバージョン。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
workweek_config.id | string |
Square が発行した一意の識別子。 |
週の開始日
|
workweek_config.start_of_week | string |
報酬目的で営業週が終了する曜日。 |
就業開始 (ローカル時刻)
|
workweek_config.start_of_day_local_time | string |
営業週が終了する現地時刻。 HH:MM 形式の文字列として表されます (HH:MM:SS も受け入れられますが、秒は切り捨てられます)。 |
[バージョン]
|
workweek_config.version | integer |
このオブジェクトの現在のバージョン。 |
作成日時
|
workweek_config.created_at | string |
このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
更新日時
|
workweek_config.updated_at | string |
このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
キャッシュ ドロワー シフト イベントを一覧表示する
単一のキャッシュ ドロワー シフトのイベントのページ付けされたリストを提供します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
シフト ID
|
shift_id | True | string |
シフトの識別子。 |
場所 ID
|
location_id | True | string |
このオプション フィルターを指定して、特定の場所に属するレコードのみを取得できます。 |
限度
|
limit | integer |
応答で返す数の上限。 |
|
カーソル
|
cursor | string |
このエンドポイントへの前回の呼び出しによって返されたページネーション カーソル。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
イベント
|
events | array of object | |
ID
|
events.id | string |
Square が発行した一意の識別子。 |
イベント タイプ
|
events.event_type | string |
キャッシュ ドロワー シフト イベントのタイプ。 |
量
|
events.event_money.amount | integer |
金額。 |
通貨
|
events.event_money.currency | string |
通貨。 |
作成日時
|
events.created_at | string |
イベント時刻 (ISO 8601 形式)。 |
Description
|
events.title | string |
説明 |
キャッシュ ドロワー シフトを一覧表示する
日付範囲内の場所のすべてのキャッシュ ドロワー シフトの詳細を提供します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
場所 ID
|
location_id | string |
このオプション フィルターを指定して、特定の場所に属するレコードのみを取得できます。 |
|
並べ替え順序
|
sort_order | string |
返された一覧を、指定された順序でカードが作成された日時で並べ替えます。 |
|
Begin Time
|
begin_time | string |
opened_at でのクエリの包括的な開始時刻 (ISO 8601形式)。 |
|
End Time
|
end_time | string |
opened_at でのクエリの排他的な終了日 (ISO 8601形式)。 |
|
限度
|
limit | integer |
応答で返す数の上限。 |
|
カーソル
|
cursor | string |
このエンドポイントへの前回の呼び出しによって返されたページネーション カーソル。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
Items
|
items | array of object | |
ID
|
items.id | string |
Square が発行した一意の識別子。 |
状態
|
items.state | string |
現在の状態。 |
開く時刻
|
items.opened_at | string |
ISO 8601 形式のシフト開始時刻。 |
終了時刻
|
items.ended_at | string |
ISO 8601 形式のシフト終了時刻。 |
Closed At
|
items.closed_at | string |
ISO 8601 形式のシフト終了時刻。 |
Description
|
items.title | string |
説明 |
量
|
items.opened_cash_money.amount | integer |
金額。 |
通貨
|
items.opened_cash_money.currency | string |
通貨。 |
量
|
items.expected_cash_money.amount | integer |
金額。 |
通貨
|
items.expected_cash_money.currency | string |
通貨。 |
量
|
items.closed_cash_money.amount | integer |
金額。 |
通貨
|
items.closed_cash_money.currency | string |
通貨。 |
キャッシュ ドロワー シフトを取得する
単一のキャッシュ ドロワー シフトの概要の詳細を提供します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
シフト ID
|
shift_id | True | string |
シフトの識別子。 |
場所 ID
|
location_id | True | string |
このオプション フィルターを指定して、特定の場所に属するレコードのみを取得できます。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
cash_drawer_shift.id | string |
Square が発行した一意の識別子。 |
状態
|
cash_drawer_shift.state | string |
現在の状態。 |
開く時刻
|
cash_drawer_shift.opened_at | string |
シフトが開始された時刻 (ISO 8601 形式)。 |
終了時刻
|
cash_drawer_shift.ended_at | string |
シフトが終了された時刻 (ISO 8601 形式)。 |
Closed At
|
cash_drawer_shift.closed_at | string |
終了時刻 (ISO 8601 形式)。 |
開始従業員 ID
|
cash_drawer_shift.opening_employee_id | string |
キャッシュ ドロワー シフトを開始した従業員の ID。 |
終了従業員 ID
|
cash_drawer_shift.ending_employee_id | string |
キャッシュ ドロワー シフトを終了した従業員の ID。 |
終了従業員 ID
|
cash_drawer_shift.closing_employee_id | string |
キャッシュ ドロワーの内容を監査してキャッシュ ドロワー シフトを閉じた従業員の ID。 |
Description
|
cash_drawer_shift.description | string |
説明 |
量
|
cash_drawer_shift.opened_cash_money.amount | integer |
金額。 |
通貨
|
cash_drawer_shift.opened_cash_money.currency | string |
通貨。 |
量
|
cash_drawer_shift.cash_payment_money.amount | integer |
金額。 |
Currency
|
cash_drawer_shift.cash_payment_money.currency | string |
通貨。 |
Amount
|
cash_drawer_shift.cash_refunds_money.amount | integer |
金額。 |
Currency
|
cash_drawer_shift.cash_refunds_money.currency | string |
通貨。 |
Amount
|
cash_drawer_shift.cash_paid_in_money.amount | integer |
金額。 |
Currency
|
cash_drawer_shift.cash_paid_in_money.currency | string |
通貨。 |
Amount
|
cash_drawer_shift.cash_paid_out_money.amount | integer |
金額。 |
Currency
|
cash_drawer_shift.cash_paid_out_money.currency | string |
通貨。 |
Amount
|
cash_drawer_shift.expected_cash_money.amount | integer |
金額。 |
Currency
|
cash_drawer_shift.expected_cash_money.currency | string |
通貨。 |
量
|
cash_drawer_shift.closed_cash_money.amount | integer |
金額。 |
通貨
|
cash_drawer_shift.closed_cash_money.currency | string |
通貨。 |
件名
|
cash_drawer_shift.device.name | string |
名前。 |
ギフト カードの活動を一覧表示する (ベータ版)
ギフト カードの活動を一覧表示します。 既定では、販売者のアカウントにあるすべてのギフト カードのギフト カード活動を取得します。 オプションで、クエリ パラメーターを指定してリストをフィルタリングできます。 たとえば、ギフト カード、特定の地域のすべてのギフト カード、または時間枠内の活動のギフト カード活動のリストを取得できます。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ギフト カード ID
|
gift_card_id | string |
ギフト カード ID を指定すると、エンドポイントは指定されたギフト カードに属する活動を返します。 それ以外の場合、エンドポイントは販売者のすべてのギフト カード活動を返します。 |
|
タイプ
|
type | string |
タイプを指定すると、エンドポイントはこのタイプのギフト カード活動を返します。 それ以外の場合、エンドポイントはギフト カード活動のすべてのタイプを返します。 |
|
場所 ID
|
location_id | string |
このオプション フィルターを指定して、特定の場所に属するレコードのみを取得できます。 |
|
Begin Time
|
begin_time | string |
opened_at でのクエリの包括的な開始時刻 (ISO 8601形式)。 |
|
End Time
|
end_time | string |
opened_at でのクエリの排他的な終了日 (ISO 8601形式)。 |
|
限度
|
limit | integer |
応答で返す数の上限。 |
|
カーソル
|
cursor | string |
このエンドポイントへの前回の呼び出しによって返されたページネーション カーソル。 |
|
並べ替え順序
|
sort_order | string |
返された一覧を、指定された順序でカードが作成された日時で並べ替えます。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ギフト カード活動
|
gift_card_activities | array of object | |
ID
|
gift_card_activities.id | string |
Square が発行した一意の識別子。 |
タイプ
|
gift_card_activities.type | string |
このオブジェクトの種類。 |
場所 ID
|
gift_card_activities.location_id | string |
場所の識別子。 |
作成日時
|
gift_card_activities.created_at | string |
イベント時刻 (ISO 8601 形式)。 |
ギフト カード ID
|
gift_card_activities.gift_card_id | string |
ギフト カード ID。 GAN が存在する場合、ID は必要ありません。 |
ギフト カード GAN
|
gift_card_activities.gift_card_gan | string |
ギフト カード GAN。 gift_card_id が存在する場合、GAN は必要ありません。 |
量
|
gift_card_activities.gift_card_balance_money.amount | integer |
金額。 |
通貨
|
gift_card_activities.gift_card_balance_money.currency | string |
通貨。 |
量
|
gift_card_activities.redeem_activity_details.amount_money.amount | integer |
金額。 |
通貨
|
gift_card_activities.redeem_activity_details.amount_money.currency | string |
通貨。 |
量
|
gift_card_activities.activate_activity_details.amount_money.amount | integer |
金額。 |
通貨
|
gift_card_activities.activate_activity_details.amount_money.currency | string |
通貨。 |
注文 ID
|
gift_card_activities.activate_activity_details.order_id | string |
活動に関連付けられた注文の ID。 |
品目 UID
|
gift_card_activities.activate_activity_details.line_item_uid | string |
注文のギフト カード品目の line_item_uid。 |
ギフト カードを取得する (ベータ版)
ID を使用してギフト カードを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ID
|
id | True | string |
識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
gift_card.id | string |
Square が発行した一意の識別子。 |
タイプ
|
gift_card.type | string |
このオブジェクトの種類。 |
GAN ソース
|
gift_card.gan_source | string |
ギフト カードのアカウント番号 (GAN) が Square によって生成されたものか、Square 以外のシステムからインポートされたものかを示します。 |
状態
|
gift_card.state | string |
現在の状態。 |
量
|
gift_card.balance_money.amount | integer |
金額。 |
通貨
|
gift_card.balance_money.currency | string |
通貨。 |
GaN
|
gift_card.gan | string |
ギフト カードのアカウント番号。 |
作成日時
|
gift_card.created_at | string |
このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
ギフト カード活動を作成する (ベータ版)
ギフト カード活動を作成します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Idempotency Key
|
idempotency_key | string |
すべての要求の中でこの要求を一意に識別するために指定する値。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。 |
|
ギフト カード ID
|
gift_card_id | string |
ギフト カード ID。 GAN が存在する場合、ID は必要ありません。 |
|
タイプ
|
type | string |
このオブジェクトの種類。 |
|
場所 ID
|
location_id | string |
場所の識別子。 |
|
注文 ID
|
order_id | string |
活動に関連付けられた注文の ID。 |
|
品目 UID
|
line_item_uid | string |
注文のギフト カード品目の line_item_uid。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
gift_card_activity.id | string |
Square が発行した一意の識別子。 |
ギフト カード ID
|
gift_card_activity.gift_card_id | string |
ギフト カード ID。 GAN が存在する場合、ID は必要ありません。 |
ギフト カード GAN
|
gift_card_activity.gift_card_gan | string |
ギフト カード GAN。 gift_card_id が存在する場合、GAN は必要ありません。 |
タイプ
|
gift_card_activity.type | string |
このオブジェクトの種類。 |
量
|
gift_card_activity.gift_card_balance_money.amount | integer |
金額。 |
通貨
|
gift_card_activity.gift_card_balance_money.currency | string |
通貨。 |
場所 ID
|
gift_card_activity.location_id | string |
場所の識別子。 |
作成日時
|
gift_card_activity.created_at | string |
このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
量
|
gift_card_activity.activate_activity_details.amount_money.amount | integer |
金額。 |
通貨
|
gift_card_activity.activate_activity_details.amount_money.currency | string |
通貨。 |
注文 ID
|
gift_card_activity.activate_activity_details.order_id | string |
活動に関連付けられた注文の ID。 |
品目 UID
|
gift_card_activity.activate_activity_details.line_item_uid | string |
注文のギフト カード品目の line_item_uid。 |
サイトの一覧表示
販売者に属する Square Online サイトを一覧表示します。
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
サイト
|
sites | array of object | |
ID
|
sites.id | string |
Square が発行した一意の識別子。 |
サイト タイトル
|
sites.site_title | string |
サイトのタイトル。 |
Domain
|
sites.domain | string |
サイトのドメイン (プロトコルなし)。 |
公開済み
|
sites.is_published | boolean |
サイトが公開済みの状態にあるかどうかを示します。 |
作成日時
|
sites.created_at | string |
イベント時刻 (ISO 8601 形式)。 |
更新日時
|
sites.updated_at | string |
最終変更タイムスタンプ (RFC 3339 形式) |
シフトを作成する
新しいシフトを作成します。 シフトは、1 人の従業員の完全な就業日を表します
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Idempotency Key
|
idempotency_key | string |
すべての要求の中でこの要求を一意に識別するために指定する値。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。 |
|
Team Member ID
|
team_member_id | string |
チーム メンバーの ID。 |
|
場所 ID
|
location_id | string |
場所の識別子。 |
|
Start At
|
start_at | string |
このオブジェクトの開始時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
|
End At
|
end_at | string |
RFC 3339; タイムゾーン + オフセットにシフトしました。 分までの精度が尊重されます。秒は切り捨てられます。 |
|
肩書き
|
title | string |
このシフト中に実行されたジョブの名前。 Square レイバー レポート UI は、シフトをタイトルごとにグループ化する場合があります。 |
|
量
|
amount | integer |
金額。 |
|
通貨
|
currency | string |
通貨。 |
|
Start At
|
start_at | string |
RFC 3339; Shift と同じタイムゾーン情報に従います。 分までの精度が尊重されます。秒は切り捨てられます。 |
|
End At
|
end_at | string |
RFC 3339; Shift と同じタイムゾーン情報に従います。 分までの精度が尊重されます。秒は切り捨てられます。 |
|
休憩タイプ ID
|
break_type_id | string |
この休憩がテンプレート化された BreakType。 |
|
件名
|
name | string |
品目の名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値は空であってはならず、長さは Unicode コード ポイントです。 |
|
想定持続期間
|
expected_duration | string |
休憩の予想される長さ。 形式: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S。 |
|
支払済みかどうか
|
is_paid | boolean |
この休憩が補償目的で働いた時間にカウントされるかどうか。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
shift.id | string |
Square が発行した一意の識別子。 |
Team Member ID
|
shift.team_member_id | string |
チーム メンバーの ID。 |
従業員 ID
|
shift.employee_id | string |
Square で生成された従業員の ID。 |
場所 ID
|
shift.location_id | string |
場所の識別子。 |
タイム ゾーン
|
shift.timezone | string |
カレンダーの日付を解釈するために使用されるタイム ゾーン。 請求書が作成されると、このフィールドは販売担当者の場所に指定されたタイムゾーンに設定されます。 値は変更できません。 |
Start At
|
shift.start_at | string |
このオブジェクトの開始時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
End At
|
shift.end_at | string |
RFC 3339; タイムゾーン + オフセットにシフトしました。 分までの精度が尊重されます。秒は切り捨てられます。 |
肩書き
|
shift.wage.title | string |
このシフト中に実行されたジョブの名前。 Square レイバー レポート UI は、シフトをタイトルごとにグループ化する場合があります。 |
量
|
shift.wage.hourly_rate.amount | integer |
金額。 |
通貨
|
shift.wage.hourly_rate.currency | string |
通貨。 |
休憩
|
shift.breaks | array of object | |
ID
|
shift.breaks.id | string |
オブジェクトの識別子 |
Start At
|
shift.breaks.start_at | string |
RFC 3339; Shift と同じタイムゾーン情報に従います。 分までの精度が尊重されます。秒は切り捨てられます。 |
End At
|
shift.breaks.end_at | string |
RFC 3339; Shift と同じタイムゾーン情報に従います。 分までの精度が尊重されます。秒は切り捨てられます。 |
休憩タイプ ID
|
shift.breaks.break_type_id | string |
この休憩がテンプレート化された BreakType。 |
件名
|
shift.breaks.name | string |
品目の名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値は空であってはならず、長さは Unicode コード ポイントです。 |
想定持続期間
|
shift.breaks.expected_duration | string |
休憩の予想される長さ。 形式: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S。 |
支払済みかどうか
|
shift.breaks.is_paid | boolean |
この休憩が補償目的で働いた時間にカウントされるかどうか。 |
Status
|
shift.status | string |
このオブジェクトの現在の検証状態。 |
[バージョン]
|
shift.version | integer |
このオブジェクトの現在のバージョン。 |
作成日時
|
shift.created_at | string |
このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
更新日時
|
shift.updated_at | string |
このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
シフトを削除する
シフトを取得する
id で指定された単一の Shift を返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ID
|
id | True | string |
識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
shift.id | string |
Square が発行した一意の識別子。 |
Team Member ID
|
shift.team_member_id | string |
チーム メンバーの ID。 |
従業員 ID
|
shift.employee_id | string |
Square で生成された従業員の ID。 |
場所 ID
|
shift.location_id | string |
場所の識別子。 |
タイム ゾーン
|
shift.timezone | string |
カレンダーの日付を解釈するために使用されるタイム ゾーン。 請求書が作成されると、このフィールドは販売担当者の場所に指定されたタイムゾーンに設定されます。 値は変更できません。 |
Start At
|
shift.start_at | string |
このオブジェクトの開始時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
End At
|
shift.end_at | string |
RFC 3339; タイムゾーン + オフセットにシフトしました。 分までの精度が尊重されます。秒は切り捨てられます。 |
肩書き
|
shift.wage.title | string |
このシフト中に実行されたジョブの名前。 Square レイバー レポート UI は、シフトをタイトルごとにグループ化する場合があります。 |
量
|
shift.wage.hourly_rate.amount | integer |
金額。 |
通貨
|
shift.wage.hourly_rate.currency | string |
通貨。 |
休憩
|
shift.breaks | array of object | |
ID
|
shift.breaks.id | string |
オブジェクトの識別子 |
Start At
|
shift.breaks.start_at | string |
RFC 3339; Shift と同じタイムゾーン情報に従います。 分までの精度が尊重されます。秒は切り捨てられます。 |
End At
|
shift.breaks.end_at | string |
RFC 3339; Shift と同じタイムゾーン情報に従います。 分までの精度が尊重されます。秒は切り捨てられます。 |
休憩タイプ ID
|
shift.breaks.break_type_id | string |
この休憩がテンプレート化された BreakType。 |
件名
|
shift.breaks.name | string |
品目の名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値は空であってはならず、長さは Unicode コード ポイントです。 |
想定持続期間
|
shift.breaks.expected_duration | string |
休憩の予想される長さ。 形式: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S。 |
支払済みかどうか
|
shift.breaks.is_paid | boolean |
この休憩が補償目的で働いた時間にカウントされるかどうか。 |
Status
|
shift.status | string |
このオブジェクトの現在の検証状態。 |
[バージョン]
|
shift.version | integer |
このオブジェクトの現在のバージョン。 |
作成日時
|
shift.created_at | string |
このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
更新日時
|
shift.updated_at | string |
このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
シフトを更新する
既存の Shift を更新します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ID
|
id | True | string |
識別子。 |
Team Member ID
|
team_member_id | string |
チーム メンバーの ID。 |
|
場所 ID
|
location_id | string |
場所の識別子。 |
|
Start At
|
start_at | string |
このオブジェクトの開始時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
|
End At
|
end_at | string |
RFC 3339; タイムゾーン + オフセットにシフトしました。 分までの精度が尊重されます。秒は切り捨てられます。 |
|
肩書き
|
title | string |
このシフト中に実行されたジョブの名前。 Square レイバー レポート UI は、シフトをタイトルごとにグループ化する場合があります。 |
|
量
|
amount | integer |
金額。 |
|
通貨
|
currency | string |
通貨。 |
|
ID
|
id | string |
オブジェクトの識別子 |
|
Start At
|
start_at | string |
RFC 3339; Shift と同じタイムゾーン情報に従います。 分までの精度が尊重されます。秒は切り捨てられます。 |
|
End At
|
end_at | string |
RFC 3339; Shift と同じタイムゾーン情報に従います。 分までの精度が尊重されます。秒は切り捨てられます。 |
|
休憩タイプ ID
|
break_type_id | string |
この休憩がテンプレート化された BreakType。 |
|
件名
|
name | string |
品目の名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値は空であってはならず、長さは Unicode コード ポイントです。 |
|
想定持続期間
|
expected_duration | string |
休憩の予想される長さ。 形式: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S。 |
|
支払済みかどうか
|
is_paid | boolean |
この休憩が補償目的で働いた時間にカウントされるかどうか。 |
|
[バージョン]
|
version | integer |
このオブジェクトの現在のバージョン。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
shift.id | string |
Square が発行した一意の識別子。 |
Team Member ID
|
shift.team_member_id | string |
チーム メンバーの ID。 |
従業員 ID
|
shift.employee_id | string |
Square で生成された従業員の ID。 |
場所 ID
|
shift.location_id | string |
場所の識別子。 |
タイム ゾーン
|
shift.timezone | string |
カレンダーの日付を解釈するために使用されるタイム ゾーン。 請求書が作成されると、このフィールドは販売担当者の場所に指定されたタイムゾーンに設定されます。 値は変更できません。 |
Start At
|
shift.start_at | string |
このオブジェクトの開始時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
End At
|
shift.end_at | string |
RFC 3339; タイムゾーン + オフセットにシフトしました。 分までの精度が尊重されます。秒は切り捨てられます。 |
肩書き
|
shift.wage.title | string |
このシフト中に実行されたジョブの名前。 Square レイバー レポート UI は、シフトをタイトルごとにグループ化する場合があります。 |
量
|
shift.wage.hourly_rate.amount | integer |
金額。 |
通貨
|
shift.wage.hourly_rate.currency | string |
通貨。 |
休憩
|
shift.breaks | array of object | |
ID
|
shift.breaks.id | string |
オブジェクトの識別子 |
Start At
|
shift.breaks.start_at | string |
RFC 3339; Shift と同じタイムゾーン情報に従います。 分までの精度が尊重されます。秒は切り捨てられます。 |
End At
|
shift.breaks.end_at | string |
RFC 3339; Shift と同じタイムゾーン情報に従います。 分までの精度が尊重されます。秒は切り捨てられます。 |
休憩タイプ ID
|
shift.breaks.break_type_id | string |
この休憩がテンプレート化された BreakType。 |
件名
|
shift.breaks.name | string |
品目の名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値は空であってはならず、長さは Unicode コード ポイントです。 |
想定持続期間
|
shift.breaks.expected_duration | string |
休憩の予想される長さ。 形式: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S。 |
支払済みかどうか
|
shift.breaks.is_paid | boolean |
この休憩が補償目的で働いた時間にカウントされるかどうか。 |
Status
|
shift.status | string |
このオブジェクトの現在の検証状態。 |
[バージョン]
|
shift.version | integer |
このオブジェクトの現在のバージョン。 |
作成日時
|
shift.created_at | string |
このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
更新日時
|
shift.updated_at | string |
このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
シフトを検索する
ビジネスの Shift レコードのページ付けされたリストを返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
開始日
|
start_date | string |
カレンダー日付の ISO 8601 拡張形式に準拠した、2017-10-31 などの YYYY-MM-DD 形式の文字列。 日付範囲の始まり (両端を含む)。 |
|
終了日
|
end_date | string |
カレンダー日付の ISO 8601 拡張形式に準拠した、2017-10-31 などの YYYY-MM-DD 形式の文字列。 日付範囲の終了 (両端を含む)。 |
|
シフトを一致させる
|
match_shifts_by | string |
日付が適用される戦略。 |
|
既定のタイムゾーン
|
default_timezone | string |
場所固有のタイムゾーンは、就業日を日時フィルターに変換します。 クエリに含まれるすべての場所にタイムゾーンが必要です。そうでない場合は、このフィールドをフォールバックとして指定する必要があります。 形式: 関連するタイムゾーンの IANA タイムゾーン データベース識別子。 |
|
限度
|
limit | integer |
1 ページに返される結果の数の制限。 制限は推奨値であり、実装によって返される結果が増減する可能性があります。 指定された制限が負、ゼロ、または最大制限の 1,000 より大きい場合、無視されます。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
Shifts
|
shifts | array of object | |
ID
|
shifts.id | string |
Square が発行した一意の識別子。 |
Team Member ID
|
shifts.team_member_id | string |
オブジェクトに関連付けられたチーム メンバーの TeamMember オブジェクトの ID。 |
場所 ID
|
shifts.location_id | string |
場所の識別子。 |
タイム ゾーン
|
shifts.timezone | string |
due_date など、請求書のカレンダーの日付を解釈するために使用されるタイムゾーン。 請求書が作成されると、このフィールドは販売担当者の場所に指定されたタイムゾーンに設定されます。 値は変更できません。 |
Start At
|
shifts.start_at | string |
使用可能なスロットの開始時刻を指定する RFC 3339 タイムスタンプ。 |
End At
|
shifts.end_at | string |
RFC 3339; タイムゾーン + オフセットにシフトしました。 分までの精度が尊重されます。秒は切り捨てられます。 |
肩書き
|
shifts.wage.title | string |
このシフト中に実行されたジョブの名前。 Square レイバー レポート UI は、シフトをタイトルごとにグループ化する場合があります。 |
量
|
shifts.wage.hourly_rate.amount | integer |
金額。 |
通貨
|
shifts.wage.hourly_rate.currency | string |
通貨。 |
休憩
|
shifts.breaks | array of object | |
ID
|
shifts.breaks.id | string |
このオブジェクトを参照するための識別子。 |
Start At
|
shifts.breaks.start_at | string |
時間範囲の開始時刻を示す RFC 3339 形式の datetime 値。 |
End At
|
shifts.breaks.end_at | string |
時間範囲の終了時刻を示す RFC 3339 形式の datetime 値。 |
休憩タイプ ID
|
shifts.breaks.break_type_id | string |
この休憩がテンプレート化された BreakType。 |
件名
|
shifts.breaks.name | string |
人間が判読できる名前。 |
想定持続期間
|
shifts.breaks.expected_duration | string |
休憩の予想される長さ。 形式: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S。 |
支払済みかどうか
|
shifts.breaks.is_paid | boolean |
この休憩が補償目的で働いた時間にカウントされるかどうか。 |
Status
|
shifts.status | string |
このオブジェクトの現在の検証状態。 |
[バージョン]
|
shifts.version | integer |
オブジェクトの現在のバージョン。 |
作成日時
|
shifts.created_at | string |
イベント時刻 (ISO 8601 形式)。 |
更新日時
|
shifts.updated_at | string |
最終変更タイムスタンプ (RFC 3339 形式) |
スニペットを削除する
Square Online サイトからスニペットを削除します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
サイト ID
|
site_id | True | string |
サイトの識別子。 |
戻り値
- 応答
- object
スニペットを取得する
Square Online サイトからスニペットを取得します。 サイトには、複数のスニペット アプリケーションからのスニペットを含めることができますが、取得できるのは、アプリケーションによって追加されたスニペットのみです。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
サイト ID
|
site_id | True | string |
サイトの識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
snippet.id | string |
Square が発行した一意の識別子。 |
サイト ID
|
snippet.site_id | string |
スニペットを含むサイトの ID。 |
Content
|
snippet.content | string |
スニペット コード。有効な HTML、JavaScript、またはその両方を含めることができます。 |
作成日時
|
snippet.created_at | string |
このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
更新日時
|
snippet.updated_at | string |
このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
チェックアウトを作成する
支払い処理ワークフローを使用して支払い情報を提供するために、顧客がダイレクトされる checkout_page_url に checkoutId をリンクします。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
場所 ID
|
location_id | True | string |
場所の識別子。 |
Idempotency Key
|
idempotency_key | string |
すべての要求の中でこの要求を一意に識別するために指定する値。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。 |
|
リダイレクト URL
|
redirect_url | string |
たとえば、提供されたリダイレクト URL が http://www.example.com/order-complete、トランザクションが成功すると、顧客は次の場所にリダイレクトされます。 リダイレクト URL を指定しない場合、Square Checkout はユーザーに代わって注文確認ページを表示します。ただし、トランザクションの結果を確認し、既存の/通常の確認ワークフローを通じて注文を確定できるように、リダイレクト URL を提供することを強くお勧めします。
|
|
Idempotency Key
|
idempotency_key | string |
作成した注文の中でこの注文を一意に識別するために指定する値。 特定の注文が正常に作成されたかどうかわからない場合は、重複する注文を作成することは心配せずに、同じべき等キーを使用して再試行できます。 |
|
場所 ID
|
location_id | string |
指定された販売者の場所 ID に一致する空き状況を検索するためのクエリ式。 |
|
顧客 ID
|
customer_id | string |
受注に関連付けられた顧客 ID。 |
|
参照 ID
|
reference_id | string |
この注文で別のシステムにエンティティを関連付けるために使用されるクライアント指定 ID。 |
|
件名
|
name | string |
品目の名前。 |
|
数量
|
quantity | string |
10 進数形式の購入数量。 数量が 0 の品目は、注文の支払いまたは完了時に自動的に削除されます。 |
|
量
|
amount | integer |
金額。 |
|
通貨
|
currency | string |
通貨。 |
|
Discount UID
|
discount_uid | string |
適用された割引が表す割引の UID。 order.discounts フィールドにある割引を参照する必要があります。 このフィールドは不変です。 品目に適用される割引を変更するには、割引を削除して、新しい OrderLineItemAppliedDiscount として再追加する必要があります。 |
|
Tax UID
|
tax_uid | string |
この適用税が表す税の UID。 order.taxes フィールドにある税を参照する必要があります。 このフィールドは不変です。 品目に適用される税金を変更するには、OrderLineItemAppliedTax を削除して新しく追加します。 |
|
UID
|
uid | string |
一意の ID。 |
|
タイプ
|
type | string |
このオブジェクトの種類。 |
|
パーセント
|
percentage | string |
小数の文字列表現としての税金のパーセンテージ。 |
|
範囲
|
scope | string |
オブジェクトが適用されるレベルを示します。 |
|
UID
|
uid | string |
一意の ID。 |
|
タイプ
|
type | string |
このオブジェクトの種類。 |
|
範囲
|
scope | string |
オブジェクトが適用されるレベルを示します。 |
|
量
|
amount | integer |
金額。 |
|
通貨
|
currency | string |
通貨。 |
|
場所 ID
|
location_id | string |
場所の識別子。 |
|
Description
|
title | string |
説明。 |
|
量
|
amount | integer |
金額。 |
|
通貨
|
currency | string |
通貨。 |
|
発送先住所を訪ねる
|
ask_for_shipping_address | boolean |
true の場合、Square Checkout はお客様に代わって配送情報を収集し、その情報を取引情報とともに Square Seller Dashboard に保存します。 |
|
マーチャント サポート メール
|
merchant_support_email | string |
Square Checkout 確認ページに表示するメール アドレスと、購入者が販売者に連絡するために使用できる確認メール。 この値が設定されていない場合、確認ページとメールには、販売者の Square アカウントに関連付けられているメインのメール アドレスが表示されます。 |
|
購入者のメールを事前入力する
|
pre_populate_buyer_email | string |
提供されている場合、購入者のメールは、編集可能なテキスト フィールドとしてチェックアウト ページに事前入力されています。 |
|
Address Line 1
|
address_line_1 | string |
住所の 1 行目。 |
|
Address Line 2
|
address_line_2 | string |
住所の 2 行目 (存在する場合)。 |
|
Locality
|
locality | string |
住所の市区町村。 |
|
Administrative District Level 1
|
administrative_district_level_1 | string |
住所の国内にある市民エンティティ。 米国では、これは州です。 |
|
Postal Code
|
postal_code | string |
住所の郵便番号。 |
|
Country
|
country | string |
ISO 3166 Alpha-2 国コード。 |
|
名
|
first_name | string |
受信者を表す場合のオプションの名。 |
|
姓
|
last_name | string |
受信者を表す場合のオプションの姓。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
checkout.id | string |
Square が発行した一意の識別子。 |
チェックアウト ページ URL
|
checkout.checkout_page_url | string |
チェックアウトの完了後に購入者のブラウザがリダイレクトされる URL。 |
発送先住所を訪ねる
|
checkout.ask_for_shipping_address | boolean |
true の場合、Square Checkout はストアに代わって配送情報を収集し、その情報を取引情報とともに Square Dashboard に保存します。 |
マーチャント サポート メール
|
checkout.merchant_support_email | string |
Square Checkout 確認ページに表示するメール アドレスと、購入者がマーチャントに連絡するために使用できる確認メール。 |
購入者のメールを事前入力する
|
checkout.pre_populate_buyer_email | string |
提供されている場合、購入者のメールは、編集可能なテキスト フィールドとしてチェックアウト ページに事前入力されています。 |
Address Line 1
|
checkout.pre_populate_shipping_address.address_line_1 | string |
住所の 1 行目。 address_line で始まるフィールドは、番地、通りの名前、建物名など、住所の最も具体的な詳細を指定します。 |
Address Line 2
|
checkout.pre_populate_shipping_address.address_line_2 | string |
住所の 2 行目 (存在する場合)。 |
Locality
|
checkout.pre_populate_shipping_address.locality | string |
住所の市区町村。 |
Administrative District Level 1
|
checkout.pre_populate_shipping_address.administrative_district_level_1 | string |
住所の国内にある市民エンティティ。 米国では、これは州です。 |
Postal Code
|
checkout.pre_populate_shipping_address.postal_code | string |
住所の郵便番号。 |
Country
|
checkout.pre_populate_shipping_address.country | string |
住所の国 (ISO 3166-1-alpha-2 形式)。 |
名
|
checkout.pre_populate_shipping_address.first_name | string |
受信者を表す場合のオプションの名。 |
姓
|
checkout.pre_populate_shipping_address.last_name | string |
受信者を表す場合のオプションの姓。 |
リダイレクト URL
|
checkout.redirect_url | string |
チェックアウトが完了した後にリダイレクトする URL は、URL パラメーターとして checkoutId、Square の orderId、transactionId、および referenceId が追加されています。 たとえば、提供された redirect_url が http://www.example.com/order-complete、トランザクションが成功すると、顧客は次の場所にリダイレクトされます。 リダイレクト URL を指定しない場合、Square Checkout はユーザーに代わって注文確認ページを表示します。ただし、Square ではトランザクションの結果を確認し、既存の/通常の確認ワークフローを通じて注文を確定できるように、リダイレクト URL を提供することを強くお勧めします。
|
場所 ID
|
checkout.order.location_id | string |
指定された販売者の場所 ID に一致する空き状況を検索するためのクエリ式。 |
顧客 ID
|
checkout.order.customer_id | string |
受注に関連付けられた顧客 ID。 |
参照 ID
|
checkout.order.reference_id | string |
この注文で別のシステムにエンティティを関連付けるために使用されるクライアント指定 ID。 |
品目
|
checkout.order.line_items | array of object | |
件名
|
checkout.order.line_items.name | string |
品目の名前。 |
数量
|
checkout.order.line_items.quantity | string |
10 進数形式の購入数量。 数量が 0 の品目は、注文の支払いまたは完了時に自動的に削除されます。 |
Applied Taxes
|
checkout.order.line_items.applied_taxes | array of object | |
Tax UID
|
checkout.order.line_items.applied_taxes.tax_uid | string |
この適用税が表す税の UID。 order.taxes フィールドにある税を参照する必要があります。 このフィールドは不変です。 品目に適用される税金を変更するには、OrderLineItemAppliedTax を削除して新しく追加します。 |
量
|
checkout.order.line_items.applied_taxes.applied_money.amount | integer |
通貨で示される通貨の最小単位での金額。 たとえば、通貨が米国ドルの場合、金額はセント単位になります。 金額には正および負の値があります。 特定の場合の符号の意味を判別するには、特定のフィールドの説明を参照してください。 |
Currency
|
checkout.order.line_items.applied_taxes.applied_money.currency | string |
通貨の種類 (ISO 4217 形式)。 たとえば、米国ドルの通貨コードは USD です。 |
Applied Discounts
|
checkout.order.line_items.applied_discounts | array of object | |
Discount UID
|
checkout.order.line_items.applied_discounts.discount_uid | string |
適用された割引が表す割引の UID。 order.discounts フィールドにある割引を参照する必要があります。 このフィールドは不変です。 品目に適用される割引を変更するには、割引を削除して、新しい OrderLineItemAppliedDiscount として再追加する必要があります。 |
量
|
checkout.order.line_items.applied_discounts.applied_money.amount | integer |
通貨で示される通貨の最小単位での金額。 たとえば、通貨が米国ドルの場合、金額はセント単位になります。 金額には正および負の値があります。 特定の場合の符号の意味を判別するには、特定のフィールドの説明を参照してください。 |
Currency
|
checkout.order.line_items.applied_discounts.applied_money.currency | string |
通貨の種類 (ISO 4217 形式)。 たとえば、米国ドルの通貨コードは USD です。 |
量
|
checkout.order.line_items.base_price_money.amount | integer |
金額。 |
通貨
|
checkout.order.line_items.base_price_money.currency | string |
通貨。 |
量
|
checkout.order.line_items.total_tax_money.amount | integer |
金額。 |
Currency
|
checkout.order.line_items.total_tax_money.currency | string |
通貨。 |
Amount
|
checkout.order.line_items.total_discount_money.amount | integer |
金額。 |
通貨
|
checkout.order.line_items.total_discount_money.currency | string |
通貨。 |
量
|
checkout.order.line_items.total_money.amount | integer |
金額。 |
通貨
|
checkout.order.line_items.total_money.currency | string |
通貨。 |
税金
|
checkout.order.taxes | array of object | |
UID
|
checkout.order.taxes.uid | string |
一意の ID。 |
タイプ
|
checkout.order.taxes.type | string |
このオブジェクトの種類。 |
パーセント
|
checkout.order.taxes.percentage | string |
小数の文字列表現としての税金のパーセンテージ。 |
範囲
|
checkout.order.taxes.scope | string |
オブジェクトが適用されるレベルを示します。 |
割引
|
checkout.order.discounts | array of object | |
UID
|
checkout.order.discounts.uid | string |
一意の ID。 |
タイプ
|
checkout.order.discounts.type | string |
このオブジェクトの種類。 |
範囲
|
checkout.order.discounts.scope | string |
オブジェクトが適用されるレベルを示します。 |
量
|
checkout.order.discounts.amount_money.amount | integer |
金額。 |
通貨
|
checkout.order.discounts.amount_money.currency | string |
通貨。 |
量
|
checkout.order.discounts.applied_money.amount | integer |
金額。 |
Currency
|
checkout.order.discounts.applied_money.currency | string |
通貨。 |
Amount
|
checkout.order.total_money.amount | integer |
金額。 |
Currency
|
checkout.order.total_money.currency | string |
通貨。 |
Amount
|
checkout.order.total_tax_money.amount | integer |
金額。 |
Currency
|
checkout.order.total_tax_money.currency | string |
通貨。 |
Amount
|
checkout.order.total_discount_money.amount | integer |
金額。 |
Currency
|
checkout.order.total_discount_money.currency | string |
通貨。 |
Created At
|
checkout.created_at | string |
このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
[バージョン]
|
checkout.version | integer |
このオブジェクトの現在のバージョン。 |
追加の受信者
|
checkout.additional_recipients | array of object | |
場所 ID
|
checkout.additional_recipients.location_id | string |
この入札の一部を受け取る受信者 (マーチャント以外) のロケーション ID。 |
Description
|
checkout.additional_recipients.title | string |
品目の説明。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値の長さは Unicode コード ポイントです。 |
量
|
checkout.additional_recipients.amount_money.amount | integer |
金額。 |
通貨
|
checkout.additional_recipients.amount_money.currency | string |
通貨。 |
チーム メンバーの予約プロファイルを一覧表示する (ベータ版)
チーム メンバーの予約プロファイルを一覧表示します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
予約可能のみ
|
bookable_only | boolean |
返される結果に予約可能なチーム メンバーのみを含めるか (true)、含めないか (false) を示します。 |
|
限度
|
limit | integer |
応答で返す数の上限。 |
|
カーソル
|
cursor | string |
このエンドポイントへの前回の呼び出しによって返されたページネーション カーソル。 |
|
Location ID
|
location_id | string |
このオプション フィルターを指定して、特定の場所に属するレコードのみを取得できます。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
チーム メンバー予約プロファイル
|
team_member_booking_profiles | array of object | |
Team Member ID
|
team_member_booking_profiles.team_member_id | string |
オブジェクトに関連付けられたチーム メンバーの TeamMember オブジェクトの ID。 |
表示名
|
team_member_booking_profiles.display_name | string |
チーム メンバーの表示名。 |
予約可能ですか
|
team_member_booking_profiles.is_bookable | boolean |
チーム メンバーが Bookings API または販売者のオンライン予約チャネルまたはサイトを介して予約できるか (true)、そうでないか (false) を示します。 |
エラー
|
errors | array of |
チーム メンバーの賃金を一覧表示する
ビジネスの TeamMemberWage インスタンスのページ付けされたリストを返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Team Member ID
|
team_member_id | string |
返された賃金を、指定されたチーム メンバーに関連付けられている賃金のみにフィルタリングします。 |
|
限度
|
limit | integer |
応答で返す数の上限。 |
|
カーソル
|
cursor | string |
このエンドポイントへの前回の呼び出しによって返されたページネーション カーソル。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
チーム メンバーの賃金
|
team_member_wages | array of object | |
ID
|
team_member_wages.id | string |
Square が発行した一意の識別子。 |
Team Member ID
|
team_member_wages.team_member_id | string |
オブジェクトに関連付けられたチーム メンバーの TeamMember オブジェクトの ID。 |
肩書き
|
team_member_wages.title | string |
請求書のタイトル。 |
量
|
team_member_wages.hourly_rate.amount | integer |
金額。 |
通貨
|
team_member_wages.hourly_rate.currency | string |
通貨。 |
カーソル
|
cursor | string |
このエンドポイントへの後続の呼び出しにページネーション カーソルを含めて、元のクエリに関連付けられた次の結果セットを取得します。 |
チーム メンバーの賃金を取得する
id で指定された単一の TeamMemberWage を返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ID
|
id | True | string |
識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
team_member_wage.id | string |
Square が発行した一意の識別子。 |
Team Member ID
|
team_member_wage.team_member_id | string |
チーム メンバーの ID。 |
肩書き
|
team_member_wage.title | string |
タイトルです。 |
量
|
team_member_wage.hourly_rate.amount | integer |
金額。 |
通貨
|
team_member_wage.hourly_rate.currency | string |
通貨。 |
チーム メンバーを一括作成する
複数の TeamMember オブジェクトを作成します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
名前
|
given_name | string |
チーム メンバーに関連付けられた名 (つまり、下の名前)。 |
|
姓
|
family_name | string |
チーム メンバーに関連付けられた姓 (つまり、名字)。 |
|
メール アドレス
|
email_address | string |
チーム メンバーに関連付けられているメール アドレス。 |
|
参照 ID
|
reference_id | string |
チーム メンバーを別のシステムのエンティティに関連付けるために使用される 2 番目の ID。 |
|
電話番号
|
phone_number | string |
チーム メンバーの電話番号 (E.164 形式)。 |
|
Location IDs
|
location_ids | array of string | ||
割り当てタイプ
|
assignment_type | string |
チーム メンバーの現在の割り当てタイプ。 |
|
名前
|
given_name | string |
チーム メンバーに関連付けられた名 (つまり、下の名前)。 |
|
姓
|
family_name | string |
チーム メンバーに関連付けられた姓 (つまり、名字)。 |
|
メール アドレス
|
email_address | string |
チーム メンバーに関連付けられているメール アドレス。 |
|
参照 ID
|
reference_id | string |
チーム メンバーを別のシステムのエンティティに関連付けるために使用される 2 番目の ID。 |
|
電話番号
|
phone_number | string |
チーム メンバーの電話番号 (E.164 形式)。 |
|
割り当てタイプ
|
assignment_type | string |
チーム メンバーの現在の割り当てタイプ。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
team_members.idempotency-key-1.team_member.id | string |
このオブジェクトを参照するための識別子。 |
参照 ID
|
team_members.idempotency-key-1.team_member.reference_id | string |
チーム メンバーを別のシステムのエンティティに関連付けるために使用される 2 番目の ID。 |
所有者です
|
team_members.idempotency-key-1.team_member.is_owner | boolean |
チーム メンバーが Square アカウントの所有者であるかどうか。 |
Status
|
team_members.idempotency-key-1.team_member.status | string |
チーム メンバーの状態を説明します。 |
名前
|
team_members.idempotency-key-1.team_member.given_name | string |
チーム メンバーに関連付けられた名 (つまり、下の名前)。 |
姓
|
team_members.idempotency-key-1.team_member.family_name | string |
チーム メンバーに関連付けられた姓 (つまり、名字)。 |
メール アドレス
|
team_members.idempotency-key-1.team_member.email_address | string |
チーム メンバーに関連付けられているメール アドレス。 |
電話番号
|
team_members.idempotency-key-1.team_member.phone_number | string |
チーム メンバーの電話番号 (E.164 形式)。 |
割り当てタイプ
|
team_members.idempotency-key-1.team_member.assigned_locations.assignment_type | string |
チーム メンバーの現在の割り当てタイプ。 |
Location IDs
|
team_members.idempotency-key-1.team_member.assigned_locations.location_ids | array of string | |
ID
|
team_members.idempotency-key-2.team_member.id | string |
このオブジェクトを参照するための識別子。 |
参照 ID
|
team_members.idempotency-key-2.team_member.reference_id | string |
チーム メンバーを別のシステムのエンティティに関連付けるために使用される 2 番目の ID。 |
所有者です
|
team_members.idempotency-key-2.team_member.is_owner | boolean |
チーム メンバーが Square アカウントの所有者であるかどうか。 |
Status
|
team_members.idempotency-key-2.team_member.status | string |
チーム メンバーの状態を説明します。 |
名前
|
team_members.idempotency-key-2.team_member.given_name | string |
チーム メンバーに関連付けられた名 (つまり、下の名前)。 |
姓
|
team_members.idempotency-key-2.team_member.family_name | string |
チーム メンバーに関連付けられた姓 (つまり、名字)。 |
メール アドレス
|
team_members.idempotency-key-2.team_member.email_address | string |
チーム メンバーに関連付けられているメール アドレス。 |
電話番号
|
team_members.idempotency-key-2.team_member.phone_number | string |
チーム メンバーの電話番号 (E.164 形式)。 |
割り当てタイプ
|
team_members.idempotency-key-2.team_member.assigned_locations.assignment_type | string |
チーム メンバーの現在の割り当てタイプ。 |
チーム メンバーを一括更新する
複数の TeamMember オブジェクトを更新します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
参照 ID
|
reference_id | string |
チーム メンバーを別のシステムのエンティティに関連付けるために使用される 2 番目の ID。 |
|
所有者です
|
is_owner | boolean |
チーム メンバーが Square アカウントの所有者であるかどうか。 |
|
Status
|
status | string |
チーム メンバーの状態を説明します。 |
|
名前
|
given_name | string |
チーム メンバーに関連付けられた名 (つまり、下の名前)。 |
|
姓
|
family_name | string |
チーム メンバーに関連付けられた姓 (つまり、名字)。 |
|
メール アドレス
|
email_address | string |
チーム メンバーに関連付けられているメール アドレス。 |
|
電話番号
|
phone_number | string |
チーム メンバーの電話番号 (E.164 形式)。 |
|
Location IDs
|
location_ids | array of string | ||
割り当てタイプ
|
assignment_type | string |
チーム メンバーの現在の割り当てタイプ。 |
|
参照 ID
|
reference_id | string |
チーム メンバーを別のシステムのエンティティに関連付けるために使用される 2 番目の ID。 |
|
所有者です
|
is_owner | boolean |
チーム メンバーが Square アカウントの所有者であるかどうか。 |
|
Status
|
status | string |
チーム メンバーの状態を説明します。 |
|
名前
|
given_name | string |
チーム メンバーに関連付けられた名 (つまり、下の名前)。 |
|
姓
|
family_name | string |
チーム メンバーに関連付けられた姓 (つまり、名字)。 |
|
メール アドレス
|
email_address | string |
チーム メンバーに関連付けられているメール アドレス。 |
|
電話番号
|
phone_number | string |
チーム メンバーの電話番号 (E.164 形式)。 |
|
割り当てタイプ
|
assignment_type | string |
チーム メンバーの現在の割り当てタイプ。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
team_members.team_member_id.team_member.id | string |
このオブジェクトを参照するための識別子。 |
参照 ID
|
team_members.team_member_id.team_member.reference_id | string |
チーム メンバーを別のシステムのエンティティに関連付けるために使用される 2 番目の ID。 |
所有者です
|
team_members.team_member_id.team_member.is_owner | boolean |
チーム メンバーが Square アカウントの所有者であるかどうか。 |
Status
|
team_members.team_member_id.team_member.status | string |
チーム メンバーの状態を説明します。 |
名前
|
team_members.team_member_id.team_member.given_name | string |
チーム メンバーに関連付けられた名 (つまり、下の名前)。 |
姓
|
team_members.team_member_id.team_member.family_name | string |
チーム メンバーに関連付けられた姓 (つまり、名字)。 |
メール アドレス
|
team_members.team_member_id.team_member.email_address | string |
チーム メンバーに関連付けられているメール アドレス。 |
電話番号
|
team_members.team_member_id.team_member.phone_number | string |
チーム メンバーの電話番号 (E.164 形式)。 |
作成日時
|
team_members.team_member_id.team_member.created_at | string |
チーム メンバーがいつ作成されたかを説明する RFC 3339 形式のタイムスタンプ |
割り当てタイプ
|
team_members.team_member_id.team_member.assigned_locations.assignment_type | string |
チーム メンバーの現在の割り当てタイプ。 |
Location IDs
|
team_members.team_member_id.team_member.assigned_locations.location_ids | array of string |
チーム メンバーを作成する
単一の TeamMember オブジェクトを作成します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Idempotency Key
|
idempotency_key | string |
すべての要求の中でこの要求を一意に識別するために指定する値。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。 |
|
参照 ID
|
reference_id | string |
オプションのユーザー定義参照 ID。 |
|
Status
|
status | string |
このオブジェクトの現在の検証状態。 |
|
名前
|
given_name | string |
顧客プロファイルに関連付けられた名 (つまり、下の名前)。 |
|
Family Name
|
family_name | string |
顧客プロファイルに関連付けられた姓 (つまり、苗字)。 |
|
メール アドレス
|
email_address | string |
顧客プロファイルに関連付けられたメール アドレス。 |
|
電話番号
|
phone_number | string |
顧客プロファイルに関連付けられた 11 桁の電話番号。 |
|
Location IDs
|
location_ids | array of string | ||
割り当てタイプ
|
assignment_type | string |
チーム メンバーの現在の割り当てタイプ。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
team_member.id | string |
Square が発行した一意の識別子。 |
参照 ID
|
team_member.reference_id | string |
オプションのユーザー定義参照 ID。 |
所有者です
|
team_member.is_owner | boolean |
チーム メンバーが Square アカウントの所有者であるかどうか。 |
Status
|
team_member.status | string |
このオブジェクトの現在の検証状態。 |
名前
|
team_member.given_name | string |
顧客プロファイルに関連付けられた名 (つまり、下の名前)。 |
Family Name
|
team_member.family_name | string |
顧客プロファイルに関連付けられた姓 (つまり、苗字)。 |
メール アドレス
|
team_member.email_address | string |
顧客プロファイルに関連付けられたメール アドレス。 |
電話番号
|
team_member.phone_number | string |
顧客プロファイルに関連付けられた 11 桁の電話番号。 |
割り当てタイプ
|
team_member.assigned_locations.assignment_type | string |
チーム メンバーの現在の割り当てタイプ。 |
Location IDs
|
team_member.assigned_locations.location_ids | array of string |
チーム メンバーを取得する
指定された TeamMember ID の TeamMember オブジェクトを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Team Member ID
|
team_member_id | True | string |
チーム メンバーの識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
team_member.id | string |
Square が発行した一意の識別子。 |
参照 ID
|
team_member.reference_id | string |
オプションのユーザー定義参照 ID。 |
所有者です
|
team_member.is_owner | boolean |
チーム メンバーが Square アカウントの所有者であるかどうか。 |
Status
|
team_member.status | string |
このオブジェクトの現在の検証状態。 |
名前
|
team_member.given_name | string |
顧客プロファイルに関連付けられた名 (つまり、下の名前)。 |
Family Name
|
team_member.family_name | string |
顧客プロファイルに関連付けられた姓 (つまり、苗字)。 |
メール アドレス
|
team_member.email_address | string |
顧客プロファイルに関連付けられたメール アドレス。 |
電話番号
|
team_member.phone_number | string |
顧客プロファイルに関連付けられた 11 桁の電話番号。 |
作成日時
|
team_member.created_at | string |
このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
更新日時
|
team_member.updated_at | string |
このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
割り当てタイプ
|
team_member.assigned_locations.assignment_type | string |
チーム メンバーの現在の割り当てタイプ。 |
Location IDs
|
team_member.assigned_locations.location_ids | array of string |
チーム メンバーを更新する
単一の TeamMember オブジェクトを更新します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Team Member ID
|
team_member_id | True | string |
チーム メンバーの識別子。 |
参照 ID
|
reference_id | string |
オプションのユーザー定義参照 ID。 |
|
Status
|
status | string |
このオブジェクトの現在の検証状態。 |
|
名前
|
given_name | string |
顧客プロファイルに関連付けられた名 (つまり、下の名前)。 |
|
Family Name
|
family_name | string |
顧客プロファイルに関連付けられた姓 (つまり、苗字)。 |
|
メール アドレス
|
email_address | string |
顧客プロファイルに関連付けられたメール アドレス。 |
|
電話番号
|
phone_number | string |
顧客プロファイルに関連付けられた 11 桁の電話番号。 |
|
Location IDs
|
location_ids | array of string | ||
割り当てタイプ
|
assignment_type | string |
チーム メンバーの現在の割り当てタイプ。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
team_member.id | string |
Square が発行した一意の識別子。 |
参照 ID
|
team_member.reference_id | string |
オプションのユーザー定義参照 ID。 |
所有者です
|
team_member.is_owner | boolean |
チーム メンバーが Square アカウントの所有者であるかどうか。 |
Status
|
team_member.status | string |
このオブジェクトの現在の検証状態。 |
名前
|
team_member.given_name | string |
顧客プロファイルに関連付けられた名 (つまり、下の名前)。 |
Family Name
|
team_member.family_name | string |
顧客プロファイルに関連付けられた姓 (つまり、苗字)。 |
メール アドレス
|
team_member.email_address | string |
顧客プロファイルに関連付けられたメール アドレス。 |
電話番号
|
team_member.phone_number | string |
顧客プロファイルに関連付けられた 11 桁の電話番号。 |
作成日時
|
team_member.created_at | string |
このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
割り当てタイプ
|
team_member.assigned_locations.assignment_type | string |
チーム メンバーの現在の割り当てタイプ。 |
Location IDs
|
team_member.assigned_locations.location_ids | array of string |
チーム メンバーを検索する
ビジネスの TeamMember オブジェクトのページ付けされたリストを返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Location IDs
|
location_ids | array of string | ||
Status
|
status | string |
現在の状態。 |
|
限度
|
limit | integer |
1 ページに返される結果の数の制限。 制限は推奨値であり、実装によって返される結果が増減する可能性があります。 指定された制限が負、ゼロ、または最大制限の 1,000 より大きい場合、無視されます。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
チーム メンバー
|
team_members | array of object | |
ID
|
team_members.id | string |
Square が発行した一意の識別子。 |
参照 ID
|
team_members.reference_id | string |
顧客プロファイルを別のシステムのエンティティに関連付けるために使用されるオプションの 2 番目の ID。 |
所有者です
|
team_members.is_owner | boolean |
チーム メンバーが Square アカウントの所有者であるかどうか。 |
Status
|
team_members.status | string |
このオブジェクトの現在の検証状態。 |
名前
|
team_members.given_name | string |
顧客プロファイルに関連付けられた名 (つまり、下の名前)。 |
Family Name
|
team_members.family_name | string |
顧客プロファイルに関連付けられた姓 (つまり、苗字)。 |
メール アドレス
|
team_members.email_address | string |
顧客プロファイルに関連付けられたメール アドレス。 |
作成日時
|
team_members.created_at | string |
イベント時刻 (ISO 8601 形式)。 |
更新日時
|
team_members.updated_at | string |
最終変更タイムスタンプ (RFC 3339 形式) |
割り当てタイプ
|
team_members.assigned_locations.assignment_type | string |
チーム メンバーの現在の割り当てタイプ。 |
電話番号
|
team_members.phone_number | string |
顧客プロファイルに関連付けられた 11 桁の電話番号。 |
カーソル
|
cursor | string |
このエンドポイントへの後続の呼び出しにページネーション カーソルを含めて、元のクエリに関連付けられた次の結果セットを取得します。 |
デバイス コードを一覧表示する
マーチャントに関連付けられているすべての DeviceCode を一覧表示します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
カーソル
|
cursor | string |
このエンドポイントへの前回の呼び出しによって返されたページネーション カーソル。 |
|
Location ID
|
location_id | string |
このオプション フィルターを指定して、特定の場所に属するレコードのみを取得できます。 |
|
製品の種類
|
product_type | string |
指定した場合、指定した製品タイプを対象とする DeviceCode のみを返します。 空の場合、すべての製品タイプの DeviceCodes を返します。 |
|
Status
|
status | string |
指定した場合、指定したステータスに一致するオブジェクトのみを返します。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
デバイス コード
|
device_codes | array of object | |
ID
|
device_codes.id | string |
Square が発行した一意の識別子。 |
件名
|
device_codes.name | string |
オブジェクトの名前。 |
コード
|
device_codes.code | string |
ログインに参加するために使用できる一意のコード。 |
製品の種類
|
device_codes.product_type | string |
デバイス コードのターゲティング製品タイプ。 |
場所 ID
|
device_codes.location_id | string |
場所の識別子。 |
作成日時
|
device_codes.created_at | string |
イベント時刻 (ISO 8601 形式)。 |
ペアの相手
|
device_codes.pair_by | string |
この DeviceCode の有効期限が切れ、ログインできなくなったとき。 RFC 3339 形式のタイムスタンプ。 |
Status
|
device_codes.status | string |
このオブジェクトの現在の検証状態。 |
デバイス ID
|
device_codes.device_id | string |
このコードを使用したデバイスの一意の ID。 デバイスがペアリングされたときに入力されます。 |
ステータスが変更された時刻
|
device_codes.status_changed_at | string |
この DeviceCode のステータスが最後に変更された時点。 RFC 3339 形式のタイムスタンプ。 |
デバイス コードを作成する
Square Terminal デバイスにログインして接続ターミナル モードに入るのに使用できる DeviceCode を作成します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Idempotency Key
|
idempotency_key | string |
すべての要求の中でこの要求を一意に識別するために指定する値。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。 |
|
件名
|
name | string |
オブジェクトの名前。 |
|
場所 ID
|
location_id | string |
場所の識別子。 |
|
製品の種類
|
product_type | string |
デバイス コードのターゲティング製品タイプ。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
device_code.id | string |
Square が発行した一意の識別子。 |
件名
|
device_code.name | string |
オブジェクトの名前。 |
コード
|
device_code.code | string |
ログインに参加するために使用できる一意のコード。 |
製品の種類
|
device_code.product_type | string |
デバイス コードのターゲティング製品タイプ。 |
場所 ID
|
device_code.location_id | string |
場所の識別子。 |
作成日時
|
device_code.created_at | string |
このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
ペアの相手
|
device_code.pair_by | string |
この DeviceCode の有効期限が切れ、ログインできなくなったとき。 RFC 3339 形式のタイムスタンプ。 |
Status
|
device_code.status | string |
このオブジェクトの現在の検証状態。 |
ステータスが変更された時刻
|
device_code.status_changed_at | string |
この DeviceCode のステータスが最後に変更された時点。 RFC 3339 形式のタイムスタンプ。 |
デバイス コードを取得する
関連付けられた ID を持つ DeviceCode を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ID
|
id | True | string |
識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
device_code.id | string |
Square が発行した一意の識別子。 |
件名
|
device_code.name | string |
オブジェクトの名前。 |
コード
|
device_code.code | string |
ログインに参加するために使用できる一意のコード。 |
製品の種類
|
device_code.product_type | string |
デバイス コードのターゲティング製品タイプ。 |
場所 ID
|
device_code.location_id | string |
場所の識別子。 |
作成日時
|
device_code.created_at | string |
このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
ペアの相手
|
device_code.pair_by | string |
この DeviceCode の有効期限が切れ、ログインできなくなったとき。 RFC 3339 形式のタイムスタンプ。 |
Status
|
device_code.status | string |
このオブジェクトの現在の検証状態。 |
デバイス ID
|
device_code.device_id | string |
デバイスの ID。 |
ステータスが変更された時刻
|
device_code.status_changed_at | string |
この DeviceCode のステータスが最後に変更された時点。 RFC 3339 形式のタイムスタンプ。 |
ビジネス予約プロファイルを取得する (ベータ版)
販売者の予約プロファイルを取得します。
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
販売者 ID
|
business_booking_profile.seller_id | string |
マーチャント API を使用して取得できる販売者の ID。 |
作成日時
|
business_booking_profile.created_at | string |
このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
予約が有効化されました
|
business_booking_profile.booking_enabled | boolean |
販売者が予約可能かどうかを示します。 |
顧客のタイムゾーンの選択
|
business_booking_profile.customer_timezone_choice | string |
予約の顧客のタイムゾーン情報の選択。 Square オンライン予約サイトと顧客へのすべての通知は、販売者の場所のタイムゾーンまたは顧客が予約時に選択したタイムゾーンのいずれかを使用します。 |
予約ポリシー
|
business_booking_profile.booking_policy | string |
販売者が予約リクエストを自動的に受け入れるか (ACCEPT_ALL)、受け入れないか (REQUIRES_ACCEPTANCE) のポリシー。 |
ユーザーがキャンセルするのを許可する
|
business_booking_profile.allow_user_cancel | boolean |
顧客が自分の予約をキャンセルまたは再スケジュールできる (true) か、できない (false) かを示します。 |
場所の種類
|
business_booking_profile.business_appointment_settings.location_types | array of string | |
位置合わせ時間
|
business_booking_profile.business_appointment_settings.alignment_time | string |
予約のサービス期間の時間単位。 |
最小予約リード時間秒
|
business_booking_profile.business_appointment_settings.min_booking_lead_time_seconds | integer |
サービスを予約できるようになるまでの最小リードタイム (秒単位)。 予約を行う必要がある予約開始時刻からさかのぼった最小時間。 |
最大予約リード時間秒
|
business_booking_profile.business_appointment_settings.max_booking_lead_time_seconds | integer |
サービスを予約できるようになるまでの最大リードタイム (秒単位)。 予約を行う必要がある予約開始時刻からさかのぼった最大時間。 |
チーム メンバーの予約が有効
|
business_booking_profile.business_appointment_settings.any_team_member_booking_enabled | boolean |
顧客が利用可能なすべてのタイム スロットから選択して、スタッフを自動的に割り当てることができる (true) か、割り当てられない (false) かを示します。 |
複数のサービスの予約が有効
|
business_booking_profile.business_appointment_settings.multiple_service_booking_enabled | boolean |
顧客が 1 回のオンライン予約で複数のサービスを予約できるかどうかを示します。 |
量
|
business_booking_profile.business_appointment_settings.cancellation_fee_money.amount | string |
通貨で示される通貨の最小単位での金額 |
通貨
|
business_booking_profile.business_appointment_settings.cancellation_fee_money.currency | string |
通貨の種類 (ISO 4217 形式)。 |
キャンセル ポリシー
|
business_booking_profile.business_appointment_settings.cancellation_policy | string |
販売者が採用したキャンセル ポリシー。 |
予約フロースタッフの選択をスキップ
|
business_booking_profile.business_appointment_settings.skip_booking_flow_staff_selection | boolean |
顧客にスタッフが割り当てられている (true) か、または選択したスタッフを選べる (false) かを示します。 |
エラー
|
errors | array of |
マーチャントを一覧表示する
指定されたアクセス トークンのマーチャント情報を返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
カーソル
|
cursor | integer |
このエンドポイントへの前回の呼び出しによって返されたページネーション カーソル。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
マーチャント
|
merchant | array of object | |
ID
|
merchant.id | string |
Square が発行した一意の識別子。 |
ビジネス名
|
merchant.business_name | string |
場所の会社名。場所の顧客に表示される名前です。 たとえば、この名前は顧客の領収書に表示されます。 |
Country
|
merchant.country | string |
ISO 3166 Alpha-2 国コード。 |
言語コード
|
merchant.language_code | string |
場所に関連付けられている言語 (BCP 47 形式)。 |
通貨
|
merchant.currency | string |
3 文字の ISO 4217 通貨コード。 |
Status
|
merchant.status | string |
このオブジェクトの現在の検証状態。 |
メインの場所 ID
|
merchant.main_location_id | string |
このマーチャントのメイン場所の ID。 |
マーチャントを取得する
指定された merchant_id の Merchant オブジェクトを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
マーチャント ID
|
merchant_id | True | string |
マーチャントの識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
merchant.id | string |
Square が発行した一意の識別子。 |
ビジネス名
|
merchant.business_name | string |
場所の会社名。場所の顧客に表示される名前です。 たとえば、この名前は顧客の領収書に表示されます。 |
Country
|
merchant.country | string |
ISO 3166 Alpha-2 国コード。 |
言語コード
|
merchant.language_code | string |
言語コードです (BCP 47 形式)。 |
通貨
|
merchant.currency | string |
3 文字の ISO 4217 通貨コード。 |
Status
|
merchant.status | string |
このオブジェクトの現在の検証状態。 |
メインの場所 ID
|
merchant.main_location_id | string |
このマーチャントのメイン場所の ID。 |
モバイル認証コードを作成する
モバイル アプリケーションが Square カード閲覧者に接続することを承認するコードを生成します。 認証コードは 1 回限りの使用で、発行後 60 分で有効期限が切れます。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
場所 ID
|
location_id | string |
場所の識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
認証コード
|
authorization_code | string |
モバイル アプリケーション インスタンスを Square アカウントに接続する生成された認証コード。 |
有効期限
|
expires_at | string |
authentication_code が RFC3339 形式で期限切れになるときのタイムスタンプ。 |
ロイヤルティ アカウントを作成する
ロイヤルティ アカウントを作成します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
電話番号
|
phone_number | string |
受信者の電話番号。 |
|
プログラム ID
|
program_id | string |
Square によって割り当てられたプログラム ID。 |
|
Idempotency Key
|
idempotency_key | string |
すべての要求の中でこの要求を一意に識別するために指定する値。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
loyalty_account.id | string |
Square が発行した一意の識別子。 |
ID
|
loyalty_account.mapping.id | string |
Square 割り当て ID。 |
電話番号
|
loyalty_account.mapping.phone_number | string |
受信者の電話番号。 |
作成日時
|
loyalty_account.mapping.created_at | string |
作成時のタイムスタンプ (RFC 3339形式)。 |
プログラム ID
|
loyalty_account.program_id | string |
Square によって割り当てられたプログラム ID。 |
残高
|
loyalty_account.balance | integer |
利用可能な残高。 |
生涯ポイント
|
loyalty_account.lifetime_points | integer |
アカウントの存続期間中に獲得した合計ポイント。 |
作成日時
|
loyalty_account.created_at | string |
このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
更新日時
|
loyalty_account.updated_at | string |
このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
ロイヤルティ アカウントを取得する
ロイヤルティ アカウントを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
アカウント ID
|
account_id | True | string |
アカウントの識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
loyalty_account.id | string |
Square が発行した一意の識別子。 |
ID
|
loyalty_account.mapping.id | string |
Square 割り当て ID。 |
電話番号
|
loyalty_account.mapping.phone_number | string |
受信者の電話番号。 |
作成日時
|
loyalty_account.mapping.created_at | string |
作成時のタイムスタンプ (RFC 3339形式)。 |
プログラム ID
|
loyalty_account.program_id | string |
Square によって割り当てられたプログラム ID。 |
残高
|
loyalty_account.balance | integer |
利用可能な残高。 |
生涯ポイント
|
loyalty_account.lifetime_points | integer |
アカウントの存続期間中に獲得した合計ポイント。 |
顧客 ID
|
loyalty_account.customer_id | string |
顧客を表すこのオブジェクトの ID。 |
作成日時
|
loyalty_account.created_at | string |
このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
更新日時
|
loyalty_account.updated_at | string |
このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
ロイヤルティ アカウントを検索する
ロイヤルティ プログラムでロイヤルティ アカウントを検索します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
限度
|
limit | integer |
1 ページに返される結果の数の制限。 制限は推奨値であり、実装によって返される結果が増減する可能性があります。 指定された制限が負、ゼロ、または最大制限の 1,000 より大きい場合、無視されます。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ロイヤルティ アカウント
|
loyalty_accounts | array of object | |
ID
|
loyalty_accounts.id | string |
Square が発行した一意の識別子。 |
ID
|
loyalty_accounts.mapping.id | string |
オブジェクトの識別子 |
電話番号
|
loyalty_accounts.mapping.phone_number | string |
受信者の電話番号。 |
作成日時
|
loyalty_accounts.mapping.created_at | string |
作成時のタイムスタンプ (RFC 3339形式)。 |
プログラム ID
|
loyalty_accounts.program_id | string |
アカウントが属する、Square によって割り当てられたロイヤルティ プログラム ID。 |
残高
|
loyalty_accounts.balance | integer |
ロイヤルティ アカウントで利用可能なポイント残高。 |
生涯ポイント
|
loyalty_accounts.lifetime_points | integer |
アカウントの存続期間中に獲得した合計ポイント。 |
顧客 ID
|
loyalty_accounts.customer_id | string |
アカウントに関連付けられた、Square で割り当てられた顧客の ID。 |
作成日時
|
loyalty_accounts.created_at | string |
イベント時刻 (ISO 8601 形式)。 |
更新日時
|
loyalty_accounts.updated_at | string |
最終変更タイムスタンプ (RFC 3339 形式) |
カーソル
|
cursor | string |
このエンドポイントへの後続の呼び出しにページネーション カーソルを含めて、元のクエリに関連付けられた次の結果セットを取得します。 |
ロイヤルティ イベントを検索する
ロイヤルティ イベントを検索します。 Square ロイヤルティ プログラムは、購入者のロイヤルティ アカウントの存続期間中に発生するイベントの台帳を維持します。 ポイント残高の各変更 (たとえば、獲得したポイント、交換したポイント、期限切れしたポイント) は、台帳に記録されます。 このエンドポイントを使用して、イベントの台帳を検索できます。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
注文 ID
|
order_id | string |
注文の識別子。 |
|
限度
|
limit | integer |
1 ページに返される結果の数の制限。 制限は推奨値であり、実装によって返される結果が増減する可能性があります。 指定された制限が負、ゼロ、または最大制限の 1,000 より大きい場合、無視されます。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
イベント
|
events | array of object | |
ID
|
events.id | string |
Square が発行した一意の識別子。 |
タイプ
|
events.type | string |
このオブジェクトの種類。 |
作成日時
|
events.created_at | string |
イベント時刻 (ISO 8601 形式)。 |
ロイヤルティ プログラム ID
|
events.accumulate_points.loyalty_program_id | string |
ロイヤルティ プロジェクトの ID |
ポイント
|
events.accumulate_points.points | integer |
イベントによって貯まったポイント数。 |
注文 ID
|
events.accumulate_points.order_id | string |
活動に関連付けられた注文の ID。 |
ロイヤルティ アカウント ID
|
events.loyalty_account_id | string |
イベントが発生したロイヤルティ アカウントの ID。 |
場所 ID
|
events.location_id | string |
場所の識別子。 |
Source
|
events.source | string |
イベントが Square POS によって生成されたかどうかを定義します。 |
ロイヤルティ プログラム ID
|
events.redeem_reward.loyalty_program_id | string |
ロイヤルティ プロジェクトの ID |
リワード ID
|
events.redeem_reward.reward_id | string |
引き換えられたロイヤルティ リワードの ID。 |
注文 ID
|
events.redeem_reward.order_id | string |
活動に関連付けられた注文の ID。 |
ロイヤルティ プログラム ID
|
events.create_reward.loyalty_program_id | string |
ロイヤルティ プロジェクトの ID |
リワード ID
|
events.create_reward.reward_id | string |
引き換えられたロイヤルティ リワードの ID。 |
ポイント
|
events.create_reward.points | integer |
イベントによって貯まったポイント数。 |
ロイヤルティ プログラムを取得する
プログラム ID またはキーワード メインで指定された、販売者のアカウントのロイヤルティ プログラムを取得します。 ロイヤルティ プログラムは、購入者がポイントを獲得し、ポイントをリワードと交換する方法を定義します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プログラム ID
|
program_id | True | string |
プログラムの識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
program.id | string |
Square が発行した一意の識別子。 |
Status
|
program.status | string |
このオブジェクトの現在の検証状態。 |
リワード階層
|
program.reward_tiers | array of object | |
ID
|
program.reward_tiers.id | string |
オブジェクトの識別子 |
ポイント
|
program.reward_tiers.points | integer |
イベントによって貯まったポイント数。 |
件名
|
program.reward_tiers.name | string |
品目の名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値は空であってはならず、長さは Unicode コード ポイントです。 |
範囲
|
program.reward_tiers.definition.scope | string |
オブジェクトが適用されるレベルを示します。 |
割引の種類
|
program.reward_tiers.definition.discount_type | string |
リワード階層が提供する割引のタイプ。 |
割引率
|
program.reward_tiers.definition.percentage_discount | string |
割引の固定率。 |
作成日時
|
program.reward_tiers.created_at | string |
作成時のタイムスタンプ (RFC 3339形式)。 |
オブジェクト ID
|
program.reward_tiers.pricing_rule_reference.object_id | string |
参照されたオブジェクトの ID。 |
Catalog Version
|
program.reward_tiers.pricing_rule_reference.catalog_version | string |
オブジェクトのバージョン。 |
1
|
program.terminology.one | string |
ポイントの単一単位 (たとえば、1 ポイントは 1 スターと呼ばれます)。 |
その他
|
program.terminology.other | string |
ポイントの複数単位 (たとえば、10 ポイントは 10 スターと呼ばれます)。 |
Location IDs
|
program.location_ids | array of string | |
作成日時
|
program.created_at | string |
このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
更新日時
|
program.updated_at | string |
このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
見越計上ルール
|
program.accrual_rules | array of object | |
見越計上タイプ
|
program.accrual_rules.accrual_type | string |
購入者がポイントを獲得する方法を定義する見越計上ルールのタイプ。 |
ポイント
|
program.accrual_rules.points | integer |
イベントによって貯まったポイント数。 |
量
|
program.accrual_rules.spend_amount_money.amount | integer |
金額。 |
除外されたカテゴリ ID
|
program.accrual_rules.excluded_category_ids | array of string | |
除外されたアイテム バリエーション ID
|
program.accrual_rules.excluded_item_variation_ids | array of string |
ロイヤルティ ポイントを計算する
購入により獲得するポイントを計算します。 アプリケーションはこれをエンドポイントと呼んで、購入者が特定の購入で獲得できるポイントを表示する場合があります。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プログラム ID
|
program_id | True | string |
プログラムの識別子。 |
注文 ID
|
order_id | string |
注文の識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ポイント
|
points | integer |
購入者が特定の購入から獲得できるポイント。 |
ロイヤルティ ポイントを調整する
購入者のアカウントにポイントを追加したり、ポイントを差し引いたりします。 このエンドポイントは、ポイントを手動で調整する必要がある場合にのみ使用してください。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
アカウント ID
|
account_id | True | string |
アカウントの識別子。 |
ポイント
|
points | integer |
追加または削除されたポイント数。 |
|
理由
|
reason | string |
このオブジェクトの理由。 |
|
Idempotency Key
|
idempotency_key | string |
すべての要求の中でこの要求を一意に識別するために指定する値。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
event.id | string |
Square が発行した一意の識別子。 |
タイプ
|
event.type | string |
このオブジェクトの種類。 |
作成日時
|
event.created_at | string |
このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
ロイヤルティ プログラム ID
|
event.adjust_points.loyalty_program_id | string |
ロイヤルティ プロジェクトの ID |
ポイント
|
event.adjust_points.points | integer |
イベントによって貯まったポイント数。 |
理由
|
event.adjust_points.reason | string |
ポイントの調整の理由。 |
ロイヤルティ アカウント ID
|
event.loyalty_account_id | string |
イベントが発生したロイヤルティ アカウントの ID。 |
Source
|
event.source | string |
ソース。 |
ロイヤルティ ポイントを貯める
ロイヤルティ アカウントにポイントを追加します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
アカウント ID
|
account_id | True | string |
アカウントの識別子。 |
注文 ID
|
order_id | string |
受注の ID。 |
|
場所 ID
|
location_id | string |
場所の識別子。 |
|
Idempotency Key
|
idempotency_key | string |
すべての要求の中でこの要求を一意に識別するために指定する値。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
event.id | string |
Square が発行した一意の識別子。 |
タイプ
|
event.type | string |
このオブジェクトの種類。 |
作成日時
|
event.created_at | string |
このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
ロイヤルティ プログラム ID
|
event.accumulate_points.loyalty_program_id | string |
ロイヤルティ プロジェクトの ID |
ポイント
|
event.accumulate_points.points | integer |
イベントによって貯まったポイント数。 |
注文 ID
|
event.accumulate_points.order_id | string |
活動に関連付けられた注文の ID。 |
ロイヤルティ アカウント ID
|
event.loyalty_account_id | string |
イベントが発生したロイヤルティ アカウントの ID。 |
場所 ID
|
event.location_id | string |
場所の識別子。 |
Source
|
event.source | string |
ソース。 |
ロイヤルティ リワードの引き換え
ロイヤルティ リワードを引き換えます。 リワードが終末期状態に達した後は、削除できません。 つまり、リワードに使用したポイントをアカウントに戻すことはできません。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
リワード ID
|
reward_id | True | string |
リワードの識別子。 |
Idempotency Key
|
idempotency_key | string |
すべての要求の中でこの要求を一意に識別するために指定する値。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。 |
|
場所 ID
|
location_id | string |
場所の識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
event.id | string |
Square が発行した一意の識別子。 |
タイプ
|
event.type | string |
このオブジェクトの種類。 |
作成日時
|
event.created_at | string |
このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
ロイヤルティ プログラム ID
|
event.redeem_reward.loyalty_program_id | string |
ロイヤルティ プロジェクトの ID |
リワード ID
|
event.redeem_reward.reward_id | string |
Square によって割り当てられたロイヤルティ リワード ID。 |
ロイヤルティ アカウント ID
|
event.loyalty_account_id | string |
イベントが発生したロイヤルティ アカウントの ID。 |
場所 ID
|
event.location_id | string |
場所の識別子。 |
Source
|
event.source | string |
ソース。 |
ロイヤルティ リワードを作成する
ロイヤルティ リワードを作成します。 特典が作成されると、ポイントはロックされ、購入者は別のリワードを利用できなくなります。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ロイヤルティ アカウント ID
|
loyalty_account_id | string |
イベントが発生したロイヤルティ アカウントの ID。 |
|
リワード階層 ID
|
reward_tier_id | string |
リワードの作成に使用されるリワード階層の Square に割り当てられた ID。 |
|
注文 ID
|
order_id | string |
受注の ID。 |
|
Idempotency Key
|
idempotency_key | string |
すべての要求の中でこの要求を一意に識別するために指定する値。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
reward.id | string |
Square が発行した一意の識別子。 |
Status
|
reward.status | string |
このオブジェクトの現在の検証状態。 |
ロイヤルティ アカウント ID
|
reward.loyalty_account_id | string |
イベントが発生したロイヤルティ アカウントの ID。 |
リワード階層 ID
|
reward.reward_tier_id | string |
リワードの作成に使用されるリワード階層の Square に割り当てられた ID。 |
ポイント
|
reward.points | integer |
追加または削除されたポイント数。 |
注文 ID
|
reward.order_id | string |
受注の ID。 |
作成日時
|
reward.created_at | string |
このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
更新日時
|
reward.updated_at | string |
このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
ロイヤルティ リワードを削除する
ロイヤルティ リワードを削除します。 ポイントをロイヤルティ アカウントに戻します。 終末期状態 (REDEEMED) に達したリワードは削除できません。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
リワード ID
|
reward_id | True | string |
リワードの識別子。 |
戻り値
- 応答
- object
ロイヤルティ リワードを取得する
ロイヤルティ リワードを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
リワード ID
|
reward_id | True | string |
リワードの識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
reward.id | string |
Square が発行した一意の識別子。 |
Status
|
reward.status | string |
このオブジェクトの現在の検証状態。 |
ロイヤルティ アカウント ID
|
reward.loyalty_account_id | string |
イベントが発生したロイヤルティ アカウントの ID。 |
リワード階層 ID
|
reward.reward_tier_id | string |
リワードの作成に使用されるリワード階層の Square に割り当てられた ID。 |
ポイント
|
reward.points | integer |
追加または削除されたポイント数。 |
作成日時
|
reward.created_at | string |
このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
更新日時
|
reward.updated_at | string |
このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
引き換え時刻
|
reward.redeemed_at | string |
リワードが引き換えられたときのタイムスタンプ (RFC 3339 形式)。 |
ロイヤルティ リワードを検索する
ロイヤルティ アカウントでロイヤルティ リワードを検索します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ロイヤルティ アカウント ID
|
loyalty_account_id | string |
イベントが発生したロイヤルティ アカウントの ID。 |
|
限度
|
limit | integer |
1 ページに返される結果の数の制限。 制限は推奨値であり、実装によって返される結果が増減する可能性があります。 指定された制限が負、ゼロ、または最大制限の 1,000 より大きい場合、無視されます。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
リワード
|
rewards | array of object | |
ID
|
rewards.id | string |
Square が発行した一意の識別子。 |
Status
|
rewards.status | string |
このオブジェクトの現在の検証状態。 |
ロイヤルティ アカウント ID
|
rewards.loyalty_account_id | string |
イベントが発生したロイヤルティ アカウントの ID。 |
リワード階層 ID
|
rewards.reward_tier_id | string |
リワードの作成に使用されるリワード階層の Square に割り当てられた ID。 |
ポイント
|
rewards.points | integer |
リワードに使用されたロイヤルティ ポイントの数。 |
注文 ID
|
rewards.order_id | string |
受注の ID。 |
作成日時
|
rewards.created_at | string |
イベント時刻 (ISO 8601 形式)。 |
更新日時
|
rewards.updated_at | string |
最終変更タイムスタンプ (RFC 3339 形式) |
引き換え時刻
|
rewards.redeemed_at | string |
リワードが引き換えられたときのタイムスタンプ (RFC 3339 形式)。 |
予約を作成する (ベータ版)
予約を作成します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
顧客 ID
|
customer_id | string |
顧客を表すこのオブジェクトの ID。 |
|
Start At
|
start_at | string |
このオブジェクトの開始時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
|
場所 ID
|
location_id | string |
場所の識別子。 |
|
期間 (分単位)
|
duration_minutes | integer |
予約セグメントの分単位の期間。 |
|
Team Member ID
|
team_member_id | string |
このセグメントで予約されたチーム メンバーを表す TeamMember オブジェクトの ID。 |
|
サービス バリエーション ID
|
service_variation_id | string |
このセグメントで予約されたサービスを表す CatalogItemVariation オブジェクトの ID。 |
|
サービス バリエーションのバージョン
|
service_variation_version | integer |
このセグメントで予約されたサービスを表すアイテム バリエーションの現行バージョン。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
booking.id | string |
Square が発行した一意の識別子。 |
[バージョン]
|
booking.version | integer |
このオブジェクトの現在のバージョン。 |
Status
|
booking.status | string |
このオブジェクトの現在の検証状態。 |
作成日時
|
booking.created_at | string |
このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
更新日時
|
booking.updated_at | string |
このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
場所 ID
|
booking.location_id | string |
場所の識別子。 |
顧客 ID
|
booking.customer_id | string |
顧客を表すこのオブジェクトの ID。 |
顧客のメモ
|
booking.customer_note | string |
顧客が予約に関するメモを提供するためのフリーテキスト フィールド。 |
販売者のメモ
|
booking.seller_note | string |
販売者が予約に関するメモを提供するためのフリーテキスト フィールド。 |
Start At
|
booking.start_at | string |
このオブジェクトの開始時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
予定セグメント
|
booking.appointment_segments | array of object | |
期間 (分単位)
|
booking.appointment_segments.duration_minutes | integer |
予約セグメントの分単位の期間。 |
サービス バリエーション ID
|
booking.appointment_segments.service_variation_id | string |
このセグメントで予約されたサービスを表す CatalogItemVariation オブジェクトの ID。 |
Team Member ID
|
booking.appointment_segments.team_member_id | string |
このセグメントで予約されたチーム メンバーを表す TeamMember オブジェクトの ID。 |
サービス バリエーションのバージョン
|
booking.appointment_segments.service_variation_version | integer |
このセグメントで予約されたサービスを表すアイテム バリエーションの現行バージョン。 |
エラー
|
errors | array of |
休憩の種類を作成する
新しい BreakType を作成します。 BreakType は、休憩オブジェクトを作成するためのテンプレートです。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Idempotency Key
|
idempotency_key | string |
すべての要求の中でこの要求を一意に識別するために指定する値。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。 |
|
場所 ID
|
location_id | string |
場所の識別子。 |
|
休憩名
|
break_name | string |
この種類の休憩の、人が判読できる名前。 名前は Square 製品の従業員に表示されます。 |
|
想定持続期間
|
expected_duration | string |
この休憩の予想される長さ。 形式: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S。 分未満の精度は切り捨てられます。 |
|
支払済みかどうか
|
is_paid | boolean |
この休憩が補償目的で働いた時間にカウントされるかどうか。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
break_type.id | string |
Square が発行した一意の識別子。 |
場所 ID
|
break_type.location_id | string |
場所の識別子。 |
休憩名
|
break_type.break_name | string |
この種類の休憩の、人が判読できる名前。 名前は Square 製品の従業員に表示されます。 |
想定持続期間
|
break_type.expected_duration | string |
この休憩の予想される長さ。 形式: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S。 分未満の精度は切り捨てられます。 |
支払済みかどうか
|
break_type.is_paid | boolean |
この休憩が補償目的で働いた時間にカウントされるかどうか。 |
[バージョン]
|
break_type.version | integer |
このオブジェクトの現在のバージョン。 |
作成日時
|
break_type.created_at | string |
このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
更新日時
|
break_type.updated_at | string |
このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
休憩の種類を取得する
id で指定された単一の BreakType を返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ID
|
id | True | string |
識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
break_type.id | string |
Square が発行した一意の識別子。 |
場所 ID
|
break_type.location_id | string |
場所の識別子。 |
休憩名
|
break_type.break_name | string |
この種類の休憩の、人が判読できる名前。 名前は Square 製品の従業員に表示されます。 |
想定持続期間
|
break_type.expected_duration | string |
この休憩の予想される長さ。 形式: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S。 分未満の精度は切り捨てられます。 |
支払済みかどうか
|
break_type.is_paid | boolean |
この休憩が補償目的で働いた時間にカウントされるかどうか。 |
[バージョン]
|
break_type.version | integer |
このオブジェクトの現在のバージョン。 |
作成日時
|
break_type.created_at | string |
このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
更新日時
|
break_type.updated_at | string |
このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
休憩の種類を更新する
既存の BreakType を更新します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ID
|
id | True | string |
識別子。 |
場所 ID
|
location_id | string |
場所の識別子。 |
|
休憩名
|
break_name | string |
この種類の休憩の、人が判読できる名前。 名前は Square 製品の従業員に表示されます。 |
|
想定持続期間
|
expected_duration | string |
この休憩の予想される長さ。 形式: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S。 分未満の精度は切り捨てられます。 |
|
支払済みかどうか
|
is_paid | boolean |
この休憩が補償目的で働いた時間にカウントされるかどうか。 |
|
[バージョン]
|
version | integer |
このオブジェクトの現在のバージョン。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
break_type.id | string |
Square が発行した一意の識別子。 |
場所 ID
|
break_type.location_id | string |
場所の識別子。 |
休憩名
|
break_type.break_name | string |
この種類の休憩の、人が判読できる名前。 名前は Square 製品の従業員に表示されます。 |
想定持続期間
|
break_type.expected_duration | string |
この休憩の予想される長さ。 形式: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S。 分未満の精度は切り捨てられます。 |
支払済みかどうか
|
break_type.is_paid | boolean |
この休憩が補償目的で働いた時間にカウントされるかどうか。 |
[バージョン]
|
break_type.version | integer |
このオブジェクトの現在のバージョン。 |
作成日時
|
break_type.created_at | string |
このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
更新日時
|
break_type.updated_at | string |
このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
休憩タイプを一覧表示する
ビジネスの BreakType インスタンスのページ付けされたリストを返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
場所 ID
|
location_id | string |
このオプション フィルターを指定して、特定の場所に属するレコードのみを取得できます。 |
|
限度
|
limit | integer |
応答で返す数の上限。 |
|
カーソル
|
cursor | string |
このエンドポイントへの前回の呼び出しによって返されたページネーション カーソル。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
休憩タイプ
|
break_types | array of object | |
ID
|
break_types.id | string |
Square が発行した一意の識別子。 |
場所 ID
|
break_types.location_id | string |
場所の識別子。 |
休憩名
|
break_types.break_name | string |
この種類の休憩の、人が判読できる名前。 名前は Square 製品の従業員に表示されます。 |
想定持続期間
|
break_types.expected_duration | string |
この休憩の予想される長さ。 形式: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S。 分未満の精度は切り捨てられます。 |
支払済みかどうか
|
break_types.is_paid | boolean |
この休憩が補償目的で働いた時間にカウントされるかどうか。 |
[バージョン]
|
break_types.version | integer |
オブジェクトの現在のバージョン。 |
作成日時
|
break_types.created_at | string |
イベント時刻 (ISO 8601 形式)。 |
更新日時
|
break_types.updated_at | string |
最終変更タイムスタンプ (RFC 3339 形式) |
カーソル
|
cursor | string |
このエンドポイントへの後続の呼び出しにページネーション カーソルを含めて、元のクエリに関連付けられた次の結果セットを取得します。 |
休憩タイプを削除する
既存の BreakType を削除します。 BreakType は、Shift から参照されている場合でも削除できます。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ID
|
id | True | string |
識別子。 |
戻り値
- 応答
- object
場所を一覧表示する
ビジネスのすべての場所の情報を提供します。
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
場所
|
locations | array of object | |
ID
|
locations.id | string |
Square が発行した一意の識別子。 |
件名
|
locations.name | string |
オブジェクトの名前。 |
Address Line 1
|
locations.address.address_line_1 | string |
住所の 1 行目。 |
地域
|
locations.address.locality | string |
住所の市区町村。 |
Administrative District Level 1
|
locations.address.administrative_district_level_1 | string |
住所の国内にある市民エンティティ。 米国では、これは州です。 |
Postal Code
|
locations.address.postal_code | string |
住所の郵便番号。 |
Country
|
locations.address.country | string |
住所の国 (ISO 3166-1-alpha-2 形式)。 |
タイム ゾーン
|
locations.timezone | string |
due_date など、請求書のカレンダーの日付を解釈するために使用されるタイムゾーン。 請求書が作成されると、このフィールドは販売担当者の場所に指定されたタイムゾーンに設定されます。 値は変更できません。 |
能力
|
locations.capabilities | array of string | |
Status
|
locations.status | string |
このオブジェクトの現在の検証状態。 |
作成日時
|
locations.created_at | string |
イベント時刻 (ISO 8601 形式)。 |
マーチャント ID
|
locations.merchant_id | string |
場所を所有するマーチャントの ID。 |
Country
|
locations.country | string |
ISO 3166 Alpha-2 国コード。 |
言語コード
|
locations.language_code | string |
場所に関連付けられている言語 (BCP 47 形式)。 |
通貨
|
locations.currency | string |
3 文字の ISO 4217 通貨コード。 |
電話番号
|
locations.phone_number | string |
顧客プロファイルに関連付けられた 11 桁の電話番号。 |
ビジネス名
|
locations.business_name | string |
場所の会社名。場所の顧客に表示される名前です。 たとえば、この名前は顧客の領収書に表示されます。 |
場所を作成する (ベータ版)
場所を作成します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
件名
|
name | string |
オブジェクトの名前。 |
|
Description
|
description | string |
説明。 |
|
Facebook URL
|
facebook_url | string |
場所の Facebook プロファイル URL。 URL は「facebook.com/」で始まる必要があります。 |
|
Address Line 1
|
address_line_1 | string |
住所の 1 行目。 address_line で始まるフィールドは、番地、通りの名前、建物名など、住所の最も具体的な詳細を指定します。 |
|
Administrative District Level 1
|
administrative_district_level_1 | string |
住所の国内にある市民エンティティ。 米国では、これは州です。 |
|
地域
|
locality | string |
住所の市区町村。 |
|
郵便番号
|
postal_code | string |
住所の郵便番号。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
location.id | string |
Square が発行した一意の識別子。 |
件名
|
location.name | string |
オブジェクトの名前。 |
Address Line 1
|
location.address.address_line_1 | string |
住所の 1 行目。 address_line で始まるフィールドは、番地、通りの名前、建物名など、住所の最も具体的な詳細を指定します。 |
地域
|
location.address.locality | string |
住所の市区町村。 |
Administrative District Level 1
|
location.address.administrative_district_level_1 | string |
住所の国内にある市民エンティティ。 米国では、これは州です。 |
郵便番号
|
location.address.postal_code | string |
住所の郵便番号。 |
能力
|
location.capabilities | array of string | |
Status
|
location.status | string |
このオブジェクトの現在の検証状態。 |
作成日時
|
location.created_at | string |
このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
マーチャント ID
|
location.merchant_id | string |
マーチャントの ID。 |
Country
|
location.country | string |
ISO 3166 Alpha-2 国コード。 |
言語コード
|
location.language_code | string |
言語コードです (BCP 47 形式)。 |
通貨
|
location.currency | string |
3 文字の ISO 4217 通貨コード。 |
タイプ
|
location.type | string |
このオブジェクトの種類。 |
Description
|
location.description | string |
説明 |
Web サイトの URL
|
location.website_url | string |
場所の Web サイトの URL です。 |
Twitter のユーザー名
|
location.twitter_username | string |
「@」記号のない場所の Twitter ユーザー名。 |
Instagram ユーザー名
|
location.instagram_username | string |
「@」記号のない場所の Instagram ユーザー名。 |
Latitude
|
location.coordinates.latitude | float |
度で表された座標の緯度。 |
Longitude
|
location.coordinates.longitude | float |
度で表された座標の経度。 |
MCC
|
location.mcc | string |
ISO 18245 で標準化されている、場所のマーチャント カテゴリ コード (MCC)。 MCC は、その場所で販売される商品またはサービスの種類を説明します。 |
場所を取得する
場所の詳細を取得します。 場所 ID として「main」を指定して、メイン場所の詳細を取得できます。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
場所 ID
|
location_id | True | string |
場所の識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
location.id | string |
Square が発行した一意の識別子。 |
件名
|
location.name | string |
オブジェクトの名前。 |
Address Line 1
|
location.address.address_line_1 | string |
住所の 1 行目。 address_line で始まるフィールドは、番地、通りの名前、建物名など、住所の最も具体的な詳細を指定します。 |
地域
|
location.address.locality | string |
住所の市区町村。 |
Administrative District Level 1
|
location.address.administrative_district_level_1 | string |
住所の国内にある市民エンティティ。 米国では、これは州です。 |
Postal Code
|
location.address.postal_code | string |
住所の郵便番号。 |
Country
|
location.address.country | string |
住所の国 (ISO 3166-1-alpha-2 形式)。 |
タイム ゾーン
|
location.timezone | string |
カレンダーの日付を解釈するために使用されるタイム ゾーン。 請求書が作成されると、このフィールドは販売担当者の場所に指定されたタイムゾーンに設定されます。 値は変更できません。 |
能力
|
location.capabilities | array of string | |
Status
|
location.status | string |
このオブジェクトの現在の検証状態。 |
作成日時
|
location.created_at | string |
このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
マーチャント ID
|
location.merchant_id | string |
マーチャントの ID。 |
Country
|
location.country | string |
ISO 3166 Alpha-2 国コード。 |
言語コード
|
location.language_code | string |
言語コードです (BCP 47 形式)。 |
通貨
|
location.currency | string |
3 文字の ISO 4217 通貨コード。 |
電話番号
|
location.phone_number | string |
顧客プロファイルに関連付けられた 11 桁の電話番号。 |
ビジネス名
|
location.business_name | string |
場所の会社名。場所の顧客に表示される名前です。 たとえば、この名前は顧客の領収書に表示されます。 |
場所を更新する (ベータ版)
場所を更新します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
場所 ID
|
location_id | True | string |
場所の識別子。 |
件名
|
name | string |
オブジェクトの名前。 |
|
Description
|
description | string |
説明 |
|
Facebook URL
|
facebook_url | string |
場所の Facebook プロファイル URL。 URL は「facebook.com/」で始まる必要があります。 |
|
Twitter のユーザー名
|
twitter_username | string |
「@」記号のない場所の Twitter ユーザー名。 |
|
Instagram ユーザー名
|
instagram_username | string |
「@」記号のない場所の Instagram ユーザー名。 |
|
Address Line 1
|
address_line_1 | string |
住所の 1 行目。 address_line で始まるフィールドは、番地、通りの名前、建物名など、住所の最も具体的な詳細を指定します。 |
|
Administrative District Level 1
|
administrative_district_level_1 | string |
住所の国内にある市民エンティティ。 米国では、これは州です。 |
|
地域
|
locality | string |
住所の市区町村。 |
|
郵便番号
|
postal_code | string |
住所の郵便番号。 |
|
曜日
|
day_of_week | string |
この期間の曜日。 |
|
開始ローカル時刻
|
start_local_time | string |
営業時間期間の開始時刻。部分時間 RFC 3339 形式を使用して現地時間で指定されます。 |
|
終了ローカル時刻
|
end_local_time | string |
営業時間期間の終了時刻。部分時間 RFC 3339 形式を使用して現地時間で指定されます。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
location.id | string |
Square が発行した一意の識別子。 |
件名
|
location.name | string |
オブジェクトの名前。 |
Address Line 1
|
location.address.address_line_1 | string |
住所の 1 行目。 address_line で始まるフィールドは、番地、通りの名前、建物名など、住所の最も具体的な詳細を指定します。 |
地域
|
location.address.locality | string |
住所の市区町村。 |
Administrative District Level 1
|
location.address.administrative_district_level_1 | string |
住所の国内にある市民エンティティ。 米国では、これは州です。 |
郵便番号
|
location.address.postal_code | string |
住所の郵便番号。 |
タイム ゾーン
|
location.timezone | string |
カレンダーの日付を解釈するために使用されるタイム ゾーン。 請求書が作成されると、このフィールドは販売担当者の場所に指定されたタイムゾーンに設定されます。 値は変更できません。 |
能力
|
location.capabilities | array of string | |
Status
|
location.status | string |
このオブジェクトの現在の検証状態。 |
作成日時
|
location.created_at | string |
このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
マーチャント ID
|
location.merchant_id | string |
マーチャントの ID。 |
Country
|
location.country | string |
ISO 3166 Alpha-2 国コード。 |
言語コード
|
location.language_code | string |
言語コードです (BCP 47 形式)。 |
通貨
|
location.currency | string |
3 文字の ISO 4217 通貨コード。 |
電話番号
|
location.phone_number | string |
顧客プロファイルに関連付けられた 11 桁の電話番号。 |
ビジネス名
|
location.business_name | string |
場所の会社名。場所の顧客に表示される名前です。 たとえば、この名前は顧客の領収書に表示されます。 |
タイプ
|
location.type | string |
このオブジェクトの種類。 |
Web サイトの URL
|
location.website_url | string |
場所の Web サイトの URL です。 |
期間
|
location.business_hours.periods | array of object | |
曜日
|
location.business_hours.periods.day_of_week | string |
この期間の曜日。 |
開始ローカル時刻
|
location.business_hours.periods.start_local_time | string |
営業時間期間の開始時刻。部分時間 RFC 3339 形式を使用して現地時間で指定されます。 |
終了ローカル時刻
|
location.business_hours.periods.end_local_time | string |
営業時間期間の終了時刻。部分時間 RFC 3339 形式を使用して現地時間で指定されます。 |
勤務先メール
|
location.business_email | string |
場所のメール。 このメールは、その場所の顧客に表示されます。 たとえば、メールは顧客の領収書に表示されます。 |
Description
|
location.description | string |
説明 |
Twitter のユーザー名
|
location.twitter_username | string |
「@」記号のない場所の Twitter ユーザー名。 |
Instagram ユーザー名
|
location.instagram_username | string |
「@」記号のない場所の Instagram ユーザー名。 |
Latitude
|
location.coordinates.latitude | float |
度で表された座標の緯度。 |
Longitude
|
location.coordinates.longitude | float |
度で表された座標の経度。 |
MCC
|
location.mcc | string |
ISO 18245 で標準化されている、場所のマーチャント カテゴリ コード (MCC)。 MCC は、その場所で販売される商品またはサービスの種類を説明します。 |
平日構成の一覧表示
ビジネスの WorkweekConfig インスタンスのリストを返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
限度
|
limit | integer |
応答で返す数の上限。 |
|
カーソル
|
cursor | string |
このエンドポイントへの前回の呼び出しによって返されたページネーション カーソル。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
平日構成
|
workweek_configs | array of object | |
ID
|
workweek_configs.id | string |
Square が発行した一意の識別子。 |
週の開始日
|
workweek_configs.start_of_week | string |
報酬目的で営業週が終了する曜日。 |
就業開始 (ローカル時刻)
|
workweek_configs.start_of_day_local_time | string |
営業週が終了する現地時刻。 HH:MM 形式の文字列として表されます (HH:MM:SS も受け入れられますが、秒は切り捨てられます)。 |
[バージョン]
|
workweek_configs.version | integer |
オブジェクトの現在のバージョン。 |
作成日時
|
workweek_configs.created_at | string |
イベント時刻 (ISO 8601 形式)。 |
更新日時
|
workweek_configs.updated_at | string |
最終変更タイムスタンプ (RFC 3339 形式) |
カーソル
|
cursor | string |
このエンドポイントへの後続の呼び出しにページネーション カーソルを含めて、元のクエリに関連付けられた次の結果セットを取得します。 |
空き時間の検索 (ベータ版)
予約の空き状況を検索します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Start At
|
start_at | string |
時間範囲の開始時刻を示す RFC 3339 形式の datetime 値。 |
|
End At
|
end_at | string |
時間範囲の終了時刻を示す RFC 3339 形式の datetime 値。 |
|
場所 ID
|
location_id | string |
指定された販売者の場所 ID に一致する空き状況を検索するためのクエリ式。 |
|
サービス バリエーション ID
|
service_variation_id | string |
このセグメントで予約されたサービスを表す CatalogItemVariation の ID。 |
|
任意
|
any | array of string |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
空き状況
|
availabilities | array of object | |
Start At
|
availabilities.start_at | string |
使用可能なスロットの開始時刻を指定する RFC 3339 タイムスタンプ。 |
場所 ID
|
availabilities.location_id | string |
場所の識別子。 |
予定セグメント
|
availabilities.appointment_segments | array of object | |
期間 (分単位)
|
availabilities.appointment_segments.duration_minutes | integer |
予約セグメントの分単位の期間。 |
Team Member ID
|
availabilities.appointment_segments.team_member_id | string |
このセグメントで予約されたチーム メンバーを表す TeamMember オブジェクトの ID。 |
サービス バリエーション ID
|
availabilities.appointment_segments.service_variation_id | string |
このセグメントで予約されたサービスを表す CatalogItemVariation オブジェクトの ID。 |
サービス バリエーションのバージョン
|
availabilities.appointment_segments.service_variation_version | integer |
このセグメントで予約されたサービスを表すアイテム バリエーションの現行バージョン。 |
エラー
|
errors | array of |
賃金設定を取得する
TeamMember id で指定されたチーム メンバーの WageSetting オブジェクトを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Team Member ID
|
team_member_id | True | string |
チーム メンバーの識別子。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
Team Member ID
|
wage_setting.team_member_id | string |
チーム メンバーの ID。 |
ジョブ割り当て
|
wage_setting.job_assignments | array of object | |
役職
|
wage_setting.job_assignments.job_title | string |
ジョブのタイトル。 |
支払の種類
|
wage_setting.job_assignments.pay_type | string |
給与期間の給与額の計算に使用されるジョブ割り当ての現在の給与タイプ。 |
量
|
wage_setting.job_assignments.hourly_rate.amount | integer |
金額。 |
通貨
|
wage_setting.job_assignments.hourly_rate.currency | string |
通貨。 |
量
|
wage_setting.job_assignments.annual_rate.amount | integer |
金額。 |
通貨
|
wage_setting.job_assignments.annual_rate.currency | string |
通貨。 |
週次時間数
|
wage_setting.job_assignments.weekly_hours | integer |
仕事のための週あたりの計画時間数。 ジョブ PayType が SALARY の場合に設定します。 |
残業免除である
|
wage_setting.is_overtime_exempt | boolean |
チーム メンバーが販売者の国の残業規則から免除されているかどうか。 |
[バージョン]
|
wage_setting.version | integer |
このオブジェクトの現在のバージョン。 |
作成日時
|
wage_setting.created_at | string |
このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
更新日時
|
wage_setting.updated_at | string |
このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
賃金設定を更新する
WageSetting オブジェクトを作成または更新します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Team Member ID
|
team_member_id | True | string |
チーム メンバーの識別子。 |
残業免除である
|
is_overtime_exempt | boolean |
チーム メンバーが販売者の国の残業規則から免除されているかどうか。 |
|
役職
|
job_title | string |
ジョブのタイトル。 |
|
支払の種類
|
pay_type | string |
給与期間の給与額の計算に使用されるジョブ割り当ての現在の給与タイプ。 |
|
量
|
amount | integer |
金額。 |
|
通貨
|
currency | string |
通貨。 |
|
週次時間数
|
weekly_hours | integer |
仕事のための週あたりの計画時間数。 ジョブ PayType が SALARY の場合に設定します。 |
|
量
|
amount | integer |
金額。 |
|
通貨
|
currency | string |
通貨。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
Team Member ID
|
wage_setting.team_member_id | string |
チーム メンバーの ID。 |
ジョブ割り当て
|
wage_setting.job_assignments | array of object | |
役職
|
wage_setting.job_assignments.job_title | string |
ジョブのタイトル。 |
支払の種類
|
wage_setting.job_assignments.pay_type | string |
給与期間の給与額の計算に使用されるジョブ割り当ての現在の給与タイプ。 |
量
|
wage_setting.job_assignments.hourly_rate.amount | integer |
金額。 |
通貨
|
wage_setting.job_assignments.hourly_rate.currency | string |
通貨。 |
量
|
wage_setting.job_assignments.annual_rate.amount | integer |
金額。 |
通貨
|
wage_setting.job_assignments.annual_rate.currency | string |
通貨。 |
週次時間数
|
wage_setting.job_assignments.weekly_hours | integer |
仕事のための週あたりの計画時間数。 ジョブ PayType が SALARY の場合に設定します。 |
残業免除である
|
wage_setting.is_overtime_exempt | boolean |
チーム メンバーが販売者の国の残業規則から免除されているかどうか。 |
[バージョン]
|
wage_setting.version | integer |
このオブジェクトの現在のバージョン。 |
作成日時
|
wage_setting.created_at | string |
このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
更新日時
|
wage_setting.updated_at | string |
このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
銀行口座を一覧表示する
Square アカウントにリンクされている BankAccount オブジェクトのリストを返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
カーソル
|
cursor | string |
このエンドポイントへの前回の呼び出しによって返されたページネーション カーソル。 |
|
限度
|
limit | integer |
応答で返す数の上限。 |
|
場所 ID
|
location_id | string |
このオプション フィルターを指定して、特定の場所に属するレコードのみを取得できます。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
銀行口座
|
bank_accounts | array of object | |
ID
|
bank_accounts.id | string |
Square が発行した一意の識別子。 |
口座番号サフィックス
|
bank_accounts.account_number_suffix | string |
口座番号の末尾数桁。 |
Country
|
bank_accounts.country | string |
ISO 3166 Alpha-2 国コード。 |
通貨
|
bank_accounts.currency | string |
3 文字の ISO 4217 通貨コード。 |
アカウントの種類
|
bank_accounts.account_type | string |
関連付けられた銀行口座の金銭的目的。 |
所有者の氏名
|
bank_accounts.holder_name | string |
アカウント所有者の名前。 この名前は、対象の銀行口座レコードの名前と一致する必要があります。 |
プライマリ銀行 ID 番号
|
bank_accounts.primary_bank_identification_number | string |
銀行のプライマリ識別子。 |
場所 ID
|
bank_accounts.location_id | string |
場所の識別子。 |
Status
|
bank_accounts.status | string |
このオブジェクトの現在の検証状態。 |
貸方記入可能
|
bank_accounts.creditable | boolean |
Square がこの銀行口座に送金できるかどうかを示します。 |
借方記入可能
|
bank_accounts.debitable | boolean |
Square がこの銀行口座に送金できるかどうかを示します。 |
[バージョン]
|
bank_accounts.version | integer |
オブジェクトの現在のバージョン。 |
銀行名
|
bank_accounts.bank_name | string |
実際の金融機関の名前。 |
銀行口座を取得する
Square アカウントにリンクされている BankAccount の詳細を返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
銀行口座 ID
|
bank_account_id | True | string |
希望する BankAccount の Square 発行 ID。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
bank_account.id | string |
Square が発行した一意の識別子。 |
口座番号サフィックス
|
bank_account.account_number_suffix | string |
口座番号の末尾数桁。 |
Country
|
bank_account.country | string |
ISO 3166 Alpha-2 国コード。 |
通貨
|
bank_account.currency | string |
3 文字の ISO 4217 通貨コード。 |
口座の種類
|
bank_account.account_type | string |
口座の種類。 |
所有者の氏名
|
bank_account.holder_name | string |
アカウント所有者の名前。 |
プライマリ銀行 ID 番号
|
bank_account.primary_bank_identification_number | string |
銀行のプライマリ識別子。 |
場所 ID
|
bank_account.location_id | string |
場所の識別子。 |
Status
|
bank_account.status | string |
このオブジェクトの現在の検証状態。 |
貸方記入可能
|
bank_account.creditable | boolean |
Square がこの口座に送金できるかどうかを示します。 |
借方記入可能
|
bank_account.debitable | boolean |
Square がこの口座から金額を取得できるかどうかを示します。 |
[バージョン]
|
bank_account.version | integer |
このオブジェクトの現在のバージョン。 |
銀行名
|
bank_account.bank_name | string |
実際の金融機関の名前。 |
顧客のリンクをギフト カードから解除する (ベータ版)
顧客のリンクをギフト カードから解除します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ギフト カード ID
|
gift_card_id | True | string |
ギフト カードの識別子。 |
顧客 ID
|
customer_id | string |
リンクする顧客の ID。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
gift_card.id | string |
Square が発行した一意の識別子。 |
タイプ
|
gift_card.type | string |
このオブジェクトの種類。 |
GAN ソース
|
gift_card.gan_source | string |
ギフト カードのアカウント番号 (GAN) が Square によって生成されたものか、Square 以外のシステムからインポートされたものかを示します。 |
状態
|
gift_card.state | string |
現在の状態。 |
量
|
gift_card.balance_money.amount | integer |
金額。 |
通貨
|
gift_card.balance_money.currency | string |
通貨。 |
GaN
|
gift_card.gan | string |
ギフト カードのアカウント番号。 |
作成日時
|
gift_card.created_at | string |
このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
顧客をギフト カードにリンクする (ベータ版)
顧客をギフト カードにリンクします
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ギフト カード ID
|
gift_card_id | True | string |
ギフト カードの識別子。 |
顧客 ID
|
customer_id | string |
リンクする顧客の ID。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
ID
|
gift_card.id | string |
Square が発行した一意の識別子。 |
タイプ
|
gift_card.type | string |
このオブジェクトの種類。 |
GAN ソース
|
gift_card.gan_source | string |
ギフト カードのアカウント番号 (GAN) が Square によって生成されたものか、Square 以外のシステムからインポートされたものかを示します。 |
状態
|
gift_card.state | string |
現在の状態。 |
量
|
gift_card.balance_money.amount | integer |
金額。 |
通貨
|
gift_card.balance_money.currency | string |
通貨。 |
GaN
|
gift_card.gan | string |
ギフト カードのアカウント番号。 |
作成日時
|
gift_card.created_at | string |
このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。 |
Customer IDs
|
gift_card.customer_ids | array of string |
定義
オブジェクト
’オブジェクト’ という種類です。