Square Payments (Independent Publisher) (プレビュー)

Squareは、何百万人もの売り手が安全なクレジットカード処理から販売時点管理ソリューションまで、ビジネスを運営するのに役立ちます。 このコネクタには、支払い、ターミナル、注文、サブスクリプション、請求書、カタログ、在庫、顧客の各エンドポイントに対するアクションが含まれています。

このコネクタは、次の製品とリージョンで使用できます。

サービス	クラス	リージョン
コピロット スタジオ	Premium	次を除くすべての Power Automate リージョン :      - 米国政府 (GCC)      - 米国政府 (GCC High)      - 21Vianet が運営する China Cloud      - 米国国防総省 (DoD)
ロジック アプリ	Standard	次を除くすべての Logic Apps リージョン :      - Azure Government リージョン      - Azure China リージョン      - 米国国防総省 (DoD)
Power Apps	Premium	次を除くすべての Power Apps リージョン :      - 米国政府 (GCC)      - 米国政府 (GCC High)      - 21Vianet が運営する China Cloud      - 米国国防総省 (DoD)
Power Automate	Premium	次を除くすべての Power Automate リージョン :      - 米国政府 (GCC)      - 米国政府 (GCC High)      - 21Vianet が運営する China Cloud      - 米国国防総省 (DoD)

お問い合わせ
名前	トロイ・テイラー
URL	https://www.hitachisolutions.com
Email	ttaylor@hitachisolutions.com

コネクタ メタデータ
Publisher	トロイ・テイラー
Web サイト	https://squareup.com/
プライバシー ポリシー	https://squareup.com/us/en/legal/general/privacy
カテゴリ	商業;売上と CRM

調整制限

名前	呼び出し	更新期間
接続ごとの API 呼び出し	100	60 秒

アクション

Apple Pay のドメインを登録する	Apple Pay on the Web および Square で使用するドメインをアクティブ化します。 Apple によってこのドメインに対して検証が実行され、Apple Pay 対応ドメインとして適切に設定されていることを確認します。
Pay order (Beta)	1 つ以上の承認された支払いを使用して注文を支払うか、合計 0 の注文を決済します。 要求にリストされているpayment_idsの合計は、注文の合計と等しい必要があります。 合計金額が 0 の注文は、要求に空のpayment_ids配列を指定することで、支払済みとしてマークできます。
Upsert カタログ オブジェクト	ターゲット CatalogObject を作成または更新します。
べき等キーによる支払いを取り消す	要求で指定されたべき等キーによって識別される支払を取り消します (無効)。 CreatePayment 要求の状態が不明な場合 (たとえば、CreatePayment 要求を送信した後、ネットワーク エラーが発生し、応答が返されない場合など) は、このメソッドを使用します。 この場合、このエンドポイントを使用して支払いを取り消すように Square に指示できます。 要求では、キャンセルする CreatePayment 要求で指定したのと同じべき等キーを指定します。 支払いを取り消した後、CreatePayment 要求をもう一度送信できます。 指定したべき等キーによる支払いが見つからない場合は、何も行われず、エンドポイントは正常に返されることに注意してください。
アイテムの税金を更新する	対象の CatalogItem に適用される CatalogTax オブジェクトを、アイテム全体に対してアップサートを実行せずに更新します。
アイテム修飾子リストを更新する	アイテム全体にアップサートを実行しなくても、対象の CatalogItem に適用される CatalogModifierList オブジェクトを更新します。
インベントリの実数を取得する	指定されたphysical_count_idを持つ InventoryPhysicalCount オブジェクトを返します。
インベントリの数を取得する	特定の場所のセットにある特定の CatalogObject の現在の計算済み在庫数を取得します。
インベントリ転送の取得 (ベータ)	指定されたtransfer_idを持つ InventoryTransfer オブジェクトを返します。
カタログ オブジェクトのバッチアップサート	指定されたオブジェクトの一覧に基づいて、最大 10,000 個のターゲット オブジェクトを作成または更新します。 ターゲット オブジェクトはバッチにグループ化され、各バッチは、すべてまたは何もしない方法で挿入/更新されます。 バッチ内のオブジェクトが何らかの形式で形式が正しくない場合、またはデータベース制約に違反している場合、その項目を含むバッチ全体は無視されます。 ただし、同じ要求内の他のバッチは引き続き成功する可能性があります。 各バッチには最大 1,000 個のオブジェクトが含まれる場合があり、要求のオブジェクト数の合計 (アイテム、バリエーション、修飾子リスト、割引、税金) が 10,000 以下であれば、バッチは順番に処理されます。
カタログ オブジェクトのバッチ削除	指定されたターゲット ID の一覧に基づいて CatalogItems のセットを削除し、応答で正常に削除された ID のセットを返します。
カタログ オブジェクトの検索	サポートされている検索属性値 (項目または項目のバリエーションのカスタム属性値を除く) を、指定されたクエリ フィルターの 1 つ以上に対して照合することで、任意の種類の CatalogObject を検索します。
カタログ オブジェクトを削除する	指定された ID に基づいて 1 つの CatalogObject を削除し、応答で正常に削除された ID のセットを返します。 削除は、ターゲット オブジェクトのすべての子も削除されるように連鎖するイベントです。 たとえば、CatalogItem を削除すると、CatalogItemVariation のすべての子も削除されます。
カタログ オブジェクトを取得する	指定された ID に基づいて、CatalogObject として 1 つの CatalogItem を返します。 返されるオブジェクトには、CatalogItemVariation 子、CatalogModifierList オブジェクトへの参照、それに適用されるすべての CatalogTax オブジェクトの ID など、関連するすべての CatalogItem 情報が含まれます。
カタログを一覧表示する	カタログ内の一連の必要な型 (たとえば、すべての CatalogItem オブジェクトと CatalogTax オブジェクト) のすべてのオブジェクトを含む CatalogObjects の一覧を返します。 ListCatalog は、削除されたカタログ アイテムを返しません。
カタログ情報	BatchUpsertCatalogObjects エンドポイントで使用できるバッチ サイズの制限など、Square Catalog API に関する情報を取得します。
カードの作成	ファイル上のカードを既存のマーチャントに追加します。
カードを一覧表示する	要求を行うアカウントが所有するカードの一覧を取得します。
カードを取得する	特定のカードの詳細を取得します。
カードを無効にする	カードを無効にして、それ以上の更新や料金が発生しないようにします。 既に無効になっているカードの無効化は許可されますが、効果はありません。
サブスクリプション イベントを一覧表示する	特定のサブスクリプションのすべてのイベントを一覧表示します。
サブスクリプションのキャンセル	[canceled_date] フィールドをアクティブな請求期間の末尾に設定します。 この日付を過ぎると、状態は ACTIVE から CANCELED に変わります。
サブスクリプションの再開	非アクティブ化されたサブスクリプションを再開します。
サブスクリプションの検索	サブスクリプションを検索します。 結果は、サブスクリプションの作成日ごとに時系列に並べ替えます。 要求で複数の場所 ID が指定されている場合、エンドポイントは、場所 ID によって結果を並べ替え、次に各場所内の作成日で結果を並べ替えます。 クエリに場所が指定されていない場合は、すべての場所が検索されます。
サブスクリプションを作成する	顧客のサブスクリプションをサブスクリプション プランに作成します。 要求でカードをファイルに入力した場合、Square はサブスクリプションのカードを請求します。 それ以外の場合、Square は顧客のメール アドレスに請求書を請求します。 要求にオプションのstart_dateが含まれている場合を除き、サブスクリプションはすぐに開始されます。 個々のサブスクリプションは、特定の場所に関連付けられます。
サブスクリプションを取得する	サブスクリプションを取得します。
サブスクリプションを更新する	サブスクリプションを更新します。 サブスクリプション フィールドの値を設定、変更、クリアできます。
ターミナル チェックアウトを作成する	ターミナル チェックアウト要求を作成し、指定したデバイスに送信して、要求された金額の支払いを受け取ります。
ターミナル チェックアウトを取得する	checkout_idでターミナル チェックアウト要求を取得します。
ターミナルのチェックアウトをキャンセルする	要求の状態で許可されている場合は、ターミナル チェックアウト要求を取り消します。
ターミナルのチェックアウトを検索する	要求を行っているアカウントによって作成されたターミナル チェックアウト要求のフィルター処理された一覧を取得します。
ターミナルの払い戻しを作成する	スクエア ターミナルで完了した Interac 支払いを払い戻す要求を作成します。
ターミナルの払い戻しを取り消す	要求の状態で許可されている場合は、払い戻し要求 ID によって Interac ターミナルの払い戻し要求を取り消します。
ターミナルの払い戻しを受ける	ID で Interac ターミナルの払い戻しオブジェクトを取得します。
バッチでインベントリの変更を取得する	指定されたフィルター条件に基づいて、物理カウントと調整の履歴を返します。
バッチでインベントリ数を取得する	要求された場所で指定された CatalogObject の現在の数を返します。
バッチで注文を取得する	ID によって注文のセットを取得します。 特定の注文 ID が存在しない場合、ID はエラーを生成する代わりに無視されます。
バッチ取得カタログ オブジェクト	指定された ID に基づいてオブジェクトのセットを返します。 セットで返される各 CatalogItem には、すべての CatalogItemVariation オブジェクト、CatalogModifierList オブジェクトへの参照、それに適用されるすべての CatalogTax オブジェクトの ID など、すべての子情報が含まれます。
バッチ変更インベントリ	指定された品目数量に調整とカウントを適用します。 成功した場合: 要求で参照されているすべてのオブジェクトの現在の計算カウントを返します。
在庫調整の取得	指定されたadjustment_idを持つ InventoryAdjustment オブジェクトを返します。
払い戻しの支払い	支払いを払い戻します。 支払い金額全体またはその一部を払い戻すことができます。 このエンドポイントを使用して、カードの支払いを返金したり、現金または外部支払いの払い戻しを記録したりすることができます。
支払いの完了	支払いを完了 (キャプチャ) します。 既定では、支払いは作成された直後に完了するように設定されます。
支払いの払い戻しを一覧表示する	要求を行っているアカウントの払い戻しの一覧を取得します。 結果は最終的に一貫しており、新しい払い戻しや払い戻しの変更が表示されるまでに数秒かかる場合があります。
支払いの払い戻しを受ける	refund_idを使用して特定の払い戻しを取得します。
支払いを一覧表示する	要求を行うアカウントによって取得された支払いの一覧を取得します。 結果は最終的に一貫しており、新しい支払いや支払いの変更が表示されるまでに数秒かかる場合があります。
支払いを作成する	指定されたソースを使用して支払いを作成します。 このエンドポイントを使用して、カード (クレジット/デビット カードまたは Square ギフト カード) を請求したり、販売者が Square の外部で受け取った支払い (購入者からの現金支払い、または外部エンティティが販売者に代わって処理した支払い) を記録したりできます。
支払いを取り消す	支払いをキャンセル (無効) します。 このエンドポイントを使用して、APPROVED 状態の支払いを取り消すことができます。
支払いを取得する	特定の支払いの詳細を取得します。
支払いを更新する	承認済みの状態で支払いを更新します。 このエンドポイントを使用して、amount_moneyとtip_moneyを更新できます。
更新順序 (ベータ)	フィールドを追加、置換、または削除して、開いている注文を更新します。 COMPLETED または CANCELED 状態の注文は更新できません。
検索ターミナルの払い戻し	要求を行っている販売者によって作成された Interac ターミナル払い戻し要求のフィルター処理された一覧を取得します。
検索順序	すべての注文で 1 つ以上の場所を検索します。 注文には、Square エコシステム (POS、請求書、Connect API など) に入った方法やタイミングに関係なく、すべての販売、返品、交換が含まれます。
注文の作成	購入の製品に関する情報と、購入に適用する設定を含めることができる新しい注文を作成します。
紛争の証拠を一覧表示する	紛争に関連する証拠の一覧を返します。
紛争の証拠を削除する	紛争から指定された証拠を削除します。
紛争の証拠を取得する	要求 URL パスの証拠 ID で指定された証拠メタデータを返します。 後で参照する場合は、アップロードする証拠のコピーを保持する必要があります。 アップロード後に証拠をダウンロードすることはできません。
紛争を一覧表示する	特定のアカウントに関連付けられている紛争の一覧を返します。
紛争を取得する	特定の紛争に関する詳細を返します。
紛争を受け入れる	紛争の損失を受け入れます。 Square は、紛争の金額をカード所有者に返し、紛争状態を ACCEPTED に更新します。 Square は、販売者の Square アカウントから紛争中の金額を引き落とします。 Square アカウントに十分な資金がない場合、Square は関連付けられている銀行口座を借方に引き落とします。
紛争証拠のテキストを作成する	紛争チャレンジの証拠として使用するテキストをアップロードします。
複製順序 (ベータ)	既存の注文を複製して、新しい注文を下書き状態で作成します。 新しく作成された注文には、元の注文からコピーされたコア フィールド (品目、税金、割引など) のみが含まれます。
証拠を送信する	カード所有者の銀行に証拠を提出します。 証拠を提出する前に、Square は使用可能なすべての証拠をコンパイルします。 これには、CreateDisputeEvidenceFile エンドポイントと CreateDisputeEvidenceText エンドポイントを使用してアップロードされた証拠と、Square によって自動的に提供される証拠 (使用可能な場合) が含まれます。
請求書の作成	Orders API を使用して作成された注文の下書き請求書を作成します。 下書き請求書はアカウントに残り、何も行われません。 Square が処理する前に請求書を発行する必要があります (顧客のメール アドレスに送信するか、ファイルで顧客のカードに請求します)。
請求書の削除	指定した請求書を削除します。 請求書が削除されると、関連付けられている注文の状態が CANCELED に変わります。 下書き請求書のみを削除できます (発行済みの請求書 (処理がスケジュールされている請求書を含む) は削除できません)。
請求書の取り消し	請求書を取り消します。 販売者は、取り消された請求書の支払いを収集できません。
請求書の更新	フィールド、消込フィールド、またはその両方を変更して請求書を更新します。
請求書を一覧表示する	特定の場所の請求書の一覧を返します。
請求書を取得する	請求書 ID で請求書を取得します。
請求書を検索する	フィルターで指定された場所から請求書を検索します。
請求書を発行する	指定した下書き請求書を発行します。 請求書が発行されると、Square は請求書の構成に基づいてフォローアップします。 たとえば、Square は請求書を顧客のメール アドレスに送信したり、顧客のカードをファイルに請求したり、何も行ったりしません。 Square は、正方形でホストされる請求書ページでも請求書を利用できるようにします。
順序の計算 (ベータ)	アプリケーションが注文を作成せずに注文価格をプレビューできるようにします。
順序を取得する	ID で Order を取得します。
顧客からグループを削除する	顧客からグループ メンバーシップを削除します。 顧客はcustomer_id値によって識別され、顧客グループはgroup_id値によって識別されます。
顧客にグループを追加する	顧客にグループ メンバーシップを追加します。 顧客はcustomer_id値によって識別され、顧客グループはgroup_id値によって識別されます。
顧客を一覧表示する	Square アカウントに関連付けられている顧客プロファイルを一覧表示します。 通常の運用条件下では、新しく作成または更新された顧客プロファイルは、30 秒以内に登録登録操作に使用できるようになります。 新しいプロファイルまたは更新されたプロファイルの伝達には、特にネットワーク インシデントや停止時に、1 分以上かかる場合があります。
顧客を作成する	ビジネス向けの新しい顧客を作成します。
顧客を削除する	ビジネスから顧客プロファイルを削除します。 この操作により、ファイル上の関連付けられているカードのリンクも解除されます。
顧客を取得する	1 人の顧客の詳細を返します。
顧客を更新する	顧客プロファイルを更新します。 属性を変更するには、新しい値を指定します。 属性を削除するには、空の文字列または空のオブジェクトとして値を指定します。
顧客を検索する	サポートされているクエリ フィルターを使用して、Square アカウントに関連付けられている顧客プロファイルを検索します。 明示的なクエリ フィルターを使用せずに SearchCustomers を呼び出すと、given_nameとfamily_nameに基づいて、すべての顧客プロファイルがアルファベット順に並べ替えられます。
顧客グループを一覧表示する	ビジネスの顧客グループの一覧を取得します。
顧客グループを作成する	ビジネス用の新しい顧客グループを作成します。
顧客グループを削除する	group_id値によって識別される顧客グループを削除します。
顧客グループを取得する	特定の顧客グループを取得します。
顧客グループを更新する	顧客グループを更新します。
顧客セグメントを一覧表示する	ビジネスの顧客セグメントの一覧を取得します。
顧客セグメントを取得する	特定の顧客セグメントを取得します。

Apple Pay のドメインを登録する

操作 ID:

ApplePayRegister

Apple Pay on the Web および Square で使用するドメインをアクティブ化します。 Apple によってこのドメインに対して検証が実行され、Apple Pay 対応ドメインとして適切に設定されていることを確認します。

パラメーター

名前	キー	必須	型	説明
ドメイン名	domain_name	True	string	Apple Pay に登録される RFC-1034 で説明されているドメイン名。

戻り値

名前	パス	型	説明
ステータス	status	string	ドメイン登録の状態。

Pay order (Beta)

操作 ID:

OrderPay

1 つ以上の承認された支払いを使用して注文を支払うか、合計 0 の注文を決済します。 要求にリストされているpayment_idsの合計は、注文の合計と等しい必要があります。 合計金額が 0 の注文は、要求に空のpayment_ids配列を指定することで、支払済みとしてマークできます。

パラメーター

名前	キー	必須	型	説明
注文 ID	order_id	True	string	注文の識別子。
べき等キー	idempotency_key		string	すべての要求の中でこの要求を一意に識別する値を指定します。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。
支払い ID	payment_ids		array of string

戻り値

名前	パス	型	説明
ID	order.id	string	Square で発行された一意の識別子。
場所 ID	order.location_id	string	場所の識別子。
行項目	order.line_items	array of object
UID	order.line_items.uid	string	正方形で生成された ID。
数量	order.line_items.quantity	string	10 進文字列としての物理カウントの影響を受ける項目の数。 この数値は、小数点の後に最大 5 桁までサポートできます。
名前	order.line_items.name	string	アイテムの名前。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、その値を空にすることはできません。長さは Unicode コード ポイントです。
金額	order.line_items.base_price_money.amount	integer	金額。
通貨	order.line_items.base_price_money.currency	string	通貨。
金額	order.line_items.gross_sales_money.amount	integer	金額。
通貨	order.line_items.gross_sales_money.currency	string	通貨。
金額	order.line_items.total_tax_money.amount	integer	金額。
通貨	order.line_items.total_tax_money.currency	string	通貨。
金額	order.line_items.total_discount_money.amount	integer	金額。
通貨	order.line_items.total_discount_money.currency	string	通貨。
金額	order.line_items.total_money.amount	integer	金額。
通貨	order.line_items.total_money.currency	string	通貨。
Created At	order.created_at	string	RFC 3339 形式で、このオブジェクトの作成時刻を指定するタイムスタンプ。
更新日時	order.updated_at	string	RFC 3339 形式で、このオブジェクトの最新の更新時刻を指定するタイムスタンプ。
バージョン	order.version	integer	このオブジェクトの現在のバージョン。
金額	order.total_tax_money.amount	integer	金額。
通貨	order.total_tax_money.currency	string	通貨。
金額	order.total_discount_money.amount	integer	金額。
通貨	order.total_discount_money.currency	string	通貨。
金額	order.total_money.amount	integer	金額。
通貨	order.total_money.currency	string	通貨。
クローズ日	order.closed_at	string	閉じた時刻 (ISO 8601 形式)。
入札	order.tenders	array of object
ID	order.tenders.id	string	オブジェクトの識別子
場所 ID	order.tenders.location_id	string	この入札の一部を受け取る受信者 (販売者以外) の場所 ID。
トランザクション ID	order.tenders.transaction_id	string	入札に関連付けられているトランザクションの ID。
Created At	order.tenders.created_at	string	作成時のタイムスタンプ (RFC 3339 形式)。
金額	order.tenders.amount_money.amount	integer	金額。
通貨	order.tenders.amount_money.currency	string	通貨。
タイプ	order.tenders.type	string	型を示します。
ステータス	order.tenders.card_details.status	string	クレジット カード支払いの現在の状態 (AUTHORIZED や CAPTURED など)
カード ブランド	order.tenders.card_details.card.card_brand	string	カードのブランド。
last_4	order.tenders.card_details.card.last_4	string	カード番号の最後の 4 桁。
Exp Month	order.tenders.card_details.card.exp_month	integer	関連付けられているカードの有効期限の月を 1 ~ 12 の整数で指定します。
Exp Year	order.tenders.card_details.card.exp_year	integer	カードの有効期限の 4 桁の年。
指紋	order.tenders.card_details.card.fingerprint	string	1 つのアプリケーション内の複数の場所でカードを識別するために、カード番号に基づいて、正方形に割り当てられた識別子として意図されています。
Entry メソッド	order.tenders.card_details.entry_method	string	トランザクションのカードの詳細を入力するために使用されるメソッド。
決済識別子	order.tenders.payment_id	string	2 乗で生成された支払いの一意の ID。
金額	order.total_service_charge_money.amount	integer	金額。
通貨	order.total_service_charge_money.currency	string	通貨。
金額	order.net_amounts.total_money.amount	integer	金額。
通貨	order.net_amounts.total_money.currency	string	通貨。
金額	order.net_amounts.tax_money.amount	integer	金額。
通貨	order.net_amounts.tax_money.currency	string	通貨。
金額	order.net_amounts.discount_money.amount	integer	金額。
通貨	order.net_amounts.discount_money.currency	string	通貨。
金額	order.net_amounts.tip_money.amount	integer	金額。
通貨	order.net_amounts.tip_money.currency	string	通貨。
金額	order.net_amounts.service_charge_money.amount	integer	金額。
通貨	order.net_amounts.service_charge_money.currency	string	通貨。
名前	order.source.name	string	名前。
State	order.state	string	現在の状態。

Upsert カタログ オブジェクト

操作 ID:

CatalogUpsert

ターゲット CatalogObject を作成または更新します。

パラメーター

名前	キー	必須	型	説明
べき等キー	idempotency_key		string	すべての要求の中でこの要求を一意に識別する値を指定します。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。
ID	id		string	Square で発行された一意の識別子。
タイプ	type		string	このオブジェクトの種類。
Abbreviation	abbreviation		string	販売時点管理アプリのアイテムの表示ラベルのテキスト。 文字列の最初の 5 文字までのみが使用されます。 この属性は検索可能であり、値の長さは Unicode コード ポイントです。
Description	title		string	アイテムの説明。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、値の長さは Unicode コード ポイントです。
名前	name		string	名前。
ID	id		string	カタログ内のこのオブジェクトを参照する識別子。
タイプ	type		string	このオブジェクトの種類。
アイテム ID	item_id		string	この項目バリエーションに関連付けられている CatalogItem の ID。
名前	name		string	アイテム バリエーションの名前。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、値の長さは Unicode コード ポイントです。
価格の種類	pricing_type		string	品目バリエーションの価格を固定するか、販売時に決定するかを示します。
金額	amount		integer	金額。
通貨	currency		string	通貨。

戻り値

名前	パス	型	説明
タイプ	catalog_object.type	string	このオブジェクトの種類。
ID	catalog_object.id	string	Square で発行された一意の識別子。
更新日時	catalog_object.updated_at	string	RFC 3339 形式で、このオブジェクトの最新の更新時刻を指定するタイムスタンプ。
バージョン	catalog_object.version	integer	このオブジェクトの現在のバージョン。
削除済み	catalog_object.is_deleted	boolean	true の場合、オブジェクトはデータベースから削除されています。 挿入する新しいオブジェクトの場合は false にする必要があります。 削除すると、updated_at フィールドは削除時間と等しくなります。
present_at_all_locations	catalog_object.present_at_all_locations	boolean	true の場合、このオブジェクトは、absent_at_location_ids フィールドで指定されている場合を除き、すべての場所 (将来の場所を含む) に存在します。 false の場合、このオブジェクトは、present_at_location_ids フィールドで指定されている場合を除き、(将来の場所を含む) どの場所にも存在しません。 指定しない場合、既定値は true になります。
名前	catalog_object.item_data.name	string	名前。
Description	catalog_object.item_data.title	string	アイテムの説明。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、値の長さは Unicode コード ポイントです。
Abbreviation	catalog_object.item_data.abbreviation	string	販売時点管理アプリのアイテムの表示ラベルのテキスト。 文字列の最初の 5 文字までのみが使用されます。 この属性は検索可能であり、値の長さは Unicode コード ポイントです。
バリエーション	catalog_object.item_data.variations	array of object
タイプ	catalog_object.item_data.variations.type	string	このオブジェクトの種類。
ID	catalog_object.item_data.variations.id	string	カタログ内のこのオブジェクトを参照する識別子。
更新日時	catalog_object.item_data.variations.updated_at	string	RFC 3339 形式の最終変更タイムスタンプ。
バージョン	catalog_object.item_data.variations.version	integer	オブジェクトのバージョン。 オブジェクトを更新する場合、指定されたバージョンはデータベース内のバージョンと一致する必要があります。そうしないと、書き込みが競合として拒否されます。
削除済み	catalog_object.item_data.variations.is_deleted	boolean	true の場合、オブジェクトはデータベースから削除されています。 挿入する新しいオブジェクトの場合は false にする必要があります。 削除すると、updated_at フィールドは削除時間と等しくなります。
すべての場所に存在する	catalog_object.item_data.variations.present_at_all_locations	boolean	true の場合、このオブジェクトは、absent_at_location_ids フィールドで指定されている場合を除き、すべての場所 (将来の場所を含む) に存在します。 false の場合、このオブジェクトは、present_at_location_ids フィールドで指定されている場合を除き、(将来の場所を含む) どの場所にも存在しません。 指定しない場合、既定値は true になります。
アイテム ID	catalog_object.item_data.variations.item_variation_data.item_id	string	この項目バリエーションに関連付けられている CatalogItem の ID。
名前	catalog_object.item_data.variations.item_variation_data.name	string	アイテム バリエーションの名前。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、値の長さは Unicode コード ポイントです。
序数	catalog_object.item_data.variations.item_variation_data.ordinal	integer	この項目のバリエーションを表示する順序。 この値は読み取り専用です。 書き込み時に、親 CatalogItem 内の各項目バリエーションの序数は、項目バリエーションの位置に従って設定されます。 読み取りの場合、値がシーケンシャルまたは一意であるとは限りません。
価格の種類	catalog_object.item_data.variations.item_variation_data.pricing_type	string	品目バリエーションの価格を固定するか、販売時に決定するかを示します。
在庫可能	catalog_object.item_data.variations.item_variation_data.stockable	boolean	在庫をこのバリエーション (TRUE) で直接カウントするか、そのコンポーネント (FALSE) でのみカウントするか。 下位互換性のために、欠損値は TRUE と解釈されます。
金額	catalog_object.item_data.variations.item_variation_data.price_money.amount	integer	金額。
通貨	catalog_object.item_data.variations.item_variation_data.price_money.currency	string	通貨。
製品タイプ	catalog_object.item_data.product_type	string	アイテムの製品の種類。 アイテムが作成された後は変更できない場合があります。
ID マッピング	id_mappings	array of object
クライアント オブジェクト ID	id_mappings.client_object_id	string	新しい CatalogObject のクライアント指定の一時 #プレフィックス付き ID。
オブジェクト ID	id_mappings.object_id	string	サーバーによって作成された永続的な ID。

べき等キーによる支払いを取り消す

操作 ID:

PaymentCancelIdempotency

要求で指定されたべき等キーによって識別される支払を取り消します (無効)。 CreatePayment 要求の状態が不明な場合 (たとえば、CreatePayment 要求を送信した後、ネットワーク エラーが発生し、応答が返されない場合など) は、このメソッドを使用します。 この場合、このエンドポイントを使用して支払いを取り消すように Square に指示できます。 要求では、キャンセルする CreatePayment 要求で指定したのと同じべき等キーを指定します。 支払いを取り消した後、CreatePayment 要求をもう一度送信できます。 指定したべき等キーによる支払いが見つからない場合は、何も行われず、エンドポイントは正常に返されることに注意してください。

パラメーター

名前	キー	必須	型	説明
べき等キー	idempotency_key		string	すべての要求の中でこの要求を一意に識別する値を指定します。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。

戻り値

response

object

アイテムの税金を更新する

操作 ID:

CatalogUpdateTaxes

対象の CatalogItem に適用される CatalogTax オブジェクトを、アイテム全体に対してアップサートを実行せずに更新します。

パラメーター

名前	キー	必須	型	説明
アイテム ID	item_ids		array of string
有効にする税	taxes_to_enable		array of string
無効にする税	taxes_to_disable		array of string

戻り値

名前	パス	型	説明
更新日時	updated_at	string	RFC 3339 形式のこの更新プログラムのデータベース タイムスタンプ。

アイテム修飾子リストを更新する

操作 ID:

CatalogUpdateModifier

アイテム全体にアップサートを実行しなくても、対象の CatalogItem に適用される CatalogModifierList オブジェクトを更新します。

パラメーター

名前	キー	必須	型	説明
アイテム ID	item_ids		array of string
有効にする修飾子リスト	modifier_lists_to_enable		array of string
無効にする修飾子リスト	modifier_lists_to_disable		array of string

戻り値

名前	パス	型	説明
更新日時	updated_at	string	RFC 3339 形式のこの更新プログラムのデータベース タイムスタンプ。

インベントリの実数を取得する

操作 ID:

InventoryRetrievePhysicalCount

指定されたphysical_count_idを持つ InventoryPhysicalCount オブジェクトを返します。

パラメーター

名前	キー	必須	型	説明
物理カウント ID	physical_count_id	True	string	物理カウントの識別子。

戻り値

名前	パス	型	説明
ID	count.id	string	Square で発行された一意の識別子。
参照 ID	count.reference_id	string	省略可能なユーザー定義参照 ID。
カタログ オブジェクト ID	count.catalog_object_id	string	追跡対象の CatalogObject の 2 乗生成 ID。
Catalog オブジェクトの種類	count.catalog_object_type	string	追跡対象の CatalogObject の種類。
State	count.state	string	現在の状態。
場所 ID	count.location_id	string	場所の識別子。
数量	count.quantity	string	調整の影響を受ける項目の数を 10 進文字列として指定します。 小数点の後に最大 5 桁までサポートできます。
Product	count.source.product	string	アプリケーションの製品の種類。
アプリケーション識別子	count.source.application_id	string	アプリケーションに割り当てられた読み取り専用の Square ID。
名前	count.source.name	string	名前。
従業員 ID	count.employee_id	string	従業員の正方形で生成された ID。
発生日	count.occurred_at	string	インベントリ調整がいつ行われたか示す、クライアントによって生成された RFC 3339 形式のタイムスタンプ。 在庫調整の更新の場合、occurred_atタイムスタンプは、要求の時刻に対して 24 時間より古くすることはできません。
Created At	count.created_at	string	RFC 3339 形式で、このオブジェクトの作成時刻を指定するタイムスタンプ。

インベントリの数を取得する

操作 ID:

InventoryRetrieveCount

特定の場所のセットにある特定の CatalogObject の現在の計算済み在庫数を取得します。

パラメーター

名前	キー	必須	型	説明
カタログ オブジェクト ID	catalog_object_id	True	string	カタログ オブジェクトの識別子。
場所 ID	location_ids		string	コンマ区切りリストとして検索する場所 ID。 空のリストは、すべての場所を照会します。
Cursor	cursor		string	このエンドポイントに対する以前の呼び出しによって返された改ページ位置カーソル。

戻り値

名前	パス	型	説明
カウント	counts	array of object
カタログ オブジェクト ID	counts.catalog_object_id	string	追跡対象の CatalogObject の 2 乗生成 ID。
Catalog オブジェクトの種類	counts.catalog_object_type	string	追跡対象の CatalogObject の種類。
State	counts.state	string	現在の状態。
場所 ID	counts.location_id	string	場所の識別子。
数量	counts.quantity	string	10 進文字列としての推定カウントの影響を受ける項目の数。 小数点の後に最大 5 桁までサポートできます。
計算対象	counts.calculated_at	string	推定カウントに影響する最新の物理カウントまたは調整をいつ受信するかを示す RFC 3339 形式のタイムスタンプ。

インベントリ転送の取得 (ベータ)

操作 ID:

InventoryRetrieveTransfer

指定されたtransfer_idを持つ InventoryTransfer オブジェクトを返します。

パラメーター

名前	キー	必須	型	説明
譲渡 ID	transfer_id	True	string	転送の識別子。

戻り値

名前	パス	型	説明
ID	transfer.id	string	Square で発行された一意の識別子。
カタログ オブジェクト ID	transfer.catalog_object_id	string	追跡対象の CatalogObject の 2 乗生成 ID。
Catalog オブジェクトの種類	transfer.catalog_object_type	string	追跡対象の CatalogObject の種類。
Created At	transfer.created_at	string	RFC 3339 形式で、このオブジェクトの作成時刻を指定するタイムスタンプ。
従業員 ID	transfer.employee_id	string	従業員の正方形で生成された ID。
From Location ID	transfer.from_location_id	string	転送前に品目の関連数量が追跡された場所の 2 乗生成 ID。
To Location ID	transfer.to_location_id	string	転送後に品目の関連数量が追跡された場所の 2 乗生成 ID。
発生日	transfer.occurred_at	string	インベントリ調整がいつ行われたか示す、クライアントによって生成された RFC 3339 形式のタイムスタンプ。 在庫調整の更新の場合、occurred_atタイムスタンプは、要求の時刻に対して 24 時間より古くすることはできません。
数量	transfer.quantity	string	調整の影響を受ける項目の数を 10 進文字列として指定します。 小数点の後に最大 5 桁までサポートできます。
参照 ID	transfer.reference_id	string	省略可能なユーザー定義参照 ID。
Product	transfer.source.product	string	アプリケーションの製品の種類。
アプリケーション識別子	transfer.source.application_id	string	アプリケーションに割り当てられた読み取り専用の Square ID。
名前	transfer.source.name	string	名前。
State	transfer.state	string	現在の状態。

カタログ オブジェクトのバッチアップサート

操作 ID:

CatalogBatchUpsert

指定されたオブジェクトの一覧に基づいて、最大 10,000 個のターゲット オブジェクトを作成または更新します。 ターゲット オブジェクトはバッチにグループ化され、各バッチは、すべてまたは何もしない方法で挿入/更新されます。 バッチ内のオブジェクトが何らかの形式で形式が正しくない場合、またはデータベース制約に違反している場合、その項目を含むバッチ全体は無視されます。 ただし、同じ要求内の他のバッチは引き続き成功する可能性があります。 各バッチには最大 1,000 個のオブジェクトが含まれる場合があり、要求のオブジェクト数の合計 (アイテム、バリエーション、修飾子リスト、割引、税金) が 10,000 以下であれば、バッチは順番に処理されます。

パラメーター

名前	キー	必須	型	説明
べき等キー	idempotency_key		string	すべての要求の中でこの要求を一意に識別する値を指定します。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。
タイプ	type		string	このオブジェクトの種類。
ID	id		string	このオブジェクトを参照する識別子。
すべての場所に存在する	present_at_all_locations		boolean	true の場合、このオブジェクトは、absent_at_location_ids フィールドで指定されている場合を除き、すべての場所 (将来の場所を含む) に存在します。 false の場合、このオブジェクトは、present_at_location_ids フィールドで指定されている場合を除き、(将来の場所を含む) どの場所にも存在しません。 指定しない場合、既定値は true になります。
名前	name		string	アイテムの名前。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、その値を空にすることはできません。長さは Unicode コード ポイントです。
Description	title		string	アイテムの説明。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、値の長さは Unicode コード ポイントです。
カテゴリ ID	category_id		string	アイテムのカテゴリの ID (存在する場合)。
税務識別番号	tax_ids		array of string
タイプ	type		string	このオブジェクトの種類。 各オブジェクト型には、対応する *_data フィールド内で構造化された形式で表されるプロパティが必要です。
ID	id		string	このオブジェクトを参照する識別子。
すべての場所に存在する	present_at_all_locations		boolean	すべての場所に存在するかどうか。
アイテム ID	item_id		string	アイテムの識別子。
名前	name		string	アイテムの名前。
価格の種類	pricing_type		string	価格の種類。
金額	amount		integer	金額。
通貨	currency		string	通貨。
名前	name		string	アイテムの名前。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、その値を空にすることはできません。長さは Unicode コード ポイントです。
名前	name		string	アイテムの名前。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、その値を空にすることはできません。長さは Unicode コード ポイントです。
計算フェーズ	calculation_phase		string	税金が支払いの小計または合計に基づいて計算されるかどうか。
包含の種類	inclusion_type		string	税金が追加的か包括かを指定します。
百分率	percentage		string	小数点区切り記号として '.' を使用し、'%' 記号を使用しない、10 進形式の税の割合。 値 7.5 は 7.5%に対応します。
カスタム金額に適用	applies_to_custom_amounts		boolean	true の場合、料金は、特定の CatalogItem に関連付けられていない Square Point of Sale アプリに入力されたカスタム金額に適用されます。
Enabled	enabled		boolean	Square Point of Sale アプリで税が有効 (true) として表示されるかどうかを示すブール値フラグ (false)。

戻り値

名前	パス	型	説明
オブジェクト	objects	array of object
タイプ	objects.type	string	このオブジェクトの種類。
ID	objects.id	string	Square で発行された一意の識別子。
更新日時	objects.updated_at	string	RFC 3339 形式の最終変更タイムスタンプ
バージョン	objects.version	integer	オブジェクトの現在のバージョン。
削除済み	objects.is_deleted	boolean	true の場合、オブジェクトはデータベースから削除されています。 挿入する新しいオブジェクトの場合は false にする必要があります。 削除すると、updated_at フィールドは削除時間と等しくなります。
すべての場所に存在する	objects.present_at_all_locations	boolean	true の場合、このオブジェクトは、absent_at_location_ids フィールドで指定されている場合を除き、すべての場所 (将来の場所を含む) に存在します。 false の場合、このオブジェクトは、present_at_location_ids フィールドで指定されている場合を除き、(将来の場所を含む) どの場所にも存在しません。 指定しない場合、既定値は true になります。
名前	objects.item_data.name	string	アイテムの名前。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、その値を空にすることはできません。長さは Unicode コード ポイントです。
Description	objects.item_data.title	string	アイテムの説明。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、値の長さは Unicode コード ポイントです。
カテゴリ ID	objects.item_data.category_id	string	アイテムのカテゴリの ID (存在する場合)。
税務識別番号	objects.item_data.tax_ids	array of string
バリエーション	objects.item_data.variations	array of object
タイプ	objects.item_data.variations.type	string	このオブジェクトの種類。 各オブジェクト型には、対応する *_data フィールド内で構造化された形式で表されるプロパティが必要です。
ID	objects.item_data.variations.id	string	このオブジェクトを参照する識別子。
更新日時	objects.item_data.variations.updated_at	string	RFC 3339 形式の最終変更タイムスタンプ
バージョン	objects.item_data.variations.version	integer	オブジェクトのバージョン。 オブジェクトを更新する場合、指定されたバージョンはデータベース内のバージョンと一致する必要があります。そうしないと、書き込みが競合として拒否されます。
削除済み	objects.item_data.variations.is_deleted	boolean	true の場合、オブジェクトはデータベースから削除されています。 挿入する新しいオブジェクトの場合は false にする必要があります。 削除すると、updated_at フィールドは削除時間と等しくなります。
すべての場所に存在する	objects.item_data.variations.present_at_all_locations	boolean	present_at_all_locationsが false の場合でも、オブジェクトが存在する場所のリスト。 これには、非アクティブ化された場所を含めることができます。
アイテム ID	objects.item_data.variations.item_variation_data.item_id	string	この項目バリエーションを持つオブジェクトの ID。
名前	objects.item_data.variations.item_variation_data.name	string	このアイテムの名前。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、値の長さは Unicode コード ポイントです。
序数	objects.item_data.variations.item_variation_data.ordinal	integer	この項目のバリエーションを表示する順序。 この値は読み取り専用です。
価格の種類	objects.item_data.variations.item_variation_data.pricing_type	string	品目バリエーションの価格を固定するか、販売時に決定するかを示します。
金額	objects.item_data.variations.item_variation_data.price_money.amount	integer	通貨で示される通貨の最小の分母単位での金額。 たとえば、通貨が USD の場合、金額はセント単位です。 金額は、正または負の値にすることができます。 特定のケースでのサインインの意味を判断するには、特定のフィールドの説明を参照してください。
通貨	objects.item_data.variations.item_variation_data.price_money.currency	string	ISO 4217 形式の通貨の種類。 たとえば、米ドルの通貨コードは USD です。
名前	objects.category_data.name	string	アイテムの名前。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、その値を空にすることはできません。長さは Unicode コード ポイントです。
名前	objects.tax_data.name	string	アイテムの名前。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、その値を空にすることはできません。長さは Unicode コード ポイントです。
計算フェーズ	objects.tax_data.calculation_phase	string	税金が支払いの小計または合計に基づいて計算されるかどうか。
包含の種類	objects.tax_data.inclusion_type	string	税金が追加的か包括かを指定します。
百分率	objects.tax_data.percentage	string	小数点区切り記号として '.' を使用し、'%' 記号を使用しない、小数点形式のパーセンテージ。 値 7.5 は 7.5%に対応します。
カスタム金額に適用	objects.tax_data.applies_to_custom_amounts	boolean	true の場合、料金は、特定の CatalogItem に関連付けられていない Square Point of Sale アプリに入力されたカスタム金額に適用されます。
Enabled	objects.tax_data.enabled	boolean	オブジェクトを使用できるかどうかを示します。
ID マッピング	id_mappings	array of object
クライアント オブジェクト ID	id_mappings.client_object_id	string	新しい CatalogObject のクライアント指定の一時 #プレフィックス付き ID。
オブジェクト ID	id_mappings.object_id	string	サーバーによって作成された永続的な ID。

カタログ オブジェクトのバッチ削除

操作 ID:

CatalogBatchDelete

指定されたターゲット ID の一覧に基づいて CatalogItems のセットを削除し、応答で正常に削除された ID のセットを返します。

パラメーター

名前	キー	必須	型	説明
オブジェクト ID	object_ids		array of string

戻り値

名前	パス	型	説明
削除されたオブジェクト ID	deleted_object_ids	array of string
削除日	deleted_at	string	RFC 3339 形式でのこの削除のデータベース タイムスタンプ

カタログ オブジェクトの検索

操作 ID:

CatalogSearch

サポートされている検索属性値 (項目または項目のバリエーションのカスタム属性値を除く) を、指定されたクエリ フィルターの 1 つ以上に対して照合することで、任意の種類の CatalogObject を検索します。

パラメーター

名前	キー	必須	型	説明
オブジェクトの種類	object_types		array of string
属性名	attribute_name		string	検索する属性の名前。
属性プレフィックス	attribute_prefix		string	検索属性値の目的のプレフィックス。
極限	limit		integer	1 ページで返される結果の数に関する制限。 制限はアドバイザリです。実装によって返される結果の数が増減する場合があります。 指定された制限が負、ゼロ、または最大値の 1,000 より大きい場合は無視されます。

戻り値

名前	パス	型	説明
オブジェクト	objects	array of object
タイプ	objects.type	string	このオブジェクトの種類。
ID	objects.id	string	Square で発行された一意の識別子。
更新日時	objects.updated_at	string	RFC 3339 形式の最終変更タイムスタンプ
バージョン	objects.version	integer	オブジェクトの現在のバージョン。
削除済み	objects.is_deleted	boolean	true の場合、オブジェクトはデータベースから削除されています。 挿入する新しいオブジェクトの場合は false にする必要があります。 削除すると、updated_at フィールドは削除時間と等しくなります。
すべての場所に存在する	objects.present_at_all_locations	boolean	true の場合、このオブジェクトは、absent_at_location_ids フィールドで指定されている場合を除き、すべての場所 (将来の場所を含む) に存在します。 false の場合、このオブジェクトは、present_at_location_ids フィールドで指定されている場合を除き、(将来の場所を含む) どの場所にも存在しません。 指定しない場合、既定値は true になります。
名前	objects.item_data.name	string	アイテムの名前。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、その値を空にすることはできません。長さは Unicode コード ポイントです。
Description	objects.item_data.title	string	アイテムの説明。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、値の長さは Unicode コード ポイントです。
カテゴリ ID	objects.item_data.category_id	string	アイテムのカテゴリの ID (存在する場合)。
製品タイプ	objects.item_data.product_type	string	指定した製品の種類を持つアイテムまたは項目のバリエーションを返す製品の種類のクエリ式。
税務識別番号	objects.item_data.tax_ids	array of string
バリエーション	objects.item_data.variations	array of object
タイプ	objects.item_data.variations.type	string	このオブジェクトの種類。 各オブジェクト型には、対応する *_data フィールド内で構造化された形式で表されるプロパティが必要です。
ID	objects.item_data.variations.id	string	このオブジェクトを参照する識別子。
更新日時	objects.item_data.variations.updated_at	string	RFC 3339 形式の最終変更タイムスタンプ
バージョン	objects.item_data.variations.version	integer	オブジェクトのバージョン。 オブジェクトを更新する場合、指定されたバージョンはデータベース内のバージョンと一致する必要があります。そうしないと、書き込みが競合として拒否されます。
削除済み	objects.item_data.variations.is_deleted	boolean	true の場合、オブジェクトはデータベースから削除されています。 挿入する新しいオブジェクトの場合は false にする必要があります。 削除すると、updated_at フィールドは削除時間と等しくなります。
すべての場所に存在する	objects.item_data.variations.present_at_all_locations	boolean	present_at_all_locationsが false の場合でも、オブジェクトが存在する場所のリスト。 これには、非アクティブ化された場所を含めることができます。
アイテム ID	objects.item_data.variations.item_variation_data.item_id	string	この項目バリエーションを持つオブジェクトの ID。
名前	objects.item_data.variations.item_variation_data.name	string	このアイテムの名前。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、値の長さは Unicode コード ポイントです。
序数	objects.item_data.variations.item_variation_data.ordinal	integer	この項目のバリエーションを表示する順序。 この値は読み取り専用です。
金額	objects.item_data.variations.item_variation_data.price_money.amount	integer	通貨で示される通貨の最小の分母単位での金額。 たとえば、通貨が USD の場合、金額はセント単位です。 金額は、正または負の値にすることができます。 特定のケースでのサインインの意味を判断するには、特定のフィールドの説明を参照してください。
通貨	objects.item_data.variations.item_variation_data.price_money.currency	string	ISO 4217 形式の通貨の種類。 たとえば、米ドルの通貨コードは USD です。
価格の種類	objects.item_data.variations.item_variation_data.pricing_type	string	品目バリエーションの価格を固定するか、販売時に決定するかを示します。
可視性	objects.item_data.visibility	string	可視性。

カタログ オブジェクトを削除する

操作 ID:

CatalogDelete

指定された ID に基づいて 1 つの CatalogObject を削除し、応答で正常に削除された ID のセットを返します。 削除は、ターゲット オブジェクトのすべての子も削除されるように連鎖するイベントです。 たとえば、CatalogItem を削除すると、CatalogItemVariation のすべての子も削除されます。

パラメーター

名前	キー	必須	型	説明
オブジェクト ID	object_id	True	string	オブジェクトの識別子。

戻り値

名前	パス	型	説明
削除されたオブジェクト ID	deleted_object_ids	array of string
削除日	deleted_at	string	RFC 3339 形式でのこの削除のデータベース タイムスタンプ

カタログ オブジェクトを取得する

操作 ID:

CatalogRetrieve

指定された ID に基づいて、CatalogObject として 1 つの CatalogItem を返します。 返されるオブジェクトには、CatalogItemVariation 子、CatalogModifierList オブジェクトへの参照、それに適用されるすべての CatalogTax オブジェクトの ID など、関連するすべての CatalogItem 情報が含まれます。

パラメーター

名前	キー	必須	型	説明
オブジェクト ID	object_id	True	string	オブジェクトの識別子。
関連オブジェクトを含める	include_related_objects		boolean	true の場合、応答には、要求されたオブジェクトに関連する追加のオブジェクトが含まれます。応答のオブジェクト フィールドに CatalogItem が含まれている場合は、対応する CatalogCategory、CatalogTax、CatalogImage、CatalogModifierList オブジェクトが応答のrelated_objects フィールドに返されます。 応答のオブジェクト フィールドに CatalogItemVariation が含まれている場合は、その親 CatalogItem が応答のrelated_objects フィールドに返されます。

戻り値

名前	パス	型	説明
タイプ	object.type	string	このオブジェクトの種類。
ID	object.id	string	Square で発行された一意の識別子。
更新日時	object.updated_at	string	RFC 3339 形式で、このオブジェクトの最新の更新時刻を指定するタイムスタンプ。
バージョン	object.version	integer	このオブジェクトの現在のバージョン。
削除済み	object.is_deleted	boolean	true の場合、オブジェクトはデータベースから削除されています。 挿入する新しいオブジェクトの場合は false にする必要があります。 削除すると、updated_at フィールドは削除時間と等しくなります。
present_at_all_locations	object.present_at_all_locations	boolean	true の場合、このオブジェクトは、absent_at_location_ids フィールドで指定されている場合を除き、すべての場所 (将来の場所を含む) に存在します。 false の場合、このオブジェクトは、present_at_location_ids フィールドで指定されている場合を除き、(将来の場所を含む) どの場所にも存在しません。 指定しない場合、既定値は true になります。
名前	object.item_data.name	string	名前。
Description	object.item_data.title	string	アイテムの説明。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、値の長さは Unicode コード ポイントです。
カテゴリ ID	object.item_data.category_id	string	アイテムのカテゴリの ID (存在する場合)。
税務識別番号	object.item_data.tax_ids	array of string
バリエーション	object.item_data.variations	array of object
タイプ	object.item_data.variations.type	string	このオブジェクトの種類。
ID	object.item_data.variations.id	string	カタログ内のこのオブジェクトを参照する識別子。
更新日時	object.item_data.variations.updated_at	string	RFC 3339 形式の最終変更タイムスタンプ。
バージョン	object.item_data.variations.version	integer	オブジェクトのバージョン。 オブジェクトを更新する場合、指定されたバージョンはデータベース内のバージョンと一致する必要があります。そうしないと、書き込みが競合として拒否されます。
削除済み	object.item_data.variations.is_deleted	boolean	true の場合、オブジェクトはデータベースから削除されています。 挿入する新しいオブジェクトの場合は false にする必要があります。 削除すると、updated_at フィールドは削除時間と等しくなります。
すべての場所に存在する	object.item_data.variations.present_at_all_locations	boolean	true の場合、このオブジェクトは、absent_at_location_ids フィールドで指定されている場合を除き、すべての場所 (将来の場所を含む) に存在します。 false の場合、このオブジェクトは、present_at_location_ids フィールドで指定されている場合を除き、(将来の場所を含む) どの場所にも存在しません。 指定しない場合、既定値は true になります。
アイテム ID	object.item_data.variations.item_variation_data.item_id	string	この項目バリエーションに関連付けられている CatalogItem の ID。
名前	object.item_data.variations.item_variation_data.name	string	アイテム バリエーションの名前。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、値の長さは Unicode コード ポイントです。
序数	object.item_data.variations.item_variation_data.ordinal	integer	この項目のバリエーションを表示する順序。 この値は読み取り専用です。 書き込み時に、親 CatalogItem 内の各項目バリエーションの序数は、項目バリエーションの位置に従って設定されます。 読み取りの場合、値がシーケンシャルまたは一意であるとは限りません。
価格の種類	object.item_data.variations.item_variation_data.pricing_type	string	品目バリエーションの価格を固定するか、販売時に決定するかを示します。
金額	object.item_data.variations.item_variation_data.price_money.amount	integer	金額。
通貨	object.item_data.variations.item_variation_data.price_money.currency	string	通貨。

カタログを一覧表示する

操作 ID:

CatalogList

カタログ内の一連の必要な型 (たとえば、すべての CatalogItem オブジェクトと CatalogTax オブジェクト) のすべてのオブジェクトを含む CatalogObjects の一覧を返します。 ListCatalog は、削除されたカタログ アイテムを返しません。

パラメーター

名前	キー	必須	型	説明
Cursor	cursor		integer	このエンドポイントに対する以前の呼び出しによって返された改ページ位置カーソル。
種類	types		string	取得するオブジェクト型の省略可能な、大文字と小文字を区別しないコンマ区切りのリスト。 有効な値は、ITEM、ITEM_VARIATION、CATEGORY、DISCOUNT、TAX、MODIFIER、MODIFIER_LIST、IMAGE など、CatalogObjectType 列挙型で定義されます。 これが指定されていない場合、操作は、要求の実行に使用される Square API のバージョンですべての型のオブジェクトを返します。

戻り値

名前	パス	型	説明
オブジェクト	objects	array of object
タイプ	objects.type	string	このオブジェクトの種類。
ID	objects.id	string	Square で発行された一意の識別子。
更新日時	objects.updated_at	string	RFC 3339 形式の最終変更タイムスタンプ
バージョン	objects.version	integer	オブジェクトの現在のバージョン。
削除済み	objects.is_deleted	boolean	true の場合、オブジェクトはデータベースから削除されています。 挿入する新しいオブジェクトの場合は false にする必要があります。 削除すると、updated_at フィールドは削除時間と等しくなります。
すべての場所に存在する	objects.present_at_all_locations	boolean	true の場合、このオブジェクトは、absent_at_location_ids フィールドで指定されている場合を除き、すべての場所 (将来の場所を含む) に存在します。 false の場合、このオブジェクトは、present_at_location_ids フィールドで指定されている場合を除き、(将来の場所を含む) どの場所にも存在しません。 指定しない場合、既定値は true になります。
名前	objects.category_data.name	string	アイテムの名前。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、その値を空にすることはできません。長さは Unicode コード ポイントです。
名前	objects.tax_data.name	string	アイテムの名前。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、その値を空にすることはできません。長さは Unicode コード ポイントです。
計算フェーズ	objects.tax_data.calculation_phase	string	税金が支払いの小計または合計に基づいて計算されるかどうか。
包含の種類	objects.tax_data.inclusion_type	string	税金が追加的か包括かを指定します。
百分率	objects.tax_data.percentage	string	小数点区切り記号として '.' を使用し、'%' 記号を使用しない、小数点形式のパーセンテージ。 値 7.5 は 7.5%に対応します。
Enabled	objects.tax_data.enabled	boolean	オブジェクトを使用できるかどうかを示します。

カタログ情報

操作 ID:

CatalogInfo

BatchUpsertCatalogObjects エンドポイントで使用できるバッチ サイズの制限など、Square Catalog API に関する情報を取得します。

戻り値

名前	パス	型	説明
Batch Upsert のバッチあたりの最大オブジェクト数	limits.batch_upsert_max_objects_per_batch	integer	/v2/catalog/batch-upsert 要求内の 1 つのバッチ内に出現する可能性があるオブジェクトの最大数。
Batch Upsert の最大合計オブジェクト数	limits.batch_upsert_max_total_objects	integer	/v2/catalog/batch-upsert 要求内のすべてのバッチに表示できるオブジェクトの最大数。
バッチ取得の最大オブジェクト ID	limits.batch_retrieve_max_object_ids	integer	/v2/catalog/batch-retrieve 要求に表示される可能性があるオブジェクト ID の最大数。
検索の最大ページ制限	limits.search_max_page_limit	integer	/v2/catalog/search 応答のページで返される可能性のある結果の最大数。
バッチ削除の最大オブジェクト ID	limits.batch_delete_max_object_ids	integer	1 つの /v2/catalog/batch-delete 要求に含まれる可能性があるオブジェクト ID の最大数。
アイテム税の最大項目 ID の更新	limits.update_item_taxes_max_item_ids	integer	1 つの /v2/catalog/update-item-taxes 要求に含まれる可能性がある項目 ID の最大数。
有効にするように品目税の最大税を更新する	limits.update_item_taxes_max_taxes_to_enable	integer	1 つの /v2/catalog/update-item-taxes 要求に含まれる可能性がある、有効にする税 ID の最大数。
アイテム税の最大税を無効に更新する	limits.update_item_taxes_max_taxes_to_disable	integer	1 つの /v2/catalog/update-item-taxes 要求に含まれる可能性がある、無効にする税 ID の最大数。
アイテム修飾子リストの最大項目 ID の更新	limits.update_item_modifier_lists_max_item_ids	integer	1 つの /v2/catalog/update-item-taxes 要求に含まれる可能性がある、無効にする税 ID の最大数。
アイテム修飾子リストの最大修飾子リストを更新して有効にする	limits.update_item_modifier_lists_max_modifier_lists_to_enable	integer	単一の /v2/catalog/update-item-modifier-lists 要求に含まれる可能性がある、有効にする修飾子リスト ID の最大数。
アイテム修飾子リストの最大修飾子リストを更新して無効にする	limits.update_item_modifier_lists_max_modifier_lists_to_disable	integer	単一の /v2/catalog/update-item-modifier-lists 要求に含まれる可能性がある、無効にする修飾子リスト ID の最大数。

カードの作成

操作 ID:

CardCreate

ファイル上のカードを既存のマーチャントに追加します。

パラメーター

名前	キー	必須	型	説明
べき等キー	idempotency_key		string	べき等キー。
ソース ID	source_id		string	ソースの識別子。
住所 1 行目	address_line_1		string	住所の 1 行目。 address_lineで始まるフィールドは、住所の最も具体的な詳細 (番地、番地、建物名など) を提供します。
住所 2 行目	address_line_2		string	アドレスの 2 行目 (ある場合)。
地域	locality		string	住所の市区町村。
行政区レベル 1	administrative_district_level_1		string	住所の国内の市民エンティティ。 米国では、これが状態です。
郵便番号	postal_code		string	住所の郵便番号。
Country	country		string	ISO 3166-1-alpha-2 形式の住所の国。
カード所有者名	cardholder_name		string	カード所有者の名前。
顧客ID	customer_id		string	顧客を表すこのオブジェクトの ID。
参照 ID	reference_id		string	省略可能なユーザー定義参照 ID。

戻り値

名前	パス	型	説明
ID	card.id	string	Square で発行された一意の識別子。
住所 1 行目	card.billing_address.address_line_1	string	住所の 1 行目。 address_lineで始まるフィールドは、住所の最も具体的な詳細 (番地、番地、建物名など) を提供します。
住所 2 行目	card.billing_address.address_line_2	string	アドレスの 2 行目 (ある場合)。
地域	card.billing_address.locality	string	住所の市区町村。
行政区レベル 1	card.billing_address.administrative_district_level_1	string	住所の国内の市民エンティティ。 米国では、これが状態です。
郵便番号	card.billing_address.postal_code	string	住所の郵便番号。
Country	card.billing_address.country	string	ISO 3166-1-alpha-2 形式の住所の国。
指紋	card.fingerprint	string	1 つのアプリケーション内の複数の場所でカードを識別するために、カード番号に基づいて、正方形に割り当てられた識別子として意図されています。
ごみ箱	card.bin	string	銀行識別番号 (BIN) と呼ばれるカード番号の最初の 6 桁。
カード ブランド	card.card_brand	string	カードのブランド。
カードの種類	card.card_type	string	カードの種類。
カード所有者名	card.cardholder_name	string	カード所有者の名前。
顧客ID	card.customer_id	string	顧客を表すこのオブジェクトの ID。
Enabled	card.enabled	boolean	有効かどうか。
Exp Month	card.exp_month	integer	関連付けられているカードの有効期限の月を 1 ~ 12 の整数で指定します。
Exp Year	card.exp_year	integer	カードの有効期限の 4 桁の年。
最後の 4	card.last_4	string	カード番号の最後の 4 桁。
前払いの種類	card.prepaid_type	string	カードが前払いされているかどうかを示します。
参照 ID	card.reference_id	string	省略可能なユーザー定義参照 ID。
バージョン	card.version	integer	このオブジェクトの現在のバージョン。

カードを一覧表示する

操作 ID:

CardList

要求を行うアカウントが所有するカードの一覧を取得します。

パラメーター

名前	キー	必須	型	説明
Cursor	cursor		string	このエンドポイントに対する以前の呼び出しによって返された改ページ位置カーソル。
顧客ID	customer_id		string	指定した顧客に関連付けられているカードに結果を制限します。 既定では、販売者が所有するすべてのカードが返されます。
無効を含める	include_disabled		boolean	無効なカードが含まれます。 既定では、販売者が所有するすべての有効なカードが返されます。
参照 ID	reference_id		string	指定されたreference_idに関連付けられているカードに結果を制限します。
並べ替え順序	sort_order		string	指定した順序でカードが作成されたときに、返されたリストを並べ替えます。

戻り値

名前	パス	型	説明
Cards	cards	array of object
ID	cards.card.id	string	オブジェクトの識別子
住所 1 行目	cards.card.billing_address.address_line_1	string	address_lineで始まるフィールドは、住所の最も具体的な詳細 (番地、番地、建物名など) を提供します。
住所 2 行目	cards.card.billing_address.address_line_2	string	アドレスの 2 行目 (ある場合)。
地域	cards.card.billing_address.locality	string	住所の市区町村。
行政区レベル 1	cards.card.billing_address.administrative_district_level_1	string	住所の国内の市民エンティティ。 米国では、これが状態です。
郵便番号	cards.card.billing_address.postal_code	string	住所の郵便番号。
Country	cards.card.billing_address.country	string	ISO 3166-1-alpha-2 形式の住所の国。
指紋	cards.card.fingerprint	string	1 つのアプリケーション内の複数の場所でカードを識別するために、カード番号に基づいて、正方形に割り当てられた識別子として意図されています。
ごみ箱	cards.card.bin	string	銀行識別番号 (BIN) と呼ばれるカード番号の最初の 6 桁。
カード ブランド	cards.card.card_brand	string	カードのブランド。
カードの種類	cards.card.card_type	string	カードの種類。
カード所有者名	cards.card.cardholder_name	string	カード所有者の名前。
顧客ID	cards.card.customer_id	string	カードに関連付ける顧客の ID。
Enabled	cards.card.enabled	boolean	オブジェクトを使用できるかどうかを示します。
有効期限月	cards.card.exp_month	integer	関連付けられているカードの有効期限の月を 1 ~ 12 の整数で指定します。
有効期限年	cards.card.exp_year	integer	カードの有効期限の 4 桁の年。
最後の 4	cards.card.last_4	string	カード番号の最後の 4 桁。
前払いの種類	cards.card.prepaid_type	string	カードが前払いされているかどうかを示します。
参照 ID	cards.card.reference_id	string	このカードを外部システムの別のエンティティに関連付ける、オプションのユーザー定義参照 ID。
バージョン	cards.card.version	integer	カードの現在のバージョン番号。 カードの更新ごとにインクリメントされます。 既存の Card オブジェクトを更新する要求は、要求のバージョンがカードの現在のバージョンと一致しない限り拒否されます。

カードを取得する

操作 ID:

CardRetrieve

特定のカードの詳細を取得します。

パラメーター

名前	キー	必須	型	説明
カード ID	card_id	True	string	カードの識別子。

戻り値

名前	パス	型	説明
ID	card.id	string	Square で発行された一意の識別子。
住所 1 行目	card.billing_address.address_line_1	string	住所の 1 行目。 address_lineで始まるフィールドは、住所の最も具体的な詳細 (番地、番地、建物名など) を提供します。
住所 2 行目	card.billing_address.address_line_2	string	アドレスの 2 行目 (ある場合)。
地域	card.billing_address.locality	string	住所の市区町村。
行政区レベル 1	card.billing_address.administrative_district_level_1	string	住所の国内の市民エンティティ。 米国では、これが状態です。
郵便番号	card.billing_address.postal_code	string	住所の郵便番号。
Country	card.billing_address.country	string	ISO 3166-1-alpha-2 形式の住所の国。
指紋	card.fingerprint	string	1 つのアプリケーション内の複数の場所でカードを識別するために、カード番号に基づいて、正方形に割り当てられた識別子として意図されています。
ごみ箱	card.bin	string	銀行識別番号 (BIN) と呼ばれるカード番号の最初の 6 桁。
カード ブランド	card.card_brand	string	カードのブランド。
カードの種類	card.card_type	string	カードの種類。
カード所有者名	card.cardholder_name	string	カード所有者の名前。
顧客ID	card.customer_id	string	顧客を表すこのオブジェクトの ID。
Enabled	card.enabled	boolean	有効かどうか。
Exp Month	card.exp_month	integer	関連付けられているカードの有効期限の月を 1 ~ 12 の整数で指定します。
Exp Year	card.exp_year	integer	カードの有効期限の 4 桁の年。
最後の 4	card.last_4	string	カード番号の最後の 4 桁。
前払いの種類	card.prepaid_type	string	カードが前払いされているかどうかを示します。
参照 ID	card.reference_id	string	省略可能なユーザー定義参照 ID。
バージョン	card.version	integer	このオブジェクトの現在のバージョン。

カードを無効にする

操作 ID:

CardDisable

カードを無効にして、それ以上の更新や料金が発生しないようにします。 既に無効になっているカードの無効化は許可されますが、効果はありません。

パラメーター

名前	キー	必須	型	説明
カード ID	card_id	True	string	カードの識別子。

戻り値

名前	パス	型	説明
ID	card.id	string	Square で発行された一意の識別子。
住所 1 行目	card.billing_address.address_line_1	string	住所の 1 行目。 address_lineで始まるフィールドは、住所の最も具体的な詳細 (番地、番地、建物名など) を提供します。
住所 2 行目	card.billing_address.address_line_2	string	アドレスの 2 行目 (ある場合)。
地域	card.billing_address.locality	string	住所の市区町村。
行政区レベル 1	card.billing_address.administrative_district_level_1	string	住所の国内の市民エンティティ。 米国では、これが状態です。
郵便番号	card.billing_address.postal_code	string	住所の郵便番号。
Country	card.billing_address.country	string	ISO 3166-1-alpha-2 形式の住所の国。
指紋	card.fingerprint	string	1 つのアプリケーション内の複数の場所でカードを識別するために、カード番号に基づいて、正方形に割り当てられた識別子として意図されています。
ごみ箱	card.bin	string	銀行識別番号 (BIN) と呼ばれるカード番号の最初の 6 桁。
カード ブランド	card.card_brand	string	カードのブランド。
カードの種類	card.card_type	string	カードの種類。
カード所有者名	card.cardholder_name	string	カード所有者の名前。
顧客ID	card.customer_id	string	顧客を表すこのオブジェクトの ID。
Enabled	card.enabled	boolean	有効かどうか。
Exp Month	card.exp_month	integer	関連付けられているカードの有効期限の月を 1 ~ 12 の整数で指定します。
Exp Year	card.exp_year	integer	カードの有効期限の 4 桁の年。
最後の 4	card.last_4	string	カード番号の最後の 4 桁。
前払いの種類	card.prepaid_type	string	カードが前払いされているかどうかを示します。
参照 ID	card.reference_id	string	省略可能なユーザー定義参照 ID。
バージョン	card.version	integer	このオブジェクトの現在のバージョン。

サブスクリプション イベントを一覧表示する

操作 ID:

SubscriptionListEvents

特定のサブスクリプションのすべてのイベントを一覧表示します。

パラメーター

名前	キー	必須	型	説明
サブスクリプション ID	subscription_id	True	string	サブスクリプションの識別子。

戻り値

名前	パス	型	説明
サブスクリプション イベント	subscription_events	array of object
ID	subscription_events.id	string	Square で発行された一意の識別子。
サブスクリプション イベントの種類	subscription_events.subscription_event_type	string	サブスクリプション イベントの種類。
有効日	subscription_events.effective_date	string	サブスクリプション イベントが有効になった日付 (YYYY-MM-DD 形式)。
プラン ID	subscription_events.plan_id	string	関連付けられているサブスクリプション プランの ID

サブスクリプションのキャンセル

操作 ID:

SubscriptionCancel

[canceled_date] フィールドをアクティブな請求期間の末尾に設定します。 この日付を過ぎると、状態は ACTIVE から CANCELED に変わります。

パラメーター

名前	キー	必須	型	説明
サブスクリプション ID	subscription_id	True	string	サブスクリプションの識別子。

戻り値

名前	パス	型	説明
ID	subscription.id	string	Square で発行された一意の識別子。
場所 ID	subscription.location_id	string	場所の識別子。
プラン ID	subscription.plan_id	string	関連付けられているサブスクリプション プランの ID。
顧客ID	subscription.customer_id	string	顧客を表すこのオブジェクトの ID。
カード ID	subscription.card_id	string	サブスクリプションに対して課金される顧客カードの ID。
開始日	subscription.start_date	string	サブスクリプションの開始日 (YYYY-MM-DD 形式)。
取り消された日付	subscription.canceled_date	string	サブスクリプションの取り消し日 (YYYY-MM-DD 形式)。
支払日まで	subscription.paid_until_date	string	支払日まで。
ステータス	subscription.status	string	このオブジェクトの現在の検証状態。
Created At	subscription.created_at	string	RFC 3339 形式で、このオブジェクトの作成時刻を指定するタイムスタンプ。
バージョン	subscription.version	integer	このオブジェクトの現在のバージョン。
Timezone	subscription.timezone	string	カレンダーの日付を解釈するために使用されるタイム ゾーン。 請求書が作成されると、このフィールドは販売者の場所に指定されたタイムゾーンに設定されます。 値は変更できません。
名前	subscription.source.name	string	名前。

サブスクリプションの再開

操作 ID:

SubscriptionResume

非アクティブ化されたサブスクリプションを再開します。

パラメーター

名前	キー	必須	型	説明
サブスクリプション ID	subscription_id	True	string	サブスクリプションの識別子。

戻り値

名前	パス	型	説明
ID	subscription.id	string	Square で発行された一意の識別子。
場所 ID	subscription.location_id	string	場所の識別子。
プラン ID	subscription.plan_id	string	関連付けられているサブスクリプション プランの ID。
顧客ID	subscription.customer_id	string	顧客を表すこのオブジェクトの ID。
ステータス	subscription.status	string	このオブジェクトの現在の検証状態。
金額	subscription.price_override_money.amount	integer	金額。
通貨	subscription.price_override_money.currency	string	通貨。
バージョン	subscription.version	integer	このオブジェクトの現在のバージョン。
Created At	subscription.created_at	string	RFC 3339 形式で、このオブジェクトの作成時刻を指定するタイムスタンプ。
Timezone	subscription.timezone	string	カレンダーの日付を解釈するために使用されるタイム ゾーン。 請求書が作成されると、このフィールドは販売者の場所に指定されたタイムゾーンに設定されます。 値は変更できません。
名前	subscription.source.name	string	名前。

サブスクリプションの検索

操作 ID:

SubscriptionSearch

サブスクリプションを検索します。 結果は、サブスクリプションの作成日ごとに時系列に並べ替えます。 要求で複数の場所 ID が指定されている場合、エンドポイントは、場所 ID によって結果を並べ替え、次に各場所内の作成日で結果を並べ替えます。 クエリに場所が指定されていない場合は、すべての場所が検索されます。

パラメーター

名前	キー	必須	型	説明
場所 ID	location_ids		array of string
顧客 ID	customer_ids		array of string
ソース名	source_names		array of string

戻り値

名前	パス	型	説明
サブスクリプション	subscriptions	array of object
ID	subscriptions.id	string	Square で発行された一意の識別子。
場所 ID	subscriptions.location_id	string	場所の識別子。
プラン ID	subscriptions.plan_id	string	関連付けられているサブスクリプション プランの ID
顧客ID	subscriptions.customer_id	string	アカウントに関連付けられている顧客の Square 割り当て ID。
開始日	subscriptions.start_date	string	サブスクリプションの開始日 (YYYY-MM-DD 形式)。
取り消された日付	subscriptions.canceled_date	string	サブスクリプションの取り消し日 (YYYY-MM-DD 形式)。
請求日	subscriptions.charged_through_date	string	顧客がサブスクリプションに対して請求される日付 (YYYY-MM-DD 形式)。
ステータス	subscriptions.status	string	このオブジェクトの現在の検証状態。
Created At	subscriptions.created_at	string	ISO 8601 形式のイベント時間。
カード ID	subscriptions.card_id	string	サブスクリプションに対して課金される顧客カードの ID。
支払日まで	subscriptions.paid_until_date	string	支払日まで。
Timezone	subscriptions.timezone	string	請求書のカレンダーの日付を解釈するために使用されるタイム ゾーン (due_dateなど)。 請求書が作成されると、このフィールドは販売者の場所に指定されたタイムゾーンに設定されます。 値は変更できません。
名前	subscriptions.source.name	string	アイテムの名前。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、その値を空にすることはできません。長さは Unicode コード ポイントです。
税の割合	subscriptions.tax_percentage	string	サブスクリプションの請求時に適用される税額。
金額	subscriptions.price_override_money.amount	integer	金額。
通貨	subscriptions.price_override_money.currency	string	通貨。
バージョン	subscriptions.version	integer	オブジェクトの現在のバージョン。
請求書 ID	subscriptions.invoice_ids	array of string

サブスクリプションを作成する

操作 ID:

SubscriptionCreate

顧客のサブスクリプションをサブスクリプション プランに作成します。 要求でカードをファイルに入力した場合、Square はサブスクリプションのカードを請求します。 それ以外の場合、Square は顧客のメール アドレスに請求書を請求します。 要求にオプションのstart_dateが含まれている場合を除き、サブスクリプションはすぐに開始されます。 個々のサブスクリプションは、特定の場所に関連付けられます。

パラメーター

名前	キー	必須	型	説明
べき等キー	idempotency_key		string	すべての要求の中でこの要求を一意に識別する値を指定します。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。
場所 ID	location_id		string	場所識別子。
プラン ID	plan_id		string	カタログ API を使用して作成されたサブスクリプション プランの ID。
顧客ID	customer_id		string	リンクする顧客の ID。
カード ID	card_id		string	請求する顧客カードの ID。
開始日	start_date		string	サブスクリプションの開始日 (YYYY-MM-DD 形式)。
税の割合	tax_percentage		string	サブスクリプションの請求時に追加する税金。
金額	amount		integer	tip_moneyを含まない、この支払いに対して受け入れる金額。
通貨	currency		string	3 文字の ISO 4217 通貨コード。
Timezone	timezone		string	サブスクリプションの日付計算で使用されるタイムゾーン。
名前	name		string	オブジェクトの名前。

戻り値

名前	パス	型	説明
ID	subscription.id	string	Square で発行された一意の識別子。
場所 ID	subscription.location_id	string	場所の識別子。
プラン ID	subscription.plan_id	string	関連付けられているサブスクリプション プランの ID。
顧客ID	subscription.customer_id	string	顧客を表すこのオブジェクトの ID。
開始日	subscription.start_date	string	サブスクリプションの開始日 (YYYY-MM-DD 形式)。
ステータス	subscription.status	string	このオブジェクトの現在の検証状態。
税の割合	subscription.tax_percentage	string	サブスクリプションの請求時に適用される税額。
金額	subscription.price_override_money.amount	integer	金額。
通貨	subscription.price_override_money.currency	string	通貨。
バージョン	subscription.version	integer	このオブジェクトの現在のバージョン。
Created At	subscription.created_at	string	RFC 3339 形式で、このオブジェクトの作成時刻を指定するタイムスタンプ。
カード ID	subscription.card_id	string	サブスクリプションに対して課金される顧客カードの ID。
Timezone	subscription.timezone	string	カレンダーの日付を解釈するために使用されるタイム ゾーン。 請求書が作成されると、このフィールドは販売者の場所に指定されたタイムゾーンに設定されます。 値は変更できません。
名前	subscription.source.name	string	名前。

サブスクリプションを取得する

操作 ID:

SubscriptionRetrieve

サブスクリプションを取得します。

パラメーター

名前	キー	必須	型	説明
サブスクリプション ID	subscription_id	True	string	サブスクリプションの識別子。

戻り値

名前	パス	型	説明
ID	subscription.id	string	Square で発行された一意の識別子。
場所 ID	subscription.location_id	string	場所の識別子。
プラン ID	subscription.plan_id	string	関連付けられているサブスクリプション プランの ID。
顧客ID	subscription.customer_id	string	顧客を表すこのオブジェクトの ID。
開始日	subscription.start_date	string	サブスクリプションの開始日 (YYYY-MM-DD 形式)。
請求日	subscription.charged_through_date	string	顧客がサブスクリプションに対して請求される日付 (YYYY-MM-DD 形式)。
ステータス	subscription.status	string	このオブジェクトの現在の検証状態。
請求書 ID	subscription.invoice_ids	array of string
金額	subscription.price_override_money.amount	integer	金額。
通貨	subscription.price_override_money.currency	string	通貨。
Created At	subscription.created_at	string	RFC 3339 形式で、このオブジェクトの作成時刻を指定するタイムスタンプ。
支払日まで	subscription.paid_until_date	string	支払日まで。
Timezone	subscription.timezone	string	カレンダーの日付を解釈するために使用されるタイム ゾーン。 請求書が作成されると、このフィールドは販売者の場所に指定されたタイムゾーンに設定されます。 値は変更できません。
名前	subscription.source.name	string	名前。

サブスクリプションを更新する

操作 ID:

SubscriptionUpdate

サブスクリプションを更新します。 サブスクリプション フィールドの値を設定、変更、クリアできます。

パラメーター

名前	キー	必須	型	説明
サブスクリプション ID	subscription_id	True	string	サブスクリプションの識別子。
バージョン	version		integer	このオブジェクトの現在のバージョン。
税の割合	tax_percentage		string	サブスクリプションの請求時に適用される税額。
金額	amount		integer	金額。
通貨	currency		string	通貨。

戻り値

名前	パス	型	説明
ID	subscription.id	string	Square で発行された一意の識別子。
場所 ID	subscription.location_id	string	場所の識別子。
プラン ID	subscription.plan_id	string	関連付けられているサブスクリプション プランの ID。
顧客ID	subscription.customer_id	string	顧客を表すこのオブジェクトの ID。
ステータス	subscription.status	string	このオブジェクトの現在の検証状態。
金額	subscription.price_override_money.amount	integer	金額。
通貨	subscription.price_override_money.currency	string	通貨。
バージョン	subscription.version	integer	このオブジェクトの現在のバージョン。
Created At	subscription.created_at	string	RFC 3339 形式で、このオブジェクトの作成時刻を指定するタイムスタンプ。
Timezone	subscription.timezone	string	カレンダーの日付を解釈するために使用されるタイム ゾーン。 請求書が作成されると、このフィールドは販売者の場所に指定されたタイムゾーンに設定されます。 値は変更できません。
名前	subscription.source.name	string	名前。

ターミナル チェックアウトを作成する

操作 ID:

TerminalCreateCheckout

ターミナル チェックアウト要求を作成し、指定したデバイスに送信して、要求された金額の支払いを受け取ります。

パラメーター

名前	キー	必須	型	説明
べき等キー	idempotency_key		string	すべての要求の中でこの要求を一意に識別する値を指定します。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。
金額	amount		integer	金額。
通貨	currency		string	通貨。
参照 ID	reference_id		string	省略可能なユーザー定義参照 ID。
デバイス識別子	device_id		string	この TerminalCheckout を対象としたデバイスの一意の ID。
注	note		string	顧客プロファイルに関連付けられているカスタム メモ。

戻り値

名前	パス	型	説明
ID	checkout.id	string	Square で発行された一意の識別子。
金額	checkout.amount_money.amount	integer	金額。
通貨	checkout.amount_money.currency	string	通貨。
参照 ID	checkout.reference_id	string	省略可能なユーザー定義参照 ID。
注	checkout.note	string	顧客プロファイルに関連付けられているカスタム メモ。
デバイス識別子	checkout.device_options.device_id	string	この TerminalCheckout を対象としたデバイスの一意の ID。
チップの受け渡しを許可する	checkout.device_options.tip_settings.allow_tipping	boolean	このチェックアウトに対してチップが有効かどうかを示します。 既定は false です。
受信確認画面をスキップする	checkout.device_options.skip_receipt_screen	boolean	受信画面をスキップするようにデバイスに指示します。 既定は false です。
ステータス	checkout.status	string	このオブジェクトの現在の検証状態。
Created At	checkout.created_at	string	RFC 3339 形式で、このオブジェクトの作成時刻を指定するタイムスタンプ。
更新日時	checkout.updated_at	string	RFC 3339 形式で、このオブジェクトの最新の更新時刻を指定するタイムスタンプ。
アプリ ID	checkout.app_id	string	チェックアウトを作成したアプリケーションの ID。
期限の期間	checkout.deadline_duration	string	RFC 3339 期間。その後、チェックアウトが自動的に取り消されます。 保留中の TerminalCheckout は自動的に取り消され、TIMED_OUTのキャンセル理由があります。 既定値: 作成から 5 分
支払いの種類	checkout.payment_type	string	ターミナルがキャプチャを試みる必要がある支払いの種類。 既定値は CARD_PRESENT です。

ターミナル チェックアウトを取得する

操作 ID:

TerminalGetCheckout

checkout_idでターミナル チェックアウト要求を取得します。

パラメーター

名前	キー	必須	型	説明
チェックアウト ID	checkout_id	True	string	チェックアウトの識別子。

戻り値

名前	パス	型	説明
ID	checkout.id	string	Square で発行された一意の識別子。
金額	checkout.amount_money.amount	integer	金額。
通貨	checkout.amount_money.currency	string	通貨。
参照 ID	checkout.reference_id	string	省略可能なユーザー定義参照 ID。
注	checkout.note	string	顧客プロファイルに関連付けられているカスタム メモ。
デバイス識別子	checkout.device_options.device_id	string	この TerminalCheckout を対象としたデバイスの一意の ID。
チップの受け渡しを許可する	checkout.device_options.tip_settings.allow_tipping	boolean	このチェックアウトに対してチップが有効かどうかを示します。 既定は false です。
受信確認画面をスキップする	checkout.device_options.skip_receipt_screen	boolean	受信画面をスキップするようにデバイスに指示します。 既定は false です。
ステータス	checkout.status	string	このオブジェクトの現在の検証状態。
Created At	checkout.created_at	string	RFC 3339 形式で、このオブジェクトの作成時刻を指定するタイムスタンプ。
更新日時	checkout.updated_at	string	RFC 3339 形式で、このオブジェクトの最新の更新時刻を指定するタイムスタンプ。
アプリ ID	checkout.app_id	string	チェックアウトを作成したアプリケーションの ID。
期限の期間	checkout.deadline_duration	string	RFC 3339 期間。その後、チェックアウトが自動的に取り消されます。 保留中の TerminalCheckout は自動的に取り消され、TIMED_OUTのキャンセル理由があります。 既定値: 作成から 5 分

ターミナルのチェックアウトをキャンセルする

操作 ID:

TerminalCancelCheckout

要求の状態で許可されている場合は、ターミナル チェックアウト要求を取り消します。

パラメーター

名前	キー	必須	型	説明
チェックアウト ID	checkout_id	True	string	チェックアウトの識別子。

戻り値

名前	パス	型	説明
ID	checkout.id	string	Square で発行された一意の識別子。
金額	checkout.amount_money.amount	integer	金額。
通貨	checkout.amount_money.currency	string	通貨。
参照 ID	checkout.reference_id	string	省略可能なユーザー定義参照 ID。
デバイス識別子	checkout.device_options.device_id	string	この TerminalCheckout を対象としたデバイスの一意の ID。
チップの受け渡しを許可する	checkout.device_options.tip_settings.allow_tipping	boolean	このチェックアウトに対してチップが有効かどうかを示します。 既定は false です。
受信確認画面をスキップする	checkout.device_options.skip_receipt_screen	boolean	受信画面をスキップするようにデバイスに指示します。 既定は false です。
ステータス	checkout.status	string	このオブジェクトの現在の検証状態。
理由の取り消し	checkout.cancel_reason	string	取り消されたトランザクションの理由。
Created At	checkout.created_at	string	RFC 3339 形式で、このオブジェクトの作成時刻を指定するタイムスタンプ。
更新日時	checkout.updated_at	string	RFC 3339 形式で、このオブジェクトの最新の更新時刻を指定するタイムスタンプ。
アプリ ID	checkout.app_id	string	チェックアウトを作成したアプリケーションの ID。
期限の期間	checkout.deadline_duration	string	RFC 3339 期間。その後、チェックアウトが自動的に取り消されます。 保留中の TerminalCheckout は自動的に取り消され、TIMED_OUTのキャンセル理由があります。 既定値: 作成から 5 分

ターミナルのチェックアウトを検索する

操作 ID:

TerminalSearchCheckouts

要求を行っているアカウントによって作成されたターミナル チェックアウト要求のフィルター処理された一覧を取得します。

パラメーター

名前	キー	必須	型	説明
極限	limit		integer	1 ページで返される結果の数に関する制限。 制限はアドバイザリです。実装によって返される結果の数が増減する場合があります。 指定された制限が負、ゼロ、または最大値の 1,000 より大きい場合は無視されます。
ステータス	status		string	現在の状態。

戻り値

名前	パス	型	説明
チェック_アウト	checkouts	array of object
ID	checkouts.id	string	Square で発行された一意の識別子。
金額	checkouts.amount_money.amount	integer	金額。
通貨	checkouts.amount_money.currency	string	通貨。
参照 ID	checkouts.reference_id	string	顧客プロファイルを別のシステムのエンティティに関連付けるために使用する省略可能な 2 番目の ID。
注	checkouts.note	string	顧客プロファイルに関連付けられているカスタム メモ。
デバイス識別子	checkouts.device_options.device_id	string	この TerminalCheckout を対象としたデバイスの一意の ID。
チップの受け渡しを許可する	checkouts.device_options.tip_settings.allow_tipping	boolean	このチェックアウトに対してチップが有効かどうかを示します。 既定は false です。
受信確認画面をスキップする	checkouts.device_options.skip_receipt_screen	boolean	受信画面をスキップするようにデバイスに指示します。 既定は false です。
ステータス	checkouts.status	string	このオブジェクトの現在の検証状態。
支払い ID	checkouts.payment_ids	array of string
Created At	checkouts.created_at	string	ISO 8601 形式のイベント時間。
更新日時	checkouts.updated_at	string	RFC 3339 形式の最終変更タイムスタンプ
アプリ ID	checkouts.app_id	string	チェックアウトを作成したアプリケーションの ID。
期限の期間	checkouts.deadline_duration	string	RFC 3339 期間。その後、チェックアウトが自動的に取り消されます。 保留中の TerminalCheckout は自動的に取り消され、TIMED_OUTのキャンセル理由があります。 既定値: 作成から 5 分
Cursor	cursor	string	このエンドポイントへの後続の呼び出しに改ページ カーソルを含め、元のクエリに関連付けられた次の結果セットを取得します。

ターミナルの払い戻しを作成する

操作 ID:

TerminalCreateRefund

スクエア ターミナルで完了した Interac 支払いを払い戻す要求を作成します。

パラメーター

名前	キー	必須	型	説明
べき等キー	idempotency_key		string	すべての要求の中でこの要求を一意に識別する値を指定します。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。
金額	amount		integer	金額。
通貨	currency		string	通貨。
デバイス識別子	device_id		string	この TerminalRefund 用のデバイスの一意の ID。
理由	reason		string	このオブジェクトの理由。
決済識別子	payment_id		string	支払いの一意の ID。

戻り値

名前	パス	型	説明
ID	refund.id	string	Square で発行された一意の識別子。
決済識別子	refund.payment_id	string	支払いの一意の ID。
金額	refund.amount_money.amount	integer	金額。
通貨	refund.amount_money.currency	string	通貨。
理由	refund.reason	string	このオブジェクトの理由。
デバイス識別子	refund.device_id	string	この TerminalRefund 用のデバイスの一意の ID。
期限の期間	refund.deadline_duration	string	RFC 3339 期間。その後、チェックアウトが自動的に取り消されます。 保留中の TerminalCheckout は自動的に取り消され、TIMED_OUTのキャンセル理由があります。 既定値: 作成から 5 分
ステータス	refund.status	string	このオブジェクトの現在の検証状態。
Created At	refund.created_at	string	RFC 3339 形式で、このオブジェクトの作成時刻を指定するタイムスタンプ。
更新日時	refund.updated_at	string	RFC 3339 形式で、このオブジェクトの最新の更新時刻を指定するタイムスタンプ。
アプリ ID	refund.app_id	string	チェックアウトを作成したアプリケーションの ID。
カード ブランド	refund.card.card_brand	string	カードのブランド。
last_4	refund.card.last_4	string	カード番号の最後の 4 桁。
Exp Month	refund.card.exp_month	integer	関連付けられているカードの有効期限の月を 1 ~ 12 の整数で指定します。
Exp Year	refund.card.exp_year	integer	カードの有効期限の 4 桁の年。
指紋	refund.card.fingerprint	string	1 つのアプリケーション内の複数の場所でカードを識別するために、カード番号に基づいて、正方形に割り当てられた識別子として意図されています。
カードの種類	refund.card.card_type	string	カードの種類。
ごみ箱	refund.card.bin	string	銀行識別番号 (BIN) と呼ばれるカード番号の最初の 6 桁。
注文 ID	refund.order_id	string	注文の ID。
場所 ID	refund.location_id	string	場所の識別子。

ターミナルの払い戻しを取り消す

操作 ID:

TerminalCancelRefund

要求の状態で許可されている場合は、払い戻し要求 ID によって Interac ターミナルの払い戻し要求を取り消します。

パラメーター

名前	キー	必須	型	説明
ターミナル払い戻し ID	terminal_refund_id	True	string	ターミナルの払い戻しの識別子。

戻り値

名前	パス	型	説明
ID	refund.id	string	Square で発行された一意の識別子。
決済識別子	refund.payment_id	string	支払いの一意の ID。
金額	refund.amount_money.amount	integer	金額。
通貨	refund.amount_money.currency	string	通貨。
理由	refund.reason	string	このオブジェクトの理由。
デバイス識別子	refund.device_id	string	この TerminalRefund 用のデバイスの一意の ID。
期限の期間	refund.deadline_duration	string	RFC 3339 期間。その後、チェックアウトが自動的に取り消されます。 保留中の TerminalCheckout は自動的に取り消され、TIMED_OUTのキャンセル理由があります。 既定値: 作成から 5 分
ステータス	refund.status	string	このオブジェクトの現在の検証状態。
理由の取り消し	refund.cancel_reason	string	取り消されたトランザクションの理由。
Created At	refund.created_at	string	RFC 3339 形式で、このオブジェクトの作成時刻を指定するタイムスタンプ。
更新日時	refund.updated_at	string	RFC 3339 形式で、このオブジェクトの最新の更新時刻を指定するタイムスタンプ。
アプリ ID	refund.app_id	string	チェックアウトを作成したアプリケーションの ID。
カード ブランド	refund.card.card_brand	string	カードのブランド。
last_4	refund.card.last_4	string	カード番号の最後の 4 桁。
Exp Month	refund.card.exp_month	integer	関連付けられているカードの有効期限の月を 1 ~ 12 の整数で指定します。
Exp Year	refund.card.exp_year	integer	カードの有効期限の 4 桁の年。
指紋	refund.card.fingerprint	string	1 つのアプリケーション内の複数の場所でカードを識別するために、カード番号に基づいて、正方形に割り当てられた識別子として意図されています。
カードの種類	refund.card.card_type	string	カードの種類。
ごみ箱	refund.card.bin	string	銀行識別番号 (BIN) と呼ばれるカード番号の最初の 6 桁。
注文 ID	refund.order_id	string	注文の ID。
場所 ID	refund.location_id	string	場所の識別子。

ターミナルの払い戻しを受ける

操作 ID:

TerminalGetRefund

ID で Interac ターミナルの払い戻しオブジェクトを取得します。

パラメーター

名前	キー	必須	型	説明
ターミナル払い戻し ID	terminal_refund_id	True	string	ターミナルの払い戻しの識別子。

戻り値

名前	パス	型	説明
ID	refund.id	string	Square で発行された一意の識別子。
払い戻し ID	refund.refund_id	string	Square によって生成された、この払い戻しの一意の ID。
決済識別子	refund.payment_id	string	支払いの一意の ID。
金額	refund.amount_money.amount	integer	金額。
通貨	refund.amount_money.currency	string	通貨。
理由	refund.reason	string	このオブジェクトの理由。
デバイス識別子	refund.device_id	string	この TerminalRefund 用のデバイスの一意の ID。
期限の期間	refund.deadline_duration	string	RFC 3339 期間。その後、チェックアウトが自動的に取り消されます。 保留中の TerminalCheckout は自動的に取り消され、TIMED_OUTのキャンセル理由があります。 既定値: 作成から 5 分
ステータス	refund.status	string	このオブジェクトの現在の検証状態。
Created At	refund.created_at	string	RFC 3339 形式で、このオブジェクトの作成時刻を指定するタイムスタンプ。
更新日時	refund.updated_at	string	RFC 3339 形式で、このオブジェクトの最新の更新時刻を指定するタイムスタンプ。
アプリ ID	refund.app_id	string	チェックアウトを作成したアプリケーションの ID。
カード ブランド	refund.card.card_brand	string	カードのブランド。
last_4	refund.card.last_4	string	カード番号の最後の 4 桁。
Exp Month	refund.card.exp_month	integer	関連付けられているカードの有効期限の月を 1 ~ 12 の整数で指定します。
Exp Year	refund.card.exp_year	integer	カードの有効期限の 4 桁の年。
指紋	refund.card.fingerprint	string	1 つのアプリケーション内の複数の場所でカードを識別するために、カード番号に基づいて、正方形に割り当てられた識別子として意図されています。
カードの種類	refund.card.card_type	string	カードの種類。
ごみ箱	refund.card.bin	string	銀行識別番号 (BIN) と呼ばれるカード番号の最初の 6 桁。
注文 ID	refund.order_id	string	注文の ID。
場所 ID	refund.location_id	string	場所の識別子。

バッチでインベントリの変更を取得する

操作 ID:

InventoryBatchRetrieveChanges

指定されたフィルター条件に基づいて、物理カウントと調整の履歴を返します。

パラメーター

名前	キー	必須	型	説明
Catalog オブジェクト ID	catalog_object_ids		array of string
場所 ID	location_ids		array of string
種類	types		array of string
States	states		array of string
更新後	updated_after		string	RFC 3339 タイムスタンプで指定された時刻より後にcalculated_at値を持つ結果を返すフィルター。
更新前	updated_before		string	RFC 3339 タイムスタンプで指定された時刻より厳密に前に、created_atまたはcalculated_at値を持つ結果を返すフィルター。

戻り値

名前	パス	型	説明
Changes	changes	array of object
タイプ	changes.type	string	このオブジェクトの種類。
ID	changes.physical_count.id	string	オブジェクトの識別子
参照 ID	changes.physical_count.reference_id	string	このカードを外部システムの別のエンティティに関連付ける、オプションのユーザー定義参照 ID。
カタログ オブジェクト ID	changes.physical_count.catalog_object_id	string	追跡対象の CatalogObject の 2 乗生成 ID。
Catalog オブジェクトの種類	changes.physical_count.catalog_object_type	string	追跡対象の CatalogObject の種類。
State	changes.physical_count.state	string	関連する品目の数量の現在の在庫状態。
場所 ID	changes.physical_count.location_id	string	この入札の一部を受け取る受信者 (販売者以外) の場所 ID。
数量	changes.physical_count.quantity	string	10 進文字列としての物理カウントの影響を受ける項目の数。 この数値は、小数点の後に最大 5 桁までサポートできます。
Product	changes.physical_count.source.product	string	アプリケーションの製品の種類。
アプリケーション識別子	changes.physical_count.source.application_id	string	アプリケーションに割り当てられた正方形の ID。
名前	changes.physical_count.source.name	string	アイテムの名前。
従業員 ID	changes.physical_count.employee_id	string	物理的なカウントを担当する従業員の 2 乗生成 ID。
発生日	changes.physical_count.occurred_at	string	物理カウントがいつ検査されたかを示す、クライアントによって生成された RFC 3339 形式のタイムスタンプ。 物理カウントの更新の場合、occurred_atタイムスタンプは、要求の時刻に対して 24 時間より古くすることはできません。
Created At	changes.physical_count.created_at	string	物理カウントがいつ作成されたかを示す、クライアントによって生成された RFC 3339 形式のタイムスタンプ。

バッチでインベントリ数を取得する

操作 ID:

InventoryBatchRetrieveCounts

要求された場所で指定された CatalogObject の現在の数を返します。

パラメーター

名前	キー	必須	型	説明
Catalog オブジェクト ID	catalog_object_ids		array of string
場所 ID	location_ids		array of string
更新後	updated_after		string	RFC 3339 タイムスタンプで指定された時刻より後にcalculated_at値を持つ結果を返すフィルター。

戻り値

名前	パス	型	説明
カウント	counts	array of object
カタログ オブジェクト ID	counts.catalog_object_id	string	追跡対象の CatalogObject の 2 乗生成 ID。
Catalog オブジェクトの種類	counts.catalog_object_type	string	追跡対象の CatalogObject の種類。
State	counts.state	string	現在の状態。
場所 ID	counts.location_id	string	場所の識別子。
数量	counts.quantity	string	10 進文字列としての推定カウントの影響を受ける項目の数。 小数点の後に最大 5 桁までサポートできます。
計算対象	counts.calculated_at	string	推定カウントに影響する最新の物理カウントまたは調整をいつ受信するかを示す RFC 3339 形式のタイムスタンプ。

バッチで注文を取得する

操作 ID:

OrderBatchRetrieve

ID によって注文のセットを取得します。 特定の注文 ID が存在しない場合、ID はエラーを生成する代わりに無視されます。

パラメーター

名前	キー	必須	型	説明
場所 ID	location_id		string	場所識別子。
注文 ID	order_ids		array of string

戻り値

名前	パス	型	説明
順序	orders	array of object
ID	orders.id	string	Square で発行された一意の識別子。
場所 ID	orders.location_id	string	場所の識別子。
参照 ID	orders.reference_id	string	顧客プロファイルを別のシステムのエンティティに関連付けるために使用する省略可能な 2 番目の ID。
行項目	orders.line_items	array of object
UID	orders.line_items.uid	string	請求書の支払い要求の 2 乗生成 ID。
名前	orders.line_items.name	string	人間が判読できる名前。
数量	orders.line_items.quantity	string	購入した数量。10 進数で書式設定されます。
金額	orders.line_items.base_price_money.amount	integer	金額。
通貨	orders.line_items.base_price_money.currency	string	通貨。
金額	orders.line_items.total_money.amount	integer	金額。
通貨	orders.line_items.total_money.currency	string	通貨。
金額	orders.total_money.amount	integer	金額。
通貨	orders.total_money.currency	string	通貨。

バッチ取得カタログ オブジェクト

操作 ID:

CatalogBatchRetrieve

指定された ID に基づいてオブジェクトのセットを返します。 セットで返される各 CatalogItem には、すべての CatalogItemVariation オブジェクト、CatalogModifierList オブジェクトへの参照、それに適用されるすべての CatalogTax オブジェクトの ID など、すべての子情報が含まれます。

パラメーター

名前	キー	必須	型	説明
オブジェクト ID	object_ids		array of string
カタログ バージョン	catalog_version		integer	応答に含めるカタログ オブジェクトの特定のバージョン。 これにより、オブジェクトの履歴バージョンを取得できます。 指定したバージョン値が CatalogObjects のバージョン属性と一致します。
関連オブジェクトを含める	include_related_objects		boolean	true の場合、応答には、要求されたオブジェクトに関連する追加のオブジェクトが含まれます。応答のオブジェクト フィールドに CatalogItem が含まれている場合、対応する CatalogCategory オブジェクト、CatalogTax オブジェクト、CatalogImage オブジェクト、CatalogModifierLists が応答のrelated_objects フィールドに返されます。 応答のオブジェクト フィールドに CatalogItemVariation が含まれている場合、その親 CatalogItem は応答の related_objects フィールドに返されます。

戻り値

名前	パス	型	説明
オブジェクト	objects	array of object
タイプ	objects.type	string	このオブジェクトの種類。
ID	objects.id	string	Square で発行された一意の識別子。
更新日時	objects.updated_at	string	RFC 3339 形式の最終変更タイムスタンプ
バージョン	objects.version	integer	オブジェクトの現在のバージョン。
削除済み	objects.is_deleted	boolean	true の場合、オブジェクトはデータベースから削除されています。 挿入する新しいオブジェクトの場合は false にする必要があります。 削除すると、updated_at フィールドは削除時間と等しくなります。
すべての場所に存在する	objects.present_at_all_locations	boolean	true の場合、このオブジェクトは、absent_at_location_ids フィールドで指定されている場合を除き、すべての場所 (将来の場所を含む) に存在します。 false の場合、このオブジェクトは、present_at_location_ids フィールドで指定されている場合を除き、(将来の場所を含む) どの場所にも存在しません。 指定しない場合、既定値は true になります。
名前	objects.item_data.name	string	アイテムの名前。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、その値を空にすることはできません。長さは Unicode コード ポイントです。
Description	objects.item_data.title	string	アイテムの説明。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、値の長さは Unicode コード ポイントです。
カテゴリ ID	objects.item_data.category_id	string	アイテムのカテゴリの ID (存在する場合)。
税務識別番号	objects.item_data.tax_ids	array of string
バリエーション	objects.item_data.variations	array of object
タイプ	objects.item_data.variations.type	string	このオブジェクトの種類。 各オブジェクト型には、対応する *_data フィールド内で構造化された形式で表されるプロパティが必要です。
ID	objects.item_data.variations.id	string	このオブジェクトを参照する識別子。
更新日時	objects.item_data.variations.updated_at	string	RFC 3339 形式の最終変更タイムスタンプ
バージョン	objects.item_data.variations.version	integer	オブジェクトのバージョン。 オブジェクトを更新する場合、指定されたバージョンはデータベース内のバージョンと一致する必要があります。そうしないと、書き込みが競合として拒否されます。
削除済み	objects.item_data.variations.is_deleted	boolean	true の場合、オブジェクトはデータベースから削除されています。 挿入する新しいオブジェクトの場合は false にする必要があります。 削除すると、updated_at フィールドは削除時間と等しくなります。
すべての場所に存在する	objects.item_data.variations.present_at_all_locations	boolean	present_at_all_locationsが false の場合でも、オブジェクトが存在する場所のリスト。 これには、非アクティブ化された場所を含めることができます。
アイテム ID	objects.item_data.variations.item_variation_data.item_id	string	この項目バリエーションを持つオブジェクトの ID。
名前	objects.item_data.variations.item_variation_data.name	string	このアイテムの名前。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、値の長さは Unicode コード ポイントです。
序数	objects.item_data.variations.item_variation_data.ordinal	integer	この項目のバリエーションを表示する順序。 この値は読み取り専用です。
価格の種類	objects.item_data.variations.item_variation_data.pricing_type	string	品目バリエーションの価格を固定するか、販売時に決定するかを示します。
金額	objects.item_data.variations.item_variation_data.price_money.amount	integer	通貨で示される通貨の最小の分母単位での金額。 たとえば、通貨が USD の場合、金額はセント単位です。 金額は、正または負の値にすることができます。 特定のケースでのサインインの意味を判断するには、特定のフィールドの説明を参照してください。
通貨	objects.item_data.variations.item_variation_data.price_money.currency	string	ISO 4217 形式の通貨の種類。 たとえば、米ドルの通貨コードは USD です。
関連オブジェクト	related_objects	array of object
タイプ	related_objects.type	string	このオブジェクトの種類。
ID	related_objects.id	string	Square で発行された一意の識別子。
更新日時	related_objects.updated_at	string	RFC 3339 形式の最終変更タイムスタンプ
バージョン	related_objects.version	integer	オブジェクトの現在のバージョン。
削除済み	related_objects.is_deleted	boolean	true の場合、オブジェクトはデータベースから削除されています。 挿入する新しいオブジェクトの場合は false にする必要があります。 削除すると、updated_at フィールドは削除時間と等しくなります。
すべての場所に存在する	related_objects.present_at_all_locations	boolean	true の場合、このオブジェクトは、absent_at_location_ids フィールドで指定されている場合を除き、すべての場所 (将来の場所を含む) に存在します。 false の場合、このオブジェクトは、present_at_location_ids フィールドで指定されている場合を除き、(将来の場所を含む) どの場所にも存在しません。 指定しない場合、既定値は true になります。
名前	related_objects.category_data.name	string	アイテムの名前。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、その値を空にすることはできません。長さは Unicode コード ポイントです。
名前	related_objects.tax_data.name	string	アイテムの名前。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、その値を空にすることはできません。長さは Unicode コード ポイントです。
計算フェーズ	related_objects.tax_data.calculation_phase	string	税金が支払いの小計または合計に基づいて計算されるかどうか。
包含の種類	related_objects.tax_data.inclusion_type	string	税金が追加的か包括かを指定します。
百分率	related_objects.tax_data.percentage	string	小数点区切り記号として '.' を使用し、'%' 記号を使用しない、小数点形式のパーセンテージ。 値 7.5 は 7.5%に対応します。
Enabled	related_objects.tax_data.enabled	boolean	オブジェクトを使用できるかどうかを示します。

バッチ変更インベントリ

操作 ID:

InventoryBatchChange

指定された品目数量に調整とカウントを適用します。 成功した場合: 要求で参照されているすべてのオブジェクトの現在の計算カウントを返します。

パラメーター

名前	キー	必須	型	説明
べき等キー	idempotency_key		string	すべての要求の中でこの要求を一意に識別する値を指定します。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。
タイプ	type		string	このオブジェクトの種類。
参照 ID	reference_id		string	このカードを外部システムの別のエンティティに関連付ける、オプションのユーザー定義参照 ID。
カタログ オブジェクト ID	catalog_object_id		string	追跡対象の CatalogObject の 2 乗生成 ID。
State	state		string	関連する品目の数量の現在の在庫状態。
場所 ID	location_id		string	この入札の一部を受け取る受信者 (販売者以外) の場所 ID。
数量	quantity		string	10 進文字列としての物理カウントの影響を受ける項目の数。 この数値は、小数点の後に最大 5 桁までサポートできます。
従業員 ID	employee_id		string	物理的なカウントを担当する従業員の 2 乗生成 ID。
発生日	occurred_at		string	物理カウントがいつ検査されたかを示す、クライアントによって生成された RFC 3339 形式のタイムスタンプ。 物理カウントの更新の場合、occurred_atタイムスタンプは、要求の時刻に対して 24 時間より古くすることはできません。
変更されていないカウントを無視する	ignore_unchanged_counts		boolean	最後の物理カウント以降に数量が変更されていない場合に、現在の物理カウントを無視するかどうかを示します。

戻り値

名前	パス	型	説明
カウント	counts	array of object
カタログ オブジェクト ID	counts.catalog_object_id	string	追跡対象の CatalogObject の 2 乗生成 ID。
Catalog オブジェクトの種類	counts.catalog_object_type	string	追跡対象の CatalogObject の種類。
State	counts.state	string	現在の状態。
場所 ID	counts.location_id	string	場所の識別子。
数量	counts.quantity	string	10 進文字列としての推定カウントの影響を受ける項目の数。 小数点の後に最大 5 桁までサポートできます。
計算対象	counts.calculated_at	string	推定カウントに影響する最新の物理カウントまたは調整をいつ受信するかを示す RFC 3339 形式のタイムスタンプ。

在庫調整の取得

操作 ID:

InventoryRetrieveAdjustment

指定されたadjustment_idを持つ InventoryAdjustment オブジェクトを返します。

パラメーター

名前	キー	必須	型	説明
調整 ID	adjustment_id	True	string	調整の識別子。

戻り値

名前	パス	型	説明
ID	adjustment.id	string	Square で発行された一意の識別子。
参照 ID	adjustment.reference_id	string	省略可能なユーザー定義参照 ID。
From State	adjustment.from_state	string	調整前の品目の関連数量の在庫状態。
To State	adjustment.to_state	string	調整後の品目の関連数量の在庫状態。
場所 ID	adjustment.location_id	string	場所の識別子。
カタログ オブジェクト ID	adjustment.catalog_object_id	string	追跡対象の CatalogObject の 2 乗生成 ID。
Catalog オブジェクトの種類	adjustment.catalog_object_type	string	追跡対象の CatalogObject の種類。
数量	adjustment.quantity	string	調整の影響を受ける項目の数を 10 進文字列として指定します。 小数点の後に最大 5 桁までサポートできます。
金額	adjustment.total_price_money.amount	integer	金額。
通貨	adjustment.total_price_money.currency	string	通貨。
発生日	adjustment.occurred_at	string	インベントリ調整がいつ行われたか示す、クライアントによって生成された RFC 3339 形式のタイムスタンプ。 在庫調整の更新の場合、occurred_atタイムスタンプは、要求の時刻に対して 24 時間より古くすることはできません。
Created At	adjustment.created_at	string	RFC 3339 形式で、このオブジェクトの作成時刻を指定するタイムスタンプ。
Product	adjustment.source.product	string	アプリケーションの製品の種類。
アプリケーション識別子	adjustment.source.application_id	string	アプリケーションに割り当てられた読み取り専用の Square ID。
名前	adjustment.source.name	string	名前。
従業員 ID	adjustment.employee_id	string	従業員の正方形で生成された ID。

払い戻しの支払い

操作 ID:

RefundPayment

支払いを払い戻します。 支払い金額全体またはその一部を払い戻すことができます。 このエンドポイントを使用して、カードの支払いを返金したり、現金または外部支払いの払い戻しを記録したりすることができます。

パラメーター

名前	キー	必須	型	説明
べき等キー	idempotency_key		string	すべての要求の中でこの要求を一意に識別する値を指定します。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。
決済識別子	payment_id		string	払い戻される支払いの一意の ID。
金額	amount		integer	tip_moneyを含まない、この支払いに対して受け入れる金額。
通貨	currency		string	3 文字の ISO 4217 通貨コード。
金額	amount		integer	tip_moneyを含まない、この支払いに対して受け入れる金額。
通貨	currency		string	3 文字の ISO 4217 通貨コード。
理由	reason		string	払い戻しの理由の説明。

戻り値

名前	パス	型	説明
ID	refund.id	string	Square で発行された一意の識別子。
ステータス	refund.status	string	このオブジェクトの現在の検証状態。
金額	refund.amount_money.amount	integer	金額。
通貨	refund.amount_money.currency	string	通貨。
決済識別子	refund.payment_id	string	支払いの一意の ID。
注文 ID	refund.order_id	string	注文の ID。
Created At	refund.created_at	string	RFC 3339 形式で、このオブジェクトの作成時刻を指定するタイムスタンプ。
更新日時	refund.updated_at	string	RFC 3339 形式で、このオブジェクトの最新の更新時刻を指定するタイムスタンプ。
金額	refund.app_fee_money.amount	integer	金額。
通貨	refund.app_fee_money.currency	string	通貨。
場所 ID	refund.location_id	string	場所の識別子。
理由	refund.reason	string	このオブジェクトの理由。

支払いの完了

操作 ID:

PaymentComplete

支払いを完了 (キャプチャ) します。 既定では、支払いは作成された直後に完了するように設定されます。

パラメーター

名前	キー	必須	型	説明
決済識別子	payment_id	True	string	支払いの識別子。

戻り値

名前	パス	型	説明
ID	payment.id	string	Square で発行された一意の識別子。
Created At	payment.created_at	string	RFC 3339 形式で、このオブジェクトの作成時刻を指定するタイムスタンプ。
更新日時	payment.updated_at	string	RFC 3339 形式で、このオブジェクトの最新の更新時刻を指定するタイムスタンプ。
金額	payment.amount_money.amount	integer	金額。
通貨	payment.amount_money.currency	string	通貨。
ステータス	payment.status	string	このオブジェクトの現在の検証状態。
遅延時間	payment.delay_duration	string	Square が自動的にdelay_actionを支払いに適用する場合の、支払の作成後の時間。 この自動delay_actionは、delay_duration期間の前に終了状態 (COMPLETED、CANCELED、または FAILED) に達しない支払いにのみ適用されます。 このフィールドは、RFC 3339 形式の期間として指定されます。
ソースの種類	payment.source_type	string	この支払のソースの種類。 現在の値には、CARD、BANK_ACCOUNT、WALLET、CASH、EXTERNAL が含まれます。
ステータス	payment.card_details.status	string	現在の状態。
カード ブランド	payment.card_details.card.card_brand	string	カードのブランド。
最後の 4	payment.card_details.card.last_4	string	カード番号の最後の 4 桁。
Exp Month	payment.card_details.card.exp_month	integer	関連付けられているカードの有効期限の月を 1 ~ 12 の整数で指定します。
Exp Year	payment.card_details.card.exp_year	integer	カードの有効期限の 4 桁の年。
指紋	payment.card_details.card.fingerprint	string	1 つのアプリケーション内の複数の場所でカードを識別するために、カード番号に基づいて、正方形に割り当てられた識別子として意図されています。
カードの種類	payment.card_details.card.card_type	string	カードの種類。
前払いの種類	payment.card_details.card.prepaid_type	string	カードが前払いされているかどうかを示します。
ごみ箱	payment.card_details.card.bin	string	銀行識別番号 (BIN) と呼ばれるカード番号の最初の 6 桁。
Entry メソッド	payment.card_details.entry_method	string	支払いのカードの詳細を入力するために使用される方法。 このメソッドには、KEYED、SWIPED、EMV、ON_FILE、または CONTACTLESS を指定できます。
CVV 状態	payment.card_details.cvv_status	string	カード検証値 (CVV) チェックから返される状態コード。 コードは、CVV_ACCEPTED、CVV_REJECTED、またはCVV_NOT_CHECKEDできます。
AVS の状態	payment.card_details.avs_status	string	アドレス確認システム (AVS) チェックから返された状態コード。 コードは、AVS_ACCEPTED、AVS_REJECTED、またはAVS_NOT_CHECKEDできます。
認証結果コード	payment.card_details.auth_result_code	string	支払いの承認状態を説明するカード発行者によって返される状態コード。
ステートメントの説明	payment.card_details.statement_description	string	カード ネットワークに送信されるステートメントの説明。
Authorized At	payment.card_details.card_payment_timeline.authorized_at	string	支払いが承認されたときのタイムスタンプ (RFC 3339 形式)。
キャプチャ日	payment.card_details.card_payment_timeline.captured_at	string	支払いがキャプチャされたときのタイムスタンプ (RFC 3339 形式)。
場所 ID	payment.location_id	string	場所の識別子。
注文 ID	payment.order_id	string	注文の ID。
処理料金	payment.processing_fee	array of object
Effective At	payment.processing_fee.effective_at	string	料金が有効になったときのタイムスタンプ (RFC 3339 形式)。
タイプ	payment.processing_fee.type	string	型を示します。
金額	payment.processing_fee.amount_money.amount	integer	金額。
通貨	payment.processing_fee.amount_money.currency	string	通貨。
注	payment.note	string	顧客プロファイルに関連付けられているカスタム メモ。
金額	payment.total_money.amount	integer	金額。
通貨	payment.total_money.currency	string	通貨。
金額	payment.approved_money.amount	integer	金額。
通貨	payment.approved_money.currency	string	通貨。
従業員 ID	payment.employee_id	string	従業員の正方形で生成された ID。
レシート番号	payment.receipt_number	string	支払いのレシート番号。 支払いが取り消された場合、このフィールドは表示されません。
レシート URL	payment.receipt_url	string	支払いの領収書の URL。 このフィールドには、COMPLETED 支払についてのみ入力されます。
遅延アクション	payment.delay_action	string	delay_durationが経過したときに支払いに適用されるアクション。
遅延時間	payment.delayed_until	string	delay_actionが自動的に適用されたときの読み取り専用タイムスタンプ (RFC 3339 形式)。
チーム メンバー ID	payment.team_member_id	string	チーム メンバーの ID。
正方形の製品	payment.application_details.square_product	string	Square Point of Sale (POS)、Square Invoices、Square Virtual Terminal などの Square 製品。
アプリケーション識別子	payment.application_details.application_id	string	アプリケーションに割り当てられた読み取り専用の Square ID。
バージョン トークン	payment.version_token	string	この不透明なトークンは、オブジェクトの特定のバージョンを識別します。

支払いの払い戻しを一覧表示する

操作 ID:

RefundList

要求を行っているアカウントの払い戻しの一覧を取得します。 結果は最終的に一貫しており、新しい払い戻しや払い戻しの変更が表示されるまでに数秒かかる場合があります。

パラメーター

名前	キー	必須	型	説明
開始時刻	begin_time		string	opened_atに対するクエリの包括的な開始時刻 (ISO 8601 形式)。
終了時刻	end_time		string	opened_atに対するクエリの排他終了日 (ISO 8601 形式)。
並べ替え順序	sort_order		string	指定した順序でカードが作成されたときに、返されたリストを並べ替えます。
Cursor	cursor		string	このエンドポイントに対する以前の呼び出しによって返された改ページ位置カーソル。
場所 ID	location_id		string	このオプションのフィルターを指定すると、特定の場所に属するレコードのみを取得できます。
ステータス	status		string	指定した場合は、指定した状態に一致するオブジェクトのみを返します。
ソースの種類	source_type		string	指定した場合、指定されたソースの種類の払い戻しのみが返されます。
極限	limit		integer	応答で返される数の上限。

戻り値

名前	パス	型	説明
払い戻し	refunds	array of object
ID	refunds.id	string	Square で発行された一意の識別子。
ステータス	refunds.status	string	このオブジェクトの現在の検証状態。
金額	refunds.amount_money.amount	integer	金額。
通貨	refunds.amount_money.currency	string	通貨。
決済識別子	refunds.payment_id	string	支払いの ID。
注文 ID	refunds.order_id	string	注文の ID。
Created At	refunds.created_at	string	ISO 8601 形式のイベント時間。
更新日時	refunds.updated_at	string	RFC 3339 形式の最終変更タイムスタンプ
処理料金	refunds.processing_fee	array of object
Effective At	refunds.processing_fee.effective_at	string	料金が有効になったときのタイムスタンプ (RFC 3339 形式)。
タイプ	refunds.processing_fee.type	string	このオブジェクトの種類。
金額	refunds.processing_fee.amount_money.amount	integer	金額。
通貨	refunds.processing_fee.amount_money.currency	string	通貨。
場所 ID	refunds.location_id	string	場所の識別子。
理由	refunds.reason	string	カード所有者が銀行との紛争を開始した理由。
Cursor	cursor	string	このエンドポイントへの後続の呼び出しに改ページ カーソルを含め、元のクエリに関連付けられた次の結果セットを取得します。

支払いの払い戻しを受ける

操作 ID:

RefundGet

refund_idを使用して特定の払い戻しを取得します。

パラメーター

名前	キー	必須	型	説明
払い戻し ID	refund_id	True	string	払い戻しの識別子。

戻り値

名前	パス	型	説明
ID	refund.id	string	Square で発行された一意の識別子。
ステータス	refund.status	string	このオブジェクトの現在の検証状態。
金額	refund.amount_money.amount	integer	金額。
通貨	refund.amount_money.currency	string	通貨。
決済識別子	refund.payment_id	string	支払いの一意の ID。
注文 ID	refund.order_id	string	注文の ID。
Created At	refund.created_at	string	RFC 3339 形式で、このオブジェクトの作成時刻を指定するタイムスタンプ。
更新日時	refund.updated_at	string	RFC 3339 形式で、このオブジェクトの最新の更新時刻を指定するタイムスタンプ。
処理料金	refund.processing_fee	array of object
Effective At	refund.processing_fee.effective_at	string	料金が有効になったときのタイムスタンプ (RFC 3339 形式)。
タイプ	refund.processing_fee.type	string	型を示します。
金額	refund.processing_fee.amount_money.amount	integer	金額。
通貨	refund.processing_fee.amount_money.currency	string	通貨。
場所 ID	refund.location_id	string	場所の識別子。
理由	refund.reason	string	このオブジェクトの理由。

支払いを一覧表示する

操作 ID:

PaymentList

要求を行うアカウントによって取得された支払いの一覧を取得します。 結果は最終的に一貫しており、新しい支払いや支払いの変更が表示されるまでに数秒かかる場合があります。

パラメーター

名前	キー	必須	型	説明
開始時刻	begin_time		string	opened_atに対するクエリの包括的な開始時刻 (ISO 8601 形式)。
終了時刻	end_time		string	opened_atに対するクエリの排他終了日 (ISO 8601 形式)。
並べ替え順序	sort_order		string	指定した順序でカードが作成されたときに、返されたリストを並べ替えます。
Cursor	cursor		string	このエンドポイントに対する以前の呼び出しによって返された改ページ位置カーソル。
場所 ID	location_id		string	このオプションのフィルターを指定すると、特定の場所に属するレコードのみを取得できます。
合計	total		integer	支払いのtotal_moneyの正確な金額。
最後の 4	last_4		string	支払いカードの最後の 4 桁。
カード ブランド	card_brand		string	支払いカードのブランド (VISA など)。
極限	limit		integer	応答で返される数の上限。

戻り値

名前	パス	型	説明
支払い	payments	array of object
ID	payments.id	string	Square で発行された一意の識別子。
Created At	payments.created_at	string	ISO 8601 形式のイベント時間。
更新日時	payments.updated_at	string	RFC 3339 形式の最終変更タイムスタンプ
金額	payments.amount_money.amount	integer	金額。
通貨	payments.amount_money.currency	string	通貨。
ステータス	payments.status	string	このオブジェクトの現在の検証状態。
遅延時間	payments.delay_duration	string	Square が自動的にdelay_actionを支払いに適用する場合の、支払の作成後の時間。
ソースの種類	payments.source_type	string	この支払のソースの種類。
ステータス	payments.card_details.status	string	カード支払いの現在の状態。 状態は、AUTHORIZED、CAPTURED、VOIDED、または FAILED にすることができます。
カード ブランド	payments.card_details.card.card_brand	string	カードのブランド。
last_4	payments.card_details.card.last_4	string	カード番号の最後の 4 桁。
Exp Month	payments.card_details.card.exp_month	integer	関連付けられているカードの有効期限の月を 1 ~ 12 の整数で指定します。
Exp Year	payments.card_details.card.exp_year	integer	カードの有効期限の 4 桁の年。
指紋	payments.card_details.card.fingerprint	string	1 つのアプリケーション内の複数の場所でカードを識別するために、カード番号に基づいて、正方形に割り当てられた識別子として意図されています。
カードの種類	payments.card_details.card.card_type	string	カードの種類。
前払いの種類	payments.card_details.card.prepaid_type	string	カードが前払いされているかどうかを示します。
ごみ箱	payments.card_details.card.bin	string	銀行識別番号 (BIN) と呼ばれるカード番号の最初の 6 桁
Entry メソッド	payments.card_details.entry_method	string	支払いのカードの詳細を入力するために使用される方法。 このメソッドには、KEYED、SWIPED、EMV、ON_FILE、または CONTACTLESS を指定できます。
Cvv の状態	payments.card_details.cvv_status	string	カード検証値 (CVV) チェックから返される状態コード。 コードは、CVV_ACCEPTED、CVV_REJECTED、またはCVV_NOT_CHECKEDできます。
Avs の状態	payments.card_details.avs_status	string	アドレス確認システム (AVS) チェックから返された状態コード。 コードは、AVS_ACCEPTED、AVS_REJECTED、またはAVS_NOT_CHECKEDできます。
認証結果コード	payments.card_details.auth_result_code	string	支払いの承認状態を説明するカード発行者によって返される状態コード。
ステートメントの説明	payments.card_details.statement_description	string	カード ネットワークに送信されるステートメントの説明。
Authorized At	payments.card_details.card_payment_timeline.authorized_at	string	支払いが承認されたときのタイムスタンプ (RFC 3339 形式)。
キャプチャ日	payments.card_details.card_payment_timeline.captured_at	string	支払いがキャプチャされたときのタイムスタンプ (RFC 3339 形式)。
場所 ID	payments.location_id	string	場所の識別子。
注文 ID	payments.order_id	string	注文の ID。
処理料金	payments.processing_fee	array of object
Effective At	payments.processing_fee.effective_at	string	料金が有効になったときのタイムスタンプ (RFC 3339 形式)。
タイプ	payments.processing_fee.type	string	このオブジェクトの種類。
金額	payments.processing_fee.amount_money.amount	integer	金額。
通貨	payments.processing_fee.amount_money.currency	string	通貨。
注	payments.note	string	顧客プロファイルに関連付けられているカスタム メモ。
金額	payments.total_money.amount	integer	金額。
通貨	payments.total_money.currency	string	通貨。
金額	payments.approved_money.amount	integer	金額。
通貨	payments.approved_money.currency	string	通貨。
レシート番号	payments.receipt_number	string	支払いのレシート番号。 支払いが取り消された場合、このフィールドは表示されません。
レシート URL	payments.receipt_url	string	支払いの領収書の URL。 このフィールドには、COMPLETED 支払についてのみ入力されます。
遅延アクション	payments.delay_action	string	delay_durationが経過したときに支払いに適用されるアクション。
遅延時間	payments.delayed_until	string	delay_actionが自動的に適用されたときの読み取り専用タイムスタンプ (RFC 3339 形式)。
チーム メンバー ID	payments.team_member_id	string	オブジェクトに関連付けられているチーム メンバーの TeamMember オブジェクトの ID。
正方形の製品	payments.application_details.square_product	string	Square Point of Sale (POS)、Square Invoices、Square Virtual Terminal などの Square 製品。
アプリケーション識別子	payments.application_details.application_id	string	支払いの受け取りに使用されるアプリケーションに割り当てられた Square ID。 アプリケーション開発者は、この情報を使用して、アプリケーションが処理した支払いを識別できます。 たとえば、開発者がカスタム アプリケーションを使用して支払いを処理する場合、このフィールドには開発者ダッシュボードのアプリケーション ID が含まれます。 販売者が Square App Marketplace アプリケーションを使用して支払いを処理する場合、フィールドには対応するアプリケーション ID が含まれます。
バージョン トークン	payments.version_token	string	オプティミスティック コンカレンシーに使用されます。 この不透明なトークンは、Payment オブジェクトの特定のバージョンを識別します。

支払いを作成する

操作 ID:

PaymentCreate

指定されたソースを使用して支払いを作成します。 このエンドポイントを使用して、カード (クレジット/デビット カードまたは Square ギフト カード) を請求したり、販売者が Square の外部で受け取った支払い (購入者からの現金支払い、または外部エンティティが販売者に代わって処理した支払い) を記録したりできます。

パラメーター

名前	キー	必須	型	説明
べき等キー	idempotency_key		string	すべての要求の中でこの要求を一意に識別する値を指定します。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。
金額	amount		integer	tip_moneyを含まない、この支払いに対して受け入れる金額。
通貨	currency		string	3 文字の ISO 4217 通貨コード。
ソース ID	source_id		string	この支払いの資金源の ID。 これは、Square 支払いフォームによって生成された支払いトークン (カード nonce) または Customers API で作成されたファイル上のカードです。 販売者が Square の外部で受け取った支払いを記録する場合は、CASH または EXTERNAL を指定します。
オートコンプリート	autocomplete		boolean	true に設定すると、可能な限りこの支払いが完了します。 false に設定すると、明示的に完了 (キャプチャ) または取り消し (無効) されるまで、この支払いは承認された状態で保持されます。
顧客ID	customer_id		string	リンクする顧客の ID。
場所 ID	location_id		string	場所識別子。
参照 ID	reference_id		string	顧客プロファイルを別のシステムのエンティティに関連付けるために使用する省略可能な 2 番目の ID。
注	note		string	顧客プロファイルに関連付けられているカスタム メモ。
金額	amount		integer	tip_moneyを含まない、この支払いに対して受け入れる金額。
通貨	currency		string	3 文字の ISO 4217 通貨コード。

戻り値

名前	パス	型	説明
ID	payment.id	string	Square で発行された一意の識別子。
Created At	payment.created_at	string	RFC 3339 形式で、このオブジェクトの作成時刻を指定するタイムスタンプ。
更新日時	payment.updated_at	string	RFC 3339 形式で、このオブジェクトの最新の更新時刻を指定するタイムスタンプ。
金額	payment.amount_money.amount	integer	金額。
通貨	payment.amount_money.currency	string	通貨。
金額	payment.app_fee_money.amount	integer	金額。
通貨	payment.app_fee_money.currency	string	通貨。
ステータス	payment.status	string	このオブジェクトの現在の検証状態。
遅延時間	payment.delay_duration	string	Square が自動的にdelay_actionを支払いに適用する場合の、支払の作成後の時間。 この自動delay_actionは、delay_duration期間の前に終了状態 (COMPLETED、CANCELED、または FAILED) に達しない支払いにのみ適用されます。 このフィールドは、RFC 3339 形式の期間として指定されます。
ソースの種類	payment.source_type	string	この支払のソースの種類。 現在の値には、CARD、BANK_ACCOUNT、WALLET、CASH、EXTERNAL が含まれます。
ステータス	payment.card_details.status	string	現在の状態。
カード ブランド	payment.card_details.card.card_brand	string	カードのブランド。
最後の 4	payment.card_details.card.last_4	string	カード番号の最後の 4 桁。
Exp Month	payment.card_details.card.exp_month	integer	関連付けられているカードの有効期限の月を 1 ~ 12 の整数で指定します。
Exp Year	payment.card_details.card.exp_year	integer	カードの有効期限の 4 桁の年。
指紋	payment.card_details.card.fingerprint	string	1 つのアプリケーション内の複数の場所でカードを識別するために、カード番号に基づいて、正方形に割り当てられた識別子として意図されています。
カードの種類	payment.card_details.card.card_type	string	カードの種類。
前払いの種類	payment.card_details.card.prepaid_type	string	カードが前払いされているかどうかを示します。
ごみ箱	payment.card_details.card.bin	string	銀行識別番号 (BIN) と呼ばれるカード番号の最初の 6 桁。
Entry メソッド	payment.card_details.entry_method	string	支払いのカードの詳細を入力するために使用される方法。 このメソッドには、KEYED、SWIPED、EMV、ON_FILE、または CONTACTLESS を指定できます。
CVV 状態	payment.card_details.cvv_status	string	カード検証値 (CVV) チェックから返される状態コード。 コードは、CVV_ACCEPTED、CVV_REJECTED、またはCVV_NOT_CHECKEDできます。
AVS の状態	payment.card_details.avs_status	string	アドレス確認システム (AVS) チェックから返された状態コード。 コードは、AVS_ACCEPTED、AVS_REJECTED、またはAVS_NOT_CHECKEDできます。
認証結果コード	payment.card_details.auth_result_code	string	支払いの承認状態を説明するカード発行者によって返される状態コード。
ステートメントの説明	payment.card_details.statement_description	string	カード ネットワークに送信されるステートメントの説明。
Authorized At	payment.card_details.card_payment_timeline.authorized_at	string	支払いが承認されたときのタイムスタンプ (RFC 3339 形式)。
キャプチャ日	payment.card_details.card_payment_timeline.captured_at	string	支払いがキャプチャされたときのタイムスタンプ (RFC 3339 形式)。
場所 ID	payment.location_id	string	場所の識別子。
注文 ID	payment.order_id	string	注文の ID。
参照 ID	payment.reference_id	string	省略可能なユーザー定義参照 ID。
Created At	payment.risk_evaluation.created_at	string	作成時のタイムスタンプ (RFC 3339 形式)。
リスク レベル	payment.risk_evaluation.risk_level	string	支払に関連するリスク レベル。
注	payment.note	string	顧客プロファイルに関連付けられているカスタム メモ。
顧客ID	payment.customer_id	string	顧客を表すこのオブジェクトの ID。
金額	payment.total_money.amount	integer	金額。
通貨	payment.total_money.currency	string	通貨。
金額	payment.approved_money.amount	integer	金額。
通貨	payment.approved_money.currency	string	通貨。
レシート番号	payment.receipt_number	string	支払いのレシート番号。 支払いが取り消された場合、このフィールドは表示されません。
レシート URL	payment.receipt_url	string	支払いの領収書の URL。 このフィールドには、COMPLETED 支払についてのみ入力されます。
遅延アクション	payment.delay_action	string	delay_durationが経過したときに支払いに適用されるアクション。
遅延時間	payment.delayed_until	string	delay_actionが自動的に適用されたときの読み取り専用タイムスタンプ (RFC 3339 形式)。
正方形の製品	payment.application_details.square_product	string	Square Point of Sale (POS)、Square Invoices、Square Virtual Terminal などの Square 製品。
アプリケーション識別子	payment.application_details.application_id	string	アプリケーションに割り当てられた読み取り専用の Square ID。
バージョン トークン	payment.version_token	string	この不透明なトークンは、オブジェクトの特定のバージョンを識別します。

支払いを取り消す

操作 ID:

PaymentCancel

支払いをキャンセル (無効) します。 このエンドポイントを使用して、APPROVED 状態の支払いを取り消すことができます。

パラメーター

名前	キー	必須	型	説明
決済識別子	payment_id	True	string	支払いの識別子。

戻り値

名前	パス	型	説明
ID	payment.id	string	Square で発行された一意の識別子。
Created At	payment.created_at	string	RFC 3339 形式で、このオブジェクトの作成時刻を指定するタイムスタンプ。
更新日時	payment.updated_at	string	RFC 3339 形式で、このオブジェクトの最新の更新時刻を指定するタイムスタンプ。
金額	payment.amount_money.amount	integer	金額。
通貨	payment.amount_money.currency	string	通貨。
金額	payment.tip_money.amount	integer	金額。
通貨	payment.tip_money.currency	string	通貨。
ステータス	payment.status	string	このオブジェクトの現在の検証状態。
遅延時間	payment.delay_duration	string	Square が自動的にdelay_actionを支払いに適用する場合の、支払の作成後の時間。 この自動delay_actionは、delay_duration期間の前に終了状態 (COMPLETED、CANCELED、または FAILED) に達しない支払いにのみ適用されます。 このフィールドは、RFC 3339 形式の期間として指定されます。
ソースの種類	payment.source_type	string	この支払のソースの種類。 現在の値には、CARD、BANK_ACCOUNT、WALLET、CASH、EXTERNAL が含まれます。
ステータス	payment.card_details.status	string	現在の状態。
カード ブランド	payment.card_details.card.card_brand	string	カードのブランド。
最後の 4	payment.card_details.card.last_4	string	カード番号の最後の 4 桁。
Exp Month	payment.card_details.card.exp_month	integer	関連付けられているカードの有効期限の月を 1 ~ 12 の整数で指定します。
Exp Year	payment.card_details.card.exp_year	integer	カードの有効期限の 4 桁の年。
指紋	payment.card_details.card.fingerprint	string	1 つのアプリケーション内の複数の場所でカードを識別するために、カード番号に基づいて、正方形に割り当てられた識別子として意図されています。
カードの種類	payment.card_details.card.card_type	string	カードの種類。
前払いの種類	payment.card_details.card.prepaid_type	string	カードが前払いされているかどうかを示します。
ごみ箱	payment.card_details.card.bin	string	銀行識別番号 (BIN) と呼ばれるカード番号の最初の 6 桁。
Entry メソッド	payment.card_details.entry_method	string	支払いのカードの詳細を入力するために使用される方法。 このメソッドには、KEYED、SWIPED、EMV、ON_FILE、または CONTACTLESS を指定できます。
CVV 状態	payment.card_details.cvv_status	string	カード検証値 (CVV) チェックから返される状態コード。 コードは、CVV_ACCEPTED、CVV_REJECTED、またはCVV_NOT_CHECKEDできます。
AVS の状態	payment.card_details.avs_status	string	アドレス確認システム (AVS) チェックから返された状態コード。 コードは、AVS_ACCEPTED、AVS_REJECTED、またはAVS_NOT_CHECKEDできます。
認証結果コード	payment.card_details.auth_result_code	string	支払いの承認状態を説明するカード発行者によって返される状態コード。
ステートメントの説明	payment.card_details.statement_description	string	カード ネットワークに送信されるステートメントの説明。
Authorized At	payment.card_details.card_payment_timeline.authorized_at	string	支払いが承認されたときのタイムスタンプ (RFC 3339 形式)。
Voided At	payment.card_details.card_payment_timeline.voided_at	string	RFC 3339 形式で支払いが無効になったときのタイムスタンプ。
場所 ID	payment.location_id	string	場所の識別子。
注文 ID	payment.order_id	string	注文の ID。
Created At	payment.risk_evaluation.created_at	string	作成時のタイムスタンプ (RFC 3339 形式)。
リスク レベル	payment.risk_evaluation.risk_level	string	支払に関連するリスク レベル。
注	payment.note	string	顧客プロファイルに関連付けられているカスタム メモ。
顧客ID	payment.customer_id	string	顧客を表すこのオブジェクトの ID。
金額	payment.total_money.amount	integer	金額。
通貨	payment.total_money.currency	string	通貨。
金額	payment.approved_money.amount	integer	金額。
通貨	payment.approved_money.currency	string	通貨。
遅延アクション	payment.delay_action	string	delay_durationが経過したときに支払いに適用されるアクション。
遅延時間	payment.delayed_until	string	delay_actionが自動的に適用されたときの読み取り専用タイムスタンプ (RFC 3339 形式)。
正方形の製品	payment.application_details.square_product	string	Square Point of Sale (POS)、Square Invoices、Square Virtual Terminal などの Square 製品。
アプリケーション識別子	payment.application_details.application_id	string	アプリケーションに割り当てられた読み取り専用の Square ID。
バージョン トークン	payment.version_token	string	この不透明なトークンは、オブジェクトの特定のバージョンを識別します。

支払いを取得する

操作 ID:

PaymentGet

特定の支払いの詳細を取得します。

パラメーター

名前	キー	必須	型	説明
決済識別子	payment_id	True	string	支払いの識別子。

戻り値

名前	パス	型	説明
ID	payment.id	string	Square で発行された一意の識別子。
Created At	payment.created_at	string	RFC 3339 形式で、このオブジェクトの作成時刻を指定するタイムスタンプ。
更新日時	payment.updated_at	string	RFC 3339 形式で、このオブジェクトの最新の更新時刻を指定するタイムスタンプ。
金額	payment.amount_money.amount	integer	金額。
通貨	payment.amount_money.currency	string	通貨。
ステータス	payment.status	string	このオブジェクトの現在の検証状態。
遅延時間	payment.delay_duration	string	Square が自動的にdelay_actionを支払いに適用する場合の、支払の作成後の時間。 この自動delay_actionは、delay_duration期間の前に終了状態 (COMPLETED、CANCELED、または FAILED) に達しない支払いにのみ適用されます。 このフィールドは、RFC 3339 形式の期間として指定されます。
ソースの種類	payment.source_type	string	この支払のソースの種類。 現在の値には、CARD、BANK_ACCOUNT、WALLET、CASH、EXTERNAL が含まれます。
ステータス	payment.card_details.status	string	現在の状態。
カード ブランド	payment.card_details.card.card_brand	string	カードのブランド。
最後の 4	payment.card_details.card.last_4	string	カード番号の最後の 4 桁。
Exp Month	payment.card_details.card.exp_month	integer	関連付けられているカードの有効期限の月を 1 ~ 12 の整数で指定します。
Exp Year	payment.card_details.card.exp_year	integer	カードの有効期限の 4 桁の年。
指紋	payment.card_details.card.fingerprint	string	1 つのアプリケーション内の複数の場所でカードを識別するために、カード番号に基づいて、正方形に割り当てられた識別子として意図されています。
カードの種類	payment.card_details.card.card_type	string	カードの種類。
前払いの種類	payment.card_details.card.prepaid_type	string	カードが前払いされているかどうかを示します。
ごみ箱	payment.card_details.card.bin	string	銀行識別番号 (BIN) と呼ばれるカード番号の最初の 6 桁。
Entry メソッド	payment.card_details.entry_method	string	支払いのカードの詳細を入力するために使用される方法。 このメソッドには、KEYED、SWIPED、EMV、ON_FILE、または CONTACTLESS を指定できます。
CVV 状態	payment.card_details.cvv_status	string	カード検証値 (CVV) チェックから返される状態コード。 コードは、CVV_ACCEPTED、CVV_REJECTED、またはCVV_NOT_CHECKEDできます。
AVS の状態	payment.card_details.avs_status	string	アドレス確認システム (AVS) チェックから返された状態コード。 コードは、AVS_ACCEPTED、AVS_REJECTED、またはAVS_NOT_CHECKEDできます。
認証結果コード	payment.card_details.auth_result_code	string	支払いの承認状態を説明するカード発行者によって返される状態コード。
ステートメントの説明	payment.card_details.statement_description	string	カード ネットワークに送信されるステートメントの説明。
Authorized At	payment.card_details.card_payment_timeline.authorized_at	string	支払いが承認されたときのタイムスタンプ (RFC 3339 形式)。
キャプチャ日	payment.card_details.card_payment_timeline.captured_at	string	支払いがキャプチャされたときのタイムスタンプ (RFC 3339 形式)。
場所 ID	payment.location_id	string	場所の識別子。
注文 ID	payment.order_id	string	注文の ID。
処理料金	payment.processing_fee	array of object
Effective At	payment.processing_fee.effective_at	string	料金が有効になったときのタイムスタンプ (RFC 3339 形式)。
タイプ	payment.processing_fee.type	string	型を示します。
金額	payment.processing_fee.amount_money.amount	integer	金額。
通貨	payment.processing_fee.amount_money.currency	string	通貨。
注	payment.note	string	顧客プロファイルに関連付けられているカスタム メモ。
金額	payment.total_money.amount	integer	金額。
通貨	payment.total_money.currency	string	通貨。
金額	payment.approved_money.amount	integer	金額。
通貨	payment.approved_money.currency	string	通貨。
従業員 ID	payment.employee_id	string	従業員の正方形で生成された ID。
レシート番号	payment.receipt_number	string	支払いのレシート番号。 支払いが取り消された場合、このフィールドは表示されません。
レシート URL	payment.receipt_url	string	支払いの領収書の URL。 このフィールドには、COMPLETED 支払についてのみ入力されます。
遅延アクション	payment.delay_action	string	delay_durationが経過したときに支払いに適用されるアクション。
遅延時間	payment.delayed_until	string	delay_actionが自動的に適用されたときの読み取り専用タイムスタンプ (RFC 3339 形式)。
チーム メンバー ID	payment.team_member_id	string	チーム メンバーの ID。
正方形の製品	payment.application_details.square_product	string	Square Point of Sale (POS)、Square Invoices、Square Virtual Terminal などの Square 製品。
アプリケーション識別子	payment.application_details.application_id	string	アプリケーションに割り当てられた読み取り専用の Square ID。
バージョン トークン	payment.version_token	string	この不透明なトークンは、オブジェクトの特定のバージョンを識別します。

支払いを更新する

操作 ID:

PaymentUpdate

承認済みの状態で支払いを更新します。 このエンドポイントを使用して、amount_moneyとtip_moneyを更新できます。

パラメーター

名前	キー	必須	型	説明
決済識別子	payment_id	True	string	支払いの識別子。
べき等キー	idempotency_key		string	すべての要求の中でこの要求を一意に識別する値を指定します。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。
金額	amount		integer	金額。
通貨	currency		string	通貨。
金額	amount		integer	金額。
通貨	currency		string	通貨。
バージョン トークン	version_token		string	この不透明なトークンは、オブジェクトの特定のバージョンを識別します。

戻り値

名前	パス	型	説明
ID	payment.id	string	Square で発行された一意の識別子。
Created At	payment.created_at	string	RFC 3339 形式で、このオブジェクトの作成時刻を指定するタイムスタンプ。
更新日時	payment.updated_at	string	RFC 3339 形式で、このオブジェクトの最新の更新時刻を指定するタイムスタンプ。
金額	payment.amount_money.amount	integer	金額。
通貨	payment.amount_money.currency	string	通貨。
金額	payment.tip_money.amount	integer	金額。
通貨	payment.tip_money.currency	string	通貨。
ステータス	payment.status	string	このオブジェクトの現在の検証状態。
遅延時間	payment.delay_duration	string	Square が自動的にdelay_actionを支払いに適用する場合の、支払の作成後の時間。 この自動delay_actionは、delay_duration期間の前に終了状態 (COMPLETED、CANCELED、または FAILED) に達しない支払いにのみ適用されます。 このフィールドは、RFC 3339 形式の期間として指定されます。
ソースの種類	payment.source_type	string	この支払のソースの種類。 現在の値には、CARD、BANK_ACCOUNT、WALLET、CASH、EXTERNAL が含まれます。
ステータス	payment.card_details.status	string	現在の状態。
カード ブランド	payment.card_details.card.card_brand	string	カードのブランド。
最後の 4	payment.card_details.card.last_4	string	カード番号の最後の 4 桁。
Exp Month	payment.card_details.card.exp_month	integer	関連付けられているカードの有効期限の月を 1 ~ 12 の整数で指定します。
Exp Year	payment.card_details.card.exp_year	integer	カードの有効期限の 4 桁の年。
指紋	payment.card_details.card.fingerprint	string	1 つのアプリケーション内の複数の場所でカードを識別するために、カード番号に基づいて、正方形に割り当てられた識別子として意図されています。
カードの種類	payment.card_details.card.card_type	string	カードの種類。
前払いの種類	payment.card_details.card.prepaid_type	string	カードが前払いされているかどうかを示します。
ごみ箱	payment.card_details.card.bin	string	銀行識別番号 (BIN) と呼ばれるカード番号の最初の 6 桁。
Entry メソッド	payment.card_details.entry_method	string	支払いのカードの詳細を入力するために使用される方法。 このメソッドには、KEYED、SWIPED、EMV、ON_FILE、または CONTACTLESS を指定できます。
CVV 状態	payment.card_details.cvv_status	string	カード検証値 (CVV) チェックから返される状態コード。 コードは、CVV_ACCEPTED、CVV_REJECTED、またはCVV_NOT_CHECKEDできます。
AVS の状態	payment.card_details.avs_status	string	アドレス確認システム (AVS) チェックから返された状態コード。 コードは、AVS_ACCEPTED、AVS_REJECTED、またはAVS_NOT_CHECKEDできます。
認証結果コード	payment.card_details.auth_result_code	string	支払いの承認状態を説明するカード発行者によって返される状態コード。
ステートメントの説明	payment.card_details.statement_description	string	カード ネットワークに送信されるステートメントの説明。
Authorized At	payment.card_details.card_payment_timeline.authorized_at	string	支払いが承認されたときのタイムスタンプ (RFC 3339 形式)。
場所 ID	payment.location_id	string	場所の識別子。
注文 ID	payment.order_id	string	注文の ID。
Created At	payment.risk_evaluation.created_at	string	作成時のタイムスタンプ (RFC 3339 形式)。
リスク レベル	payment.risk_evaluation.risk_level	string	支払に関連するリスク レベル。
注	payment.note	string	顧客プロファイルに関連付けられているカスタム メモ。
顧客ID	payment.customer_id	string	顧客を表すこのオブジェクトの ID。
金額	payment.total_money.amount	integer	金額。
通貨	payment.total_money.currency	string	通貨。
金額	payment.approved_money.amount	integer	金額。
通貨	payment.approved_money.currency	string	通貨。
能力	payment.capabilities	array of string
レシート番号	payment.receipt_number	string	支払いのレシート番号。 支払いが取り消された場合、このフィールドは表示されません。
遅延アクション	payment.delay_action	string	delay_durationが経過したときに支払いに適用されるアクション。
遅延時間	payment.delayed_until	string	delay_actionが自動的に適用されたときの読み取り専用タイムスタンプ (RFC 3339 形式)。
正方形の製品	payment.application_details.square_product	string	Square Point of Sale (POS)、Square Invoices、Square Virtual Terminal などの Square 製品。
アプリケーション識別子	payment.application_details.application_id	string	アプリケーションに割り当てられた読み取り専用の Square ID。
バージョン トークン	payment.version_token	string	この不透明なトークンは、オブジェクトの特定のバージョンを識別します。

更新順序 (ベータ)

操作 ID:

OrderUpdate

フィールドを追加、置換、または削除して、開いている注文を更新します。 COMPLETED または CANCELED 状態の注文は更新できません。

パラメーター

名前	キー	必須	型	説明
注文 ID	order_id	True	string	注文の識別子。
べき等キー	idempotency_key		string	すべての要求の中でこの要求を一意に識別する値を指定します。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。
バージョン	version		integer	このオブジェクトの現在のバージョン。
UID	uid		string	正方形で生成された ID。
数量	quantity		string	10 進文字列としての物理カウントの影響を受ける項目の数。 この数値は、小数点の後に最大 5 桁までサポートできます。
名前	name		string	アイテムの名前。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、その値を空にすることはできません。長さは Unicode コード ポイントです。
金額	amount		integer	金額。
通貨	currency		string	通貨。
クリアするフィールド	fields_to_clear		array of string

戻り値

名前	パス	型	説明
バージョン	order.version	integer	このオブジェクトの現在のバージョン。
通貨	order.total_money.currency	string	通貨。
金額	order.total_money.amount	integer	金額。
名前	order.source.name	string	名前。
行項目	order.line_items	array of object
通貨	order.line_items.total_tax_money.currency	string	通貨。
金額	order.line_items.total_tax_money.amount	integer	金額。
金額	order.line_items.total_money.amount	integer	金額。
通貨	order.line_items.total_money.currency	string	通貨。
金額	order.line_items.gross_sales_money.amount	integer	金額。
通貨	order.line_items.gross_sales_money.currency	string	通貨。
金額	order.line_items.base_price_money.amount	integer	金額。
通貨	order.line_items.base_price_money.currency	string	通貨。
数量	order.line_items.quantity	string	10 進文字列としての物理カウントの影響を受ける項目の数。 この数値は、小数点の後に最大 5 桁までサポートできます。
通貨	order.line_items.total_discount_money.currency	string	通貨。
金額	order.line_items.total_discount_money.amount	integer	金額。
名前	order.line_items.name	string	アイテムの名前。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、その値を空にすることはできません。長さは Unicode コード ポイントです。
UID	order.line_items.uid	string	正方形で生成された ID。
金額	order.line_items.variation_total_price_money.amount	integer	金額。
通貨	order.line_items.variation_total_price_money.currency	string	通貨。
State	order.state	string	現在の状態。
金額	order.total_service_charge_money.amount	integer	金額。
通貨	order.total_service_charge_money.currency	string	通貨。
ID	order.id	string	Square で発行された一意の識別子。
場所 ID	order.location_id	string	場所の識別子。
金額	order.total_tax_money.amount	integer	金額。
通貨	order.total_tax_money.currency	string	通貨。
Created At	order.created_at	string	RFC 3339 形式で、このオブジェクトの作成時刻を指定するタイムスタンプ。
金額	order.total_discount_money.amount	integer	金額。
通貨	order.total_discount_money.currency	string	通貨。
通貨	order.net_amounts.service_charge_money.currency	string	通貨。
金額	order.net_amounts.service_charge_money.amount	integer	金額。
金額	order.net_amounts.total_money.amount	integer	金額。
通貨	order.net_amounts.total_money.currency	string	通貨。
通貨	order.net_amounts.discount_money.currency	string	通貨。
金額	order.net_amounts.discount_money.amount	integer	金額。
通貨	order.net_amounts.tax_money.currency	string	通貨。
金額	order.net_amounts.tax_money.amount	integer	金額。
更新日時	order.updated_at	string	RFC 3339 形式で、このオブジェクトの最新の更新時刻を指定するタイムスタンプ。

検索ターミナルの払い戻し

操作 ID:

TerminalSearchRefunds

要求を行っている販売者によって作成された Interac ターミナル払い戻し要求のフィルター処理された一覧を取得します。

パラメーター

名前	キー	必須	型	説明
極限	limit		integer	1 ページで返される結果の数に関する制限。 制限はアドバイザリです。実装によって返される結果の数が増減する場合があります。 指定された制限が負、ゼロ、または最大値の 1,000 より大きい場合は無視されます。
ステータス	status		string	現在の状態。

戻り値

名前	パス	型	説明
払い戻し	refunds	array of object
ID	refunds.id	string	Square で発行された一意の識別子。
払い戻し ID	refunds.refund_id	string	Square によって生成された、この払い戻しの一意の ID。
決済識別子	refunds.payment_id	string	支払いの ID。
金額	refunds.amount_money.amount	integer	金額。
通貨	refunds.amount_money.currency	string	通貨。
理由	refunds.reason	string	カード所有者が銀行との紛争を開始した理由。
デバイス識別子	refunds.device_id	string	このコードを使用したデバイスの一意の ID。 デバイスがペアリングされるときに設定されます。
期限の期間	refunds.deadline_duration	string	RFC 3339 期間。その後、チェックアウトが自動的に取り消されます。 保留中の TerminalCheckout は自動的に取り消され、TIMED_OUTのキャンセル理由があります。 既定値: 作成から 5 分
ステータス	refunds.status	string	このオブジェクトの現在の検証状態。
Created At	refunds.created_at	string	ISO 8601 形式のイベント時間。
更新日時	refunds.updated_at	string	RFC 3339 形式の最終変更タイムスタンプ
アプリ ID	refunds.app_id	string	チェックアウトを作成したアプリケーションの ID。
カード ブランド	refunds.card.card_brand	string	カードのブランド。
最後の 4	refunds.card.last_4	string	カード番号の最後の 4 桁。
有効期限月	refunds.card.exp_month	integer	関連付けられているカードの有効期限の月を 1 ~ 12 の整数で指定します。
有効期限年	refunds.card.exp_year	integer	カードの有効期限の 4 桁の年。
指紋	refunds.card.fingerprint	string	1 つのアプリケーション内の複数の場所でカードを識別するために、カード番号に基づいて、正方形に割り当てられた識別子として意図されています。
カードの種類	refunds.card.card_type	string	カードの種類。
ごみ箱	refunds.card.bin	string	銀行識別番号 (BIN) と呼ばれるカード番号の最初の 6 桁。
注文 ID	refunds.order_id	string	注文の ID。
場所 ID	refunds.location_id	string	場所の識別子。

検索順序

操作 ID:

OrderSearch

すべての注文で 1 つ以上の場所を検索します。 注文には、Square エコシステム (POS、請求書、Connect API など) に入った方法やタイミングに関係なく、すべての販売、返品、交換が含まれます。

パラメーター

名前	キー	必須	型	説明
エントリを返す	return_entries		boolean	検索結果の形式を制御するブール値。 true の場合、SearchOrders は OrderEntry オブジェクトを返します。 false の場合、SearchOrders は完全な注文オブジェクトを返します。
極限	limit		integer	1 ページで返される結果の数に関する制限。 制限はアドバイザリです。実装によって返される結果の数が増減する場合があります。 指定された制限が負、ゼロ、または最大値の 1,000 より大きい場合は無視されます。
場所 ID	location_ids		array of string
開始位置	start_at		string	時間範囲がいつ開始するかを示す RFC 3339 形式の datetime 値。
End At	end_at		string	時間範囲がいつ終了するかを示す RFC 3339 形式の datetime 値。
States	states		array of string
並べ替えフィールド	sort_field		string	並べ替えの基準となるフィールド。
並べ替え順序	sort_order		string	結果が返される時系列の順序。

戻り値

名前	パス	型	説明
注文エントリ	order_entries	array of object
注文 ID	order_entries.order_id	string	注文の ID。
場所 ID	order_entries.location_id	string	場所の識別子。
バージョン	order_entries.version	integer	オブジェクトの現在のバージョン。
Cursor	cursor	string	このエンドポイントへの後続の呼び出しに改ページ カーソルを含め、元のクエリに関連付けられた次の結果セットを取得します。

注文の作成

操作 ID:

OrderCreate

購入の製品に関する情報と、購入に適用する設定を含めることができる新しい注文を作成します。

パラメーター

名前	キー	必須	型	説明
べき等キー	idempotency_key		string	すべての要求の中でこの要求を一意に識別する値を指定します。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。
参照 ID	reference_id		string	省略可能なユーザー定義参照 ID。
場所 ID	location_id		string	場所の識別子。
名前	name		string	アイテムの名前。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、その値を空にすることはできません。長さは Unicode コード ポイントです。
数量	quantity		string	10 進文字列としての物理カウントの影響を受ける項目の数。 この数値は、小数点の後に最大 5 桁までサポートできます。
金額	amount		integer	金額。
通貨	currency		string	通貨。
カタログ オブジェクト ID	catalog_object_id		string	追跡対象の CatalogObject の 2 乗生成 ID。
カタログ オブジェクト ID	catalog_object_id		string	カタログ オブジェクト ID。
割引 UID	discount_uid		string	適用される割引が表す割引の UID。
UID	uid		string	正方形で生成された ID。
名前	name		string	アイテムの名前。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、その値を空にすることはできません。長さは Unicode コード ポイントです。
百分率	percentage		string	小数点区切り記号として '.' を使用し、'%' 記号を使用しない、小数点形式のパーセンテージ。 値 7.5 は 7.5%に対応します。
Scope	scope		string	現在のレベルを示します。
UID	uid		string	正方形で生成された ID。
名前	name		string	アイテムの名前。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、その値を空にすることはできません。長さは Unicode コード ポイントです。
百分率	percentage		string	小数点区切り記号として '.' を使用し、'%' 記号を使用しない、小数点形式のパーセンテージ。 値 7.5 は 7.5%に対応します。
Scope	scope		string	現在のレベルを示します。
カタログ オブジェクト ID	catalog_object_id		string	追跡対象の CatalogObject の 2 乗生成 ID。
金額	amount		integer	金額。
通貨	currency		string	通貨。

戻り値

名前	パス	型	説明
ID	order.id	string	Square で発行された一意の識別子。
場所 ID	order.location_id	string	場所の識別子。
行項目	order.line_items	array of object
UID	order.line_items.uid	string	正方形で生成された ID。
名前	order.line_items.name	string	アイテムの名前。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、その値を空にすることはできません。長さは Unicode コード ポイントです。
数量	order.line_items.quantity	string	10 進文字列としての物理カウントの影響を受ける項目の数。 この数値は、小数点の後に最大 5 桁までサポートできます。
適用される税金	order.line_items.applied_taxes	array of object
UID	order.line_items.applied_taxes.uid	string	正方形に割り当てられた ID。
税 UID	order.line_items.applied_taxes.tax_uid	string	この適用される税金が表す税の UID。
金額	order.line_items.applied_taxes.applied_money.amount	integer	金額。
通貨	order.line_items.applied_taxes.applied_money.currency	string	通貨。
適用される割引	order.line_items.applied_discounts	array of object
UID	order.line_items.applied_discounts.uid	string	正方形に割り当てられた ID。
割引 UID	order.line_items.applied_discounts.discount_uid	string	適用される割引が表す割引の UID。
金額	order.line_items.applied_discounts.applied_money.amount	integer	金額。
通貨	order.line_items.applied_discounts.applied_money.currency	string	通貨。
金額	order.line_items.base_price_money.amount	integer	金額。
通貨	order.line_items.base_price_money.currency	string	通貨。
金額	order.line_items.gross_sales_money.amount	integer	金額。
通貨	order.line_items.gross_sales_money.currency	string	通貨。
金額	order.line_items.total_tax_money.amount	integer	金額。
通貨	order.line_items.total_tax_money.currency	string	通貨。
金額	order.line_items.total_discount_money.amount	integer	金額。
通貨	order.line_items.total_discount_money.currency	string	通貨。
金額	order.line_items.total_money.amount	integer	金額。
通貨	order.line_items.total_money.currency	string	通貨。
金額	order.line_items.variation_total_price_money.amount	integer	金額。
通貨	order.line_items.variation_total_price_money.currency	string	通貨。
カタログ オブジェクト ID	order.line_items.catalog_object_id	string	追跡対象の CatalogObject の 2 乗生成 ID。
バリエーション名	order.line_items.variation_name	string	この品目に適用されるバリエーションの名前。
修飾子	order.line_items.modifiers	array of object
UID	order.line_items.modifiers.uid	string	正方形に割り当てられた ID。
カタログ オブジェクト ID	order.line_items.modifiers.catalog_object_id	string	カタログ オブジェクト ID。
名前	order.line_items.modifiers.name	string	アイテムの名前。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、その値を空にすることはできません。長さは Unicode コード ポイントです。
金額	order.line_items.modifiers.base_price_money.amount	integer	金額。
通貨	order.line_items.modifiers.base_price_money.currency	string	通貨。
金額	order.line_items.modifiers.total_price_money.amount	integer	金額。
通貨	order.line_items.modifiers.total_price_money.currency	string	通貨。
税	order.taxes	array of object
UID	order.taxes.uid	string	正方形で生成された ID。
名前	order.taxes.name	string	アイテムの名前。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、その値を空にすることはできません。長さは Unicode コード ポイントです。
タイプ	order.taxes.type	string	型を示します。
百分率	order.taxes.percentage	string	小数点区切り記号として '.' を使用し、'%' 記号を使用しない、小数点形式のパーセンテージ。 値 7.5 は 7.5%に対応します。
金額	order.taxes.applied_money.amount	integer	金額。
通貨	order.taxes.applied_money.currency	string	通貨。
Scope	order.taxes.scope	string	現在のレベルを示します。
割引	order.discounts	array of object
UID	order.discounts.uid	string	正方形で生成された ID。
カタログ オブジェクト ID	order.discounts.catalog_object_id	string	追跡対象の CatalogObject の 2 乗生成 ID。
名前	order.discounts.name	string	アイテムの名前。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、その値を空にすることはできません。長さは Unicode コード ポイントです。
タイプ	order.discounts.type	string	型を示します。
百分率	order.discounts.percentage	string	小数点区切り記号として '.' を使用し、'%' 記号を使用しない、小数点形式のパーセンテージ。 値 7.5 は 7.5%に対応します。
金額	order.discounts.applied_money.amount	integer	金額。
通貨	order.discounts.applied_money.currency	string	通貨。
Scope	order.discounts.scope	string	現在のレベルを示します。
金額	order.discounts.amount_money.amount	integer	金額。
通貨	order.discounts.amount_money.currency	string	通貨。
Created At	order.created_at	string	RFC 3339 形式で、このオブジェクトの作成時刻を指定するタイムスタンプ。
更新日時	order.updated_at	string	RFC 3339 形式で、このオブジェクトの最新の更新時刻を指定するタイムスタンプ。
State	order.state	string	現在の状態。
バージョン	order.version	integer	このオブジェクトの現在のバージョン。
参照 ID	order.reference_id	string	省略可能なユーザー定義参照 ID。
金額	order.total_money.amount	integer	金額。
通貨	order.total_money.currency	string	通貨。
金額	order.total_tax_money.amount	integer	金額。
通貨	order.total_tax_money.currency	string	通貨。
金額	order.total_discount_money.amount	integer	金額。
通貨	order.total_discount_money.currency	string	通貨。
金額	order.total_tip_money.amount	integer	金額。
通貨	order.total_tip_money.currency	string	通貨。
金額	order.total_service_charge_money.amount	integer	金額。
通貨	order.total_service_charge_money.currency	string	通貨。
金額	order.net_amounts.total_money.amount	integer	金額。
通貨	order.net_amounts.total_money.currency	string	通貨。
金額	order.net_amounts.tax_money.amount	integer	金額。
通貨	order.net_amounts.tax_money.currency	string	通貨。
金額	order.net_amounts.discount_money.amount	integer	金額。
通貨	order.net_amounts.discount_money.currency	string	通貨。
金額	order.net_amounts.tip_money.amount	integer	金額。
通貨	order.net_amounts.tip_money.currency	string	通貨。
金額	order.net_amounts.service_charge_money.amount	integer	金額。
通貨	order.net_amounts.service_charge_money.currency	string	通貨。
名前	order.source.name	string	名前。

紛争の証拠を一覧表示する

操作 ID:

DisputeListEvidence

紛争に関連する証拠の一覧を返します。

パラメーター

名前	キー	必須	型	説明
紛争 ID	dispute_id	True	string	紛争の識別子。

戻り値

名前	パス	型	説明
Evidence	evidence	array of object
ID	evidence.id	string	Square で発行された一意の識別子。
紛争 ID	evidence.dispute_id	string	証拠が関連付けられている紛争の ID。
証拠テキスト	evidence.evidence_text	string	生のテキスト。
証拠の種類	evidence.evidence_type	string	証拠の種類。
アップロード日	evidence.uploaded_at	string	RFC 3339 形式の次のアクションが期限の時刻。
証拠 ID	evidence.evidence_id	string	証拠の 2 乗生成 ID。
Filename	evidence.evidence_file.filename	string	ファイル拡張子を含むファイル名
Filetype	evidence.evidence_file.filetype	string	紛争証拠ファイルは、application/pdf、image/heic、image/heif、image/jpeg、image/png、または image/tiff 形式である必要があります。
Cursor	cursor	string	このエンドポイントへの後続の呼び出しに改ページ カーソルを含め、元のクエリに関連付けられた次の結果セットを取得します。

紛争の証拠を削除する

操作 ID:

DisputeDeleteEvidence

紛争から指定された証拠を削除します。

パラメーター

名前	キー	必須	型	説明
紛争 ID	dispute_id	True	string	紛争の識別子。
証拠 ID	evidence_id	True	string	証拠の識別子。

戻り値

response

object

紛争の証拠を取得する

操作 ID:

DisputeRetrieveEvidence

要求 URL パスの証拠 ID で指定された証拠メタデータを返します。 後で参照する場合は、アップロードする証拠のコピーを保持する必要があります。 アップロード後に証拠をダウンロードすることはできません。

パラメーター

名前	キー	必須	型	説明
紛争 ID	dispute_id	True	string	紛争の識別子。
証拠 ID	evidence_id	True	string	証拠の識別子。

戻り値

名前	パス	型	説明
ID	evidence.id	string	Square で発行された一意の識別子。
紛争 ID	evidence.dispute_id	string	証拠が関連付けられている紛争の ID。
Filename	evidence.evidence_file.filename	string	紛争証拠ファイルは、application/pdf、image/heic、image/heif、image/jpeg、image/png、または image/tiff 形式である必要があります。
Filetype	evidence.evidence_file.filetype	string	ファイル拡張子を含むファイル名。
証拠の種類	evidence.evidence_type	string	型 pf evidence。
アップロード日	evidence.uploaded_at	string	RFC 3339 形式の次のアクションが期限の時刻。

紛争を一覧表示する

操作 ID:

DisputeList

特定のアカウントに関連付けられている紛争の一覧を返します。

パラメーター

名前	キー	必須	型	説明
Cursor	cursor		string	このエンドポイントに対する以前の呼び出しによって返された改ページ位置カーソル。
States	states		string	結果をフィルター処理する紛争状態。 指定しない場合、エンドポイントはすべての未解決の紛争を返します (紛争の状態はINQUIRY_CLOSED、WON、または LOST ではありません)。
場所 ID	location_id		string	このオプションのフィルターを指定すると、特定の場所に属するレコードのみを取得できます。

戻り値

名前	パス	型	説明
紛争	disputes	array of object
ID	disputes.id	string	Square で発行された一意の識別子。
金額	disputes.amount_money.amount	integer	金額。
通貨	disputes.amount_money.currency	string	通貨。
理由	disputes.reason	string	カード所有者が銀行との紛争を開始した理由。
State	disputes.state	string	現在の状態。
期限	disputes.due_at	string	RFC 3339 形式の次のアクションが期限の時刻。
紛争中の支払い	disputes.disputed_payments	array of object
決済識別子	disputes.disputed_payments.payment_id	string	紛争中の支払いの二乗によって生成された一意の ID。
カード ブランド	disputes.card_brand	string	紛争中の支払いに使用されるカード ブランド。
Created At	disputes.created_at	string	ISO 8601 形式のイベント時間。
更新日時	disputes.updated_at	string	RFC 3339 形式の最終変更タイムスタンプ
ブランド紛争 ID	disputes.brand_dispute_id	string	カード ブランドによって生成されたカード ブランド システム内の紛争の ID。
Cursor	cursor	string	このエンドポイントへの後続の呼び出しに改ページ カーソルを含め、元のクエリに関連付けられた次の結果セットを取得します。

紛争を取得する

操作 ID:

DisputeRetrieve

特定の紛争に関する詳細を返します。

パラメーター

名前	キー	必須	型	説明
紛争 ID	dispute_id	True	string	紛争の識別子。

戻り値

名前	パス	型	説明
ID	dispute.id	string	Square で発行された一意の識別子。
金額	dispute.amount_money.amount	integer	金額。
通貨	dispute.amount_money.currency	string	通貨。
理由	dispute.reason	string	このオブジェクトの理由。
State	dispute.state	string	現在の状態。
期限	dispute.due_at	string	RFC 3339 形式の次のアクションが期限の時刻。
紛争中の支払い	dispute.disputed_payments	array of object
決済識別子	dispute.disputed_payments.payment_id	string	2 乗で生成された支払いの一意の ID。
カード ブランド	dispute.card_brand	string	カードのブランド。
Created At	dispute.created_at	string	RFC 3339 形式で、このオブジェクトの作成時刻を指定するタイムスタンプ。
更新日時	dispute.updated_at	string	RFC 3339 形式で、このオブジェクトの最新の更新時刻を指定するタイムスタンプ。
ブランド紛争 ID	dispute.brand_dispute_id	string	カード ブランドによって生成されたカード ブランド システム内の紛争の ID。

紛争を受け入れる

操作 ID:

DisputeAccept

紛争の損失を受け入れます。 Square は、紛争の金額をカード所有者に返し、紛争状態を ACCEPTED に更新します。 Square は、販売者の Square アカウントから紛争中の金額を引き落とします。 Square アカウントに十分な資金がない場合、Square は関連付けられている銀行口座を借方に引き落とします。

パラメーター

名前	キー	必須	型	説明
紛争 ID	dispute_id	True	string	紛争の識別子。

戻り値

名前	パス	型	説明
ID	dispute.id	string	Square で発行された一意の識別子。
金額	dispute.amount_money.amount	integer	金額。
通貨	dispute.amount_money.currency	string	通貨。
理由	dispute.reason	string	このオブジェクトの理由。
State	dispute.state	string	現在の状態。
期限	dispute.due_at	string	RFC 3339 形式の次のアクションが期限の時刻。
紛争中の支払い	dispute.disputed_payments	array of object
決済識別子	dispute.disputed_payments.payment_id	string	2 乗で生成された支払いの一意の ID。
カード ブランド	dispute.card_brand	string	カードのブランド。
Created At	dispute.created_at	string	RFC 3339 形式で、このオブジェクトの作成時刻を指定するタイムスタンプ。
更新日時	dispute.updated_at	string	RFC 3339 形式で、このオブジェクトの最新の更新時刻を指定するタイムスタンプ。
ブランド紛争 ID	dispute.brand_dispute_id	string	カード ブランドによって生成されたカード ブランド システム内の紛争の ID。

紛争証拠のテキストを作成する

操作 ID:

DisputeCreateEvidenceText

紛争チャレンジの証拠として使用するテキストをアップロードします。

パラメーター

名前	キー	必須	型	説明
紛争 ID	dispute_id	True	string	紛争の識別子。
証拠の種類	evidence_type		string	アップロードする証拠の種類。
証拠テキスト	evidence_text		string	証拠文字列。
べき等キー	idempotency_key		string	すべての要求の中でこの要求を一意に識別する値を指定します。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。

戻り値

名前	パス	型	説明
ID	evidence.id	string	Square で発行された一意の識別子。
紛争 ID	evidence.dispute_id	string	証拠が関連付けられている紛争の ID。
証拠テキスト	evidence.evidence_text	string	生のテキスト。
証拠の種類	evidence.evidence_type	string	型 pf evidence。
アップロード日	evidence.uploaded_at	string	RFC 3339 形式の次のアクションが期限の時刻。

複製順序 (ベータ)

操作 ID:

OrderClone

既存の注文を複製して、新しい注文を下書き状態で作成します。 新しく作成された注文には、元の注文からコピーされたコア フィールド (品目、税金、割引など) のみが含まれます。

パラメーター

名前	キー	必須	型	説明
注文 ID	order_id		string	注文識別子。
バージョン	version		integer	バージョン。
べき等キー	idempotency_key		string	すべての要求の中でこの要求を一意に識別する値を指定します。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。

戻り値

名前	パス	型	説明
ID	order.id	string	Square で発行された一意の識別子。
場所 ID	order.location_id	string	場所の識別子。
行項目	order.line_items	array of object
UID	order.line_items.uid	string	正方形で生成された ID。
名前	order.line_items.name	string	アイテムの名前。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、その値を空にすることはできません。長さは Unicode コード ポイントです。
数量	order.line_items.quantity	string	10 進文字列としての物理カウントの影響を受ける項目の数。 この数値は、小数点の後に最大 5 桁までサポートできます。
適用される税金	order.line_items.applied_taxes	array of object
UID	order.line_items.applied_taxes.uid	string	正方形に割り当てられた ID。
税 UID	order.line_items.applied_taxes.tax_uid	string	この適用される税金が表す税の UID。
金額	order.line_items.applied_taxes.applied_money.amount	integer	金額。
通貨	order.line_items.applied_taxes.applied_money.currency	string	通貨。
適用される割引	order.line_items.applied_discounts	array of object
UID	order.line_items.applied_discounts.uid	string	正方形に割り当てられた ID。
割引 UID	order.line_items.applied_discounts.discount_uid	string	適用される割引が表す割引の UID。
金額	order.line_items.applied_discounts.applied_money.amount	integer	金額。
通貨	order.line_items.applied_discounts.applied_money.currency	string	通貨。
金額	order.line_items.base_price_money.amount	integer	金額。
通貨	order.line_items.base_price_money.currency	string	通貨。
金額	order.line_items.gross_sales_money.amount	integer	金額。
通貨	order.line_items.gross_sales_money.currency	string	通貨。
金額	order.line_items.total_tax_money.amount	integer	金額。
通貨	order.line_items.total_tax_money.currency	string	通貨。
金額	order.line_items.total_discount_money.amount	integer	金額。
通貨	order.line_items.total_discount_money.currency	string	通貨。
金額	order.line_items.total_money.amount	integer	金額。
通貨	order.line_items.total_money.currency	string	通貨。
金額	order.line_items.variation_total_price_money.amount	integer	金額。
通貨	order.line_items.variation_total_price_money.currency	string	通貨。
カタログ オブジェクト ID	order.line_items.catalog_object_id	string	追跡対象の CatalogObject の 2 乗生成 ID。
バリエーション名	order.line_items.variation_name	string	この品目に適用されるバリエーションの名前。
修飾子	order.line_items.modifiers	array of object
UID	order.line_items.modifiers.uid	string	正方形に割り当てられた ID。
カタログ オブジェクト ID	order.line_items.modifiers.catalog_object_id	string	カタログ オブジェクト ID。
名前	order.line_items.modifiers.name	string	アイテムの名前。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、その値を空にすることはできません。長さは Unicode コード ポイントです。
金額	order.line_items.modifiers.base_price_money.amount	integer	金額。
通貨	order.line_items.modifiers.base_price_money.currency	string	通貨。
金額	order.line_items.modifiers.total_price_money.amount	integer	金額。
通貨	order.line_items.modifiers.total_price_money.currency	string	通貨。
税	order.taxes	array of object
UID	order.taxes.uid	string	正方形で生成された ID。
名前	order.taxes.name	string	アイテムの名前。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、その値を空にすることはできません。長さは Unicode コード ポイントです。
タイプ	order.taxes.type	string	型を示します。
百分率	order.taxes.percentage	string	小数点区切り記号として '.' を使用し、'%' 記号を使用しない、小数点形式のパーセンテージ。 値 7.5 は 7.5%に対応します。
金額	order.taxes.applied_money.amount	integer	金額。
通貨	order.taxes.applied_money.currency	string	通貨。
Scope	order.taxes.scope	string	現在のレベルを示します。
割引	order.discounts	array of object
UID	order.discounts.uid	string	正方形で生成された ID。
カタログ オブジェクト ID	order.discounts.catalog_object_id	string	追跡対象の CatalogObject の 2 乗生成 ID。
名前	order.discounts.name	string	アイテムの名前。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、その値を空にすることはできません。長さは Unicode コード ポイントです。
タイプ	order.discounts.type	string	型を示します。
百分率	order.discounts.percentage	string	小数点区切り記号として '.' を使用し、'%' 記号を使用しない、小数点形式のパーセンテージ。 値 7.5 は 7.5%に対応します。
金額	order.discounts.applied_money.amount	integer	金額。
通貨	order.discounts.applied_money.currency	string	通貨。
Scope	order.discounts.scope	string	現在のレベルを示します。
金額	order.discounts.amount_money.amount	integer	金額。
通貨	order.discounts.amount_money.currency	string	通貨。
Created At	order.created_at	string	RFC 3339 形式で、このオブジェクトの作成時刻を指定するタイムスタンプ。
更新日時	order.updated_at	string	RFC 3339 形式で、このオブジェクトの最新の更新時刻を指定するタイムスタンプ。
State	order.state	string	現在の状態。
バージョン	order.version	integer	このオブジェクトの現在のバージョン。
参照 ID	order.reference_id	string	省略可能なユーザー定義参照 ID。
金額	order.total_money.amount	integer	金額。
通貨	order.total_money.currency	string	通貨。
金額	order.total_tax_money.amount	integer	金額。
通貨	order.total_tax_money.currency	string	通貨。
金額	order.total_discount_money.amount	integer	金額。
通貨	order.total_discount_money.currency	string	通貨。
金額	order.total_tip_money.amount	integer	金額。
通貨	order.total_tip_money.currency	string	通貨。
金額	order.total_service_charge_money.amount	integer	金額。
通貨	order.total_service_charge_money.currency	string	通貨。
金額	order.net_amounts.total_money.amount	integer	金額。
通貨	order.net_amounts.total_money.currency	string	通貨。
金額	order.net_amounts.tax_money.amount	integer	金額。
通貨	order.net_amounts.tax_money.currency	string	通貨。
金額	order.net_amounts.discount_money.amount	integer	金額。
通貨	order.net_amounts.discount_money.currency	string	通貨。
金額	order.net_amounts.tip_money.amount	integer	金額。
通貨	order.net_amounts.tip_money.currency	string	通貨。
金額	order.net_amounts.service_charge_money.amount	integer	金額。
通貨	order.net_amounts.service_charge_money.currency	string	通貨。
名前	order.source.name	string	名前。

証拠を送信する

操作 ID:

EvidenceSubmit

カード所有者の銀行に証拠を提出します。 証拠を提出する前に、Square は使用可能なすべての証拠をコンパイルします。 これには、CreateDisputeEvidenceFile エンドポイントと CreateDisputeEvidenceText エンドポイントを使用してアップロードされた証拠と、Square によって自動的に提供される証拠 (使用可能な場合) が含まれます。

パラメーター

名前	キー	必須	型	説明
紛争 ID	dispute_id	True	string	紛争の識別子。

戻り値

名前	パス	型	説明
ID	dispute.id	string	Square で発行された一意の識別子。
金額	dispute.amount_money.amount	integer	金額。
通貨	dispute.amount_money.currency	string	通貨。
理由	dispute.reason	string	このオブジェクトの理由。
State	dispute.state	string	現在の状態。
期限	dispute.due_at	string	RFC 3339 形式の次のアクションが期限の時刻。
紛争中の支払い	dispute.disputed_payments	array of object
決済識別子	dispute.disputed_payments.payment_id	string	2 乗で生成された支払いの一意の ID。
カード ブランド	dispute.card_brand	string	カードのブランド。
Created At	dispute.created_at	string	RFC 3339 形式で、このオブジェクトの作成時刻を指定するタイムスタンプ。
更新日時	dispute.updated_at	string	RFC 3339 形式で、このオブジェクトの最新の更新時刻を指定するタイムスタンプ。
ブランド紛争 ID	dispute.brand_dispute_id	string	カード ブランドによって生成されたカード ブランド システム内の紛争の ID。

請求書の作成

操作 ID:

InvoiceCreate

Orders API を使用して作成された注文の下書き請求書を作成します。 下書き請求書はアカウントに残り、何も行われません。 Square が処理する前に請求書を発行する必要があります (顧客のメール アドレスに送信するか、ファイルで顧客のカードに請求します)。

パラメーター

名前	キー	必須	型	説明
べき等キー	idempotency_key		string	すべての要求の中でこの要求を一意に識別する値を指定します。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。
場所 ID	location_id		string	場所の識別子。
注文 ID	order_id		string	注文の ID。
Scheduled At	scheduled_at		string	RFC 3339 形式で処理がスケジュールされている場合のタイムスタンプ。
顧客ID	customer_id		string	注文に関連付けられている顧客の ID。
配信方法	delivery_method		string	Square が請求書、リマインダー、および領収書を顧客に送信するために使用する配信方法。 請求書が発行されると、Square は、配信方法と支払い要求の設定に基づいて、直ちに、またはscheduled_at日 (指定されている場合) に基づいて請求書を処理します。
要求の種類	request_type		string	支払い要求の種類を識別します。 このタイプでは、支払依頼金額の決定方法を定義します。
期日	due_date		string	支払い要求の期限 (YYYY-MM-DD 形式)。
Tipping Enabled	tipping_enabled		boolean	true に設定すると、顧客がチップを支払う場所が提供されます。
自動支払いソース	automatic_payment_source		string	自動支払いの支払い方法。
メッセージ	message		string	メッセージ。
相対スケジュール日	relative_scheduled_days		integer	アラームが送信されたときにdue_date支払要求の前 (負の数) または後 (正の数値) の日数。
請求書番号	invoice_number		string	わかりやすい請求書番号。 値は、場所内で一意です。 請求書の作成時に指定しない場合は、値が Square によって割り当てられます。
Title	title		string	タイトル。
Description	description		string	説明。
Card	card		boolean	クレジット カードまたはデビット カードの支払いを受け入れるかどうかを示します。
正方形のギフト カード	square_gift_card		boolean	Square ギフト カードの支払いが受け入れられるかどうかを示します。
預金	bank_account		boolean	銀行振り込みの支払いを受け入れるかどうかを示します。
ラベル	label		string	ユーザー設定フィールドのラベルまたはタイトル。
価値	value		string	ユーザー設定フィールドのテキスト。
位置付け	placement		string	請求書のユーザー設定フィールドの場所。
販売またはサービスの日付	sale_or_service_date		string	販売日またはサービスがレンダリングされる日付 (YYYY-MM-DD 形式)。 このフィールドを使用して、請求書に表示される過去または将来の日付を指定できます。

戻り値

名前	パス	型	説明
ID	invoice.id	string	Square で発行された一意の識別子。
バージョン	invoice.version	integer	このオブジェクトの現在のバージョン。
場所 ID	invoice.location_id	string	場所の識別子。
注文 ID	invoice.order_id	string	注文の ID。
支払い要求	invoice.payment_requests	array of object
UID	invoice.payment_requests.uid	string	正方形で生成された ID。
要求の種類	invoice.payment_requests.request_type	string	支払い要求の種類を識別します。 このタイプでは、支払依頼金額の決定方法を定義します。
期日	invoice.payment_requests.due_date	string	支払い要求の期限 (YYYY-MM-DD 形式)。
Tipping Enabled	invoice.payment_requests.tipping_enabled	boolean	true に設定すると、顧客がチップを支払う場所が提供されます。
リマインダー	invoice.payment_requests.reminders	array of object
UID	invoice.payment_requests.reminders.uid	string	正方形に割り当てられた ID。
相対スケジュール日	invoice.payment_requests.reminders.relative_scheduled_days	integer	アラームが送信されたときにdue_date支払要求の前 (負の数) または後 (正の数値) の日数。
メッセージ	invoice.payment_requests.reminders.message	string	メッセージ。
ステータス	invoice.payment_requests.reminders.status	string	現在の状態。
金額	invoice.payment_requests.computed_amount_money.amount	integer	金額。
通貨	invoice.payment_requests.computed_amount_money.currency	string	通貨。
金額	invoice.payment_requests.total_completed_amount_money.amount	integer	金額。
通貨	invoice.payment_requests.total_completed_amount_money.currency	string	通貨。
自動支払いソース	invoice.payment_requests.automatic_payment_source	string	自動支払いの支払い方法。
請求書番号	invoice.invoice_number	string	わかりやすい請求書番号。 値は、場所内で一意です。 請求書の作成時に指定しない場合は、値が Square によって割り当てられます。
Title	invoice.title	string	タイトル。
Description	invoice.description	string	説明。
Scheduled At	invoice.scheduled_at	string	RFC 3339 形式で処理がスケジュールされている場合のタイムスタンプ。
ステータス	invoice.status	string	このオブジェクトの現在の検証状態。
Timezone	invoice.timezone	string	カレンダーの日付を解釈するために使用されるタイム ゾーン。 請求書が作成されると、このフィールドは販売者の場所に指定されたタイムゾーンに設定されます。 値は変更できません。
Created At	invoice.created_at	string	RFC 3339 形式で、このオブジェクトの作成時刻を指定するタイムスタンプ。
更新日時	invoice.updated_at	string	RFC 3339 形式で、このオブジェクトの最新の更新時刻を指定するタイムスタンプ。
顧客ID	invoice.primary_recipient.customer_id	string	注文に関連付けられている顧客の ID。
名前	invoice.primary_recipient.given_name	string	受信者の名前 (つまり、名)。
名字	invoice.primary_recipient.family_name	string	受信者のファミリ (つまり、姓) の名前。
メール アドレス	invoice.primary_recipient.email_address	string	受信者の電子メール アドレス。
電話番号	invoice.primary_recipient.phone_number	string	受信者の電話番号。
Card	invoice.accepted_payment_methods.card	boolean	クレジット カードまたはデビット カードの支払いを受け入れるかどうかを示します。
正方形のギフト カード	invoice.accepted_payment_methods.square_gift_card	boolean	Square ギフト カードの支払いが受け入れられるかどうかを示します。
預金	invoice.accepted_payment_methods.bank_account	boolean	銀行振り込みの支払いを受け入れるかどうかを示します。
ユーザー設定フィールド	invoice.custom_fields	array of object
ラベル	invoice.custom_fields.label	string	ユーザー設定フィールドのラベルまたはタイトル。
価値	invoice.custom_fields.value	string	ユーザー設定フィールドのテキスト。
位置付け	invoice.custom_fields.placement	string	請求書のユーザー設定フィールドの場所。
配信方法	invoice.delivery_method	string	Square が請求書、リマインダー、および領収書を顧客に送信するために使用する配信方法。 請求書が発行されると、Square は、配信方法と支払い要求の設定に基づいて、直ちに、またはscheduled_at日 (指定されている場合) に基づいて請求書を処理します。
販売またはサービスの日付	invoice.sale_or_service_date	string	販売日またはサービスがレンダリングされる日付 (YYYY-MM-DD 形式)。 このフィールドを使用して、請求書に表示される過去または将来の日付を指定できます。

請求書の削除

操作 ID:

InvoiceDelete

指定した請求書を削除します。 請求書が削除されると、関連付けられている注文の状態が CANCELED に変わります。 下書き請求書のみを削除できます (発行済みの請求書 (処理がスケジュールされている請求書を含む) は削除できません)。

パラメーター

名前	キー	必須	型	説明
請求書 ID	invoice_id	True	string	請求書の識別子。
バージョン	version		integer	削除する請求書のバージョン。

戻り値

response

object

請求書の取り消し

操作 ID:

InvoiceCancel

請求書を取り消します。 販売者は、取り消された請求書の支払いを収集できません。

パラメーター

名前	キー	必須	型	説明
請求書 ID	invoice_id	True	string	請求書の識別子。
バージョン	version		integer	バージョン。

戻り値

名前	パス	型	説明
ID	invoice.id	string	Square で発行された一意の識別子。
バージョン	invoice.version	integer	このオブジェクトの現在のバージョン。
場所 ID	invoice.location_id	string	場所の識別子。
注文 ID	invoice.order_id	string	注文の ID。
支払い要求	invoice.payment_requests	array of object
UID	invoice.payment_requests.uid	string	正方形で生成された ID。
要求の種類	invoice.payment_requests.request_type	string	支払い要求の種類を識別します。 このタイプでは、支払依頼金額の決定方法を定義します。
期日	invoice.payment_requests.due_date	string	支払い要求の期限 (YYYY-MM-DD 形式)。
Tipping Enabled	invoice.payment_requests.tipping_enabled	boolean	true に設定すると、顧客がチップを支払う場所が提供されます。
リマインダー	invoice.payment_requests.reminders	array of object
UID	invoice.payment_requests.reminders.uid	string	正方形に割り当てられた ID。
相対スケジュール日	invoice.payment_requests.reminders.relative_scheduled_days	integer	アラームが送信されたときにdue_date支払要求の前 (負の数) または後 (正の数値) の日数。
メッセージ	invoice.payment_requests.reminders.message	string	メッセージ。
ステータス	invoice.payment_requests.reminders.status	string	現在の状態。
金額	invoice.payment_requests.computed_amount_money.amount	integer	金額。
通貨	invoice.payment_requests.computed_amount_money.currency	string	通貨。
金額	invoice.payment_requests.total_completed_amount_money.amount	integer	金額。
通貨	invoice.payment_requests.total_completed_amount_money.currency	string	通貨。
自動支払いソース	invoice.payment_requests.automatic_payment_source	string	自動支払いの支払い方法。
請求書番号	invoice.invoice_number	string	わかりやすい請求書番号。 値は、場所内で一意です。 請求書の作成時に指定しない場合は、値が Square によって割り当てられます。
Title	invoice.title	string	タイトル。
Description	invoice.description	string	説明。
Scheduled At	invoice.scheduled_at	string	RFC 3339 形式で処理がスケジュールされている場合のタイムスタンプ。
ステータス	invoice.status	string	このオブジェクトの現在の検証状態。
Timezone	invoice.timezone	string	カレンダーの日付を解釈するために使用されるタイム ゾーン。 請求書が作成されると、このフィールドは販売者の場所に指定されたタイムゾーンに設定されます。 値は変更できません。
Created At	invoice.created_at	string	RFC 3339 形式で、このオブジェクトの作成時刻を指定するタイムスタンプ。
更新日時	invoice.updated_at	string	RFC 3339 形式で、このオブジェクトの最新の更新時刻を指定するタイムスタンプ。
顧客ID	invoice.primary_recipient.customer_id	string	注文に関連付けられている顧客の ID。
名前	invoice.primary_recipient.given_name	string	受信者の名前 (つまり、名)。
名字	invoice.primary_recipient.family_name	string	受信者のファミリ (つまり、姓) の名前。
メール アドレス	invoice.primary_recipient.email_address	string	受信者の電子メール アドレス。
電話番号	invoice.primary_recipient.phone_number	string	受信者の電話番号。
Card	invoice.accepted_payment_methods.card	boolean	クレジット カードまたはデビット カードの支払いを受け入れるかどうかを示します。
正方形のギフト カード	invoice.accepted_payment_methods.square_gift_card	boolean	Square ギフト カードの支払いが受け入れられるかどうかを示します。
預金	invoice.accepted_payment_methods.bank_account	boolean	銀行振り込みの支払いを受け入れるかどうかを示します。
ユーザー設定フィールド	invoice.custom_fields	array of object
ラベル	invoice.custom_fields.label	string	ユーザー設定フィールドのラベルまたはタイトル。
価値	invoice.custom_fields.value	string	ユーザー設定フィールドのテキスト。
位置付け	invoice.custom_fields.placement	string	請求書のユーザー設定フィールドの場所。
配信方法	invoice.delivery_method	string	Square が請求書、リマインダー、および領収書を顧客に送信するために使用する配信方法。 請求書が発行されると、Square は、配信方法と支払い要求の設定に基づいて、直ちに、またはscheduled_at日 (指定されている場合) に基づいて請求書を処理します。
販売またはサービスの日付	invoice.sale_or_service_date	string	販売日またはサービスがレンダリングされる日付 (YYYY-MM-DD 形式)。 このフィールドを使用して、請求書に表示される過去または将来の日付を指定できます。

請求書の更新

操作 ID:

InvoiceUpdate

フィールド、消込フィールド、またはその両方を変更して請求書を更新します。

パラメーター

名前	キー	必須	型	説明
請求書 ID	invoice_id	True	string	請求書の識別子。
べき等キー	idempotency_key		string	すべての要求の中でこの要求を一意に識別する値を指定します。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。
UID	uid		string	正方形で生成された ID。
Tipping Enabled	tipping_enabled		boolean	true に設定すると、顧客がチップを支払う場所が提供されます。
クリアするフィールド	fields_to_clear		array of string

戻り値

名前	パス	型	説明
ID	invoice.id	string	Square で発行された一意の識別子。
バージョン	invoice.version	integer	このオブジェクトの現在のバージョン。
場所 ID	invoice.location_id	string	場所の識別子。
注文 ID	invoice.order_id	string	注文の ID。
支払い要求	invoice.payment_requests	array of object
UID	invoice.payment_requests.uid	string	正方形で生成された ID。
要求の種類	invoice.payment_requests.request_type	string	支払い要求の種類を識別します。 このタイプでは、支払依頼金額の決定方法を定義します。
期日	invoice.payment_requests.due_date	string	支払い要求の期限 (YYYY-MM-DD 形式)。
Tipping Enabled	invoice.payment_requests.tipping_enabled	boolean	true に設定すると、顧客がチップを支払う場所が提供されます。
金額	invoice.payment_requests.computed_amount_money.amount	integer	金額。
通貨	invoice.payment_requests.computed_amount_money.currency	string	通貨。
金額	invoice.payment_requests.total_completed_amount_money.amount	integer	金額。
通貨	invoice.payment_requests.total_completed_amount_money.currency	string	通貨。
自動支払いソース	invoice.payment_requests.automatic_payment_source	string	自動支払いの支払い方法。
請求書番号	invoice.invoice_number	string	わかりやすい請求書番号。 値は、場所内で一意です。 請求書の作成時に指定しない場合は、値が Square によって割り当てられます。
Title	invoice.title	string	タイトル。
Description	invoice.description	string	説明。
Scheduled At	invoice.scheduled_at	string	RFC 3339 形式で処理がスケジュールされている場合のタイムスタンプ。
ステータス	invoice.status	string	このオブジェクトの現在の検証状態。
Timezone	invoice.timezone	string	カレンダーの日付を解釈するために使用されるタイム ゾーン。 請求書が作成されると、このフィールドは販売者の場所に指定されたタイムゾーンに設定されます。 値は変更できません。
Created At	invoice.created_at	string	RFC 3339 形式で、このオブジェクトの作成時刻を指定するタイムスタンプ。
更新日時	invoice.updated_at	string	RFC 3339 形式で、このオブジェクトの最新の更新時刻を指定するタイムスタンプ。
顧客ID	invoice.primary_recipient.customer_id	string	注文に関連付けられている顧客の ID。
名前	invoice.primary_recipient.given_name	string	受信者の名前 (つまり、名)。
名字	invoice.primary_recipient.family_name	string	受信者のファミリ (つまり、姓) の名前。
メール アドレス	invoice.primary_recipient.email_address	string	受信者の電子メール アドレス。
電話番号	invoice.primary_recipient.phone_number	string	受信者の電話番号。
金額	invoice.next_payment_amount_money.amount	integer	金額。
通貨	invoice.next_payment_amount_money.currency	string	通貨。
Card	invoice.accepted_payment_methods.card	boolean	クレジット カードまたはデビット カードの支払いを受け入れるかどうかを示します。
正方形のギフト カード	invoice.accepted_payment_methods.square_gift_card	boolean	Square ギフト カードの支払いが受け入れられるかどうかを示します。
預金	invoice.accepted_payment_methods.bank_account	boolean	銀行振り込みの支払いを受け入れるかどうかを示します。
ユーザー設定フィールド	invoice.custom_fields	array of object
ラベル	invoice.custom_fields.label	string	ユーザー設定フィールドのラベルまたはタイトル。
価値	invoice.custom_fields.value	string	ユーザー設定フィールドのテキスト。
位置付け	invoice.custom_fields.placement	string	請求書のユーザー設定フィールドの場所。
配信方法	invoice.delivery_method	string	Square が請求書、リマインダー、および領収書を顧客に送信するために使用する配信方法。 請求書が発行されると、Square は、配信方法と支払い要求の設定に基づいて、直ちに、またはscheduled_at日 (指定されている場合) に基づいて請求書を処理します。
販売またはサービスの日付	invoice.sale_or_service_date	string	販売日またはサービスがレンダリングされる日付 (YYYY-MM-DD 形式)。 このフィールドを使用して、請求書に表示される過去または将来の日付を指定できます。

請求書を一覧表示する

操作 ID:

InvoiceList

特定の場所の請求書の一覧を返します。

パラメーター

名前	キー	必須	型	説明
場所 ID	location_id		string	このオプションのフィルターを指定すると、特定の場所に属するレコードのみを取得できます。
Cursor	cursor		string	このエンドポイントに対する以前の呼び出しによって返された改ページ位置カーソル。
極限	limit		integer	応答で返される数の上限。

戻り値

名前	パス	型	説明
Invoices	invoices	array of object
ID	invoices.id	string	Square で発行された一意の識別子。
バージョン	invoices.version	integer	オブジェクトの現在のバージョン。
場所 ID	invoices.location_id	string	場所の識別子。
注文 ID	invoices.order_id	string	注文の ID。
支払い要求	invoices.payment_requests	array of object
UID	invoices.payment_requests.uid	string	請求書の支払い要求の 2 乗生成 ID。
要求の種類	invoices.payment_requests.request_type	string	支払い要求の種類を識別します。 このタイプでは、支払依頼金額の決定方法を定義します。
期日	invoices.payment_requests.due_date	string	支払い要求の期限 (請求書のタイム ゾーン内) を YYYY-MM-DD 形式で指定します。
Tipping Enabled	invoices.payment_requests.tipping_enabled	boolean	true に設定すると、正方形でホストされる請求書ページ (請求書のpublic_url フィールド) に、顧客がチップを支払う場所が提供されます。
アラーム	invoices.payment_requests.reminders	array of object	リマインダー
UID	invoices.payment_requests.reminders.uid	string	InvoicePaymentRequest 内のアラームを一意に識別する、正方形に割り当てられた ID。
相対スケジュール日	invoices.payment_requests.reminders.relative_scheduled_days	integer	アラームが送信されたときにdue_date支払要求の前 (負の数) または後 (正の数値) の日数。
メッセージ	invoices.payment_requests.reminders.message	string	アラーム メッセージ。
ステータス	invoices.payment_requests.reminders.status	string	アラームの状態。
金額	invoices.payment_requests.computed_amount_money.amount	integer	金額。
通貨	invoices.payment_requests.computed_amount_money.currency	string	通貨。
金額	invoices.payment_requests.total_completed_amount_money.amount	integer	金額。
通貨	invoices.payment_requests.total_completed_amount_money.currency	string	通貨。
自動支払いソース	invoices.payment_requests.automatic_payment_source	string	自動支払いの支払い方法。
要求された割合	invoices.payment_requests.percentage_requested	string	支払い要求の金額をパーセンテージで指定します。
カード ID	invoices.payment_requests.card_id	string	支払い要求に対して請求するクレジット カードまたはデビット カードの ID。
請求書番号	invoices.invoice_number	string	わかりやすい請求書番号。
Title	invoices.title	string	請求書のタイトル。
Description	invoices.description	string	説明。
Scheduled At	invoices.scheduled_at	string	請求書の処理がスケジュールされている場合のタイムスタンプ (RFC 3339 形式)。 請求書が発行されると、Square は、配信方法と支払い要求の設定に従って、指定した日付に請求書を処理します。
ステータス	invoices.status	string	このオブジェクトの現在の検証状態。
Timezone	invoices.timezone	string	請求書のカレンダーの日付を解釈するために使用されるタイム ゾーン (due_dateなど)。 請求書が作成されると、このフィールドは販売者の場所に指定されたタイムゾーンに設定されます。 値は変更できません。
Created At	invoices.created_at	string	ISO 8601 形式のイベント時間。
更新日時	invoices.updated_at	string	RFC 3339 形式の最終変更タイムスタンプ
顧客ID	invoices.primary_recipient.customer_id	string	カードに関連付ける顧客の ID。
名前	invoices.primary_recipient.given_name	string	受信者の名前 (つまり、名)。
名字	invoices.primary_recipient.family_name	string	受信者のファミリ (つまり、姓) の名前。
メール アドレス	invoices.primary_recipient.email_address	string	受信者の電子メール アドレス。
電話番号	invoices.primary_recipient.phone_number	string	受信者の電話番号。
Card	invoices.accepted_payment_methods.card	boolean	クレジット カードまたはデビット カードの支払いを受け入れるかどうかを示します。
正方形のギフト カード	invoices.accepted_payment_methods.square_gift_card	boolean	Square ギフト カードの支払いが受け入れられるかどうかを示します。
預金	invoices.accepted_payment_methods.bank_account	boolean	銀行振り込みの支払いを受け入れるかどうかを示します。
ユーザー設定フィールド	invoices.custom_fields	array of object
ラベル	invoices.custom_fields.label	string	ユーザー設定フィールドのラベルまたはタイトル。
価値	invoices.custom_fields.value	string	ユーザー設定フィールドのテキスト。
位置付け	invoices.custom_fields.placement	string	請求書のユーザー設定フィールドの場所
配信方法	invoices.delivery_method	string	Square が請求書、リマインダー、および領収書を顧客に送信するために使用する配信方法。
販売またはサービスの日付	invoices.sale_or_service_date	string	販売日またはサービスがレンダリングされる日付 (YYYY-MM-DD 形式)。 このフィールドを使用して、請求書に表示される過去または将来の日付を指定できます。
パブリック URL	invoices.public_url	string	正方形でホストされる請求書ページの URL。 PublishInvoice エンドポイントを使用して請求書を発行すると、Square は請求書ページをホストし、応答でページ URL を返します。
金額	invoices.next_payment_amount_money.amount	integer	金額。
通貨	invoices.next_payment_amount_money.currency	string	通貨。
Cursor	cursor	string	このエンドポイントへの後続の呼び出しに改ページ カーソルを含め、元のクエリに関連付けられた次の結果セットを取得します。

請求書を取得する

操作 ID:

InvoiceGet

請求書 ID で請求書を取得します。

パラメーター

名前	キー	必須	型	説明
請求書 ID	invoice_id	True	string	請求書の識別子。

戻り値

名前	パス	型	説明
ID	invoice.id	string	Square で発行された一意の識別子。
バージョン	invoice.version	integer	このオブジェクトの現在のバージョン。
場所 ID	invoice.location_id	string	場所の識別子。
注文 ID	invoice.order_id	string	注文の ID。
支払い要求	invoice.payment_requests	array of object
UID	invoice.payment_requests.uid	string	正方形で生成された ID。
要求の種類	invoice.payment_requests.request_type	string	支払い要求の種類を識別します。 このタイプでは、支払依頼金額の決定方法を定義します。
期日	invoice.payment_requests.due_date	string	支払い要求の期限 (YYYY-MM-DD 形式)。
Tipping Enabled	invoice.payment_requests.tipping_enabled	boolean	true に設定すると、顧客がチップを支払う場所が提供されます。
リマインダー	invoice.payment_requests.reminders	array of object
UID	invoice.payment_requests.reminders.uid	string	正方形に割り当てられた ID。
相対スケジュール日	invoice.payment_requests.reminders.relative_scheduled_days	integer	アラームが送信されたときにdue_date支払要求の前 (負の数) または後 (正の数値) の日数。
メッセージ	invoice.payment_requests.reminders.message	string	メッセージ。
ステータス	invoice.payment_requests.reminders.status	string	現在の状態。
金額	invoice.payment_requests.computed_amount_money.amount	integer	金額。
通貨	invoice.payment_requests.computed_amount_money.currency	string	通貨。
金額	invoice.payment_requests.total_completed_amount_money.amount	integer	金額。
通貨	invoice.payment_requests.total_completed_amount_money.currency	string	通貨。
自動支払いソース	invoice.payment_requests.automatic_payment_source	string	自動支払いの支払い方法。
請求書番号	invoice.invoice_number	string	わかりやすい請求書番号。 値は、場所内で一意です。 請求書の作成時に指定しない場合は、値が Square によって割り当てられます。
Title	invoice.title	string	タイトル。
Description	invoice.description	string	説明。
Scheduled At	invoice.scheduled_at	string	RFC 3339 形式で処理がスケジュールされている場合のタイムスタンプ。
ステータス	invoice.status	string	このオブジェクトの現在の検証状態。
Timezone	invoice.timezone	string	カレンダーの日付を解釈するために使用されるタイム ゾーン。 請求書が作成されると、このフィールドは販売者の場所に指定されたタイムゾーンに設定されます。 値は変更できません。
Created At	invoice.created_at	string	RFC 3339 形式で、このオブジェクトの作成時刻を指定するタイムスタンプ。
更新日時	invoice.updated_at	string	RFC 3339 形式で、このオブジェクトの最新の更新時刻を指定するタイムスタンプ。
顧客ID	invoice.primary_recipient.customer_id	string	注文に関連付けられている顧客の ID。
名前	invoice.primary_recipient.given_name	string	受信者の名前 (つまり、名)。
名字	invoice.primary_recipient.family_name	string	受信者のファミリ (つまり、姓) の名前。
メール アドレス	invoice.primary_recipient.email_address	string	受信者の電子メール アドレス。
電話番号	invoice.primary_recipient.phone_number	string	受信者の電話番号。
Card	invoice.accepted_payment_methods.card	boolean	クレジット カードまたはデビット カードの支払いを受け入れるかどうかを示します。
正方形のギフト カード	invoice.accepted_payment_methods.square_gift_card	boolean	Square ギフト カードの支払いが受け入れられるかどうかを示します。
預金	invoice.accepted_payment_methods.bank_account	boolean	銀行振り込みの支払いを受け入れるかどうかを示します。
ユーザー設定フィールド	invoice.custom_fields	array of object
ラベル	invoice.custom_fields.label	string	ユーザー設定フィールドのラベルまたはタイトル。
価値	invoice.custom_fields.value	string	ユーザー設定フィールドのテキスト。
位置付け	invoice.custom_fields.placement	string	請求書のユーザー設定フィールドの場所。
配信方法	invoice.delivery_method	string	Square が請求書、リマインダー、および領収書を顧客に送信するために使用する配信方法。 請求書が発行されると、Square は、配信方法と支払い要求の設定に基づいて、直ちに、またはscheduled_at日 (指定されている場合) に基づいて請求書を処理します。
販売またはサービスの日付	invoice.sale_or_service_date	string	販売日またはサービスがレンダリングされる日付 (YYYY-MM-DD 形式)。 このフィールドを使用して、請求書に表示される過去または将来の日付を指定できます。

請求書を検索する

操作 ID:

InvoiceSearch

フィルターで指定された場所から請求書を検索します。

パラメーター

名前	キー	必須	型	説明
場所 ID	location_ids		array of string
顧客 ID	customer_ids		array of string
フィールド	field		string	1 つ以上の顧客属性を並べ替えキーとして使用して、検索された顧客プロファイルを並べ替えます。
注文	order		string	並べ替えフィールドの値に基づいて結果を並べ替える順序を示します。 文字列は、標準のアルファベット比較を使用して順序を決定します。
極限	limit		integer	返される請求書の最大数 (上限は 200)。 指定しない場合、サーバーは既定の 100 個の請求書の制限を使用します。

戻り値

名前	パス	型	説明
Invoices	invoices	array of object
ID	invoices.id	string	Square で発行された一意の識別子。
バージョン	invoices.version	integer	オブジェクトの現在のバージョン。
場所 ID	invoices.location_id	string	場所の識別子。
注文 ID	invoices.order_id	string	注文の ID。
支払い要求	invoices.payment_requests	array of object
UID	invoices.payment_requests.uid	string	請求書の支払い要求の 2 乗生成 ID。
要求の種類	invoices.payment_requests.request_type	string	支払い要求の種類を識別します。 このタイプでは、支払依頼金額の決定方法を定義します。
期日	invoices.payment_requests.due_date	string	支払い要求の期限 (請求書のタイム ゾーン内) を YYYY-MM-DD 形式で指定します。
Tipping Enabled	invoices.payment_requests.tipping_enabled	boolean	true に設定すると、正方形でホストされる請求書ページ (請求書のpublic_url フィールド) に、顧客がチップを支払う場所が提供されます。
アラーム	invoices.payment_requests.reminders	array of object	リマインダー
UID	invoices.payment_requests.reminders.uid	string	InvoicePaymentRequest 内のアラームを一意に識別する、正方形に割り当てられた ID。
相対スケジュール日	invoices.payment_requests.reminders.relative_scheduled_days	integer	アラームが送信されたときにdue_date支払要求の前 (負の数) または後 (正の数値) の日数。
メッセージ	invoices.payment_requests.reminders.message	string	アラーム メッセージ。
ステータス	invoices.payment_requests.reminders.status	string	アラームの状態。
金額	invoices.payment_requests.computed_amount_money.amount	integer	金額。
通貨	invoices.payment_requests.computed_amount_money.currency	string	通貨。
金額	invoices.payment_requests.total_completed_amount_money.amount	integer	金額。
通貨	invoices.payment_requests.total_completed_amount_money.currency	string	通貨。
自動支払いソース	invoices.payment_requests.automatic_payment_source	string	自動支払いの支払い方法。
要求された割合	invoices.payment_requests.percentage_requested	string	支払い要求の金額をパーセンテージで指定します。
カード ID	invoices.payment_requests.card_id	string	支払い要求に対して請求するクレジット カードまたはデビット カードの ID。
請求書番号	invoices.invoice_number	string	わかりやすい請求書番号。
Title	invoices.title	string	請求書のタイトル。
Description	invoices.description	string	説明。
Scheduled At	invoices.scheduled_at	string	請求書の処理がスケジュールされている場合のタイムスタンプ (RFC 3339 形式)。 請求書が発行されると、Square は、配信方法と支払い要求の設定に従って、指定した日付に請求書を処理します。
ステータス	invoices.status	string	このオブジェクトの現在の検証状態。
Timezone	invoices.timezone	string	請求書のカレンダーの日付を解釈するために使用されるタイム ゾーン (due_dateなど)。 請求書が作成されると、このフィールドは販売者の場所に指定されたタイムゾーンに設定されます。 値は変更できません。
Created At	invoices.created_at	string	ISO 8601 形式のイベント時間。
更新日時	invoices.updated_at	string	RFC 3339 形式の最終変更タイムスタンプ
顧客ID	invoices.primary_recipient.customer_id	string	カードに関連付ける顧客の ID。
名前	invoices.primary_recipient.given_name	string	受信者の名前 (つまり、名)。
名字	invoices.primary_recipient.family_name	string	受信者のファミリ (つまり、姓) の名前。
メール アドレス	invoices.primary_recipient.email_address	string	受信者の電子メール アドレス。
電話番号	invoices.primary_recipient.phone_number	string	受信者の電話番号。
Card	invoices.accepted_payment_methods.card	boolean	クレジット カードまたはデビット カードの支払いを受け入れるかどうかを示します。
正方形のギフト カード	invoices.accepted_payment_methods.square_gift_card	boolean	Square ギフト カードの支払いが受け入れられるかどうかを示します。
預金	invoices.accepted_payment_methods.bank_account	boolean	銀行振り込みの支払いを受け入れるかどうかを示します。
ユーザー設定フィールド	invoices.custom_fields	array of object
ラベル	invoices.custom_fields.label	string	ユーザー設定フィールドのラベルまたはタイトル。
価値	invoices.custom_fields.value	string	ユーザー設定フィールドのテキスト。
位置付け	invoices.custom_fields.placement	string	請求書のユーザー設定フィールドの場所
配信方法	invoices.delivery_method	string	Square が請求書、リマインダー、および領収書を顧客に送信するために使用する配信方法。
販売またはサービスの日付	invoices.sale_or_service_date	string	販売日またはサービスがレンダリングされる日付 (YYYY-MM-DD 形式)。 このフィールドを使用して、請求書に表示される過去または将来の日付を指定できます。
パブリック URL	invoices.public_url	string	正方形でホストされる請求書ページの URL。 PublishInvoice エンドポイントを使用して請求書を発行すると、Square は請求書ページをホストし、応答でページ URL を返します。
金額	invoices.next_payment_amount_money.amount	integer	金額。
通貨	invoices.next_payment_amount_money.currency	string	通貨。
Cursor	cursor	string	このエンドポイントへの後続の呼び出しに改ページ カーソルを含め、元のクエリに関連付けられた次の結果セットを取得します。

請求書を発行する

操作 ID:

InvoicePublish

指定した下書き請求書を発行します。 請求書が発行されると、Square は請求書の構成に基づいてフォローアップします。 たとえば、Square は請求書を顧客のメール アドレスに送信したり、顧客のカードをファイルに請求したり、何も行ったりしません。 Square は、正方形でホストされる請求書ページでも請求書を利用できるようにします。

パラメーター

名前	キー	必須	型	説明
請求書 ID	invoice_id	True	string	請求書の識別子。
バージョン	version		integer	バージョン。
べき等キー	idempotency_key		string	すべての要求の中でこの要求を一意に識別する値を指定します。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。

戻り値

名前	パス	型	説明
ID	invoice.id	string	Square で発行された一意の識別子。
バージョン	invoice.version	integer	このオブジェクトの現在のバージョン。
場所 ID	invoice.location_id	string	場所の識別子。
注文 ID	invoice.order_id	string	注文の ID。
支払い要求	invoice.payment_requests	array of object
UID	invoice.payment_requests.uid	string	正方形で生成された ID。
要求の種類	invoice.payment_requests.request_type	string	支払い要求の種類を識別します。 このタイプでは、支払依頼金額の決定方法を定義します。
期日	invoice.payment_requests.due_date	string	支払い要求の期限 (YYYY-MM-DD 形式)。
Tipping Enabled	invoice.payment_requests.tipping_enabled	boolean	true に設定すると、顧客がチップを支払う場所が提供されます。
リマインダー	invoice.payment_requests.reminders	array of object
UID	invoice.payment_requests.reminders.uid	string	正方形に割り当てられた ID。
相対スケジュール日	invoice.payment_requests.reminders.relative_scheduled_days	integer	アラームが送信されたときにdue_date支払要求の前 (負の数) または後 (正の数値) の日数。
メッセージ	invoice.payment_requests.reminders.message	string	メッセージ。
ステータス	invoice.payment_requests.reminders.status	string	現在の状態。
金額	invoice.payment_requests.computed_amount_money.amount	integer	金額。
通貨	invoice.payment_requests.computed_amount_money.currency	string	通貨。
金額	invoice.payment_requests.total_completed_amount_money.amount	integer	金額。
通貨	invoice.payment_requests.total_completed_amount_money.currency	string	通貨。
自動支払いソース	invoice.payment_requests.automatic_payment_source	string	自動支払いの支払い方法。
請求書番号	invoice.invoice_number	string	わかりやすい請求書番号。 値は、場所内で一意です。 請求書の作成時に指定しない場合は、値が Square によって割り当てられます。
Title	invoice.title	string	タイトル。
Description	invoice.description	string	説明。
Scheduled At	invoice.scheduled_at	string	RFC 3339 形式で処理がスケジュールされている場合のタイムスタンプ。
ステータス	invoice.status	string	このオブジェクトの現在の検証状態。
Timezone	invoice.timezone	string	カレンダーの日付を解釈するために使用されるタイム ゾーン。 請求書が作成されると、このフィールドは販売者の場所に指定されたタイムゾーンに設定されます。 値は変更できません。
Created At	invoice.created_at	string	RFC 3339 形式で、このオブジェクトの作成時刻を指定するタイムスタンプ。
更新日時	invoice.updated_at	string	RFC 3339 形式で、このオブジェクトの最新の更新時刻を指定するタイムスタンプ。
顧客ID	invoice.primary_recipient.customer_id	string	注文に関連付けられている顧客の ID。
名前	invoice.primary_recipient.given_name	string	受信者の名前 (つまり、名)。
名字	invoice.primary_recipient.family_name	string	受信者のファミリ (つまり、姓) の名前。
メール アドレス	invoice.primary_recipient.email_address	string	受信者の電子メール アドレス。
電話番号	invoice.primary_recipient.phone_number	string	受信者の電話番号。
パブリック URL	invoice.public_url	string	正方形でホストされる請求書ページの URL。 PublishInvoice エンドポイントを使用して請求書を発行すると、Square は請求書ページをホストし、応答でページ URL を返します。
Card	invoice.accepted_payment_methods.card	boolean	クレジット カードまたはデビット カードの支払いを受け入れるかどうかを示します。
正方形のギフト カード	invoice.accepted_payment_methods.square_gift_card	boolean	Square ギフト カードの支払いが受け入れられるかどうかを示します。
預金	invoice.accepted_payment_methods.bank_account	boolean	銀行振り込みの支払いを受け入れるかどうかを示します。
ユーザー設定フィールド	invoice.custom_fields	array of object
ラベル	invoice.custom_fields.label	string	ユーザー設定フィールドのラベルまたはタイトル。
価値	invoice.custom_fields.value	string	ユーザー設定フィールドのテキスト。
位置付け	invoice.custom_fields.placement	string	請求書のユーザー設定フィールドの場所。
配信方法	invoice.delivery_method	string	Square が請求書、リマインダー、および領収書を顧客に送信するために使用する配信方法。 請求書が発行されると、Square は、配信方法と支払い要求の設定に基づいて、直ちに、またはscheduled_at日 (指定されている場合) に基づいて請求書を処理します。
販売またはサービスの日付	invoice.sale_or_service_date	string	販売日またはサービスがレンダリングされる日付 (YYYY-MM-DD 形式)。 このフィールドを使用して、請求書に表示される過去または将来の日付を指定できます。

順序の計算 (ベータ)

操作 ID:

OrderCalculate

アプリケーションが注文を作成せずに注文価格をプレビューできるようにします。

パラメーター

名前	キー	必須	型	説明
べき等キー	idempotency_key		string	すべての要求の中でこの要求を一意に識別する値を指定します。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。
場所 ID	location_id		string	場所の識別子。
名前	name		string	アイテムの名前。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、その値を空にすることはできません。長さは Unicode コード ポイントです。
百分率	percentage		string	小数点区切り記号として '.' を使用し、'%' 記号を使用しない、小数点形式のパーセンテージ。 値 7.5 は 7.5%に対応します。
Scope	scope		string	現在のレベルを示します。
名前	name		string	アイテムの名前。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、その値を空にすることはできません。長さは Unicode コード ポイントです。
数量	quantity		string	10 進文字列としての物理カウントの影響を受ける項目の数。 この数値は、小数点の後に最大 5 桁までサポートできます。
金額	amount		integer	金額。
通貨	currency		string	通貨。

戻り値

名前	パス	型	説明
場所 ID	order.location_id	string	場所の識別子。
行項目	order.line_items	array of object
UID	order.line_items.uid	string	正方形で生成された ID。
数量	order.line_items.quantity	string	10 進文字列としての物理カウントの影響を受ける項目の数。 この数値は、小数点の後に最大 5 桁までサポートできます。
名前	order.line_items.name	string	アイテムの名前。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、その値を空にすることはできません。長さは Unicode コード ポイントです。
金額	order.line_items.base_price_money.amount	integer	金額。
通貨	order.line_items.base_price_money.currency	string	通貨。
金額	order.line_items.gross_sales_money.amount	integer	金額。
通貨	order.line_items.gross_sales_money.currency	string	通貨。
金額	order.line_items.total_tax_money.amount	integer	金額。
通貨	order.line_items.total_tax_money.currency	string	通貨。
金額	order.line_items.total_discount_money.amount	integer	金額。
通貨	order.line_items.total_discount_money.currency	string	通貨。
金額	order.line_items.total_money.amount	integer	金額。
通貨	order.line_items.total_money.currency	string	通貨。
金額	order.line_items.variation_total_price_money.amount	integer	金額。
通貨	order.line_items.variation_total_price_money.currency	string	通貨。
適用される割引	order.line_items.applied_discounts	array of object
UID	order.line_items.applied_discounts.uid	string	正方形に割り当てられた ID。
割引 UID	order.line_items.applied_discounts.discount_uid	string	適用される割引が表す割引の UID。
金額	order.line_items.applied_discounts.applied_money.amount	integer	金額。
通貨	order.line_items.applied_discounts.applied_money.currency	string	通貨。
割引	order.discounts	array of object
UID	order.discounts.uid	string	正方形で生成された ID。
名前	order.discounts.name	string	アイテムの名前。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、その値を空にすることはできません。長さは Unicode コード ポイントです。
百分率	order.discounts.percentage	string	小数点区切り記号として '.' を使用し、'%' 記号を使用しない、小数点形式のパーセンテージ。 値 7.5 は 7.5%に対応します。
金額	order.discounts.applied_money.amount	integer	金額。
通貨	order.discounts.applied_money.currency	string	通貨。
タイプ	order.discounts.type	string	型を示します。
Scope	order.discounts.scope	string	現在のレベルを示します。
Created At	order.created_at	string	RFC 3339 形式で、このオブジェクトの作成時刻を指定するタイムスタンプ。
更新日時	order.updated_at	string	RFC 3339 形式で、このオブジェクトの最新の更新時刻を指定するタイムスタンプ。
State	order.state	string	現在の状態。
バージョン	order.version	integer	このオブジェクトの現在のバージョン。
金額	order.total_tax_money.amount	integer	金額。
通貨	order.total_tax_money.currency	string	通貨。
金額	order.total_discount_money.amount	integer	金額。
通貨	order.total_discount_money.currency	string	通貨。
金額	order.total_tip_money.amount	integer	金額。
通貨	order.total_tip_money.currency	string	通貨。
金額	order.total_money.amount	integer	金額。
通貨	order.total_money.currency	string	通貨。
金額	order.total_service_charge_money.amount	integer	金額。
通貨	order.total_service_charge_money.currency	string	通貨。
金額	order.net_amounts.total_money.amount	integer	金額。
通貨	order.net_amounts.total_money.currency	string	通貨。
金額	order.net_amounts.tax_money.amount	integer	金額。
通貨	order.net_amounts.tax_money.currency	string	通貨。
金額	order.net_amounts.discount_money.amount	integer	金額。
通貨	order.net_amounts.discount_money.currency	string	通貨。
金額	order.net_amounts.tip_money.amount	integer	金額。
通貨	order.net_amounts.tip_money.currency	string	通貨。
金額	order.net_amounts.service_charge_money.amount	integer	金額。
通貨	order.net_amounts.service_charge_money.currency	string	通貨。

順序を取得する

操作 ID:

OrderRetrieve

ID で Order を取得します。

パラメーター

名前	キー	必須	型	説明
注文 ID	order_id	True	string	注文の識別子。

戻り値

名前	パス	型	説明
ID	order.id	string	Square で発行された一意の識別子。
場所 ID	order.location_id	string	場所の識別子。
行項目	order.line_items	array of object
UID	order.line_items.uid	string	正方形で生成された ID。
数量	order.line_items.quantity	string	10 進文字列としての物理カウントの影響を受ける項目の数。 この数値は、小数点の後に最大 5 桁までサポートできます。
名前	order.line_items.name	string	アイテムの名前。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、その値を空にすることはできません。長さは Unicode コード ポイントです。
金額	order.line_items.base_price_money.amount	integer	金額。
通貨	order.line_items.base_price_money.currency	string	通貨。
金額	order.line_items.gross_sales_money.amount	integer	金額。
通貨	order.line_items.gross_sales_money.currency	string	通貨。
金額	order.line_items.total_tax_money.amount	integer	金額。
通貨	order.line_items.total_tax_money.currency	string	通貨。
金額	order.line_items.total_discount_money.amount	integer	金額。
通貨	order.line_items.total_discount_money.currency	string	通貨。
金額	order.line_items.total_money.amount	integer	金額。
通貨	order.line_items.total_money.currency	string	通貨。
金額	order.line_items.variation_total_price_money.amount	integer	金額。
通貨	order.line_items.variation_total_price_money.currency	string	通貨。
適用される割引	order.line_items.applied_discounts	array of object
UID	order.line_items.applied_discounts.uid	string	正方形に割り当てられた ID。
割引 UID	order.line_items.applied_discounts.discount_uid	string	適用される割引が表す割引の UID。
金額	order.line_items.applied_discounts.applied_money.amount	integer	金額。
通貨	order.line_items.applied_discounts.applied_money.currency	string	通貨。
割引	order.discounts	array of object
UID	order.discounts.uid	string	正方形で生成された ID。
名前	order.discounts.name	string	アイテムの名前。 これは、適用可能なクエリ フィルターで使用する検索可能な属性であり、その値を空にすることはできません。長さは Unicode コード ポイントです。
百分率	order.discounts.percentage	string	小数点区切り記号として '.' を使用し、'%' 記号を使用しない、小数点形式のパーセンテージ。 値 7.5 は 7.5%に対応します。
金額	order.discounts.applied_money.amount	integer	金額。
通貨	order.discounts.applied_money.currency	string	通貨。
タイプ	order.discounts.type	string	型を示します。
Scope	order.discounts.scope	string	現在のレベルを示します。
Created At	order.created_at	string	RFC 3339 形式で、このオブジェクトの作成時刻を指定するタイムスタンプ。
更新日時	order.updated_at	string	RFC 3339 形式で、このオブジェクトの最新の更新時刻を指定するタイムスタンプ。
State	order.state	string	現在の状態。
バージョン	order.version	integer	このオブジェクトの現在のバージョン。
金額	order.total_tax_money.amount	integer	金額。
通貨	order.total_tax_money.currency	string	通貨。
金額	order.total_discount_money.amount	integer	金額。
通貨	order.total_discount_money.currency	string	通貨。
金額	order.total_tip_money.amount	integer	金額。
通貨	order.total_tip_money.currency	string	通貨。
金額	order.total_money.amount	integer	金額。
通貨	order.total_money.currency	string	通貨。
金額	order.total_service_charge_money.amount	integer	金額。
通貨	order.total_service_charge_money.currency	string	通貨。
金額	order.net_amounts.total_money.amount	integer	金額。
通貨	order.net_amounts.total_money.currency	string	通貨。
金額	order.net_amounts.tax_money.amount	integer	金額。
通貨	order.net_amounts.tax_money.currency	string	通貨。
金額	order.net_amounts.discount_money.amount	integer	金額。
通貨	order.net_amounts.discount_money.currency	string	通貨。
金額	order.net_amounts.tip_money.amount	integer	金額。
通貨	order.net_amounts.tip_money.currency	string	通貨。
金額	order.net_amounts.service_charge_money.amount	integer	金額。
通貨	order.net_amounts.service_charge_money.currency	string	通貨。

顧客からグループを削除する

操作 ID:

CustomerRemoveGroup

顧客からグループ メンバーシップを削除します。 顧客はcustomer_id値によって識別され、顧客グループはgroup_id値によって識別されます。

パラメーター

名前	キー	必須	型	説明
顧客ID	customer_id	True	string	顧客の識別子。
グループ識別子	group_id	True	string	グループの識別子。

戻り値

response

object

顧客にグループを追加する

操作 ID:

CustomerAddGroup

顧客にグループ メンバーシップを追加します。 顧客はcustomer_id値によって識別され、顧客グループはgroup_id値によって識別されます。

パラメーター

名前	キー	必須	型	説明
顧客ID	customer_id	True	string	顧客の識別子。
グループ識別子	group_id	True	string	グループの識別子。

戻り値

response

object

顧客を一覧表示する

操作 ID:

CustomerList

Square アカウントに関連付けられている顧客プロファイルを一覧表示します。 通常の運用条件下では、新しく作成または更新された顧客プロファイルは、30 秒以内に登録登録操作に使用できるようになります。 新しいプロファイルまたは更新されたプロファイルの伝達には、特にネットワーク インシデントや停止時に、1 分以上かかる場合があります。

パラメーター

名前	キー	必須	型	説明
Cursor	cursor		string	このエンドポイントに対する以前の呼び出しによって返された改ページ位置カーソル。
極限	limit		integer	応答で返される数の上限。
並べ替えフィールド	sort_field		string	顧客の並べ替え方法を示します。 既定値は DEFAULT です。
並べ替え順序	sort_order		string	指定した順序でカードが作成されたときに、返されたリストを並べ替えます。

戻り値

名前	パス	型	説明
顧客	customers	array of object
ID	customers.id	string	Square で発行された一意の識別子。
Created At	customers.created_at	string	ISO 8601 形式のイベント時間。
更新日時	customers.updated_at	string	RFC 3339 形式の最終変更タイムスタンプ
名前	customers.given_name	string	顧客プロファイルに関連付けられている指定された (つまり、最初の) 名前。
名字	customers.family_name	string	顧客プロファイルに関連付けられているファミリ (つまり、姓) の名前。
メール アドレス	customers.email_address	string	顧客プロファイルに関連付けられている電子メール アドレス。
住所 1 行目	customers.address.address_line_1	string	住所の 1 行目。
住所 2 行目	customers.address.address_line_2	string	アドレスの 2 行目 (ある場合)。
地域	customers.address.locality	string	住所の市区町村。
行政区レベル 1	customers.address.administrative_district_level_1	string	住所の国内の市民エンティティ。 米国では、これが状態です。
郵便番号	customers.address.postal_code	string	住所の郵便番号。
Country	customers.address.country	string	ISO 3166-1-alpha-2 形式の住所の国。
電話番号	customers.phone_number	string	顧客プロファイルに関連付けられている 11 桁の電話番号。
参照 ID	customers.reference_id	string	顧客プロファイルを別のシステムのエンティティに関連付けるために使用する省略可能な 2 番目の ID。
注	customers.note	string	顧客プロファイルに関連付けられているカスタム メモ。
電子メールの登録を解除しました	customers.preferences.email_unsubscribed	boolean	顧客がマーケティング キャンペーンの電子メールの登録を解除したかどうかを示します。 true の値は、顧客が現在の Square 販売者またはすべての Square 販売者から電子メール マーケティングをオプトアウトすることを選択したことを意味します。 この値は、Customers API からの読み取り専用です。
作成ソース	customers.creation_source	string	作成ソースは、顧客プロファイルの作成に使用されるメソッドを表します。
グループ ID	customers.group_ids	array of string
セグメント ID	customers.segment_ids	array of string
バージョン	customers.version	integer	オブジェクトの現在のバージョン。

顧客を作成する

操作 ID:

CustomerCreate

ビジネス向けの新しい顧客を作成します。

パラメーター

名前	キー	必須	型	説明
名前	given_name		string	顧客プロファイルに関連付けられている指定された名前 (つまり、名)。
名字	family_name		string	顧客プロファイルに関連付けられているファミリ名 (つまり、姓)。
メール アドレス	email_address		string	顧客プロファイルに関連付けられている電子メール アドレス。
会社名	company_name		string	顧客プロファイルに関連付けられているビジネス名。
Nickname	nickname		string	顧客プロファイルのニックネーム。
住所 1 行目	address_line_1		string	住所の 1 行目。
住所 2 行目	address_line_2		string	アドレスの 2 行目 (ある場合)。
地域	locality		string	住所の市区町村。
行政区レベル 1	administrative_district_level_1		string	住所の国内の市民エンティティ。 米国では、これが状態です。
郵便番号	postal_code		string	住所の郵便番号。
Country	country		string	ISO 3166 Alpha-2 国コード。
電話番号	phone_number		string	顧客プロファイルに関連付けられている 11 桁の電話番号。
参照 ID	reference_id		string	顧客プロファイルを別のシステムのエンティティに関連付けるために使用する省略可能な 2 番目の ID。
注	note		string	顧客プロファイルに関連付けられているカスタム メモ。
Birthday	birthday		string	RFC 3339 形式の顧客プロファイルに関連付けられている誕生日。 年は省略可能です。 タイムゾーンと時刻は使用できません。 たとえば、0000-09-21T00:00:00-00:00 は 9 月 21 日の誕生日を表し、1998-09-21T00:00:00-00:00 は 1998 年 9 月 21 日の誕生日を表します。 この値は、YYYY-MM-DD 形式で指定することもできます。

戻り値

名前	パス	型	説明
ID	customer.id	string	Square で発行された一意の識別子。
Created At	customer.created_at	string	RFC 3339 形式で、このオブジェクトの作成時刻を指定するタイムスタンプ。
更新日時	customer.updated_at	string	RFC 3339 形式で、このオブジェクトの最新の更新時刻を指定するタイムスタンプ。
名前	customer.given_name	string	顧客プロファイルに関連付けられている指定された (つまり、最初の) 名前。
名字	customer.family_name	string	顧客プロファイルに関連付けられているファミリ (つまり、姓) の名前。
メール アドレス	customer.email_address	string	顧客プロファイルに関連付けられている電子メール アドレス。
会社名	customer.company_name	string	顧客プロファイルに関連付けられているビジネス名。
Nickname	customer.nickname	string	顧客プロファイルのニックネーム。
住所 1 行目	customer.address.address_line_1	string	住所の 1 行目。 address_lineで始まるフィールドは、住所の最も具体的な詳細 (番地、番地、建物名など) を提供します。
住所 2 行目	customer.address.address_line_2	string	アドレスの 2 行目 (ある場合)。
地域	customer.address.locality	string	住所の市区町村。
行政区レベル 1	customer.address.administrative_district_level_1	string	住所の国内の市民エンティティ。 米国では、これが状態です。
郵便番号	customer.address.postal_code	string	住所の郵便番号。
Country	customer.address.country	string	ISO 3166-1-alpha-2 形式の住所の国。
電話番号	customer.phone_number	string	顧客プロファイルに関連付けられている 11 桁の電話番号。
参照 ID	customer.reference_id	string	省略可能なユーザー定義参照 ID。
注	customer.note	string	顧客プロファイルに関連付けられているカスタム メモ。
Birthday	customer.birthday	string	RFC 3339 形式の顧客プロファイルに関連付けられている誕生日。 年は省略可能です。 タイムゾーンと時刻は使用できません。 たとえば、0000-09-21T00:00:00-00:00 は 9 月 21 日の誕生日を表し、1998-09-21T00:00:00-00:00 は 1998 年 9 月 21 日の誕生日を表します。
電子メールの登録を解除しました	customer.preferences.email_unsubscribed	boolean	顧客がマーケティング キャンペーンの電子メールの登録を解除したかどうかを示します。 true の値は、顧客が現在の Square 販売者またはすべての Square 販売者から電子メール マーケティングをオプトアウトすることを選択したことを意味します。
作成ソース	customer.creation_source	string	作成ソースは、顧客プロファイルの作成に使用されるメソッドを表します。
バージョン	customer.version	integer	このオブジェクトの現在のバージョン。

顧客を削除する

操作 ID:

CustomerDelete

ビジネスから顧客プロファイルを削除します。 この操作により、ファイル上の関連付けられているカードのリンクも解除されます。

パラメーター

名前	キー	必須	型	説明
顧客ID	customer_id	True	string	顧客の識別子。

戻り値

response

object

顧客を取得する

操作 ID:

CustomerRetrieve

1 人の顧客の詳細を返します。

パラメーター

名前	キー	必須	型	説明
顧客ID	customer_id	True	string	顧客の識別子。

戻り値

名前	パス	型	説明
ID	customer.id	string	Square で発行された一意の識別子。
Created At	customer.created_at	string	RFC 3339 形式で、このオブジェクトの作成時刻を指定するタイムスタンプ。
更新日時	customer.updated_at	string	RFC 3339 形式で、このオブジェクトの最新の更新時刻を指定するタイムスタンプ。
名前	customer.given_name	string	顧客プロファイルに関連付けられている指定された (つまり、最初の) 名前。
名字	customer.family_name	string	顧客プロファイルに関連付けられているファミリ (つまり、姓) の名前。
メール アドレス	customer.email_address	string	顧客プロファイルに関連付けられている電子メール アドレス。
住所 1 行目	customer.address.address_line_1	string	住所の 1 行目。 address_lineで始まるフィールドは、住所の最も具体的な詳細 (番地、番地、建物名など) を提供します。
住所 2 行目	customer.address.address_line_2	string	アドレスの 2 行目 (ある場合)。
地域	customer.address.locality	string	住所の市区町村。
行政区レベル 1	customer.address.administrative_district_level_1	string	住所の国内の市民エンティティ。 米国では、これが状態です。
郵便番号	customer.address.postal_code	string	住所の郵便番号。
Country	customer.address.country	string	ISO 3166-1-alpha-2 形式の住所の国。
電話番号	customer.phone_number	string	顧客プロファイルに関連付けられている 11 桁の電話番号。
参照 ID	customer.reference_id	string	省略可能なユーザー定義参照 ID。
注	customer.note	string	顧客プロファイルに関連付けられているカスタム メモ。
電子メールの登録を解除しました	customer.preferences.email_unsubscribed	boolean	顧客がマーケティング キャンペーンの電子メールの登録を解除したかどうかを示します。 true の値は、顧客が現在の Square 販売者またはすべての Square 販売者から電子メール マーケティングをオプトアウトすることを選択したことを意味します。
作成ソース	customer.creation_source	string	作成ソースは、顧客プロファイルの作成に使用されるメソッドを表します。
グループ ID	customer.group_ids	array of string
セグメント ID	customer.segment_ids	array of string
バージョン	customer.version	integer	このオブジェクトの現在のバージョン。

顧客を更新する

操作 ID:

CustomerUpdate

顧客プロファイルを更新します。 属性を変更するには、新しい値を指定します。 属性を削除するには、空の文字列または空のオブジェクトとして値を指定します。

パラメーター

名前	キー	必須	型	説明
顧客ID	customer_id	True	string	顧客の識別子。

戻り値

名前	パス	型	説明
ID	customer.id	string	Square で発行された一意の識別子。
Created At	customer.created_at	string	RFC 3339 形式で、このオブジェクトの作成時刻を指定するタイムスタンプ。
更新日時	customer.updated_at	string	RFC 3339 形式で、このオブジェクトの最新の更新時刻を指定するタイムスタンプ。
名前	customer.given_name	string	顧客プロファイルに関連付けられている指定された (つまり、最初の) 名前。
名字	customer.family_name	string	顧客プロファイルに関連付けられているファミリ (つまり、姓) の名前。
メール アドレス	customer.email_address	string	顧客プロファイルに関連付けられている電子メール アドレス。
住所 1 行目	customer.address.address_line_1	string	住所の 1 行目。 address_lineで始まるフィールドは、住所の最も具体的な詳細 (番地、番地、建物名など) を提供します。
住所 2 行目	customer.address.address_line_2	string	アドレスの 2 行目 (ある場合)。
地域	customer.address.locality	string	住所の市区町村。
行政区レベル 1	customer.address.administrative_district_level_1	string	住所の国内の市民エンティティ。 米国では、これが状態です。
郵便番号	customer.address.postal_code	string	住所の郵便番号。
Country	customer.address.country	string	ISO 3166-1-alpha-2 形式の住所の国。
参照 ID	customer.reference_id	string	省略可能なユーザー定義参照 ID。
注	customer.note	string	顧客プロファイルに関連付けられているカスタム メモ。
電子メールの登録を解除しました	customer.preferences.email_unsubscribed	boolean	顧客がマーケティング キャンペーンの電子メールの登録を解除したかどうかを示します。 true の値は、顧客が現在の Square 販売者またはすべての Square 販売者から電子メール マーケティングをオプトアウトすることを選択したことを意味します。
作成ソース	customer.creation_source	string	作成ソースは、顧客プロファイルの作成に使用されるメソッドを表します。
バージョン	customer.version	integer	このオブジェクトの現在のバージョン。

顧客を検索する

操作 ID:

CustomerSearch

サポートされているクエリ フィルターを使用して、Square アカウントに関連付けられている顧客プロファイルを検索します。 明示的なクエリ フィルターを使用せずに SearchCustomers を呼び出すと、given_nameとfamily_nameに基づいて、すべての顧客プロファイルがアルファベット順に並べ替えられます。

パラメーター

名前	キー	必須	型	説明
ファジー	fuzzy		string	あいまいフィルターを使用して、指定したクエリと一致する属性をあいまいな方法で選択します。 あいまいオプションを使用すると、検索クエリがトークン化され、各クエリ トークンが検索された属性のどこかで照合される必要があります。 単一トークン クエリの場合、これは実質的に部分一致操作と同じ動作です。
価値観	values		array of string
ルール	rule		string	フィルター条件に一致する顧客プロファイルを結果に含めるか、結果から除外するかを示します。
開始位置	start_at		string	時間範囲がいつ開始するかを示す RFC 3339 形式の datetime 値。
End At	end_at		string	時間範囲がいつ終了するかを示す RFC 3339 形式の datetime 値。
All	all		array of string
フィールド	field		string	1 つ以上の顧客属性を並べ替えキーとして使用して、検索された顧客プロファイルを並べ替えます。
注文	order		string	並べ替えフィールドの値に基づいて結果を並べ替える順序を示します。 文字列は、標準のアルファベット比較を使用して順序を決定します。
極限	limit		integer	1 ページで返される結果の数に関する制限。 制限はアドバイザリです。実装によって返される結果の数が増減する場合があります。 指定された制限が負、ゼロ、または最大値の 1,000 より大きい場合は無視されます。

戻り値

名前	パス	型	説明
顧客	customers	array of object
ID	customers.id	string	Square で発行された一意の識別子。
Created At	customers.created_at	string	ISO 8601 形式のイベント時間。
更新日時	customers.updated_at	string	RFC 3339 形式の最終変更タイムスタンプ
名前	customers.given_name	string	顧客プロファイルに関連付けられている指定された (つまり、最初の) 名前。
名字	customers.family_name	string	顧客プロファイルに関連付けられているファミリ (つまり、姓) の名前。
メール アドレス	customers.email_address	string	顧客プロファイルに関連付けられている電子メール アドレス。
住所 1 行目	customers.address.address_line_1	string	住所の 1 行目。
住所 2 行目	customers.address.address_line_2	string	アドレスの 2 行目 (ある場合)。
地域	customers.address.locality	string	住所の市区町村。
行政区レベル 1	customers.address.administrative_district_level_1	string	住所の国内の市民エンティティ。 米国では、これが状態です。
郵便番号	customers.address.postal_code	string	住所の郵便番号。
Country	customers.address.country	string	ISO 3166-1-alpha-2 形式の住所の国。
電話番号	customers.phone_number	string	顧客プロファイルに関連付けられている 11 桁の電話番号。
参照 ID	customers.reference_id	string	顧客プロファイルを別のシステムのエンティティに関連付けるために使用する省略可能な 2 番目の ID。
電子メールの登録を解除しました	customers.preferences.email_unsubscribed	boolean	顧客がマーケティング キャンペーンの電子メールの登録を解除したかどうかを示します。 true の値は、顧客が現在の Square 販売者またはすべての Square 販売者から電子メール マーケティングをオプトアウトすることを選択したことを意味します。 この値は、Customers API からの読み取り専用です。
作成ソース	customers.creation_source	string	作成ソースは、顧客プロファイルの作成に使用されるメソッドを表します。
グループ ID	customers.group_ids	array of string
セグメント ID	customers.segment_ids	array of string
バージョン	customers.version	integer	オブジェクトの現在のバージョン。
注	customers.note	string	顧客プロファイルに関連付けられているカスタム メモ。
Cursor	cursor	string	このエンドポイントへの後続の呼び出しに改ページ カーソルを含め、元のクエリに関連付けられた次の結果セットを取得します。

顧客グループを一覧表示する

操作 ID:

CustomerGroupList

ビジネスの顧客グループの一覧を取得します。

戻り値

名前	パス	型	説明
Groups	groups	array of object
ID	groups.id	string	Square で発行された一意の識別子。
名前	groups.name	string	オブジェクトの名前。
Created At	groups.created_at	string	ISO 8601 形式のイベント時間。
更新日時	groups.updated_at	string	RFC 3339 形式の最終変更タイムスタンプ

顧客グループを作成する

操作 ID:

CustomGroupCreate

ビジネス用の新しい顧客グループを作成します。

パラメーター

名前	キー	必須	型	説明
名前	name		string	オブジェクトの名前。

戻り値

名前	パス	型	説明
ID	group.id	string	Square で発行された一意の識別子。
名前	group.name	string	オブジェクトの名前。
Created At	group.created_at	string	RFC 3339 形式で、このオブジェクトの作成時刻を指定するタイムスタンプ。
更新日時	group.updated_at	string	RFC 3339 形式で、このオブジェクトの最新の更新時刻を指定するタイムスタンプ。

顧客グループを削除する

操作 ID:

CustomerGroupDelete

group_id値によって識別される顧客グループを削除します。

パラメーター

名前	キー	必須	型	説明
グループ識別子	group_id	True	string	グループの識別子。

戻り値

response

object

顧客グループを取得する

操作 ID:

CustomerGroupRetrieve

特定の顧客グループを取得します。

パラメーター

名前	キー	必須	型	説明
グループ識別子	group_id	True	string	グループの識別子。

戻り値

名前	パス	型	説明
ID	group.id	string	Square で発行された一意の識別子。
名前	group.name	string	オブジェクトの名前。
Created At	group.created_at	string	RFC 3339 形式で、このオブジェクトの作成時刻を指定するタイムスタンプ。
更新日時	group.updated_at	string	RFC 3339 形式で、このオブジェクトの最新の更新時刻を指定するタイムスタンプ。

顧客グループを更新する

操作 ID:

CustomerGroupUpdate

顧客グループを更新します。

パラメーター

名前	キー	必須	型	説明
グループ識別子	group_id	True	string	グループの識別子。
名前	name		string	オブジェクトの名前。

戻り値

名前	パス	型	説明
ID	group.id	string	Square で発行された一意の識別子。
名前	group.name	string	オブジェクトの名前。
Created At	group.created_at	string	RFC 3339 形式で、このオブジェクトの作成時刻を指定するタイムスタンプ。
更新日時	group.updated_at	string	RFC 3339 形式で、このオブジェクトの最新の更新時刻を指定するタイムスタンプ。

顧客セグメントを一覧表示する

操作 ID:

CustomerSegmentList

ビジネスの顧客セグメントの一覧を取得します。

パラメーター

名前	キー	必須	型	説明
Cursor	cursor		string	このエンドポイントに対する以前の呼び出しによって返された改ページ位置カーソル。
極限	limit		integer	応答で返される数の上限。

戻り値

名前	パス	型	説明
セグメント	segments	array of object
ID	segments.id	string	Square で発行された一意の識別子。
名前	segments.name	string	オブジェクトの名前。
Created At	segments.created_at	string	ISO 8601 形式のイベント時間。
更新日時	segments.updated_at	string	RFC 3339 形式の最終変更タイムスタンプ

顧客セグメントを取得する

操作 ID:

CustomerSegmentRetrieve

特定の顧客セグメントを取得します。

パラメーター

名前	キー	必須	型	説明
セグメント ID	segment_id	True	string	セグメントの識別子。

戻り値

名前	パス	型	説明
ID	segment.id	string	Square で発行された一意の識別子。
名前	segment.name	string	オブジェクトの名前。
Created At	segment.created_at	string	RFC 3339 形式で、このオブジェクトの作成時刻を指定するタイムスタンプ。
更新日時	segment.updated_at	string	RFC 3339 形式で、このオブジェクトの最新の更新時刻を指定するタイムスタンプ。

定義

オブジェクト

これは型 'object' です。