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

Square は、安全なクレジット カード処理から販売時点管理ソリューションまで、何百万人もの販売担当者のビジネス遂行を支援します。 このコネクタには、支払い、ターミナル、受注、サブスクリプション、請求書、カタログ、在庫、および顧客のエンドポイントに対するアクションが含まれています。

このコネクタは、次の製品および地域で利用可能です。

Service クラス 地域
Logic Apps 標準 以下を除くすべての Logic Apps 地域 :
     -   Azure 政府の地域
     -   Azure 中国の地域
     -   国防総省 (DoD)
Power Automate プレミアム 以下を除くすべての Power Automate 地域 :
     -   米国政府 (GCC)
     -   米国政府 (GCC High)
     -   21Vianet が運用する中国のクラウド
     -   国防総省 (DoD)
Power Apps プレミアム 以下を除くすべての Power Apps 地域 :
     -   米国政府 (GCC)
     -   米国政府 (GCC High)
     -   21Vianet が運用する中国のクラウド
     -   米国国防総省 (DoD)
お問い合わせ先
件名 Troy Taylor
[URL] https://www.hitachisolutions.com
メール ttaylor@hitachisolutions.com
Connector Metadata
発行者 Troy Taylor
Web サイト https://squareup.com/
プライバシー ポリシー https://squareup.com/us/en/legal/general/privacy
カテゴリ コマース; 営業と CRM

調整制限

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

アクション

Apple Pay のドメインの登録

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

べき等キーによる支払のキャンセル

要求で指定されたべき等キーで識別される支払をキャンセル (無効化) します。 CreatePayment 要求のステータスが不明な場合 (たとえば、CreatePayment 要求を送信した後、ネットワーク エラーが発生し、応答がない場合) にこの方法を使用します。 いこの場合、このエンドポイントを使用して、Square に支払いをキャンセルするように指示できます。 要求では、キャンセルする CreatePayment 要求で指定したものと同じべき等キーを指定します。 支払いをキャンセルした後、CreatePayment 要求を再度送信できます。 指定されたべき等キーを持つ支払いが見つからない場合、アクションは実行されず、エンドポイントは正常に返されることに注意してください。

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

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

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

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

カタログ オブジェクトの一括削除

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

カタログ オブジェクトの一括取得

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

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

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

カタログ オブジェクトの取得

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

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

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

カタログの一覧表示

カタログ内の目的の種類 (たとえば、すべての CatalogItem オブジェクトや CatalogTax オブジェクト) のセットのすべてのオブジェクトを含む CatalogObjects の一覧を返します。 ListCatalog は、削除されたカタログ品目を返しません。

カタログ情報

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

カードの一覧表示

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

カードの作成

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

カードの取得

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

カードの無効化

カードを無効にして、それ以上の更新や請求を防ぎます。 すでに無効になっているカードを無効にすることはできますが、影響はありません。

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

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

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

Cancelled_date フィールドをアクティブな請求期間の終わりに設定します。 この日付を過ぎると、ステータスは ACTIVE から CANCELED に変わります。

サブスクリプションの作成

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

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

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

サブスクリプションの取得

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

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

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

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

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

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

要求のステータスが許可している場合、ターミナル チェックアウトの要求をキャンセルします。

ターミナル チェックアウトの作成

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

ターミナル チェックアウトの取得

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

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

要求を行ったアカウントによって作成されたターミナル チェックアウト要求のフィルター済みリストを取得します。

ターミナル払い戻しのキャンセル

要求のステータスが許可している場合、払戻し要求 ID による Interac ターミナルの払戻し要求をキャンセルします。

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

Square ターミナルで完了した Interac 決済の払い戻し要求を作成します。

ターミナル払い戻しの取得

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

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

要求を行った販売担当者によって作成された Interac ターミナル 払い戻し要求のフィルター済みリストを取得します。

受注の一括取得

ID で一連の受注を取得します。 指定された受注 ID が存在しない場合、エラーを生成する代わりに ID は無視されます。

受注の作成

購入する製品に関する情報や、購入に適用する設定を含む新しい注文を作成します。

受注の計算 (ベータ版)

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

品目の修飾子リストの更新

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

品目税の更新

品目全体に対してアップサートを実行することなく、対象の CatalogItem に適用される CatalogTax オブジェクトを更新します。

在庫の一括変更

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

在庫の現物棚卸の取得

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

在庫変更の一括取得

指定されたフィルター条件に基づいて、過去の現物棚卸と調整を返します。

在庫数の一括取得

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

在庫数の取得

特定の場所のセットで特定の CatalogObject に対して現在の計算された在庫数を取得します。

在庫移動の取得 (ベータ版)

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

在庫調整の取得

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

支払いの一覧表示

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

支払いの作成

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

支払いの取得

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

支払いの払い戻し

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

支払いの払い戻しの一覧表示

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

支払いの払い戻しの取得

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

支払いの更新

支払いを APPROVED ステータスで更新します。 このエンドポイントを使用して、amount_money と tip_money を更新できます。

支払のキャンセル

支払をキャンセル (無効化) します。 このエンドポイントを使用して、APPROVED ステータスの支払をキャンセルできます。

支払の完了

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

注文の取得

ID で注文を取得します。

注文の支払い (ベータ版)

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

注文の更新 (ベータ版)

フィールドを追加、置換、または削除することにより、未処理の注文を更新します。 COMPLETED または CANCELED 状態の注文は更新できません。

注文の検索

1 つ以上の場所の注文をすべて検索します。 注文には、Square エコシステム (POS、Invoices、Connect の API など) に、いつ、どのように入ったかに関係なく、すべての販売、返品、交換が含まれます。

注文の複製 (ベータ版)

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

紛争の一覧表示

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

紛争の取得

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

紛争の承諾

紛争による損失を受け入れます。 Square は異議を申し立てられた金額をカード名義人に返し、異議を申し立ての状態を ACCEPTED に更新します。 Square は、販売担当者の Square アカウントから異議を申し立てられた金額を引き落とします。 Square アカウントに十分な資金がない場合、Square は関連する銀行口座から引き落します。

紛争の証拠となるテキストの作成

異議申立の証拠として使用するテキストをアップロードします。

紛争証拠の一覧表示

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

紛争証拠の削除

紛争から特定の証拠を削除します。

紛争証拠の取得

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

証拠の送信

カード名義人の銀行に証拠を送信します。 証拠を送信する前に、Square は利用可能なすべての証拠を集めます。 これには、CreateDisputeEvidenceFile および CreateDisputeEvidenceText のエンドポイントを使用してアップロードされた証拠と、利用可能な場合は Square によって自動的に提供される証拠が含まれます。

請求書の一覧表示

指定された場所の請求書の一覧を返します。

請求書の作成

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

請求書の削除

指定した請求書を削除します。 請求書が削除されると、関連する注文ステータスが CANCELED に変更されます。 削除できるのは下書き請求書のみです (処理が予定されている請求書を含め、発行済み請求書は削除できません)。

請求書の取り消し

請求書をキャンセルします。 販売担当者は、キャンセルされた請求書の支払いを回収できません。

請求書の取得

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

請求書の更新

フィールドを変更するか、フィールドをクリアするか、またはその両方を行うことで請求書を更新します。

請求書の検索

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

請求書の発行

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

顧客からグループを削除

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

顧客にグループを追加

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

顧客の一覧表示

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

顧客の作成

ビジネスの新規顧客を作成します。

顧客の削除

ビジネスから顧客プロファイルを削除します。 この操作では、ファイル上の関連カードのリンクも解除されます。

顧客の取得

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

顧客の更新

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

顧客の検索

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

顧客グループの一覧表示

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

顧客グループの作成

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

顧客グループの削除

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

顧客グループの取得

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

顧客グループの更新

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

顧客区分の一覧表示

ビジネスの顧客区分の一覧を取得します。

顧客区分の取得

特定の顧客区分を取得します。

Apple Pay のドメインの登録

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

パラメーター

名前 キー 必須 説明
Domain Name
domain_name True string

Apple Pay に登録される RFC-1034 に記載されているドメイン名。

戻り値

名前 パス 説明
Status
status string

ドメイン登録のステータス。

べき等キーによる支払のキャンセル

要求で指定されたべき等キーで識別される支払をキャンセル (無効化) します。 CreatePayment 要求のステータスが不明な場合 (たとえば、CreatePayment 要求を送信した後、ネットワーク エラーが発生し、応答がない場合) にこの方法を使用します。 いこの場合、このエンドポイントを使用して、Square に支払いをキャンセルするように指示できます。 要求では、キャンセルする CreatePayment 要求で指定したものと同じべき等キーを指定します。 支払いをキャンセルした後、CreatePayment 要求を再度送信できます。 指定されたべき等キーを持つ支払いが見つからない場合、アクションは実行されず、エンドポイントは正常に返されることに注意してください。

パラメーター

名前 キー 必須 説明
Idempotency Key
idempotency_key string

すべての要求の中でこの要求を一意に識別するために指定する値。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。

戻り値

response
object

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

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

パラメーター

名前 キー 必須 説明
Idempotency Key
idempotency_key string

すべての要求の中でこの要求を一意に識別するために指定する値。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。

ID
id string

Square が発行した一意の識別子。

Type
type string

このオブジェクトの種類。

Abbreviation
abbreviation string

Square POS アプリの品目表示ラベルのテキスト。 文字列の最初の 5 文字までが使用されます。 この属性は検索可能であり、その値の長さは Unicode コード ポイントです。

Description
title string

品目の説明。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値の長さは Unicode コード ポイントです。

Name
name string

名前。

ID
id string

カタログでこのオブジェクトを参照するための識別子。

Type
type string

このオブジェクトの種類。

Item ID
item_id string

この品目バリエーションに関連付けられた CatalogItem の ID。

Name
name string

品目バリエーションの名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値の長さは Unicode コード ポイントです。

Pricing Type
pricing_type string

品目バリエーションの価格が販売時に固定または決定されているかを示します。

Amount
amount integer

金額。

Currency
currency string

通貨。

戻り値

名前 パス 説明
Type
catalog_object.type string

このオブジェクトの種類。

ID
catalog_object.id string

Square が発行した一意の識別子。

Updated At
catalog_object.updated_at string

このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。

Version
catalog_object.version integer

このオブジェクトの現在のバージョン。

Is Deleted
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 になります。

Name
catalog_object.item_data.name string

名前。

Description
catalog_object.item_data.title string

品目の説明。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値の長さは Unicode コード ポイントです。

Abbreviation
catalog_object.item_data.abbreviation string

Square POS アプリの品目表示ラベルのテキスト。 文字列の最初の 5 文字までが使用されます。 この属性は検索可能であり、その値の長さは Unicode コード ポイントです。

Variations
catalog_object.item_data.variations array of object
Type
catalog_object.item_data.variations.type string

このオブジェクトの種類。

ID
catalog_object.item_data.variations.id string

カタログでこのオブジェクトを参照するための識別子。

Updated At
catalog_object.item_data.variations.updated_at string

最終変更タイムスタンプ (RFC 3339 形式)。

Version
catalog_object.item_data.variations.version integer

オブジェクトのバージョン。 オブジェクトを更新する場合、指定されるバージョンはデータベース内のバージョンと一致する必要があり、一致しない場合、書き込みは競合として拒否されます。

Is Deleted
catalog_object.item_data.variations.is_deleted boolean

true の場合、オブジェクトはデータベースから削除されています。 新しいオブジェクトを挿入する場合は false にする必要があります。 削除されると、updated_at フィールドは削除時間と等しくなります。

Present at All Locations
catalog_object.item_data.variations.present_at_all_locations boolean

true の場合、このオブジェクトは、absent_at_location_ids フィールドで指定されている場合を除き、すべての場所 (将来の場所を含む) に存在します。 false の場合、このオブジェクトは、present_at_location_ids フィールドで指定されている場合を除き、どの場所 (将来の場所を含む) にも存在しません。 指定しない場合、既定で true になります。

Item ID
catalog_object.item_data.variations.item_variation_data.item_id string

この品目バリエーションに関連付けられた CatalogItem の ID。

Name
catalog_object.item_data.variations.item_variation_data.name string

品目バリエーションの名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値の長さは Unicode コード ポイントです。

Ordinal
catalog_object.item_data.variations.item_variation_data.ordinal integer

この品目のバリエーションを表示する順序。 この値は読み取り専用です。 書き込み時には、親 CatalogItem 内の各品目バリエーションの序数が、品目バリエーションのポジションに従って設定されます。 読み取り時には、値がシーケンシャルまたは一意であることは保証されません。

Pricing Type
catalog_object.item_data.variations.item_variation_data.pricing_type string

品目バリエーションの価格が販売時に固定または決定されているかを示します。

Stockable
catalog_object.item_data.variations.item_variation_data.stockable boolean

在庫がこのバリエーション (TRUE) に直接カウントされるか、そのコンポーネント (FALSE) のみにカウントされるか。 下位互換性のために、不足値は TRUE と解釈されます。

Amount
catalog_object.item_data.variations.item_variation_data.price_money.amount integer

金額。

Currency
catalog_object.item_data.variations.item_variation_data.price_money.currency string

通貨。

Product Type
catalog_object.item_data.product_type string

品目の製品の種類。 品目が作成された後は変更できません。

ID Mappings
id_mappings array of object
Client Object ID
id_mappings.client_object_id string

クライアントが提供する、新しい CatalogObject の一時的な # 接頭辞付き ID。

Object ID
id_mappings.object_id string

サーバーによって作成された永続的な ID。

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

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

パラメーター

名前 キー 必須 説明
Idempotency Key
idempotency_key string

すべての要求の中でこの要求を一意に識別するために指定する値。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。

Type
type string

このオブジェクトの種類。

ID
id string

このオブジェクトを参照するための識別子。

Present at All Locations
present_at_all_locations boolean

true の場合、このオブジェクトは、absent_at_location_ids フィールドで指定されている場合を除き、すべての場所 (将来の場所を含む) に存在します。 false の場合、このオブジェクトは、present_at_location_ids フィールドで指定されている場合を除き、どの場所 (将来の場所を含む) にも存在しません。 指定しない場合、既定で true になります。

Name
name string

品目の名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値は空であってはならず、長さは Unicode コード ポイントです。

Description
title string

品目の説明。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値の長さは Unicode コード ポイントです。

Category ID
category_id string

品目のカテゴリ ID (存在する場合)。

Tax IDs
tax_ids array of string
Type
type string

このオブジェクトの種類。 各オブジェクトの種類には、以下の対応する *_data フィールド内に構造化された形式で表現された期待されるプロパティがあります。

ID
id string

このオブジェクトを参照するための識別子。

Present At All Locations
present_at_all_locations boolean

すべての場所に存在するかどうか。

Item ID
item_id string

品目の識別子。

Name
name string

品目の名前。

Pricing Type
pricing_type string

価格の種類。

Amount
amount integer

金額。

Currency
currency string

通貨。

Name
name string

品目の名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値は空であってはならず、長さは Unicode コード ポイントです。

Name
name string

品目の名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値は空であってはならず、長さは Unicode コード ポイントです。

Calculation Phase
calculation_phase string

税金が支払いの小計または合計に基づいて計算されるかどうか。

Inclusion Type
inclusion_type string

税金が ADDITIVE か INCLUSIVE か。

Percentage
percentage string

小数点の区切り文字に「.」を使用し、「%」記号を使用しない 10 進形式の税率。 値 7.5 は 7.5% に相当します。

Applies to Custom Amounts
applies_to_custom_amounts boolean

true の場合、料金は、特定の CatalogItem に関連付けられていない Square POS アプリに入力されたカスタム金額に適用されます。

Enabled
enabled boolean

Square POS アプリで税金が有効 (true) として表示するか、しないか (false) を示すブール値フラグ。

戻り値

名前 パス 説明
Objects
objects array of object
Type
objects.type string

このオブジェクトの種類。

ID
objects.id string

Square が発行した一意の識別子。

Updated At
objects.updated_at string

最終変更タイムスタンプ (RFC 3339 形式)

Version
objects.version integer

オブジェクトの現在のバージョン。

Is Deleted
objects.is_deleted boolean

true の場合、オブジェクトはデータベースから削除されています。 新しいオブジェクトを挿入する場合は false にする必要があります。 削除されると、updated_at フィールドは削除時間と等しくなります。

Present at All Locations
objects.present_at_all_locations boolean

true の場合、このオブジェクトは、absent_at_location_ids フィールドで指定されている場合を除き、すべての場所 (将来の場所を含む) に存在します。 false の場合、このオブジェクトは、present_at_location_ids フィールドで指定されている場合を除き、どの場所 (将来の場所を含む) にも存在しません。 指定しない場合、既定で true になります。

Name
objects.item_data.name string

品目の名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値は空であってはならず、長さは Unicode コード ポイントです。

Description
objects.item_data.title string

品目の説明。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値の長さは Unicode コード ポイントです。

Category ID
objects.item_data.category_id string

品目のカテゴリ ID (存在する場合)。

Tax IDs
objects.item_data.tax_ids array of string
Variations
objects.item_data.variations array of object
Type
objects.item_data.variations.type string

このオブジェクトの種類。 各オブジェクトの種類には、以下の対応する *_data フィールド内に構造化された形式で表現された期待されるプロパティがあります。

ID
objects.item_data.variations.id string

このオブジェクトを参照するための識別子。

Updated At
objects.item_data.variations.updated_at string

最終変更タイムスタンプ (RFC 3339 形式)

Version
objects.item_data.variations.version integer

オブジェクトのバージョン。 オブジェクトを更新する場合、指定されるバージョンはデータベース内のバージョンと一致する必要があり、一致しない場合、書き込みは競合として拒否されます。

Is Deleted
objects.item_data.variations.is_deleted boolean

true の場合、オブジェクトはデータベースから削除されています。 新しいオブジェクトを挿入する場合は false にする必要があります。 削除されると、updated_at フィールドは削除時間と等しくなります。

Present At All Locations
objects.item_data.variations.present_at_all_locations boolean

present_at_all_locations が false の場合でもオブジェクトが存在する場所の一覧。 これには、非アクティブ化された場所も含まれます。

Item ID
objects.item_data.variations.item_variation_data.item_id string

この品目のバリエーションを持つオブジェクトの ID。

Name
objects.item_data.variations.item_variation_data.name string

この品目の名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値の長さは Unicode コード ポイントです。

Ordinal
objects.item_data.variations.item_variation_data.ordinal integer

この品目のバリエーションを表示する順序。 この値は読み取り専用です。

Pricing Type
objects.item_data.variations.item_variation_data.pricing_type string

品目バリエーションの価格が販売時に固定または決定されているかを示します。

Amount
objects.item_data.variations.item_variation_data.price_money.amount integer

通貨で示される通貨の最小単位での金額。 たとえば、通貨が米国ドルの場合、金額はセント単位になります。 金額には正および負の値があります。 特定の場合の符号の意味を判別するには、特定のフィールドの説明を参照してください。

Currency
objects.item_data.variations.item_variation_data.price_money.currency string

通貨の種類 (ISO 4217 形式)。 たとえば、米国ドルの通貨コードは USD です。

Name
objects.category_data.name string

品目の名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値は空であってはならず、長さは Unicode コード ポイントです。

Name
objects.tax_data.name string

品目の名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値は空であってはならず、長さは Unicode コード ポイントです。

Calculation Phase
objects.tax_data.calculation_phase string

税金が支払いの小計または合計に基づいて計算されるかどうか。

Inclusion Type
objects.tax_data.inclusion_type string

税金が ADDITIVE か INCLUSIVE か。

Percentage
objects.tax_data.percentage string

小数点の区切り文字に「.」を使用し、「%」記号を使用しない 10 進形式のパーセント。 値 7.5 は 7.5% に相当します。

Applies To Custom Amounts
objects.tax_data.applies_to_custom_amounts boolean

true の場合、料金は、特定の CatalogItem に関連付けられていない Square POS アプリに入力されたカスタム金額に適用されます。

Enabled
objects.tax_data.enabled boolean

オブジェクトを使用できるかどうかを示します。

ID Mappings
id_mappings array of object
Client Object ID
id_mappings.client_object_id string

クライアントが提供する、新しい CatalogObject の一時的な # 接頭辞付き ID。

Object ID
id_mappings.object_id string

サーバーによって作成された永続的な ID。

カタログ オブジェクトの一括削除

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

パラメーター

名前 キー 必須 説明
Object IDs
object_ids array of string

戻り値

名前 パス 説明
Deleted Object IDs
deleted_object_ids array of string
Deleted At
deleted_at string

この削除のデータベース タイムスタンプ (RFC 3339 形式)

カタログ オブジェクトの一括取得

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

パラメーター

名前 キー 必須 説明
Object IDs
object_ids array of string
Catalog Version
catalog_version integer

応答に含まれるカタログ オブジェクトの特定のバージョン。 これにより、オブジェクトの履歴バージョンを取得できます。 指定されたバージョン値は、CatalogObjects のバージョン属性と照合されます。

Include Related Objects
include_related_objects boolean

true の場合、応答には、次のように、要求されたオブジェクトに関連する追加のオブジェクトが含まれます: 応答のオブジェクト フィールドに CatalogItem が含まれている場合、関連する CatalogCategory オブジェクト、CatalogTax オブジェクト、CatalogImage オブジェクト、CatalogModifierLists が応答の related_objects フィールドに返されます。 応答のオブジェクト フィールドに CatalogItemVariation が含まれている場合、その親の CatalogItem が応答の related_objects フィールドに返されます。

戻り値

名前 パス 説明
Objects
objects array of object
Type
objects.type string

このオブジェクトの種類。

ID
objects.id string

Square が発行した一意の識別子。

Updated At
objects.updated_at string

最終変更タイムスタンプ (RFC 3339 形式)

Version
objects.version integer

オブジェクトの現在のバージョン。

Is Deleted
objects.is_deleted boolean

true の場合、オブジェクトはデータベースから削除されています。 新しいオブジェクトを挿入する場合は false にする必要があります。 削除されると、updated_at フィールドは削除時間と等しくなります。

Present at All Locations
objects.present_at_all_locations boolean

true の場合、このオブジェクトは、absent_at_location_ids フィールドで指定されている場合を除き、すべての場所 (将来の場所を含む) に存在します。 false の場合、このオブジェクトは、present_at_location_ids フィールドで指定されている場合を除き、どの場所 (将来の場所を含む) にも存在しません。 指定しない場合、既定で true になります。

Name
objects.item_data.name string

品目の名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値は空であってはならず、長さは Unicode コード ポイントです。

Description
objects.item_data.title string

品目の説明。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値の長さは Unicode コード ポイントです。

Category ID
objects.item_data.category_id string

品目のカテゴリ ID (存在する場合)。

Tax IDs
objects.item_data.tax_ids array of string
Variations
objects.item_data.variations array of object
Type
objects.item_data.variations.type string

このオブジェクトの種類。 各オブジェクトの種類には、以下の対応する *_data フィールド内に構造化された形式で表現された期待されるプロパティがあります。

ID
objects.item_data.variations.id string

このオブジェクトを参照するための識別子。

Updated At
objects.item_data.variations.updated_at string

最終変更タイムスタンプ (RFC 3339 形式)

Version
objects.item_data.variations.version integer

オブジェクトのバージョン。 オブジェクトを更新する場合、指定されるバージョンはデータベース内のバージョンと一致する必要があり、一致しない場合、書き込みは競合として拒否されます。

Is Deleted
objects.item_data.variations.is_deleted boolean

true の場合、オブジェクトはデータベースから削除されています。 新しいオブジェクトを挿入する場合は false にする必要があります。 削除されると、updated_at フィールドは削除時間と等しくなります。

Present At All Locations
objects.item_data.variations.present_at_all_locations boolean

present_at_all_locations が false の場合でもオブジェクトが存在する場所の一覧。 これには、非アクティブ化された場所も含まれます。

Item ID
objects.item_data.variations.item_variation_data.item_id string

この品目のバリエーションを持つオブジェクトの ID。

Name
objects.item_data.variations.item_variation_data.name string

この品目の名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値の長さは Unicode コード ポイントです。

Ordinal
objects.item_data.variations.item_variation_data.ordinal integer

この品目のバリエーションを表示する順序。 この値は読み取り専用です。

Pricing Type
objects.item_data.variations.item_variation_data.pricing_type string

品目バリエーションの価格が販売時に固定または決定されているかを示します。

Amount
objects.item_data.variations.item_variation_data.price_money.amount integer

通貨で示される通貨の最小単位での金額。 たとえば、通貨が米国ドルの場合、金額はセント単位になります。 金額には正および負の値があります。 特定の場合の符号の意味を判別するには、特定のフィールドの説明を参照してください。

Currency
objects.item_data.variations.item_variation_data.price_money.currency string

通貨の種類 (ISO 4217 形式)。 たとえば、米国ドルの通貨コードは USD です。

Related Objects
related_objects array of object
Type
related_objects.type string

このオブジェクトの種類。

ID
related_objects.id string

Square が発行した一意の識別子。

Updated At
related_objects.updated_at string

最終変更タイムスタンプ (RFC 3339 形式)

Version
related_objects.version integer

オブジェクトの現在のバージョン。

Is Deleted
related_objects.is_deleted boolean

true の場合、オブジェクトはデータベースから削除されています。 新しいオブジェクトを挿入する場合は false にする必要があります。 削除されると、updated_at フィールドは削除時間と等しくなります。

Present at All Locations
related_objects.present_at_all_locations boolean

true の場合、このオブジェクトは、absent_at_location_ids フィールドで指定されている場合を除き、すべての場所 (将来の場所を含む) に存在します。 false の場合、このオブジェクトは、present_at_location_ids フィールドで指定されている場合を除き、どの場所 (将来の場所を含む) にも存在しません。 指定しない場合、既定で true になります。

Name
related_objects.category_data.name string

品目の名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値は空であってはならず、長さは Unicode コード ポイントです。

Name
related_objects.tax_data.name string

品目の名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値は空であってはならず、長さは Unicode コード ポイントです。

Calculation Phase
related_objects.tax_data.calculation_phase string

税金が支払いの小計または合計に基づいて計算されるかどうか。

Inclusion Type
related_objects.tax_data.inclusion_type string

税金が ADDITIVE か INCLUSIVE か。

Percentage
related_objects.tax_data.percentage string

小数点の区切り文字に「.」を使用し、「%」記号を使用しない 10 進形式のパーセント。 値 7.5 は 7.5% に相当します。

Enabled
related_objects.tax_data.enabled boolean

オブジェクトを使用できるかどうかを示します。

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

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

パラメーター

名前 キー 必須 説明
Object ID
object_id True string

オブジェクトの識別子。

戻り値

名前 パス 説明
Deleted Object IDs
deleted_object_ids array of string
Deleted At
deleted_at string

この削除のデータベース タイムスタンプ (RFC 3339 形式)

カタログ オブジェクトの取得

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

パラメーター

名前 キー 必須 説明
Object ID
object_id True string

オブジェクトの識別子。

Include Related Objects
include_related_objects boolean

true の場合、応答には、次のように、要求されたオブジェクトに関連する追加のオブジェクトが含まれます: 応答のオブジェクト フィールドに CatalogItem が含まれている場合、関連する CatalogCategory、CatalogTax、CatalogImage、CatalogModifierList のオブジェクトが応答の related_objects フィールドに返されます。 応答のオブジェクト フィールドに CatalogItemVariation が含まれている場合、その親の CatalogItem が応答の related_objects フィールドに返されます。

戻り値

名前 パス 説明
Type
object.type string

このオブジェクトの種類。

ID
object.id string

Square が発行した一意の識別子。

Updated At
object.updated_at string

このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。

Version
object.version integer

このオブジェクトの現在のバージョン。

Is Deleted
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 になります。

Name
object.item_data.name string

名前。

Description
object.item_data.title string

品目の説明。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値の長さは Unicode コード ポイントです。

Category ID
object.item_data.category_id string

品目のカテゴリ ID (存在する場合)。

Tax IDs
object.item_data.tax_ids array of string
Variations
object.item_data.variations array of object
Type
object.item_data.variations.type string

このオブジェクトの種類。

ID
object.item_data.variations.id string

カタログでこのオブジェクトを参照するための識別子。

Updated At
object.item_data.variations.updated_at string

最終変更タイムスタンプ (RFC 3339 形式)。

Version
object.item_data.variations.version integer

オブジェクトのバージョン。 オブジェクトを更新する場合、指定されるバージョンはデータベース内のバージョンと一致する必要があり、一致しない場合、書き込みは競合として拒否されます。

Is Deleted
object.item_data.variations.is_deleted boolean

true の場合、オブジェクトはデータベースから削除されています。 新しいオブジェクトを挿入する場合は false にする必要があります。 削除されると、updated_at フィールドは削除時間と等しくなります。

Present at All Locations
object.item_data.variations.present_at_all_locations boolean

true の場合、このオブジェクトは、absent_at_location_ids フィールドで指定されている場合を除き、すべての場所 (将来の場所を含む) に存在します。 false の場合、このオブジェクトは、present_at_location_ids フィールドで指定されている場合を除き、どの場所 (将来の場所を含む) にも存在しません。 指定しない場合、既定で true になります。

Item ID
object.item_data.variations.item_variation_data.item_id string

この品目バリエーションに関連付けられた CatalogItem の ID。

Name
object.item_data.variations.item_variation_data.name string

品目バリエーションの名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値の長さは Unicode コード ポイントです。

Ordinal
object.item_data.variations.item_variation_data.ordinal integer

この品目のバリエーションを表示する順序。 この値は読み取り専用です。 書き込み時には、親 CatalogItem 内の各品目バリエーションの序数が、品目バリエーションのポジションに従って設定されます。 読み取り時には、値がシーケンシャルまたは一意であることは保証されません。

Pricing Type
object.item_data.variations.item_variation_data.pricing_type string

品目バリエーションの価格が販売時に固定または決定されているかを示します。

Amount
object.item_data.variations.item_variation_data.price_money.amount integer

金額。

Currency
object.item_data.variations.item_variation_data.price_money.currency string

通貨。

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

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

パラメーター

名前 キー 必須 説明
Object Types
object_types array of string
Attribute Name
attribute_name string

検索する属性の名前。

Attribute Prefix
attribute_prefix string

検索属性値の目的の接頭辞。

Limit
limit integer

1 ページに返される結果の数の制限。 制限は推奨値であり、実装によって返される結果が増減する可能性があります。 指定された制限が負、ゼロ、または最大制限の 1,000 より大きい場合、無視されます。

戻り値

名前 パス 説明
Objects
objects array of object
Type
objects.type string

このオブジェクトの種類。

ID
objects.id string

Square が発行した一意の識別子。

Updated At
objects.updated_at string

最終変更タイムスタンプ (RFC 3339 形式)

Version
objects.version integer

オブジェクトの現在のバージョン。

Is Deleted
objects.is_deleted boolean

true の場合、オブジェクトはデータベースから削除されています。 新しいオブジェクトを挿入する場合は false にする必要があります。 削除されると、updated_at フィールドは削除時間と等しくなります。

Present at All Locations
objects.present_at_all_locations boolean

true の場合、このオブジェクトは、absent_at_location_ids フィールドで指定されている場合を除き、すべての場所 (将来の場所を含む) に存在します。 false の場合、このオブジェクトは、present_at_location_ids フィールドで指定されている場合を除き、どの場所 (将来の場所を含む) にも存在しません。 指定しない場合、既定で true になります。

Name
objects.item_data.name string

品目の名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値は空であってはならず、長さは Unicode コード ポイントです。

Description
objects.item_data.title string

品目の説明。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値の長さは Unicode コード ポイントです。

Category ID
objects.item_data.category_id string

品目のカテゴリ ID (存在する場合)。

Product Type
objects.item_data.product_type string

指定した製品タイプを持つ品目または品目バリエーションを返す製品タイプのクエリ式。

Tax IDs
objects.item_data.tax_ids array of string
Variations
objects.item_data.variations array of object
Type
objects.item_data.variations.type string

このオブジェクトの種類。 各オブジェクトの種類には、以下の対応する *_data フィールド内に構造化された形式で表現された期待されるプロパティがあります。

ID
objects.item_data.variations.id string

このオブジェクトを参照するための識別子。

Updated At
objects.item_data.variations.updated_at string

最終変更タイムスタンプ (RFC 3339 形式)

Version
objects.item_data.variations.version integer

オブジェクトのバージョン。 オブジェクトを更新する場合、指定されるバージョンはデータベース内のバージョンと一致する必要があり、一致しない場合、書き込みは競合として拒否されます。

Is Deleted
objects.item_data.variations.is_deleted boolean

true の場合、オブジェクトはデータベースから削除されています。 新しいオブジェクトを挿入する場合は false にする必要があります。 削除されると、updated_at フィールドは削除時間と等しくなります。

Present At All Locations
objects.item_data.variations.present_at_all_locations boolean

present_at_all_locations が false の場合でもオブジェクトが存在する場所の一覧。 これには、非アクティブ化された場所も含まれます。

Item ID
objects.item_data.variations.item_variation_data.item_id string

この品目のバリエーションを持つオブジェクトの ID。

Name
objects.item_data.variations.item_variation_data.name string

この品目の名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値の長さは Unicode コード ポイントです。

Ordinal
objects.item_data.variations.item_variation_data.ordinal integer

この品目のバリエーションを表示する順序。 この値は読み取り専用です。

Amount
objects.item_data.variations.item_variation_data.price_money.amount integer

通貨で示される通貨の最小単位での金額。 たとえば、通貨が米国ドルの場合、金額はセント単位になります。 金額には正および負の値があります。 特定の場合の符号の意味を判別するには、特定のフィールドの説明を参照してください。

Currency
objects.item_data.variations.item_variation_data.price_money.currency string

通貨の種類 (ISO 4217 形式)。 たとえば、米国ドルの通貨コードは USD です。

Pricing Type
objects.item_data.variations.item_variation_data.pricing_type string

品目バリエーションの価格が販売時に固定または決定されているかを示します。

Visibility
objects.item_data.visibility string

表示。

カタログの一覧表示

カタログ内の目的の種類 (たとえば、すべての CatalogItem オブジェクトや CatalogTax オブジェクト) のセットのすべてのオブジェクトを含む CatalogObjects の一覧を返します。 ListCatalog は、削除されたカタログ品目を返しません。

パラメーター

名前 キー 必須 説明
Cursor
cursor integer

このエンドポイントへの前回の呼び出しによって返されたページネーション カーソル。

Types
types string

取得するオブジェクト型の、オプションで大文字と小文字を区別しないコンマ区切りリスト。 有効な値は、ITEM、ITEM_VARIATION、CATEGORY、DISCOUNT、TAX、MODIFIER、MODIFIER_LIST、または IMAGE を含む CatalogObjectType 列挙型で定義されます。 これが指定されていない場合、操作は、要求の作成に使用された Square API のバージョンで、すべての型のオブジェクトを返します。

戻り値

名前 パス 説明
Objects
objects array of object
Type
objects.type string

このオブジェクトの種類。

ID
objects.id string

Square が発行した一意の識別子。

Updated At
objects.updated_at string

最終変更タイムスタンプ (RFC 3339 形式)

Version
objects.version integer

オブジェクトの現在のバージョン。

Is Deleted
objects.is_deleted boolean

true の場合、オブジェクトはデータベースから削除されています。 新しいオブジェクトを挿入する場合は false にする必要があります。 削除されると、updated_at フィールドは削除時間と等しくなります。

Present at All Locations
objects.present_at_all_locations boolean

true の場合、このオブジェクトは、absent_at_location_ids フィールドで指定されている場合を除き、すべての場所 (将来の場所を含む) に存在します。 false の場合、このオブジェクトは、present_at_location_ids フィールドで指定されている場合を除き、どの場所 (将来の場所を含む) にも存在しません。 指定しない場合、既定で true になります。

Name
objects.category_data.name string

品目の名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値は空であってはならず、長さは Unicode コード ポイントです。

Name
objects.tax_data.name string

品目の名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値は空であってはならず、長さは Unicode コード ポイントです。

Calculation Phase
objects.tax_data.calculation_phase string

税金が支払いの小計または合計に基づいて計算されるかどうか。

Inclusion Type
objects.tax_data.inclusion_type string

税金が ADDITIVE か INCLUSIVE か。

Percentage
objects.tax_data.percentage string

小数点の区切り文字に「.」を使用し、「%」記号を使用しない 10 進形式のパーセント。 値 7.5 は 7.5% に相当します。

Enabled
objects.tax_data.enabled boolean

オブジェクトを使用できるかどうかを示します。

カタログ情報

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

戻り値

名前 パス 説明
Batch Upsert Max Objects per Batch
limits.batch_upsert_max_objects_per_batch integer

/v2/catalog/batch-upsert 要求で 1 つのバッチ内に表示できるオブジェクトの最大数。

Batch Upsert Max Total Objects
limits.batch_upsert_max_total_objects integer

/v2/catalog/batch-upsert 要求で全バッチに表示できるオブジェクトの最大数。

Batch Retrieve Max Object IDs
limits.batch_retrieve_max_object_ids integer

/v2/catalog/batch-retrieve 要求で表示できるオブジェクト ID の最大数。

Search Max Page Limit
limits.search_max_page_limit integer

/v2/catalog/search 応答のページで返される結果の最大数。

Batch Delete Max Object IDs
limits.batch_delete_max_object_ids integer

1 つの /v2/catalog/batch-delete 要求に含めることができるオブジェクト ID の最大数。

Update Item Taxes Max Item IDs
limits.update_item_taxes_max_item_ids integer

1 つの /v2/catalog/update-item-taxes 要求に含めることができる品目 ID の最大数。

Update Item Taxes Max Taxes to Enable
limits.update_item_taxes_max_taxes_to_enable integer

1 つの /v2/catalog/update-item-taxes 要求に含めることができる、有効化する税 ID の最大数。

Update Item Taxes Max Taxes to Disable
limits.update_item_taxes_max_taxes_to_disable integer

1 つの /v2/catalog/update-item-taxes 要求に含めることができる、無効化する税 ID の最大数。

Update Item Modifier Lists Max Item IDs
limits.update_item_modifier_lists_max_item_ids integer

1 つの /v2/catalog/update-item-taxes 要求に含めることができる、無効化する税 ID の最大数。

Update Item Modifier Lists Max Modifier Lists to Enable
limits.update_item_modifier_lists_max_modifier_lists_to_enable integer

1 つの /v2/catalog/update-item-modifier-lists 要求に含めることができる、有効化する修飾子リスト ID の最大数。

Update Item Modifier Lists Max Modifier Lists to Disable
limits.update_item_modifier_lists_max_modifier_lists_to_disable integer

1 つの /v2/catalog/update-item-modifier-lists 要求に含めることができる、無効化する修飾子リスト ID の最大数。

カードの一覧表示

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

パラメーター

名前 キー 必須 説明
Cursor
cursor string

このエンドポイントへの前回の呼び出しによって返されたページネーション カーソル。

Customer ID
customer_id string

結果を提供された顧客に関連付けられたカードに限定します。 既定では、マーチャントが所有するすべてのカードが返されます。

Include Disabled
include_disabled boolean

無効化されたカードが含まれます。 既定では、マーチャントが所有するすべての有効なカードが返されます。

Reference ID
reference_id string

結果を提供された reference_id に関連付けられたカードに限定します。

Sort Order
sort_order string

返された一覧を、指定された順序でカードが作成された日時で並べ替えます。

戻り値

名前 パス 説明
Cards
cards array of object
ID
cards.card.id string

オブジェクトの識別子

Address Line 1
cards.card.billing_address.address_line_1 string

address_line で始まるフィールドは、番地、通りの名前、建物名など、住所の最も具体的な詳細を指定します。

Address Line 2
cards.card.billing_address.address_line_2 string

住所の 2 行目 (存在する場合)。

Locality
cards.card.billing_address.locality string

住所の市区町村。

Administrative District Level 1
cards.card.billing_address.administrative_district_level_1 string

住所の国内にある市民エンティティ。 米国では、これは州です。

Postal Code
cards.card.billing_address.postal_code string

住所の郵便番号。

Country
cards.card.billing_address.country string

住所の国 (ISO 3166-1-alpha-2 形式)。

Fingerprint
cards.card.fingerprint string

カード番号に基づく、1 つのアプリケーション内の複数の場所でカードを識別するための、Square で割り当てられた識別子として使用されます。

BIN
cards.card.bin string

カード番号の最初の 6 桁は、銀行識別番号 (BIN) と呼ばれます。

Card Brand
cards.card.card_brand string

カードのブランド。

Card Type
cards.card.card_type string

カードの種類。

Cardholder Name
cards.card.cardholder_name string

カード名義人の名前。

Customer ID
cards.card.customer_id string

カードと関連付ける顧客の ID。

Enabled
cards.card.enabled boolean

オブジェクトを使用できるかどうかを示します。

Expiration Month
cards.card.exp_month integer

関連付けられているカードの有効期限の月 (1 - 12 の整数)。

Expiration Year
cards.card.exp_year integer

カードの有効期限の 4 桁の年。

Last 4
cards.card.last_4 string

カード番号の末尾 4 桁。

Prepaid Type
cards.card.prepaid_type string

カードがプリペイドかどうかを示します。

Reference ID
cards.card.reference_id string

このカードを外部システムの別のエンティティに関連付けるオプションのユーザー定義参照 ID。

Version
cards.card.version integer

カードの現在のバージョン番号。 カードが更新されるたびに増加します。 既存の Card オブジェクトを更新する要求は、要求のバージョンが Card の現在のバージョンと一致しない限り拒否されます。

カードの作成

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

パラメーター

名前 キー 必須 説明
Idempotency Key
idempotency_key string

べき等キー。

Source ID
source_id string

ソースの識別子。

Address Line 1
address_line_1 string

住所の 1 行目。 address_line で始まるフィールドは、番地、通りの名前、建物名など、住所の最も具体的な詳細を指定します。

Address Line 2
address_line_2 string

住所の 2 行目 (存在する場合)。

Locality
locality string

住所の市区町村。

Administrative District Level 1
administrative_district_level_1 string

住所の国内にある市民エンティティ。 米国では、これは州です。

Postal Code
postal_code string

住所の郵便番号。

Country
country string

住所の国 (ISO 3166-1-alpha-2 形式)。

Cardholder Name
cardholder_name string

カード名義人の名前。

Customer ID
customer_id string

顧客を表すこのオブジェクトの ID。

Reference ID
reference_id string

オプションのユーザー定義参照 ID。

戻り値

名前 パス 説明
ID
card.id string

Square が発行した一意の識別子。

Address Line 1
card.billing_address.address_line_1 string

住所の 1 行目。 address_line で始まるフィールドは、番地、通りの名前、建物名など、住所の最も具体的な詳細を指定します。

Address Line 2
card.billing_address.address_line_2 string

住所の 2 行目 (存在する場合)。

Locality
card.billing_address.locality string

住所の市区町村。

Administrative District Level 1
card.billing_address.administrative_district_level_1 string

住所の国内にある市民エンティティ。 米国では、これは州です。

Postal Code
card.billing_address.postal_code string

住所の郵便番号。

Country
card.billing_address.country string

住所の国 (ISO 3166-1-alpha-2 形式)。

Fingerprint
card.fingerprint string

カード番号に基づく、1 つのアプリケーション内の複数の場所でカードを識別するための、Square で割り当てられた識別子として使用されます。

BIN
card.bin string

カード番号の最初の 6 桁は、銀行識別番号 (BIN) と呼ばれます。

Card Brand
card.card_brand string

カードのブランド。

Card Type
card.card_type string

カードの種類。

Cardholder Name
card.cardholder_name string

カード名義人の名前。

Customer 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 桁の年。

Last 4
card.last_4 string

カード番号の末尾 4 桁。

Prepaid Type
card.prepaid_type string

カードがプリペイドかどうかを示します。

Reference ID
card.reference_id string

オプションのユーザー定義参照 ID。

Version
card.version integer

このオブジェクトの現在のバージョン。

カードの取得

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

パラメーター

名前 キー 必須 説明
Card ID
card_id True string

カードの識別子。

戻り値

名前 パス 説明
ID
card.id string

Square が発行した一意の識別子。

Address Line 1
card.billing_address.address_line_1 string

住所の 1 行目。 address_line で始まるフィールドは、番地、通りの名前、建物名など、住所の最も具体的な詳細を指定します。

Address Line 2
card.billing_address.address_line_2 string

住所の 2 行目 (存在する場合)。

Locality
card.billing_address.locality string

住所の市区町村。

Administrative District Level 1
card.billing_address.administrative_district_level_1 string

住所の国内にある市民エンティティ。 米国では、これは州です。

Postal Code
card.billing_address.postal_code string

住所の郵便番号。

Country
card.billing_address.country string

住所の国 (ISO 3166-1-alpha-2 形式)。

Fingerprint
card.fingerprint string

カード番号に基づく、1 つのアプリケーション内の複数の場所でカードを識別するための、Square で割り当てられた識別子として使用されます。

BIN
card.bin string

カード番号の最初の 6 桁は、銀行識別番号 (BIN) と呼ばれます。

Card Brand
card.card_brand string

カードのブランド。

Card Type
card.card_type string

カードの種類。

Cardholder Name
card.cardholder_name string

カード名義人の名前。

Customer 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 桁の年。

Last 4
card.last_4 string

カード番号の末尾 4 桁。

Prepaid Type
card.prepaid_type string

カードがプリペイドかどうかを示します。

Reference ID
card.reference_id string

オプションのユーザー定義参照 ID。

Version
card.version integer

このオブジェクトの現在のバージョン。

カードの無効化

カードを無効にして、それ以上の更新や請求を防ぎます。 すでに無効になっているカードを無効にすることはできますが、影響はありません。

パラメーター

名前 キー 必須 説明
Card ID
card_id True string

カードの識別子。

戻り値

名前 パス 説明
ID
card.id string

Square が発行した一意の識別子。

Address Line 1
card.billing_address.address_line_1 string

住所の 1 行目。 address_line で始まるフィールドは、番地、通りの名前、建物名など、住所の最も具体的な詳細を指定します。

Address Line 2
card.billing_address.address_line_2 string

住所の 2 行目 (存在する場合)。

Locality
card.billing_address.locality string

住所の市区町村。

Administrative District Level 1
card.billing_address.administrative_district_level_1 string

住所の国内にある市民エンティティ。 米国では、これは州です。

Postal Code
card.billing_address.postal_code string

住所の郵便番号。

Country
card.billing_address.country string

住所の国 (ISO 3166-1-alpha-2 形式)。

Fingerprint
card.fingerprint string

カード番号に基づく、1 つのアプリケーション内の複数の場所でカードを識別するための、Square で割り当てられた識別子として使用されます。

BIN
card.bin string

カード番号の最初の 6 桁は、銀行識別番号 (BIN) と呼ばれます。

Card Brand
card.card_brand string

カードのブランド。

Card Type
card.card_type string

カードの種類。

Cardholder Name
card.cardholder_name string

カード名義人の名前。

Customer 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 桁の年。

Last 4
card.last_4 string

カード番号の末尾 4 桁。

Prepaid Type
card.prepaid_type string

カードがプリペイドかどうかを示します。

Reference ID
card.reference_id string

オプションのユーザー定義参照 ID。

Version
card.version integer

このオブジェクトの現在のバージョン。

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

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

パラメーター

名前 キー 必須 説明
Subscription ID
subscription_id True string

サブスクリプションの識別子。

戻り値

名前 パス 説明
Subscription Events
subscription_events array of object
ID
subscription_events.id string

Square が発行した一意の識別子。

Subscription Event Type
subscription_events.subscription_event_type string

サブスクリプション イベントの種類。

Effective Date
subscription_events.effective_date string

サブスクリプション イベントが有効になった日付 (YYYY-MM-DD 形式)。

Plan ID
subscription_events.plan_id string

関連するサブスクリプション プランの ID

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

Cancelled_date フィールドをアクティブな請求期間の終わりに設定します。 この日付を過ぎると、ステータスは ACTIVE から CANCELED に変わります。

パラメーター

名前 キー 必須 説明
Subscription ID
subscription_id True string

サブスクリプションの識別子。

戻り値

名前 パス 説明
ID
subscription.id string

Square が発行した一意の識別子。

Location ID
subscription.location_id string

場所の識別子。

Plan ID
subscription.plan_id string

関連するサブスクリプション プランの ID。

Customer ID
subscription.customer_id string

顧客を表すこのオブジェクトの ID。

Card ID
subscription.card_id string

サブスクリプションに対して請求される顧客カードの ID。

Start Date
subscription.start_date string

サブスクリプションの開始日 (YYYY-MM-DD 形式)。

Canceled Date
subscription.canceled_date string

サブスクリプションのキャンセル日 (YYYY-MM-DD 形式)。

Paid Until Date
subscription.paid_until_date string

支払期日。

Status
subscription.status string

このオブジェクトの現在の検証状態。

Created At
subscription.created_at string

このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。

Version
subscription.version integer

このオブジェクトの現在のバージョン。

Timezone
subscription.timezone string

カレンダーの日付を解釈するために使用されるタイム ゾーン。 請求書が作成されると、このフィールドは販売担当者の場所に指定されたタイムゾーンに設定されます。 値は変更できません。

Name
subscription.source.name string

名前。

サブスクリプションの作成

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

パラメーター

名前 キー 必須 説明
Idempotency Key
idempotency_key string

すべての要求の中でこの要求を一意に識別するために指定する値。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。

Location ID
location_id string

場所の識別子。

Plan ID
plan_id string

Catalog API を使用して作成されたサブスクリプション プランの ID。

Customer ID
customer_id string

リンクする顧客の ID。

Card ID
card_id string

請求する顧客カードの ID。

Start Date
start_date string

サブスクリプションの開始日 (YYYY-MM-DD 形式)。

Tax Percentage
tax_percentage string

サブスクリプションの請求時に追加する税金。

Amount
amount integer

この支払いを受け入れる金額 (tip_money を除く)。

Currency
currency string

3 文字の ISO 4217 通貨コード。

Timezone
timezone string

サブスクリプションの日付計算で使用されるタイムゾーン。

Name
name string

オブジェクトの名前。

戻り値

名前 パス 説明
ID
subscription.id string

Square が発行した一意の識別子。

Location ID
subscription.location_id string

場所の識別子。

Plan ID
subscription.plan_id string

関連するサブスクリプション プランの ID。

Customer ID
subscription.customer_id string

顧客を表すこのオブジェクトの ID。

Start Date
subscription.start_date string

サブスクリプションの開始日 (YYYY-MM-DD 形式)。

Status
subscription.status string

このオブジェクトの現在の検証状態。

Tax Percentage
subscription.tax_percentage string

サブスクリプションの請求時に適用される税額。

Amount
subscription.price_override_money.amount integer

金額。

Currency
subscription.price_override_money.currency string

通貨。

Version
subscription.version integer

このオブジェクトの現在のバージョン。

Created At
subscription.created_at string

このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。

Card ID
subscription.card_id string

サブスクリプションに対して請求される顧客カードの ID。

Timezone
subscription.timezone string

カレンダーの日付を解釈するために使用されるタイム ゾーン。 請求書が作成されると、このフィールドは販売担当者の場所に指定されたタイムゾーンに設定されます。 値は変更できません。

Name
subscription.source.name string

名前。

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

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

パラメーター

名前 キー 必須 説明
Subscription ID
subscription_id True string

サブスクリプションの識別子。

戻り値

名前 パス 説明
ID
subscription.id string

Square が発行した一意の識別子。

Location ID
subscription.location_id string

場所の識別子。

Plan ID
subscription.plan_id string

関連するサブスクリプション プランの ID。

Customer ID
subscription.customer_id string

顧客を表すこのオブジェクトの ID。

Status
subscription.status string

このオブジェクトの現在の検証状態。

Amount
subscription.price_override_money.amount integer

金額。

Currency
subscription.price_override_money.currency string

通貨。

Version
subscription.version integer

このオブジェクトの現在のバージョン。

Created At
subscription.created_at string

このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。

Timezone
subscription.timezone string

カレンダーの日付を解釈するために使用されるタイム ゾーン。 請求書が作成されると、このフィールドは販売担当者の場所に指定されたタイムゾーンに設定されます。 値は変更できません。

Name
subscription.source.name string

名前。

サブスクリプションの取得

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

パラメーター

名前 キー 必須 説明
Subscription ID
subscription_id True string

サブスクリプションの識別子。

戻り値

名前 パス 説明
ID
subscription.id string

Square が発行した一意の識別子。

Location ID
subscription.location_id string

場所の識別子。

Plan ID
subscription.plan_id string

関連するサブスクリプション プランの ID。

Customer ID
subscription.customer_id string

顧客を表すこのオブジェクトの ID。

Start Date
subscription.start_date string

サブスクリプションの開始日 (YYYY-MM-DD 形式)。

Charged Through Date
subscription.charged_through_date string

YYYY-MM-DD 形式で、顧客にサブスクリプションの請求が行われるまでの日付。

Status
subscription.status string

このオブジェクトの現在の検証状態。

Invoice IDs
subscription.invoice_ids array of string
Amount
subscription.price_override_money.amount integer

金額。

Currency
subscription.price_override_money.currency string

通貨。

Created At
subscription.created_at string

このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。

Paid Until Date
subscription.paid_until_date string

支払期日。

Timezone
subscription.timezone string

カレンダーの日付を解釈するために使用されるタイム ゾーン。 請求書が作成されると、このフィールドは販売担当者の場所に指定されたタイムゾーンに設定されます。 値は変更できません。

Name
subscription.source.name string

名前。

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

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

パラメーター

名前 キー 必須 説明
Location IDs
location_ids array of string
Customer IDs
customer_ids array of string
Source Names
source_names array of string

戻り値

名前 パス 説明
Subscriptions
subscriptions array of object
ID
subscriptions.id string

Square が発行した一意の識別子。

Location ID
subscriptions.location_id string

場所の識別子。

Plan ID
subscriptions.plan_id string

関連するサブスクリプション プランの ID

Customer ID
subscriptions.customer_id string

アカウントに関連付けられた、Square で割り当てられた顧客の ID。

Start Date
subscriptions.start_date string

サブスクリプションの開始日 (YYYY-MM-DD 形式)。

Canceled Date
subscriptions.canceled_date string

サブスクリプションのキャンセル日 (YYYY-MM-DD 形式)。

Charged Through Date
subscriptions.charged_through_date string

YYYY-MM-DD 形式で、顧客にサブスクリプションの請求が行われるまでの日付。

Status
subscriptions.status string

このオブジェクトの現在の検証状態。

Created At
subscriptions.created_at string

イベント時刻 (ISO 8601 形式)。

Card ID
subscriptions.card_id string

サブスクリプションに対して請求される顧客カードの ID。

Paid Until Date
subscriptions.paid_until_date string

支払期日。

Timezone
subscriptions.timezone string

due_date など、請求書のカレンダーの日付を解釈するために使用されるタイムゾーン。 請求書が作成されると、このフィールドは販売担当者の場所に指定されたタイムゾーンに設定されます。 値は変更できません。

Name
subscriptions.source.name string

品目の名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値は空であってはならず、長さは Unicode コード ポイントです。

Tax Percentage
subscriptions.tax_percentage string

サブスクリプションの請求時に適用される税額。

Amount
subscriptions.price_override_money.amount integer

金額。

Currency
subscriptions.price_override_money.currency string

通貨。

Version
subscriptions.version integer

オブジェクトの現在のバージョン。

Invoice IDs
subscriptions.invoice_ids array of string

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

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

パラメーター

名前 キー 必須 説明
Subscription ID
subscription_id True string

サブスクリプションの識別子。

Version
version integer

このオブジェクトの現在のバージョン。

Tax Percentage
tax_percentage string

サブスクリプションの請求時に適用される税額。

Amount
amount integer

金額。

Currency
currency string

通貨。

戻り値

名前 パス 説明
ID
subscription.id string

Square が発行した一意の識別子。

Location ID
subscription.location_id string

場所の識別子。

Plan ID
subscription.plan_id string

関連するサブスクリプション プランの ID。

Customer ID
subscription.customer_id string

顧客を表すこのオブジェクトの ID。

Status
subscription.status string

このオブジェクトの現在の検証状態。

Amount
subscription.price_override_money.amount integer

金額。

Currency
subscription.price_override_money.currency string

通貨。

Version
subscription.version integer

このオブジェクトの現在のバージョン。

Created At
subscription.created_at string

このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。

Timezone
subscription.timezone string

カレンダーの日付を解釈するために使用されるタイム ゾーン。 請求書が作成されると、このフィールドは販売担当者の場所に指定されたタイムゾーンに設定されます。 値は変更できません。

Name
subscription.source.name string

名前。

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

要求のステータスが許可している場合、ターミナル チェックアウトの要求をキャンセルします。

パラメーター

名前 キー 必須 説明
Checkout ID
checkout_id True string

チェックアウトの識別子。

戻り値

名前 パス 説明
ID
checkout.id string

Square が発行した一意の識別子。

Amount
checkout.amount_money.amount integer

金額。

Currency
checkout.amount_money.currency string

通貨。

Reference ID
checkout.reference_id string

オプションのユーザー定義参照 ID。

Device ID
checkout.device_options.device_id string

この TerminalCheckout 用のデバイスの一意の ID。

Allow Tipping
checkout.device_options.tip_settings.allow_tipping boolean

このチェックアウトでチップが有効かどうかを示します。 既定値は false。

Skip Receipt Screen
checkout.device_options.skip_receipt_screen boolean

受信確認画面をスキップするようにデバイスに指示します。 既定値は false。

Status
checkout.status string

このオブジェクトの現在の検証状態。

Cancel Reason
checkout.cancel_reason string

取り消されたトランザクションの理由。

Created At
checkout.created_at string

このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。

更新日時
checkout.updated_at string

このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。

App ID
checkout.app_id string

チェックアウトを作成したアプリケーションの ID。

Deadline Duration
checkout.deadline_duration string

RFC 3339 の期間。この期間を過ぎると、チェックアウトは自動的に取り消されます。 PENDING の TerminalCheckout は自動的に CANCELED となり、取消理由は TIMED_OUT です。 既定値: 作成から 5 分

ターミナル チェックアウトの作成

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

パラメーター

名前 キー 必須 説明
Idempotency Key
idempotency_key string

すべての要求の中でこの要求を一意に識別するために指定する値。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。

Amount
amount integer

金額。

Currency
currency string

通貨。

Reference ID
reference_id string

オプションのユーザー定義参照 ID。

Device ID
device_id string

この TerminalCheckout 用のデバイスの一意の ID。

Note
note string

顧客プロファイルに関連付けられたカスタム メモ。

戻り値

名前 パス 説明
ID
checkout.id string

Square が発行した一意の識別子。

Amount
checkout.amount_money.amount integer

金額。

Currency
checkout.amount_money.currency string

通貨。

Reference ID
checkout.reference_id string

オプションのユーザー定義参照 ID。

Note
checkout.note string

顧客プロファイルに関連付けられたカスタム メモ。

Device ID
checkout.device_options.device_id string

この TerminalCheckout 用のデバイスの一意の ID。

Allow Tipping
checkout.device_options.tip_settings.allow_tipping boolean

このチェックアウトでチップが有効かどうかを示します。 既定値は false。

Skip Receipt Screen
checkout.device_options.skip_receipt_screen boolean

受信確認画面をスキップするようにデバイスに指示します。 既定値は false。

Status
checkout.status string

このオブジェクトの現在の検証状態。

Created At
checkout.created_at string

このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。

更新日時
checkout.updated_at string

このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。

App ID
checkout.app_id string

チェックアウトを作成したアプリケーションの ID。

Deadline Duration
checkout.deadline_duration string

RFC 3339 の期間。この期間を過ぎると、チェックアウトは自動的に取り消されます。 PENDING の TerminalCheckout は自動的に CANCELED となり、取消理由は TIMED_OUT です。 既定値: 作成から 5 分

Payment Type
checkout.payment_type string

ターミナルが取得しようとする支払いのタイプ。 既定値は CARD_PRESENT です。

ターミナル チェックアウトの取得

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

パラメーター

名前 キー 必須 説明
Checkout ID
checkout_id True string

チェックアウトの識別子。

戻り値

名前 パス 説明
ID
checkout.id string

Square が発行した一意の識別子。

Amount
checkout.amount_money.amount integer

金額。

Currency
checkout.amount_money.currency string

通貨。

Reference ID
checkout.reference_id string

オプションのユーザー定義参照 ID。

Note
checkout.note string

顧客プロファイルに関連付けられたカスタム メモ。

Device ID
checkout.device_options.device_id string

この TerminalCheckout 用のデバイスの一意の ID。

Allow Tipping
checkout.device_options.tip_settings.allow_tipping boolean

このチェックアウトでチップが有効かどうかを示します。 既定値は false。

Skip Receipt Screen
checkout.device_options.skip_receipt_screen boolean

受信確認画面をスキップするようにデバイスに指示します。 既定値は false。

Status
checkout.status string

このオブジェクトの現在の検証状態。

Created At
checkout.created_at string

このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。

更新日時
checkout.updated_at string

このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。

App ID
checkout.app_id string

チェックアウトを作成したアプリケーションの ID。

Deadline Duration
checkout.deadline_duration string

RFC 3339 の期間。この期間を過ぎると、チェックアウトは自動的に取り消されます。 PENDING の TerminalCheckout は自動的に CANCELED となり、取消理由は TIMED_OUT です。 既定値: 作成から 5 分

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

要求を行ったアカウントによって作成されたターミナル チェックアウト要求のフィルター済みリストを取得します。

パラメーター

名前 キー 必須 説明
Limit
limit integer

1 ページに返される結果の数の制限。 制限は推奨値であり、実装によって返される結果が増減する可能性があります。 指定された制限が負、ゼロ、または最大制限の 1,000 より大きい場合、無視されます。

Status
status string

現在の状態。

戻り値

名前 パス 説明
Checkouts
checkouts array of object
ID
checkouts.id string

Square が発行した一意の識別子。

Amount
checkouts.amount_money.amount integer

金額。

Currency
checkouts.amount_money.currency string

通貨。

Reference ID
checkouts.reference_id string

顧客プロファイルを別のシステムのエンティティに関連付けるために使用されるオプションの 2 番目の ID。

Note
checkouts.note string

顧客プロファイルに関連付けられたカスタム メモ。

Device ID
checkouts.device_options.device_id string

この TerminalCheckout 用のデバイスの一意の ID。

Allow Tipping
checkouts.device_options.tip_settings.allow_tipping boolean

このチェックアウトでチップが有効かどうかを示します。 既定値は false。

Skip Receipt Screen
checkouts.device_options.skip_receipt_screen boolean

受信確認画面をスキップするようにデバイスに指示します。 既定値は false。

Status
checkouts.status string

このオブジェクトの現在の検証状態。

Payment IDs
checkouts.payment_ids array of string
Created At
checkouts.created_at string

イベント時刻 (ISO 8601 形式)。

Updated At
checkouts.updated_at string

最終変更タイムスタンプ (RFC 3339 形式)

App ID
checkouts.app_id string

チェックアウトを作成したアプリケーションの ID。

Deadline Duration
checkouts.deadline_duration string

RFC 3339 の期間。この期間を過ぎると、チェックアウトは自動的に取り消されます。 PENDING の TerminalCheckout は自動的に CANCELED となり、取消理由は TIMED_OUT です。 既定値: 作成から 5 分

Cursor
cursor string

このエンドポイントへの後続の呼び出しにページネーション カーソルを含めて、元のクエリに関連付けられた次の結果セットを取得します。

ターミナル払い戻しのキャンセル

要求のステータスが許可している場合、払戻し要求 ID による Interac ターミナルの払戻し要求をキャンセルします。

パラメーター

名前 キー 必須 説明
Terminal Refund ID
terminal_refund_id True string

ターミナル払い戻しの識別子。

戻り値

名前 パス 説明
ID
refund.id string

Square が発行した一意の識別子。

Payment ID
refund.payment_id string

支払の一意の ID。

Amount
refund.amount_money.amount integer

金額。

Currency
refund.amount_money.currency string

通貨。

Reason
refund.reason string

このオブジェクトの理由。

Device ID
refund.device_id string

この TerminalRefund 用のデバイスの一意の ID。

Deadline Duration
refund.deadline_duration string

RFC 3339 の期間。この期間を過ぎると、チェックアウトは自動的に取り消されます。 PENDING の TerminalCheckout は自動的に CANCELED となり、取消理由は TIMED_OUT です。 既定値: 作成から 5 分

Status
refund.status string

このオブジェクトの現在の検証状態。

Cancel Reason
refund.cancel_reason string

取り消されたトランザクションの理由。

Created At
refund.created_at string

このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。

更新日時
refund.updated_at string

このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。

App ID
refund.app_id string

チェックアウトを作成したアプリケーションの ID。

Card Brand
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 桁の年。

Fingerprint
refund.card.fingerprint string

カード番号に基づく、1 つのアプリケーション内の複数の場所でカードを識別するための、Square で割り当てられた識別子として使用されます。

Card Type
refund.card.card_type string

カードの種類。

BIN
refund.card.bin string

カード番号の最初の 6 桁は、銀行識別番号 (BIN) と呼ばれます。

Order ID
refund.order_id string

受注の ID。

Location ID
refund.location_id string

場所の識別子。

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

Square ターミナルで完了した Interac 決済の払い戻し要求を作成します。

パラメーター

名前 キー 必須 説明
Idempotency Key
idempotency_key string

すべての要求の中でこの要求を一意に識別するために指定する値。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。

Amount
amount integer

金額。

Currency
currency string

通貨。

Device ID
device_id string

この TerminalRefund 用のデバイスの一意の ID。

Reason
reason string

このオブジェクトの理由。

Payment ID
payment_id string

支払の一意の ID。

戻り値

名前 パス 説明
ID
refund.id string

Square が発行した一意の識別子。

Payment ID
refund.payment_id string

支払の一意の ID。

Amount
refund.amount_money.amount integer

金額。

Currency
refund.amount_money.currency string

通貨。

Reason
refund.reason string

このオブジェクトの理由。

Device ID
refund.device_id string

この TerminalRefund 用のデバイスの一意の ID。

Deadline Duration
refund.deadline_duration string

RFC 3339 の期間。この期間を過ぎると、チェックアウトは自動的に取り消されます。 PENDING の TerminalCheckout は自動的に CANCELED となり、取消理由は TIMED_OUT です。 既定値: 作成から 5 分

Status
refund.status string

このオブジェクトの現在の検証状態。

Created At
refund.created_at string

このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。

更新日時
refund.updated_at string

このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。

App ID
refund.app_id string

チェックアウトを作成したアプリケーションの ID。

Card Brand
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 桁の年。

Fingerprint
refund.card.fingerprint string

カード番号に基づく、1 つのアプリケーション内の複数の場所でカードを識別するための、Square で割り当てられた識別子として使用されます。

Card Type
refund.card.card_type string

カードの種類。

BIN
refund.card.bin string

カード番号の最初の 6 桁は、銀行識別番号 (BIN) と呼ばれます。

Order ID
refund.order_id string

受注の ID。

Location ID
refund.location_id string

場所の識別子。

ターミナル払い戻しの取得

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

パラメーター

名前 キー 必須 説明
Terminal Refund ID
terminal_refund_id True string

ターミナル払い戻しの識別子。

戻り値

名前 パス 説明
ID
refund.id string

Square が発行した一意の識別子。

Refund ID
refund.refund_id string

Square によって生成されたこの払い戻しの一意の ID。

Payment ID
refund.payment_id string

支払の一意の ID。

Amount
refund.amount_money.amount integer

金額。

Currency
refund.amount_money.currency string

通貨。

Reason
refund.reason string

このオブジェクトの理由。

Device ID
refund.device_id string

この TerminalRefund 用のデバイスの一意の ID。

Deadline Duration
refund.deadline_duration string

RFC 3339 の期間。この期間を過ぎると、チェックアウトは自動的に取り消されます。 PENDING の TerminalCheckout は自動的に CANCELED となり、取消理由は TIMED_OUT です。 既定値: 作成から 5 分

Status
refund.status string

このオブジェクトの現在の検証状態。

Created At
refund.created_at string

このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。

更新日時
refund.updated_at string

このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。

App ID
refund.app_id string

チェックアウトを作成したアプリケーションの ID。

Card Brand
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 桁の年。

Fingerprint
refund.card.fingerprint string

カード番号に基づく、1 つのアプリケーション内の複数の場所でカードを識別するための、Square で割り当てられた識別子として使用されます。

Card Type
refund.card.card_type string

カードの種類。

BIN
refund.card.bin string

カード番号の最初の 6 桁は、銀行識別番号 (BIN) と呼ばれます。

Order ID
refund.order_id string

受注の ID。

Location ID
refund.location_id string

場所の識別子。

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

要求を行った販売担当者によって作成された Interac ターミナル 払い戻し要求のフィルター済みリストを取得します。

パラメーター

名前 キー 必須 説明
Limit
limit integer

1 ページに返される結果の数の制限。 制限は推奨値であり、実装によって返される結果が増減する可能性があります。 指定された制限が負、ゼロ、または最大制限の 1,000 より大きい場合、無視されます。

Status
status string

現在の状態。

戻り値

名前 パス 説明
Refunds
refunds array of object
ID
refunds.id string

Square が発行した一意の識別子。

Refund ID
refunds.refund_id string

Square によって生成されたこの払い戻しの一意の ID。

Payment ID
refunds.payment_id string

支払いの ID。

Amount
refunds.amount_money.amount integer

金額。

Currency
refunds.amount_money.currency string

通貨。

Reason
refunds.reason string

カード名義人が銀行と紛争を開始した紛争の理由。

Device ID
refunds.device_id string

このコードを使用したデバイスの一意の ID。 デバイスがペアリングされたときに入力されます。

Deadline Duration
refunds.deadline_duration string

RFC 3339 の期間。この期間を過ぎると、チェックアウトは自動的に取り消されます。 PENDING の TerminalCheckout は自動的に CANCELED となり、取消理由は TIMED_OUT です。 既定値: 作成から 5 分

Status
refunds.status string

このオブジェクトの現在の検証状態。

Created At
refunds.created_at string

イベント時刻 (ISO 8601 形式)。

Updated At
refunds.updated_at string

最終変更タイムスタンプ (RFC 3339 形式)

App ID
refunds.app_id string

チェックアウトを作成したアプリケーションの ID。

Card Brand
refunds.card.card_brand string

カードのブランド。

Last 4
refunds.card.last_4 string

カード番号の末尾 4 桁。

Expiration Month
refunds.card.exp_month integer

関連付けられているカードの有効期限の月 (1 - 12 の整数)。

Expiration Year
refunds.card.exp_year integer

カードの有効期限の 4 桁の年。

Fingerprint
refunds.card.fingerprint string

カード番号に基づく、1 つのアプリケーション内の複数の場所でカードを識別するための、Square で割り当てられた識別子として使用されます。

Card Type
refunds.card.card_type string

カードの種類。

BIN
refunds.card.bin string

カード番号の最初の 6 桁は、銀行識別番号 (BIN) と呼ばれます。

Order ID
refunds.order_id string

受注の ID。

Location ID
refunds.location_id string

場所の識別子。

受注の一括取得

ID で一連の受注を取得します。 指定された受注 ID が存在しない場合、エラーを生成する代わりに ID は無視されます。

パラメーター

名前 キー 必須 説明
Location ID
location_id string

場所の識別子。

Order IDs
order_ids array of string

戻り値

名前 パス 説明
Orders
orders array of object
ID
orders.id string

Square が発行した一意の識別子。

Location ID
orders.location_id string

場所の識別子。

Reference ID
orders.reference_id string

顧客プロファイルを別のシステムのエンティティに関連付けるために使用されるオプションの 2 番目の ID。

Line Items
orders.line_items array of object
UID
orders.line_items.uid string

Square で生成された請求書の支払要求 ID。

Name
orders.line_items.name string

人間が判読できる名前。

Quantity
orders.line_items.quantity string

10 進数形式の購入数量。

Amount
orders.line_items.base_price_money.amount integer

金額。

Currency
orders.line_items.base_price_money.currency string

通貨。

Amount
orders.line_items.total_money.amount integer

金額。

Currency
orders.line_items.total_money.currency string

通貨。

Amount
orders.total_money.amount integer

金額。

Currency
orders.total_money.currency string

通貨。

受注の作成

購入する製品に関する情報や、購入に適用する設定を含む新しい注文を作成します。

パラメーター

名前 キー 必須 説明
Idempotency Key
idempotency_key string

すべての要求の中でこの要求を一意に識別するために指定する値。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。

Reference ID
reference_id string

オプションのユーザー定義参照 ID。

Location ID
location_id string

場所の識別子。

Name
name string

品目の名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値は空であってはならず、長さは Unicode コード ポイントです。

Quantity
quantity string

現物棚卸によって影響を受ける品目の 10 進文字列数。 数値は、小数点以下 5 桁まで対応可能です。

Amount
amount integer

金額。

Currency
currency string

通貨。

Catalog Object ID
catalog_object_id string

Square で生成された追跡対象の CatalogObject の ID。

Catalog Object ID
catalog_object_id string

カタログ オブジェクト ID。

Discount UID
discount_uid string

適用された割引が表す割引の uid。

UID
uid string

Square で生成された ID。

Name
name string

品目の名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値は空であってはならず、長さは Unicode コード ポイントです。

Percentage
percentage string

小数点の区切り文字に「.」を使用し、「%」記号を使用しない 10 進形式のパーセント。 値 7.5 は 7.5% に相当します。

Scope
scope string

現在のレベルを示します。

UID
uid string

Square で生成された ID。

Name
name string

品目の名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値は空であってはならず、長さは Unicode コード ポイントです。

Percentage
percentage string

小数点の区切り文字に「.」を使用し、「%」記号を使用しない 10 進形式のパーセント。 値 7.5 は 7.5% に相当します。

Scope
scope string

現在のレベルを示します。

Catalog Object ID
catalog_object_id string

Square で生成された追跡対象の CatalogObject の ID。

Amount
amount integer

金額。

Currency
currency string

通貨。

戻り値

名前 パス 説明
ID
order.id string

Square が発行した一意の識別子。

Location ID
order.location_id string

場所の識別子。

Line Items
order.line_items array of object
UID
order.line_items.uid string

Square で生成された ID。

Name
order.line_items.name string

品目の名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値は空であってはならず、長さは Unicode コード ポイントです。

Quantity
order.line_items.quantity string

現物棚卸によって影響を受ける品目の 10 進文字列数。 数値は、小数点以下 5 桁まで対応可能です。

Applied Taxes
order.line_items.applied_taxes array of object
UID
order.line_items.applied_taxes.uid string

Square で割り当てられた ID。

Tax UID
order.line_items.applied_taxes.tax_uid string

この適用税が表す税の UID。

Amount
order.line_items.applied_taxes.applied_money.amount integer

金額。

Currency
order.line_items.applied_taxes.applied_money.currency string

通貨。

Applied Discounts
order.line_items.applied_discounts array of object
UID
order.line_items.applied_discounts.uid string

Square で割り当てられた ID。

Discount UID
order.line_items.applied_discounts.discount_uid string

適用された割引が表す割引の uid。

Amount
order.line_items.applied_discounts.applied_money.amount integer

金額。

Currency
order.line_items.applied_discounts.applied_money.currency string

通貨。

Amount
order.line_items.base_price_money.amount integer

金額。

Currency
order.line_items.base_price_money.currency string

通貨。

Amount
order.line_items.gross_sales_money.amount integer

金額。

Currency
order.line_items.gross_sales_money.currency string

通貨。

Amount
order.line_items.total_tax_money.amount integer

金額。

Currency
order.line_items.total_tax_money.currency string

通貨。

Amount
order.line_items.total_discount_money.amount integer

金額。

Currency
order.line_items.total_discount_money.currency string

通貨。

Amount
order.line_items.total_money.amount integer

金額。

Currency
order.line_items.total_money.currency string

通貨。

Amount
order.line_items.variation_total_price_money.amount integer

金額。

Currency
order.line_items.variation_total_price_money.currency string

通貨。

Catalog Object ID
order.line_items.catalog_object_id string

Square で生成された追跡対象の CatalogObject の ID。

Variation Name
order.line_items.variation_name string

この品目に適用されるバリエーションの名前。

Modifiers
order.line_items.modifiers array of object
UID
order.line_items.modifiers.uid string

Square で割り当てられた ID。

Catalog Object ID
order.line_items.modifiers.catalog_object_id string

カタログ オブジェクト ID。

Name
order.line_items.modifiers.name string

品目の名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値は空であってはならず、長さは Unicode コード ポイントです。

Amount
order.line_items.modifiers.base_price_money.amount integer

金額。

Currency
order.line_items.modifiers.base_price_money.currency string

通貨。

Amount
order.line_items.modifiers.total_price_money.amount integer

金額。

Currency
order.line_items.modifiers.total_price_money.currency string

通貨。

Taxes
order.taxes array of object
UID
order.taxes.uid string

Square で生成された ID。

Name
order.taxes.name string

品目の名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値は空であってはならず、長さは Unicode コード ポイントです。

Type
order.taxes.type string

種類を示します。

Percentage
order.taxes.percentage string

小数点の区切り文字に「.」を使用し、「%」記号を使用しない 10 進形式のパーセント。 値 7.5 は 7.5% に相当します。

Amount
order.taxes.applied_money.amount integer

金額。

Currency
order.taxes.applied_money.currency string

通貨。

Scope
order.taxes.scope string

現在のレベルを示します。

Discounts
order.discounts array of object
UID
order.discounts.uid string

Square で生成された ID。

Catalog Object ID
order.discounts.catalog_object_id string

Square で生成された追跡対象の CatalogObject の ID。

Name
order.discounts.name string

品目の名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値は空であってはならず、長さは Unicode コード ポイントです。

Type
order.discounts.type string

種類を示します。

Percentage
order.discounts.percentage string

小数点の区切り文字に「.」を使用し、「%」記号を使用しない 10 進形式のパーセント。 値 7.5 は 7.5% に相当します。

Amount
order.discounts.applied_money.amount integer

金額。

Currency
order.discounts.applied_money.currency string

通貨。

Scope
order.discounts.scope string

現在のレベルを示します。

Amount
order.discounts.amount_money.amount integer

金額。

Currency
order.discounts.amount_money.currency string

通貨。

Created At
order.created_at string

このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。

更新日時
order.updated_at string

このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。

State
order.state string

現在の状態。

Version
order.version integer

このオブジェクトの現在のバージョン。

Reference ID
order.reference_id string

オプションのユーザー定義参照 ID。

Amount
order.total_money.amount integer

金額。

Currency
order.total_money.currency string

通貨。

Amount
order.total_tax_money.amount integer

金額。

Currency
order.total_tax_money.currency string

通貨。

Amount
order.total_discount_money.amount integer

金額。

Currency
order.total_discount_money.currency string

通貨。

Amount
order.total_tip_money.amount integer

金額。

Currency
order.total_tip_money.currency string

通貨。

Amount
order.total_service_charge_money.amount integer

金額。

Currency
order.total_service_charge_money.currency string

通貨。

Amount
order.net_amounts.total_money.amount integer

金額。

Currency
order.net_amounts.total_money.currency string

通貨。

Amount
order.net_amounts.tax_money.amount integer

金額。

Currency
order.net_amounts.tax_money.currency string

通貨。

Amount
order.net_amounts.discount_money.amount integer

金額。

Currency
order.net_amounts.discount_money.currency string

通貨。

Amount
order.net_amounts.tip_money.amount integer

金額。

Currency
order.net_amounts.tip_money.currency string

通貨。

Amount
order.net_amounts.service_charge_money.amount integer

金額。

Currency
order.net_amounts.service_charge_money.currency string

通貨。

Name
order.source.name string

名前。

受注の計算 (ベータ版)

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

パラメーター

名前 キー 必須 説明
Idempotency Key
idempotency_key string

すべての要求の中でこの要求を一意に識別するために指定する値。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。

Location ID
location_id string

場所の識別子。

Name
name string

品目の名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値は空であってはならず、長さは Unicode コード ポイントです。

Percentage
percentage string

小数点の区切り文字に「.」を使用し、「%」記号を使用しない 10 進形式のパーセント。 値 7.5 は 7.5% に相当します。

Scope
scope string

現在のレベルを示します。

Name
name string

品目の名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値は空であってはならず、長さは Unicode コード ポイントです。

Quantity
quantity string

現物棚卸によって影響を受ける品目の 10 進文字列数。 数値は、小数点以下 5 桁まで対応可能です。

Amount
amount integer

金額。

Currency
currency string

通貨。

戻り値

名前 パス 説明
Location ID
order.location_id string

場所の識別子。

Line Items
order.line_items array of object
UID
order.line_items.uid string

Square で生成された ID。

Quantity
order.line_items.quantity string

現物棚卸によって影響を受ける品目の 10 進文字列数。 数値は、小数点以下 5 桁まで対応可能です。

Name
order.line_items.name string

品目の名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値は空であってはならず、長さは Unicode コード ポイントです。

Amount
order.line_items.base_price_money.amount integer

金額。

Currency
order.line_items.base_price_money.currency string

通貨。

Amount
order.line_items.gross_sales_money.amount integer

金額。

Currency
order.line_items.gross_sales_money.currency string

通貨。

Amount
order.line_items.total_tax_money.amount integer

金額。

Currency
order.line_items.total_tax_money.currency string

通貨。

Amount
order.line_items.total_discount_money.amount integer

金額。

Currency
order.line_items.total_discount_money.currency string

通貨。

Amount
order.line_items.total_money.amount integer

金額。

Currency
order.line_items.total_money.currency string

通貨。

Amount
order.line_items.variation_total_price_money.amount integer

金額。

Currency
order.line_items.variation_total_price_money.currency string

通貨。

Applied Discounts
order.line_items.applied_discounts array of object
UID
order.line_items.applied_discounts.uid string

Square で割り当てられた ID。

Discount UID
order.line_items.applied_discounts.discount_uid string

適用された割引が表す割引の uid。

Amount
order.line_items.applied_discounts.applied_money.amount integer

金額。

Currency
order.line_items.applied_discounts.applied_money.currency string

通貨。

Discounts
order.discounts array of object
UID
order.discounts.uid string

Square で生成された ID。

Name
order.discounts.name string

品目の名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値は空であってはならず、長さは Unicode コード ポイントです。

Percentage
order.discounts.percentage string

小数点の区切り文字に「.」を使用し、「%」記号を使用しない 10 進形式のパーセント。 値 7.5 は 7.5% に相当します。

Amount
order.discounts.applied_money.amount integer

金額。

Currency
order.discounts.applied_money.currency string

通貨。

Type
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

現在の状態。

Version
order.version integer

このオブジェクトの現在のバージョン。

Amount
order.total_tax_money.amount integer

金額。

Currency
order.total_tax_money.currency string

通貨。

Amount
order.total_discount_money.amount integer

金額。

Currency
order.total_discount_money.currency string

通貨。

Amount
order.total_tip_money.amount integer

金額。

Currency
order.total_tip_money.currency string

通貨。

Amount
order.total_money.amount integer

金額。

Currency
order.total_money.currency string

通貨。

Amount
order.total_service_charge_money.amount integer

金額。

Currency
order.total_service_charge_money.currency string

通貨。

Amount
order.net_amounts.total_money.amount integer

金額。

Currency
order.net_amounts.total_money.currency string

通貨。

Amount
order.net_amounts.tax_money.amount integer

金額。

Currency
order.net_amounts.tax_money.currency string

通貨。

Amount
order.net_amounts.discount_money.amount integer

金額。

Currency
order.net_amounts.discount_money.currency string

通貨。

Amount
order.net_amounts.tip_money.amount integer

金額。

Currency
order.net_amounts.tip_money.currency string

通貨。

Amount
order.net_amounts.service_charge_money.amount integer

金額。

Currency
order.net_amounts.service_charge_money.currency string

通貨。

品目の修飾子リストの更新

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

パラメーター

名前 キー 必須 説明
Item IDs
item_ids array of string
Modifier Lists to Enable
modifier_lists_to_enable array of string
Modifier Lists to Disable
modifier_lists_to_disable array of string

戻り値

名前 パス 説明
Updated At
updated_at string

この更新のデータベース タイムスタンプ (RFC 3339 形式)。

品目税の更新

品目全体に対してアップサートを実行することなく、対象の CatalogItem に適用される CatalogTax オブジェクトを更新します。

パラメーター

名前 キー 必須 説明
Item IDs
item_ids array of string
Taxes to Enable
taxes_to_enable array of string
Taxes to Disable
taxes_to_disable array of string

戻り値

名前 パス 説明
Updated At
updated_at string

この更新のデータベース タイムスタンプ (RFC 3339 形式)。

在庫の一括変更

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

パラメーター

名前 キー 必須 説明
Idempotency Key
idempotency_key string

すべての要求の中でこの要求を一意に識別するために指定する値。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。

Type
type string

このオブジェクトの種類。

Reference ID
reference_id string

このカードを外部システムの別のエンティティに関連付けるオプションのユーザー定義参照 ID。

Catalog Object ID
catalog_object_id string

Square で生成された追跡対象の CatalogObject の ID。

State
state string

関連する品目数量の現在の在庫状態。

Location ID
location_id string

この入札の一部を受け取る受信者 (マーチャント以外) のロケーション ID。

Quantity
quantity string

現物棚卸によって影響を受ける品目の 10 進文字列数。 数値は、小数点以下 5 桁まで対応可能です。

Employee ID
employee_id string

Square で生成された現物棚卸を担当する従業員の ID。

Occurred At
occurred_at string

現物棚卸がいつであったかを示す、クライアントが生成した RFC 3339 形式のタイムスタンプ。 現物棚卸の更新の場合、occured_at タイムスタンプは、要求の時刻に対して 24 時間より前、または未来のものにすることはできません。

Ignore Unchanged Counts
ignore_unchanged_counts boolean

最後の現物棚卸以降、数量が変更されていない場合に、現在の現物棚卸を無視するかどうかを示します。

戻り値

名前 パス 説明
Counts
counts array of object
Catalog Object ID
counts.catalog_object_id string

Square で生成された追跡対象の CatalogObject の ID。

Catalog Object Type
counts.catalog_object_type string

追跡対象である CatalogObject の種類。

State
counts.state string

現在の状態。

Location ID
counts.location_id string

場所の識別子。

Quantity
counts.quantity string

推定数によって影響を受ける品目の 10 進文字列数。 小数点以下 5 桁まで対応可能です。

Calculated At
counts.calculated_at string

最新の現物棚卸または推定数に影響を与える調整がいつ受信されたかを示す RFC 3339 形式のタイムスタンプ。

在庫の現物棚卸の取得

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

パラメーター

名前 キー 必須 説明
Physical Count ID
physical_count_id True string

現物棚卸の識別子。

戻り値

名前 パス 説明
ID
count.id string

Square が発行した一意の識別子。

Reference ID
count.reference_id string

オプションのユーザー定義参照 ID。

Catalog Object ID
count.catalog_object_id string

Square で生成された追跡対象の CatalogObject の ID。

Catalog Object Type
count.catalog_object_type string

追跡対象である CatalogObject の種類。

State
count.state string

現在の状態。

Location ID
count.location_id string

場所の識別子。

Quantity
count.quantity string

調整によって影響を受ける品目の 10 進文字列数。 小数点以下 5 桁まで対応可能です。

Product
count.source.product string

アプリケーションの製品の種類。

Application ID
count.source.application_id string

アプリケーションに割り当てられた読み取り専用 Square ID。

Name
count.source.name string

名前。

Employee ID
count.employee_id string

Square で生成された従業員の ID。

Occurred At
count.occurred_at string

在庫調整がいつ行われたかを示す、クライアントが生成した RFC 3339 形式のタイムスタンプ。 在庫調整の更新の場合、occured_at タイムスタンプは、要求の時刻に対して 24 時間より前、または未来のものにすることはできません。

Created At
count.created_at string

このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。

在庫変更の一括取得

指定されたフィルター条件に基づいて、過去の現物棚卸と調整を返します。

パラメーター

名前 キー 必須 説明
Catalog Object IDs
catalog_object_ids array of string
Location IDs
location_ids array of string
Types
types array of string
States
states array of string
Updated After
updated_after string

RFC 3339 タイムスタンプで指定された指定時間の後に calculated_at 値で結果を返すフィルター。

Updated Before
updated_before string

RFC 3339 タイムスタンプで指定された指定時間よりも前に厳密に created_at または calculated_at 値で結果を返すフィルター。

戻り値

名前 パス 説明
Changes
changes array of object
Type
changes.type string

このオブジェクトの種類。

ID
changes.physical_count.id string

オブジェクトの識別子

Reference ID
changes.physical_count.reference_id string

このカードを外部システムの別のエンティティに関連付けるオプションのユーザー定義参照 ID。

Catalog Object ID
changes.physical_count.catalog_object_id string

Square で生成された追跡対象の CatalogObject の ID。

Catalog Object Type
changes.physical_count.catalog_object_type string

追跡対象である CatalogObject の種類。

State
changes.physical_count.state string

関連する品目数量の現在の在庫状態。

Location ID
changes.physical_count.location_id string

この入札の一部を受け取る受信者 (マーチャント以外) のロケーション ID。

Quantity
changes.physical_count.quantity string

現物棚卸によって影響を受ける品目の 10 進文字列数。 数値は、小数点以下 5 桁まで対応可能です。

Product
changes.physical_count.source.product string

アプリケーションの製品の種類。

Application ID
changes.physical_count.source.application_id string

アプリケーションに割り当てられた Square ID。

Name
changes.physical_count.source.name string

品目の名前。

Employee ID
changes.physical_count.employee_id string

Square で生成された現物棚卸を担当する従業員の ID。

Occurred At
changes.physical_count.occurred_at string

現物棚卸がいつであったかを示す、クライアントが生成した RFC 3339 形式のタイムスタンプ。 現物棚卸の更新の場合、occured_at タイムスタンプは、要求の時刻に対して 24 時間より前、または未来のものにすることはできません。

Created At
changes.physical_count.created_at string

現物棚卸がいつ作成されたかを示す、クライアントが生成した RFC 3339 形式のタイムスタンプ。

在庫数の一括取得

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

パラメーター

名前 キー 必須 説明
Catalog Object IDs
catalog_object_ids array of string
Location IDs
location_ids array of string
Updated After
updated_after string

RFC 3339 タイムスタンプで指定された指定時間の後に calculated_at 値で結果を返すフィルター。

戻り値

名前 パス 説明
Counts
counts array of object
Catalog Object ID
counts.catalog_object_id string

Square で生成された追跡対象の CatalogObject の ID。

Catalog Object Type
counts.catalog_object_type string

追跡対象である CatalogObject の種類。

State
counts.state string

現在の状態。

Location ID
counts.location_id string

場所の識別子。

Quantity
counts.quantity string

推定数によって影響を受ける品目の 10 進文字列数。 小数点以下 5 桁まで対応可能です。

Calculated At
counts.calculated_at string

最新の現物棚卸または推定数に影響を与える調整がいつ受信されたかを示す RFC 3339 形式のタイムスタンプ。

在庫数の取得

特定の場所のセットで特定の CatalogObject に対して現在の計算された在庫数を取得します。

パラメーター

名前 キー 必須 説明
Catalog Object ID
catalog_object_id True string

カタログ オブジェクトの識別子。

Location IDs
location_ids string

コンマ区切りリストとして検索する Location ID。 空のリストはすべての場所を照会します。

Cursor
cursor string

このエンドポイントへの前回の呼び出しによって返されたページネーション カーソル。

戻り値

名前 パス 説明
Counts
counts array of object
Catalog Object ID
counts.catalog_object_id string

Square で生成された追跡対象の CatalogObject の ID。

Catalog Object Type
counts.catalog_object_type string

追跡対象である CatalogObject の種類。

State
counts.state string

現在の状態。

Location ID
counts.location_id string

場所の識別子。

Quantity
counts.quantity string

推定数によって影響を受ける品目の 10 進文字列数。 小数点以下 5 桁まで対応可能です。

Calculated At
counts.calculated_at string

最新の現物棚卸または推定数に影響を与える調整がいつ受信されたかを示す RFC 3339 形式のタイムスタンプ。

在庫移動の取得 (ベータ版)

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

パラメーター

名前 キー 必須 説明
Transfer ID
transfer_id True string

移動の識別子。

戻り値

名前 パス 説明
ID
transfer.id string

Square が発行した一意の識別子。

Catalog Object ID
transfer.catalog_object_id string

Square で生成された追跡対象の CatalogObject の ID。

Catalog Object Type
transfer.catalog_object_type string

追跡対象である CatalogObject の種類。

Created At
transfer.created_at string

このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。

Employee ID
transfer.employee_id string

Square で生成された従業員の ID。

From Location ID
transfer.from_location_id string

Square で生成された、移動前に関連する品目数量を追跡した場所の ID。

To Location ID
transfer.to_location_id string

Square で生成された、移動後に関連する品目数量を追跡した場所の ID。

Occurred At
transfer.occurred_at string

在庫調整がいつ行われたかを示す、クライアントが生成した RFC 3339 形式のタイムスタンプ。 在庫調整の更新の場合、occured_at タイムスタンプは、要求の時刻に対して 24 時間より前、または未来のものにすることはできません。

Quantity
transfer.quantity string

調整によって影響を受ける品目の 10 進文字列数。 小数点以下 5 桁まで対応可能です。

Reference ID
transfer.reference_id string

オプションのユーザー定義参照 ID。

Product
transfer.source.product string

アプリケーションの製品の種類。

Application ID
transfer.source.application_id string

アプリケーションに割り当てられた読み取り専用 Square ID。

Name
transfer.source.name string

名前。

State
transfer.state string

現在の状態。

在庫調整の取得

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

パラメーター

名前 キー 必須 説明
Adjustment ID
adjustment_id True string

調整の識別子。

戻り値

名前 パス 説明
ID
adjustment.id string

Square が発行した一意の識別子。

Reference ID
adjustment.reference_id string

オプションのユーザー定義参照 ID。

From State
adjustment.from_state string

調整前の関連する品目数量の在庫状態。

To State
adjustment.to_state string

調整後の関連する品目数量の在庫状態。

Location ID
adjustment.location_id string

場所の識別子。

Catalog Object ID
adjustment.catalog_object_id string

Square で生成された追跡対象の CatalogObject の ID。

Catalog Object Type
adjustment.catalog_object_type string

追跡対象である CatalogObject の種類。

Quantity
adjustment.quantity string

調整によって影響を受ける品目の 10 進文字列数。 小数点以下 5 桁まで対応可能です。

Amount
adjustment.total_price_money.amount integer

金額。

Currency
adjustment.total_price_money.currency string

通貨。

Occurred At
adjustment.occurred_at string

在庫調整がいつ行われたかを示す、クライアントが生成した RFC 3339 形式のタイムスタンプ。 在庫調整の更新の場合、occured_at タイムスタンプは、要求の時刻に対して 24 時間より前、または未来のものにすることはできません。

Created At
adjustment.created_at string

このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。

Product
adjustment.source.product string

アプリケーションの製品の種類。

Application ID
adjustment.source.application_id string

アプリケーションに割り当てられた読み取り専用 Square ID。

Name
adjustment.source.name string

名前。

Employee ID
adjustment.employee_id string

Square で生成された従業員の ID。

支払いの一覧表示

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

パラメーター

名前 キー 必須 説明
Begin Time
begin_time string

opened_at でのクエリの包括的な開始時刻 (ISO 8601形式)。

End Time
end_time string

opened_at でのクエリの排他的な終了日 (ISO 8601形式)。

Sort Order
sort_order string

返された一覧を、指定された順序でカードが作成された日時で並べ替えます。

Cursor
cursor string

このエンドポイントへの前回の呼び出しによって返されたページネーション カーソル。

Location ID
location_id string

このオプション フィルターを指定して、特定の場所に属するレコードのみを取得できます。

Total
total integer

支払いに対する total_money の正確な金額。

Last 4
last_4 string

決済カードの下 4 桁。

Card Brand
card_brand string

決済カードのブランド (VISA など)。

Limit
limit integer

応答で返す数の上限。

戻り値

名前 パス 説明
Payments
payments array of object
ID
payments.id string

Square が発行した一意の識別子。

Created At
payments.created_at string

イベント時刻 (ISO 8601 形式)。

Updated At
payments.updated_at string

最終変更タイムスタンプ (RFC 3339 形式)

Amount
payments.amount_money.amount integer

金額。

Currency
payments.amount_money.currency string

通貨。

Status
payments.status string

このオブジェクトの現在の検証状態。

Delay Duration
payments.delay_duration string

Square が支払に delay_action を自動的に適用する場合の、支払作成後の期間。

Source Type
payments.source_type string

この支払のソースの種類。

Status
payments.card_details.status string

カード決済の現在の状態。 状態は、AUTHORIZED、CAPTURED、VOIDED、または FAILED のいずれかです。

Card Brand
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 桁の年。

Fingerprint
payments.card_details.card.fingerprint string

カード番号に基づく、1 つのアプリケーション内の複数の場所でカードを識別するための、Square で割り当てられた識別子として使用されます。

Card Type
payments.card_details.card.card_type string

カードの種類。

Prepaid Type
payments.card_details.card.prepaid_type string

カードがプリペイドかどうかを示します。

BIN
payments.card_details.card.bin string

銀行識別番号 (BIN) と呼ばれるカード番号の最初の 6 桁

Entry Method
payments.card_details.entry_method string

決済に使用するカード情報の入力方法。 方法は、KEYED、SWIPED、EMV、ON_FILE、または CONTACTLESS です。

Cvv Status
payments.card_details.cvv_status string

セキュリティ コード (CVV) チェックから返される状態コード。 コードは、CVV_ACCEPTED、CVV_REJECTED、または CVV_NOT_CHECKED です。

Avs Status
payments.card_details.avs_status string

アドレス検証システム (AVS) チェックから返される状態コード。 コードは、AVS_ACCEPTED、AVS_REJECTED、または AVS_NOT_CHECKED です。

Auth Result Code
payments.card_details.auth_result_code string

カード発行会社から返された、決済の承認状況を示す状態コード。

Statement Description
payments.card_details.statement_description string

カード ネットワークに送信されるステートメントの説明。

Authorized At
payments.card_details.card_payment_timeline.authorized_at string

支払いが承認されたときのタイムスタンプ (RFC 3339 形式)。

Captured At
payments.card_details.card_payment_timeline.captured_at string

支払いが取得されたときのタイムスタンプ (RFC 3339 形式)。

Location ID
payments.location_id string

場所の識別子。

Order ID
payments.order_id string

受注の ID。

Processing Fee
payments.processing_fee array of object
Effective At
payments.processing_fee.effective_at string

料金が発生した時点のタイムスタンプ (RFC 3339 形式)。

Type
payments.processing_fee.type string

このオブジェクトの種類。

Amount
payments.processing_fee.amount_money.amount integer

金額。

Currency
payments.processing_fee.amount_money.currency string

通貨。

Note
payments.note string

顧客プロファイルに関連付けられたカスタム メモ。

Amount
payments.total_money.amount integer

金額。

Currency
payments.total_money.currency string

通貨。

Amount
payments.approved_money.amount integer

金額。

Currency
payments.approved_money.currency string

通貨。

Receipt Number
payments.receipt_number string

支払領収書番号。 支払いがキャンセルされた場合、フィールドは表示されません。

Receipt URL
payments.receipt_url string

支払領収書の URL。 このフィールドには、COMPLETED 支払いの場合にのみ入力されます。

Delay Action
payments.delay_action string

delay_duration が経過したときに支払に適用されるアクション。

Delayed Until
payments.delayed_until string

delay_action が自動的に適用されるときの読み取り専用タイムスタンプ (RFC 3339 形式)。

Team Member ID
payments.team_member_id string

オブジェクトに関連付けられたチーム メンバーの TeamMember オブジェクトの ID。

Square Product
payments.application_details.square_product string

Square POS (販売時点管理)、Square 請求書、Square ブラウザ決済などの Square 製品。

Application ID
payments.application_details.application_id string

支払いを受け取るために使用されるアプリケーションに割り当てられた Square ID。 アプリケーション開発者は、この情報を使用して、アプリケーションが処理した支払いを識別できます。 たとえば、開発者がカスタム アプリケーションを使用して支払いを処理する場合、このフィールドには開発者ダッシュボードのアプリケーション ID が含まれます。 販売担当者が Square のアプリ マーケットプレース アプリケーションを使用して支払いを処理する場合、フィールドには対応するアプリケーション ID が含まれます。

Version Token
payments.version_token string

オプティミスティック同時実行に使用されます。 この不明瞭なトークンは、Payment オブジェクトの特定のバージョンを識別します。

支払いの作成

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

パラメーター

名前 キー 必須 説明
Idempotency Key
idempotency_key string

すべての要求の中でこの要求を一意に識別するために指定する値。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。

Amount
amount integer

この支払いを受け入れる金額 (tip_money を除く)。

Currency
currency string

3 文字の ISO 4217 通貨コード。

Source ID
source_id string

この支払いの資金源の ID。 これは、Square 決済フォームで生成された決済トークン (card nonce) または Customers API で作成されたファイル上のカードです。 販売担当者が Square の外部で受け取った支払いを記録する場合は、CASH または EXTERNAL のいずれかを指定します。

Autocomplete
autocomplete boolean

true に設定すると、この支払いは可能なときに完了します。 false に設定した場合、この支払いは、明示的に完了する (取得される) かキャンセルされる (無効になる) まで、承認済の状態で保持されます。

Customer ID
customer_id string

リンクする顧客の ID。

Location ID
location_id string

場所の識別子。

Reference ID
reference_id string

顧客プロファイルを別のシステムのエンティティに関連付けるために使用されるオプションの 2 番目の ID。

Note
note string

顧客プロファイルに関連付けられたカスタム メモ。

Amount
amount integer

この支払いを受け入れる金額 (tip_money を除く)。

Currency
currency string

3 文字の ISO 4217 通貨コード。

戻り値

名前 パス 説明
ID
payment.id string

Square が発行した一意の識別子。

Created At
payment.created_at string

このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。

更新日時
payment.updated_at string

このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。

Amount
payment.amount_money.amount integer

金額。

Currency
payment.amount_money.currency string

通貨。

Amount
payment.app_fee_money.amount integer

金額。

Currency
payment.app_fee_money.currency string

通貨。

Status
payment.status string

このオブジェクトの現在の検証状態。

Delay Duration
payment.delay_duration string

Square が支払に delay_action を自動的に適用する場合の、支払作成後の期間。 この自動 delay_action は、delay_duration 期間の前にターミナル状態 (COMPLETED、CANCELED、FAILED) に達しない支払にのみ適用されます。 このフィールドは、RFC 3339 形式で期間として指定されます。

Source Type
payment.source_type string

この支払のソースの種類。 現在の値には、CARD、BANK_ACCOUNT、WALLET、CASH、または EXTERNAL が含まれます。

Status
payment.card_details.status string

現在の状態。

Card Brand
payment.card_details.card.card_brand string

カードのブランド。

Last 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 桁の年。

Fingerprint
payment.card_details.card.fingerprint string

カード番号に基づく、1 つのアプリケーション内の複数の場所でカードを識別するための、Square で割り当てられた識別子として使用されます。

Card Type
payment.card_details.card.card_type string

カードの種類。

Prepaid Type
payment.card_details.card.prepaid_type string

カードがプリペイドかどうかを示します。

BIN
payment.card_details.card.bin string

カード番号の最初の 6 桁は、銀行識別番号 (BIN) と呼ばれます。

Entry Method
payment.card_details.entry_method string

決済に使用するカード情報の入力方法。 方法は、KEYED、SWIPED、EMV、ON_FILE、または CONTACTLESS です。

CVV Status
payment.card_details.cvv_status string

セキュリティ コード (CVV) チェックから返される状態コード。 コードは、CVV_ACCEPTED、CVV_REJECTED、または CVV_NOT_CHECKED です。

AVS Status
payment.card_details.avs_status string

アドレス検証システム (AVS) チェックから返される状態コード。 コードは、AVS_ACCEPTED、AVS_REJECTED、または AVS_NOT_CHECKED です。

Auth Result Code
payment.card_details.auth_result_code string

カード発行会社から返された、決済の承認状況を示す状態コード。

Statement Description
payment.card_details.statement_description string

カード ネットワークに送信されるステートメントの説明。

Authorized At
payment.card_details.card_payment_timeline.authorized_at string

支払いが承認されたときのタイムスタンプ (RFC 3339 形式)。

Captured At
payment.card_details.card_payment_timeline.captured_at string

支払いが取得されたときのタイムスタンプ (RFC 3339 形式)。

Location ID
payment.location_id string

場所の識別子。

Order ID
payment.order_id string

受注の ID。

Reference ID
payment.reference_id string

オプションのユーザー定義参照 ID。

Created At
payment.risk_evaluation.created_at string

作成時のタイムスタンプ (RFC 3339形式)。

Risk Level
payment.risk_evaluation.risk_level string

支払に関連付けられているリスク レベル。

Note
payment.note string

顧客プロファイルに関連付けられたカスタム メモ。

Customer ID
payment.customer_id string

顧客を表すこのオブジェクトの ID。

Amount
payment.total_money.amount integer

金額。

Currency
payment.total_money.currency string

通貨。

Amount
payment.approved_money.amount integer

金額。

Currency
payment.approved_money.currency string

通貨。

Receipt Number
payment.receipt_number string

支払領収書番号。 支払いがキャンセルされた場合、フィールドは表示されません。

Receipt URL
payment.receipt_url string

支払領収書の URL。 このフィールドには、COMPLETED 支払いの場合にのみ入力されます。

Delay Action
payment.delay_action string

delay_duration が経過したときに支払に適用されるアクション。

Delayed Until
payment.delayed_until string

delay_action が自動的に適用されるときの読み取り専用タイムスタンプ (RFC 3339 形式)。

Square Product
payment.application_details.square_product string

Square POS (販売時点管理)、Square 請求書、Square ブラウザ決済などの Square 製品。

Application ID
payment.application_details.application_id string

アプリケーションに割り当てられた読み取り専用 Square ID。

Version Token
payment.version_token string

この不明瞭なトークンは、オブジェクトの特定のバージョンを識別します。

支払いの取得

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

パラメーター

名前 キー 必須 説明
Payment ID
payment_id True string

支払の識別子。

戻り値

名前 パス 説明
ID
payment.id string

Square が発行した一意の識別子。

Created At
payment.created_at string

このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。

更新日時
payment.updated_at string

このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。

Amount
payment.amount_money.amount integer

金額。

Currency
payment.amount_money.currency string

通貨。

Status
payment.status string

このオブジェクトの現在の検証状態。

Delay Duration
payment.delay_duration string

Square が支払に delay_action を自動的に適用する場合の、支払作成後の期間。 この自動 delay_action は、delay_duration 期間の前にターミナル状態 (COMPLETED、CANCELED、FAILED) に達しない支払にのみ適用されます。 このフィールドは、RFC 3339 形式で期間として指定されます。

Source Type
payment.source_type string

この支払のソースの種類。 現在の値には、CARD、BANK_ACCOUNT、WALLET、CASH、または EXTERNAL が含まれます。

Status
payment.card_details.status string

現在の状態。

Card Brand
payment.card_details.card.card_brand string

カードのブランド。

Last 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 桁の年。

Fingerprint
payment.card_details.card.fingerprint string

カード番号に基づく、1 つのアプリケーション内の複数の場所でカードを識別するための、Square で割り当てられた識別子として使用されます。

Card Type
payment.card_details.card.card_type string

カードの種類。

Prepaid Type
payment.card_details.card.prepaid_type string

カードがプリペイドかどうかを示します。

BIN
payment.card_details.card.bin string

カード番号の最初の 6 桁は、銀行識別番号 (BIN) と呼ばれます。

Entry Method
payment.card_details.entry_method string

決済に使用するカード情報の入力方法。 方法は、KEYED、SWIPED、EMV、ON_FILE、または CONTACTLESS です。

CVV Status
payment.card_details.cvv_status string

セキュリティ コード (CVV) チェックから返される状態コード。 コードは、CVV_ACCEPTED、CVV_REJECTED、または CVV_NOT_CHECKED です。

AVS Status
payment.card_details.avs_status string

アドレス検証システム (AVS) チェックから返される状態コード。 コードは、AVS_ACCEPTED、AVS_REJECTED、または AVS_NOT_CHECKED です。

Auth Result Code
payment.card_details.auth_result_code string

カード発行会社から返された、決済の承認状況を示す状態コード。

Statement Description
payment.card_details.statement_description string

カード ネットワークに送信されるステートメントの説明。

Authorized At
payment.card_details.card_payment_timeline.authorized_at string

支払いが承認されたときのタイムスタンプ (RFC 3339 形式)。

Captured At
payment.card_details.card_payment_timeline.captured_at string

支払いが取得されたときのタイムスタンプ (RFC 3339 形式)。

Location ID
payment.location_id string

場所の識別子。

Order ID
payment.order_id string

受注の ID。

Processing Fee
payment.processing_fee array of object
Effective At
payment.processing_fee.effective_at string

料金が発生した時点のタイムスタンプ (RFC 3339 形式)。

Type
payment.processing_fee.type string

種類を示します。

Amount
payment.processing_fee.amount_money.amount integer

金額。

Currency
payment.processing_fee.amount_money.currency string

通貨。

Note
payment.note string

顧客プロファイルに関連付けられたカスタム メモ。

Amount
payment.total_money.amount integer

金額。

Currency
payment.total_money.currency string

通貨。

Amount
payment.approved_money.amount integer

金額。

Currency
payment.approved_money.currency string

通貨。

Employee ID
payment.employee_id string

Square で生成された従業員の ID。

Receipt Number
payment.receipt_number string

支払領収書番号。 支払いがキャンセルされた場合、フィールドは表示されません。

Receipt URL
payment.receipt_url string

支払領収書の URL。 このフィールドには、COMPLETED 支払いの場合にのみ入力されます。

Delay Action
payment.delay_action string

delay_duration が経過したときに支払に適用されるアクション。

Delayed Until
payment.delayed_until string

delay_action が自動的に適用されるときの読み取り専用タイムスタンプ (RFC 3339 形式)。

Team Member ID
payment.team_member_id string

チーム メンバーの ID。

Square Product
payment.application_details.square_product string

Square POS (販売時点管理)、Square 請求書、Square ブラウザ決済などの Square 製品。

Application ID
payment.application_details.application_id string

アプリケーションに割り当てられた読み取り専用 Square ID。

Version Token
payment.version_token string

この不明瞭なトークンは、オブジェクトの特定のバージョンを識別します。

支払いの払い戻し

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

パラメーター

名前 キー 必須 説明
Idempotency Key
idempotency_key string

すべての要求の中でこの要求を一意に識別するために指定する値。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。

Payment ID
payment_id string

返金される支払いの一意の ID。

Amount
amount integer

この支払いを受け入れる金額 (tip_money を除く)。

Currency
currency string

3 文字の ISO 4217 通貨コード。

Amount
amount integer

この支払いを受け入れる金額 (tip_money を除く)。

Currency
currency string

3 文字の ISO 4217 通貨コード。

Reason
reason string

払い戻しの理由の説明。

戻り値

名前 パス 説明
ID
refund.id string

Square が発行した一意の識別子。

Status
refund.status string

このオブジェクトの現在の検証状態。

Amount
refund.amount_money.amount integer

金額。

Currency
refund.amount_money.currency string

通貨。

Payment ID
refund.payment_id string

支払の一意の ID。

Order ID
refund.order_id string

受注の ID。

Created At
refund.created_at string

このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。

更新日時
refund.updated_at string

このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。

Amount
refund.app_fee_money.amount integer

金額。

Currency
refund.app_fee_money.currency string

通貨。

Location ID
refund.location_id string

場所の識別子。

Reason
refund.reason string

このオブジェクトの理由。

支払いの払い戻しの一覧表示

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

パラメーター

名前 キー 必須 説明
Begin Time
begin_time string

opened_at でのクエリの包括的な開始時刻 (ISO 8601形式)。

End Time
end_time string

opened_at でのクエリの排他的な終了日 (ISO 8601形式)。

Sort Order
sort_order string

返された一覧を、指定された順序でカードが作成された日時で並べ替えます。

Cursor
cursor string

このエンドポイントへの前回の呼び出しによって返されたページネーション カーソル。

Location ID
location_id string

このオプション フィルターを指定して、特定の場所に属するレコードのみを取得できます。

Status
status string

指定した場合、指定したステータスに一致するオブジェクトのみを返します。

Source Type
source_type string

指定すると、指定したソースの種類の払い戻しのみが返されます。

Limit
limit integer

応答で返す数の上限。

戻り値

名前 パス 説明
Refunds
refunds array of object
ID
refunds.id string

Square が発行した一意の識別子。

Status
refunds.status string

このオブジェクトの現在の検証状態。

Amount
refunds.amount_money.amount integer

金額。

Currency
refunds.amount_money.currency string

通貨。

Payment ID
refunds.payment_id string

支払いの ID。

Order ID
refunds.order_id string

受注の ID。

Created At
refunds.created_at string

イベント時刻 (ISO 8601 形式)。

Updated At
refunds.updated_at string

最終変更タイムスタンプ (RFC 3339 形式)

Processing Fee
refunds.processing_fee array of object
Effective At
refunds.processing_fee.effective_at string

料金が発生した時点のタイムスタンプ (RFC 3339 形式)。

Type
refunds.processing_fee.type string

このオブジェクトの種類。

Amount
refunds.processing_fee.amount_money.amount integer

金額。

Currency
refunds.processing_fee.amount_money.currency string

通貨。

Location ID
refunds.location_id string

場所の識別子。

Reason
refunds.reason string

カード名義人が銀行と紛争を開始した紛争の理由。

Cursor
cursor string

このエンドポイントへの後続の呼び出しにページネーション カーソルを含めて、元のクエリに関連付けられた次の結果セットを取得します。

支払いの払い戻しの取得

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

パラメーター

名前 キー 必須 説明
Refund ID
refund_id True string

払い戻しの識別子。

戻り値

名前 パス 説明
ID
refund.id string

Square が発行した一意の識別子。

Status
refund.status string

このオブジェクトの現在の検証状態。

Amount
refund.amount_money.amount integer

金額。

Currency
refund.amount_money.currency string

通貨。

Payment ID
refund.payment_id string

支払の一意の ID。

Order ID
refund.order_id string

受注の ID。

Created At
refund.created_at string

このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。

更新日時
refund.updated_at string

このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。

Processing Fee
refund.processing_fee array of object
Effective At
refund.processing_fee.effective_at string

料金が発生した時点のタイムスタンプ (RFC 3339 形式)。

Type
refund.processing_fee.type string

種類を示します。

Amount
refund.processing_fee.amount_money.amount integer

金額。

Currency
refund.processing_fee.amount_money.currency string

通貨。

Location ID
refund.location_id string

場所の識別子。

Reason
refund.reason string

このオブジェクトの理由。

支払いの更新

支払いを APPROVED ステータスで更新します。 このエンドポイントを使用して、amount_money と tip_money を更新できます。

パラメーター

名前 キー 必須 説明
Payment ID
payment_id True string

支払の識別子。

Idempotency Key
idempotency_key string

すべての要求の中でこの要求を一意に識別するために指定する値。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。

Amount
amount integer

金額。

Currency
currency string

通貨。

Amount
amount integer

金額。

Currency
currency string

通貨。

Version Token
version_token string

この不明瞭なトークンは、オブジェクトの特定のバージョンを識別します。

戻り値

名前 パス 説明
ID
payment.id string

Square が発行した一意の識別子。

Created At
payment.created_at string

このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。

更新日時
payment.updated_at string

このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。

Amount
payment.amount_money.amount integer

金額。

Currency
payment.amount_money.currency string

通貨。

Amount
payment.tip_money.amount integer

金額。

Currency
payment.tip_money.currency string

通貨。

Status
payment.status string

このオブジェクトの現在の検証状態。

Delay Duration
payment.delay_duration string

Square が支払に delay_action を自動的に適用する場合の、支払作成後の期間。 この自動 delay_action は、delay_duration 期間の前にターミナル状態 (COMPLETED、CANCELED、FAILED) に達しない支払にのみ適用されます。 このフィールドは、RFC 3339 形式で期間として指定されます。

Source Type
payment.source_type string

この支払のソースの種類。 現在の値には、CARD、BANK_ACCOUNT、WALLET、CASH、または EXTERNAL が含まれます。

Status
payment.card_details.status string

現在の状態。

Card Brand
payment.card_details.card.card_brand string

カードのブランド。

Last 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 桁の年。

Fingerprint
payment.card_details.card.fingerprint string

カード番号に基づく、1 つのアプリケーション内の複数の場所でカードを識別するための、Square で割り当てられた識別子として使用されます。

Card Type
payment.card_details.card.card_type string

カードの種類。

Prepaid Type
payment.card_details.card.prepaid_type string

カードがプリペイドかどうかを示します。

BIN
payment.card_details.card.bin string

カード番号の最初の 6 桁は、銀行識別番号 (BIN) と呼ばれます。

Entry Method
payment.card_details.entry_method string

決済に使用するカード情報の入力方法。 方法は、KEYED、SWIPED、EMV、ON_FILE、または CONTACTLESS です。

CVV Status
payment.card_details.cvv_status string

セキュリティ コード (CVV) チェックから返される状態コード。 コードは、CVV_ACCEPTED、CVV_REJECTED、または CVV_NOT_CHECKED です。

AVS Status
payment.card_details.avs_status string

アドレス検証システム (AVS) チェックから返される状態コード。 コードは、AVS_ACCEPTED、AVS_REJECTED、または AVS_NOT_CHECKED です。

Auth Result Code
payment.card_details.auth_result_code string

カード発行会社から返された、決済の承認状況を示す状態コード。

Statement Description
payment.card_details.statement_description string

カード ネットワークに送信されるステートメントの説明。

Authorized At
payment.card_details.card_payment_timeline.authorized_at string

支払いが承認されたときのタイムスタンプ (RFC 3339 形式)。

Location ID
payment.location_id string

場所の識別子。

Order ID
payment.order_id string

受注の ID。

Created At
payment.risk_evaluation.created_at string

作成時のタイムスタンプ (RFC 3339形式)。

Risk Level
payment.risk_evaluation.risk_level string

支払に関連付けられているリスク レベル。

Note
payment.note string

顧客プロファイルに関連付けられたカスタム メモ。

Customer ID
payment.customer_id string

顧客を表すこのオブジェクトの ID。

Amount
payment.total_money.amount integer

金額。

Currency
payment.total_money.currency string

通貨。

Amount
payment.approved_money.amount integer

金額。

Currency
payment.approved_money.currency string

通貨。

Capabilities
payment.capabilities array of string
Receipt Number
payment.receipt_number string

支払領収書番号。 支払いがキャンセルされた場合、フィールドは表示されません。

Delay Action
payment.delay_action string

delay_duration が経過したときに支払に適用されるアクション。

Delayed Until
payment.delayed_until string

delay_action が自動的に適用されるときの読み取り専用タイムスタンプ (RFC 3339 形式)。

Square Product
payment.application_details.square_product string

Square POS (販売時点管理)、Square 請求書、Square ブラウザ決済などの Square 製品。

Application ID
payment.application_details.application_id string

アプリケーションに割り当てられた読み取り専用 Square ID。

Version Token
payment.version_token string

この不明瞭なトークンは、オブジェクトの特定のバージョンを識別します。

支払のキャンセル

支払をキャンセル (無効化) します。 このエンドポイントを使用して、APPROVED ステータスの支払をキャンセルできます。

パラメーター

名前 キー 必須 説明
Payment ID
payment_id True string

支払の識別子。

戻り値

名前 パス 説明
ID
payment.id string

Square が発行した一意の識別子。

Created At
payment.created_at string

このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。

更新日時
payment.updated_at string

このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。

Amount
payment.amount_money.amount integer

金額。

Currency
payment.amount_money.currency string

通貨。

Amount
payment.tip_money.amount integer

金額。

Currency
payment.tip_money.currency string

通貨。

Status
payment.status string

このオブジェクトの現在の検証状態。

Delay Duration
payment.delay_duration string

Square が支払に delay_action を自動的に適用する場合の、支払作成後の期間。 この自動 delay_action は、delay_duration 期間の前にターミナル状態 (COMPLETED、CANCELED、FAILED) に達しない支払にのみ適用されます。 このフィールドは、RFC 3339 形式で期間として指定されます。

Source Type
payment.source_type string

この支払のソースの種類。 現在の値には、CARD、BANK_ACCOUNT、WALLET、CASH、または EXTERNAL が含まれます。

Status
payment.card_details.status string

現在の状態。

Card Brand
payment.card_details.card.card_brand string

カードのブランド。

Last 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 桁の年。

Fingerprint
payment.card_details.card.fingerprint string

カード番号に基づく、1 つのアプリケーション内の複数の場所でカードを識別するための、Square で割り当てられた識別子として使用されます。

Card Type
payment.card_details.card.card_type string

カードの種類。

Prepaid Type
payment.card_details.card.prepaid_type string

カードがプリペイドかどうかを示します。

BIN
payment.card_details.card.bin string

カード番号の最初の 6 桁は、銀行識別番号 (BIN) と呼ばれます。

Entry Method
payment.card_details.entry_method string

決済に使用するカード情報の入力方法。 方法は、KEYED、SWIPED、EMV、ON_FILE、または CONTACTLESS です。

CVV Status
payment.card_details.cvv_status string

セキュリティ コード (CVV) チェックから返される状態コード。 コードは、CVV_ACCEPTED、CVV_REJECTED、または CVV_NOT_CHECKED です。

AVS Status
payment.card_details.avs_status string

アドレス検証システム (AVS) チェックから返される状態コード。 コードは、AVS_ACCEPTED、AVS_REJECTED、または AVS_NOT_CHECKED です。

Auth Result Code
payment.card_details.auth_result_code string

カード発行会社から返された、決済の承認状況を示す状態コード。

Statement Description
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 形式)。

Location ID
payment.location_id string

場所の識別子。

Order ID
payment.order_id string

受注の ID。

Created At
payment.risk_evaluation.created_at string

作成時のタイムスタンプ (RFC 3339形式)。

Risk Level
payment.risk_evaluation.risk_level string

支払に関連付けられているリスク レベル。

Note
payment.note string

顧客プロファイルに関連付けられたカスタム メモ。

Customer ID
payment.customer_id string

顧客を表すこのオブジェクトの ID。

Amount
payment.total_money.amount integer

金額。

Currency
payment.total_money.currency string

通貨。

Amount
payment.approved_money.amount integer

金額。

Currency
payment.approved_money.currency string

通貨。

Delay Action
payment.delay_action string

delay_duration が経過したときに支払に適用されるアクション。

Delayed Until
payment.delayed_until string

delay_action が自動的に適用されるときの読み取り専用タイムスタンプ (RFC 3339 形式)。

Square Product
payment.application_details.square_product string

Square POS (販売時点管理)、Square 請求書、Square ブラウザ決済などの Square 製品。

Application ID
payment.application_details.application_id string

アプリケーションに割り当てられた読み取り専用 Square ID。

Version Token
payment.version_token string

この不明瞭なトークンは、オブジェクトの特定のバージョンを識別します。

支払の完了

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

パラメーター

名前 キー 必須 説明
Payment ID
payment_id True string

支払の識別子。

戻り値

名前 パス 説明
ID
payment.id string

Square が発行した一意の識別子。

Created At
payment.created_at string

このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。

更新日時
payment.updated_at string

このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。

Amount
payment.amount_money.amount integer

金額。

Currency
payment.amount_money.currency string

通貨。

Status
payment.status string

このオブジェクトの現在の検証状態。

Delay Duration
payment.delay_duration string

Square が支払に delay_action を自動的に適用する場合の、支払作成後の期間。 この自動 delay_action は、delay_duration 期間の前にターミナル状態 (COMPLETED、CANCELED、FAILED) に達しない支払にのみ適用されます。 このフィールドは、RFC 3339 形式で期間として指定されます。

Source Type
payment.source_type string

この支払のソースの種類。 現在の値には、CARD、BANK_ACCOUNT、WALLET、CASH、または EXTERNAL が含まれます。

Status
payment.card_details.status string

現在の状態。

Card Brand
payment.card_details.card.card_brand string

カードのブランド。

Last 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 桁の年。

Fingerprint
payment.card_details.card.fingerprint string

カード番号に基づく、1 つのアプリケーション内の複数の場所でカードを識別するための、Square で割り当てられた識別子として使用されます。

Card Type
payment.card_details.card.card_type string

カードの種類。

Prepaid Type
payment.card_details.card.prepaid_type string

カードがプリペイドかどうかを示します。

BIN
payment.card_details.card.bin string

カード番号の最初の 6 桁は、銀行識別番号 (BIN) と呼ばれます。

Entry Method
payment.card_details.entry_method string

決済に使用するカード情報の入力方法。 方法は、KEYED、SWIPED、EMV、ON_FILE、または CONTACTLESS です。

CVV Status
payment.card_details.cvv_status string

セキュリティ コード (CVV) チェックから返される状態コード。 コードは、CVV_ACCEPTED、CVV_REJECTED、または CVV_NOT_CHECKED です。

AVS Status
payment.card_details.avs_status string

アドレス検証システム (AVS) チェックから返される状態コード。 コードは、AVS_ACCEPTED、AVS_REJECTED、または AVS_NOT_CHECKED です。

Auth Result Code
payment.card_details.auth_result_code string

カード発行会社から返された、決済の承認状況を示す状態コード。

Statement Description
payment.card_details.statement_description string

カード ネットワークに送信されるステートメントの説明。

Authorized At
payment.card_details.card_payment_timeline.authorized_at string

支払いが承認されたときのタイムスタンプ (RFC 3339 形式)。

Captured At
payment.card_details.card_payment_timeline.captured_at string

支払いが取得されたときのタイムスタンプ (RFC 3339 形式)。

Location ID
payment.location_id string

場所の識別子。

Order ID
payment.order_id string

受注の ID。

Processing Fee
payment.processing_fee array of object
Effective At
payment.processing_fee.effective_at string

料金が発生した時点のタイムスタンプ (RFC 3339 形式)。

Type
payment.processing_fee.type string

種類を示します。

Amount
payment.processing_fee.amount_money.amount integer

金額。

Currency
payment.processing_fee.amount_money.currency string

通貨。

Note
payment.note string

顧客プロファイルに関連付けられたカスタム メモ。

Amount
payment.total_money.amount integer

金額。

Currency
payment.total_money.currency string

通貨。

Amount
payment.approved_money.amount integer

金額。

Currency
payment.approved_money.currency string

通貨。

Employee ID
payment.employee_id string

Square で生成された従業員の ID。

Receipt Number
payment.receipt_number string

支払領収書番号。 支払いがキャンセルされた場合、フィールドは表示されません。

Receipt URL
payment.receipt_url string

支払領収書の URL。 このフィールドには、COMPLETED 支払いの場合にのみ入力されます。

Delay Action
payment.delay_action string

delay_duration が経過したときに支払に適用されるアクション。

Delayed Until
payment.delayed_until string

delay_action が自動的に適用されるときの読み取り専用タイムスタンプ (RFC 3339 形式)。

Team Member ID
payment.team_member_id string

チーム メンバーの ID。

Square Product
payment.application_details.square_product string

Square POS (販売時点管理)、Square 請求書、Square ブラウザ決済などの Square 製品。

Application ID
payment.application_details.application_id string

アプリケーションに割り当てられた読み取り専用 Square ID。

Version Token
payment.version_token string

この不明瞭なトークンは、オブジェクトの特定のバージョンを識別します。

注文の取得

ID で注文を取得します。

パラメーター

名前 キー 必須 説明
Order ID
order_id True string

注文の識別子。

戻り値

名前 パス 説明
ID
order.id string

Square が発行した一意の識別子。

Location ID
order.location_id string

場所の識別子。

Line Items
order.line_items array of object
UID
order.line_items.uid string

Square で生成された ID。

Quantity
order.line_items.quantity string

現物棚卸によって影響を受ける品目の 10 進文字列数。 数値は、小数点以下 5 桁まで対応可能です。

Name
order.line_items.name string

品目の名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値は空であってはならず、長さは Unicode コード ポイントです。

Amount
order.line_items.base_price_money.amount integer

金額。

Currency
order.line_items.base_price_money.currency string

通貨。

Amount
order.line_items.gross_sales_money.amount integer

金額。

Currency
order.line_items.gross_sales_money.currency string

通貨。

Amount
order.line_items.total_tax_money.amount integer

金額。

Currency
order.line_items.total_tax_money.currency string

通貨。

Amount
order.line_items.total_discount_money.amount integer

金額。

Currency
order.line_items.total_discount_money.currency string

通貨。

Amount
order.line_items.total_money.amount integer

金額。

Currency
order.line_items.total_money.currency string

通貨。

Amount
order.line_items.variation_total_price_money.amount integer

金額。

Currency
order.line_items.variation_total_price_money.currency string

通貨。

Applied Discounts
order.line_items.applied_discounts array of object
UID
order.line_items.applied_discounts.uid string

Square で割り当てられた ID。

Discount UID
order.line_items.applied_discounts.discount_uid string

適用された割引が表す割引の uid。

Amount
order.line_items.applied_discounts.applied_money.amount integer

金額。

Currency
order.line_items.applied_discounts.applied_money.currency string

通貨。

Discounts
order.discounts array of object
UID
order.discounts.uid string

Square で生成された ID。

Name
order.discounts.name string

品目の名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値は空であってはならず、長さは Unicode コード ポイントです。

Percentage
order.discounts.percentage string

小数点の区切り文字に「.」を使用し、「%」記号を使用しない 10 進形式のパーセント。 値 7.5 は 7.5% に相当します。

Amount
order.discounts.applied_money.amount integer

金額。

Currency
order.discounts.applied_money.currency string

通貨。

Type
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

現在の状態。

Version
order.version integer

このオブジェクトの現在のバージョン。

Amount
order.total_tax_money.amount integer

金額。

Currency
order.total_tax_money.currency string

通貨。

Amount
order.total_discount_money.amount integer

金額。

Currency
order.total_discount_money.currency string

通貨。

Amount
order.total_tip_money.amount integer

金額。

Currency
order.total_tip_money.currency string

通貨。

Amount
order.total_money.amount integer

金額。

Currency
order.total_money.currency string

通貨。

Amount
order.total_service_charge_money.amount integer

金額。

Currency
order.total_service_charge_money.currency string

通貨。

Amount
order.net_amounts.total_money.amount integer

金額。

Currency
order.net_amounts.total_money.currency string

通貨。

Amount
order.net_amounts.tax_money.amount integer

金額。

Currency
order.net_amounts.tax_money.currency string

通貨。

Amount
order.net_amounts.discount_money.amount integer

金額。

Currency
order.net_amounts.discount_money.currency string

通貨。

Amount
order.net_amounts.tip_money.amount integer

金額。

Currency
order.net_amounts.tip_money.currency string

通貨。

Amount
order.net_amounts.service_charge_money.amount integer

金額。

Currency
order.net_amounts.service_charge_money.currency string

通貨。

注文の支払い (ベータ版)

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

パラメーター

名前 キー 必須 説明
Order ID
order_id True string

注文の識別子。

Idempotency Key
idempotency_key string

すべての要求の中でこの要求を一意に識別するために指定する値。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。

Payment IDs
payment_ids array of string

戻り値

名前 パス 説明
ID
order.id string

Square が発行した一意の識別子。

Location ID
order.location_id string

場所の識別子。

Line Items
order.line_items array of object
UID
order.line_items.uid string

Square で生成された ID。

Quantity
order.line_items.quantity string

現物棚卸によって影響を受ける品目の 10 進文字列数。 数値は、小数点以下 5 桁まで対応可能です。

Name
order.line_items.name string

品目の名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値は空であってはならず、長さは Unicode コード ポイントです。

Amount
order.line_items.base_price_money.amount integer

金額。

Currency
order.line_items.base_price_money.currency string

通貨。

Amount
order.line_items.gross_sales_money.amount integer

金額。

Currency
order.line_items.gross_sales_money.currency string

通貨。

Amount
order.line_items.total_tax_money.amount integer

金額。

Currency
order.line_items.total_tax_money.currency string

通貨。

Amount
order.line_items.total_discount_money.amount integer

金額。

Currency
order.line_items.total_discount_money.currency string

通貨。

Amount
order.line_items.total_money.amount integer

金額。

Currency
order.line_items.total_money.currency string

通貨。

Created At
order.created_at string

このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。

更新日時
order.updated_at string

このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。

Version
order.version integer

このオブジェクトの現在のバージョン。

Amount
order.total_tax_money.amount integer

金額。

Currency
order.total_tax_money.currency string

通貨。

Amount
order.total_discount_money.amount integer

金額。

Currency
order.total_discount_money.currency string

通貨。

Amount
order.total_money.amount integer

金額。

Currency
order.total_money.currency string

通貨。

Closed At
order.closed_at string

終了時刻 (ISO 8601 形式)。

Tenders
order.tenders array of object
ID
order.tenders.id string

オブジェクトの識別子

Location ID
order.tenders.location_id string

この入札の一部を受け取る受信者 (マーチャント以外) のロケーション ID。

Transaction ID
order.tenders.transaction_id string

入札に関連するトランザクションの ID。

Created At
order.tenders.created_at string

作成時のタイムスタンプ (RFC 3339形式)。

Amount
order.tenders.amount_money.amount integer

金額。

Currency
order.tenders.amount_money.currency string

通貨。

Type
order.tenders.type string

種類を示します。

Status
order.tenders.card_details.status string

クレジット カード決済の現在の状態 (AUTHORIZED や CAPTURED など)

Card Brand
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 桁の年。

Fingerprint
order.tenders.card_details.card.fingerprint string

カード番号に基づく、1 つのアプリケーション内の複数の場所でカードを識別するための、Square で割り当てられた識別子として使用されます。

Entry Method
order.tenders.card_details.entry_method string

トランザクションに使用するカード情報の入力方法。

Payment ID
order.tenders.payment_id string

Square で生成された支払いの一意の ID。

Amount
order.total_service_charge_money.amount integer

金額。

Currency
order.total_service_charge_money.currency string

通貨。

Amount
order.net_amounts.total_money.amount integer

金額。

Currency
order.net_amounts.total_money.currency string

通貨。

Amount
order.net_amounts.tax_money.amount integer

金額。

Currency
order.net_amounts.tax_money.currency string

通貨。

Amount
order.net_amounts.discount_money.amount integer

金額。

Currency
order.net_amounts.discount_money.currency string

通貨。

Amount
order.net_amounts.tip_money.amount integer

金額。

Currency
order.net_amounts.tip_money.currency string

通貨。

Amount
order.net_amounts.service_charge_money.amount integer

金額。

Currency
order.net_amounts.service_charge_money.currency string

通貨。

Name
order.source.name string

名前。

State
order.state string

現在の状態。

注文の更新 (ベータ版)

フィールドを追加、置換、または削除することにより、未処理の注文を更新します。 COMPLETED または CANCELED 状態の注文は更新できません。

パラメーター

名前 キー 必須 説明
Order ID
order_id True string

注文の識別子。

Idempotency Key
idempotency_key string

すべての要求の中でこの要求を一意に識別するために指定する値。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。

Version
version integer

このオブジェクトの現在のバージョン。

UID
uid string

Square で生成された ID。

Quantity
quantity string

現物棚卸によって影響を受ける品目の 10 進文字列数。 数値は、小数点以下 5 桁まで対応可能です。

Name
name string

品目の名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値は空であってはならず、長さは Unicode コード ポイントです。

Amount
amount integer

金額。

Currency
currency string

通貨。

Fields to Clear
fields_to_clear array of string

戻り値

名前 パス 説明
[バージョン]
order.version integer

このオブジェクトの現在のバージョン。

Currency
order.total_money.currency string

通貨。

Amount
order.total_money.amount integer

金額。

Name
order.source.name string

名前。

Line Items
order.line_items array of object
Currency
order.line_items.total_tax_money.currency string

通貨。

Amount
order.line_items.total_tax_money.amount integer

金額。

Amount
order.line_items.total_money.amount integer

金額。

Currency
order.line_items.total_money.currency string

通貨。

Amount
order.line_items.gross_sales_money.amount integer

金額。

Currency
order.line_items.gross_sales_money.currency string

通貨。

Amount
order.line_items.base_price_money.amount integer

金額。

Currency
order.line_items.base_price_money.currency string

通貨。

Quantity
order.line_items.quantity string

現物棚卸によって影響を受ける品目の 10 進文字列数。 数値は、小数点以下 5 桁まで対応可能です。

Currency
order.line_items.total_discount_money.currency string

通貨。

Amount
order.line_items.total_discount_money.amount integer

金額。

Name
order.line_items.name string

品目の名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値は空であってはならず、長さは Unicode コード ポイントです。

UID
order.line_items.uid string

Square で生成された ID。

Amount
order.line_items.variation_total_price_money.amount integer

金額。

Currency
order.line_items.variation_total_price_money.currency string

通貨。

State
order.state string

現在の状態。

Amount
order.total_service_charge_money.amount integer

金額。

Currency
order.total_service_charge_money.currency string

通貨。

ID
order.id string

Square が発行した一意の識別子。

Location ID
order.location_id string

場所の識別子。

Amount
order.total_tax_money.amount integer

金額。

Currency
order.total_tax_money.currency string

通貨。

Created At
order.created_at string

このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。

Amount
order.total_discount_money.amount integer

金額。

Currency
order.total_discount_money.currency string

通貨。

Currency
order.net_amounts.service_charge_money.currency string

通貨。

Amount
order.net_amounts.service_charge_money.amount integer

金額。

Amount
order.net_amounts.total_money.amount integer

金額。

Currency
order.net_amounts.total_money.currency string

通貨。

Currency
order.net_amounts.discount_money.currency string

通貨。

Amount
order.net_amounts.discount_money.amount integer

金額。

Currency
order.net_amounts.tax_money.currency string

通貨。

Amount
order.net_amounts.tax_money.amount integer

金額。

Updated At
order.updated_at string

このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。

注文の検索

1 つ以上の場所の注文をすべて検索します。 注文には、Square エコシステム (POS、Invoices、Connect の API など) に、いつ、どのように入ったかに関係なく、すべての販売、返品、交換が含まれます。

パラメーター

名前 キー 必須 説明
Return Entries
return_entries boolean

検索結果の形式を制御するブール値。 true の場合、SearchOrders は OrderEntry オブジェクトを返します。 false の場合、SearchOrders は完全な注文オブジェクトを返します。

Limit
limit integer

1 ページに返される結果の数の制限。 制限は推奨値であり、実装によって返される結果が増減する可能性があります。 指定された制限が負、ゼロ、または最大制限の 1,000 より大きい場合、無視されます。

Location IDs
location_ids array of string
Start At
start_at string

時間範囲の開始時刻を示す RFC 3339 形式の datetime 値。

End At
end_at string

時間範囲の終了時刻を示す RFC 3339 形式の datetime 値。

States
states array of string
Sort Field
sort_field string

並べ替えるフィールド。

Sort Order
sort_order string

結果が返される時系列順。

戻り値

名前 パス 説明
Order Entries
order_entries array of object
Order ID
order_entries.order_id string

受注の ID。

Location ID
order_entries.location_id string

場所の識別子。

Version
order_entries.version integer

オブジェクトの現在のバージョン。

Cursor
cursor string

このエンドポイントへの後続の呼び出しにページネーション カーソルを含めて、元のクエリに関連付けられた次の結果セットを取得します。

注文の複製 (ベータ版)

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

パラメーター

名前 キー 必須 説明
Order ID
order_id string

注文の識別子。

Version
version integer

バージョン。

Idempotency Key
idempotency_key string

すべての要求の中でこの要求を一意に識別するために指定する値。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。

戻り値

名前 パス 説明
ID
order.id string

Square が発行した一意の識別子。

Location ID
order.location_id string

場所の識別子。

Line Items
order.line_items array of object
UID
order.line_items.uid string

Square で生成された ID。

Name
order.line_items.name string

品目の名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値は空であってはならず、長さは Unicode コード ポイントです。

Quantity
order.line_items.quantity string

現物棚卸によって影響を受ける品目の 10 進文字列数。 数値は、小数点以下 5 桁まで対応可能です。

Applied Taxes
order.line_items.applied_taxes array of object
UID
order.line_items.applied_taxes.uid string

Square で割り当てられた ID。

Tax UID
order.line_items.applied_taxes.tax_uid string

この適用税が表す税の UID。

Amount
order.line_items.applied_taxes.applied_money.amount integer

金額。

Currency
order.line_items.applied_taxes.applied_money.currency string

通貨。

Applied Discounts
order.line_items.applied_discounts array of object
UID
order.line_items.applied_discounts.uid string

Square で割り当てられた ID。

Discount UID
order.line_items.applied_discounts.discount_uid string

適用された割引が表す割引の uid。

Amount
order.line_items.applied_discounts.applied_money.amount integer

金額。

Currency
order.line_items.applied_discounts.applied_money.currency string

通貨。

Amount
order.line_items.base_price_money.amount integer

金額。

Currency
order.line_items.base_price_money.currency string

通貨。

Amount
order.line_items.gross_sales_money.amount integer

金額。

Currency
order.line_items.gross_sales_money.currency string

通貨。

Amount
order.line_items.total_tax_money.amount integer

金額。

Currency
order.line_items.total_tax_money.currency string

通貨。

Amount
order.line_items.total_discount_money.amount integer

金額。

Currency
order.line_items.total_discount_money.currency string

通貨。

Amount
order.line_items.total_money.amount integer

金額。

Currency
order.line_items.total_money.currency string

通貨。

Amount
order.line_items.variation_total_price_money.amount integer

金額。

Currency
order.line_items.variation_total_price_money.currency string

通貨。

Catalog Object ID
order.line_items.catalog_object_id string

Square で生成された追跡対象の CatalogObject の ID。

Variation Name
order.line_items.variation_name string

この品目に適用されるバリエーションの名前。

Modifiers
order.line_items.modifiers array of object
UID
order.line_items.modifiers.uid string

Square で割り当てられた ID。

Catalog Object ID
order.line_items.modifiers.catalog_object_id string

カタログ オブジェクト ID。

Name
order.line_items.modifiers.name string

品目の名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値は空であってはならず、長さは Unicode コード ポイントです。

Amount
order.line_items.modifiers.base_price_money.amount integer

金額。

Currency
order.line_items.modifiers.base_price_money.currency string

通貨。

Amount
order.line_items.modifiers.total_price_money.amount integer

金額。

Currency
order.line_items.modifiers.total_price_money.currency string

通貨。

Taxes
order.taxes array of object
UID
order.taxes.uid string

Square で生成された ID。

Name
order.taxes.name string

品目の名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値は空であってはならず、長さは Unicode コード ポイントです。

Type
order.taxes.type string

種類を示します。

Percentage
order.taxes.percentage string

小数点の区切り文字に「.」を使用し、「%」記号を使用しない 10 進形式のパーセント。 値 7.5 は 7.5% に相当します。

Amount
order.taxes.applied_money.amount integer

金額。

Currency
order.taxes.applied_money.currency string

通貨。

Scope
order.taxes.scope string

現在のレベルを示します。

Discounts
order.discounts array of object
UID
order.discounts.uid string

Square で生成された ID。

Catalog Object ID
order.discounts.catalog_object_id string

Square で生成された追跡対象の CatalogObject の ID。

Name
order.discounts.name string

品目の名前。 これは、該当するクエリ フィルターで使用するための検索可能な属性であり、その値は空であってはならず、長さは Unicode コード ポイントです。

Type
order.discounts.type string

種類を示します。

Percentage
order.discounts.percentage string

小数点の区切り文字に「.」を使用し、「%」記号を使用しない 10 進形式のパーセント。 値 7.5 は 7.5% に相当します。

Amount
order.discounts.applied_money.amount integer

金額。

Currency
order.discounts.applied_money.currency string

通貨。

Scope
order.discounts.scope string

現在のレベルを示します。

Amount
order.discounts.amount_money.amount integer

金額。

Currency
order.discounts.amount_money.currency string

通貨。

Created At
order.created_at string

このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。

更新日時
order.updated_at string

このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。

State
order.state string

現在の状態。

Version
order.version integer

このオブジェクトの現在のバージョン。

Reference ID
order.reference_id string

オプションのユーザー定義参照 ID。

Amount
order.total_money.amount integer

金額。

Currency
order.total_money.currency string

通貨。

Amount
order.total_tax_money.amount integer

金額。

Currency
order.total_tax_money.currency string

通貨。

Amount
order.total_discount_money.amount integer

金額。

Currency
order.total_discount_money.currency string

通貨。

Amount
order.total_tip_money.amount integer

金額。

Currency
order.total_tip_money.currency string

通貨。

Amount
order.total_service_charge_money.amount integer

金額。

Currency
order.total_service_charge_money.currency string

通貨。

Amount
order.net_amounts.total_money.amount integer

金額。

Currency
order.net_amounts.total_money.currency string

通貨。

Amount
order.net_amounts.tax_money.amount integer

金額。

Currency
order.net_amounts.tax_money.currency string

通貨。

Amount
order.net_amounts.discount_money.amount integer

金額。

Currency
order.net_amounts.discount_money.currency string

通貨。

Amount
order.net_amounts.tip_money.amount integer

金額。

Currency
order.net_amounts.tip_money.currency string

通貨。

Amount
order.net_amounts.service_charge_money.amount integer

金額。

Currency
order.net_amounts.service_charge_money.currency string

通貨。

Name
order.source.name string

名前。

紛争の一覧表示

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

パラメーター

名前 キー 必須 説明
Cursor
cursor string

このエンドポイントへの前回の呼び出しによって返されたページネーション カーソル。

States
states string

結果をフィルターするための紛争の状態。 指定しない場合、エンドポイントはすべての未解決の紛争 (紛争ステータスは INQUIRY_CLOSED、WON、または LOST ではありません) を返します。

Location ID
location_id string

このオプション フィルターを指定して、特定の場所に属するレコードのみを取得できます。

戻り値

名前 パス 説明
Disputes
disputes array of object
ID
disputes.id string

Square が発行した一意の識別子。

Amount
disputes.amount_money.amount integer

金額。

Currency
disputes.amount_money.currency string

通貨。

Reason
disputes.reason string

カード名義人が銀行と紛争を開始した紛争の理由。

State
disputes.state string

現在の状態。

Due At
disputes.due_at string

次のアクションの期限 (RFC 3339 形式)。

Disputed Payments
disputes.disputed_payments array of object
Payment ID
disputes.disputed_payments.payment_id string

Square で生成された紛争中の支払いの一意の ID。

Card Brand
disputes.card_brand string

紛争中の支払いに使用されたカード ブランド。

Created At
disputes.created_at string

イベント時刻 (ISO 8601 形式)。

Updated At
disputes.updated_at string

最終変更タイムスタンプ (RFC 3339 形式)

Brand Dispute ID
disputes.brand_dispute_id string

カード ブランドによって生成された、カード ブランド システムの紛争の ID。

Cursor
cursor string

このエンドポイントへの後続の呼び出しにページネーション カーソルを含めて、元のクエリに関連付けられた次の結果セットを取得します。

紛争の取得

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

パラメーター

名前 キー 必須 説明
Dispute ID
dispute_id True string

紛争の識別子。

戻り値

名前 パス 説明
ID
dispute.id string

Square が発行した一意の識別子。

Amount
dispute.amount_money.amount integer

金額。

Currency
dispute.amount_money.currency string

通貨。

Reason
dispute.reason string

このオブジェクトの理由。

State
dispute.state string

現在の状態。

Due At
dispute.due_at string

次のアクションの期限 (RFC 3339 形式)。

Disputed Payments
dispute.disputed_payments array of object
Payment ID
dispute.disputed_payments.payment_id string

Square で生成された支払いの一意の ID。

Card Brand
dispute.card_brand string

カードのブランド。

Created At
dispute.created_at string

このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。

更新日時
dispute.updated_at string

このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。

Brand Dispute ID
dispute.brand_dispute_id string

カード ブランドによって生成された、カード ブランド システムの紛争の ID。

紛争の承諾

紛争による損失を受け入れます。 Square は異議を申し立てられた金額をカード名義人に返し、異議を申し立ての状態を ACCEPTED に更新します。 Square は、販売担当者の Square アカウントから異議を申し立てられた金額を引き落とします。 Square アカウントに十分な資金がない場合、Square は関連する銀行口座から引き落します。

パラメーター

名前 キー 必須 説明
Dispute ID
dispute_id True string

紛争の識別子。

戻り値

名前 パス 説明
ID
dispute.id string

Square が発行した一意の識別子。

Amount
dispute.amount_money.amount integer

金額。

Currency
dispute.amount_money.currency string

通貨。

Reason
dispute.reason string

このオブジェクトの理由。

State
dispute.state string

現在の状態。

Due At
dispute.due_at string

次のアクションの期限 (RFC 3339 形式)。

Disputed Payments
dispute.disputed_payments array of object
Payment ID
dispute.disputed_payments.payment_id string

Square で生成された支払いの一意の ID。

Card Brand
dispute.card_brand string

カードのブランド。

Created At
dispute.created_at string

このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。

更新日時
dispute.updated_at string

このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。

Brand Dispute ID
dispute.brand_dispute_id string

カード ブランドによって生成された、カード ブランド システムの紛争の ID。

紛争の証拠となるテキストの作成

異議申立の証拠として使用するテキストをアップロードします。

パラメーター

名前 キー 必須 説明
Dispute ID
dispute_id True string

紛争の識別子。

Evidence Type
evidence_type string

アップロードする証拠の種類。

Evidence Text
evidence_text string

証拠の文字列。

Idempotency Key
idempotency_key string

すべての要求の中でこの要求を一意に識別するために指定する値。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。

戻り値

名前 パス 説明
ID
evidence.id string

Square が発行した一意の識別子。

Dispute ID
evidence.dispute_id string

証拠が関連付けられている紛争の ID。

Evidence Text
evidence.evidence_text string

未加工のテキスト。

Evidence Type
evidence.evidence_type string

証拠の種類。

Uploaded At
evidence.uploaded_at string

次のアクションの期限 (RFC 3339 形式)。

紛争証拠の一覧表示

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

パラメーター

名前 キー 必須 説明
Dispute ID
dispute_id True string

紛争の識別子。

戻り値

名前 パス 説明
Evidence
evidence array of object
ID
evidence.id string

Square が発行した一意の識別子。

Dispute ID
evidence.dispute_id string

証拠が関連付けられている紛争の ID。

Evidence Text
evidence.evidence_text string

未加工のテキスト。

Evidence Type
evidence.evidence_type string

証拠の種類。

Uploaded At
evidence.uploaded_at string

次のアクションの期限 (RFC 3339 形式)。

Evidence ID
evidence.evidence_id string

Square で生成された証拠の 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

このエンドポイントへの後続の呼び出しにページネーション カーソルを含めて、元のクエリに関連付けられた次の結果セットを取得します。

紛争証拠の削除

紛争から特定の証拠を削除します。

パラメーター

名前 キー 必須 説明
Dispute ID
dispute_id True string

紛争の識別子。

Evidence ID
evidence_id True string

証拠の識別子。

戻り値

response
object

紛争証拠の取得

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

パラメーター

名前 キー 必須 説明
Dispute ID
dispute_id True string

紛争の識別子。

Evidence ID
evidence_id True string

証拠の識別子。

戻り値

名前 パス 説明
ID
evidence.id string

Square が発行した一意の識別子。

Dispute 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 Type
evidence.evidence_type string

証拠の種類。

Uploaded At
evidence.uploaded_at string

次のアクションの期限 (RFC 3339 形式)。

証拠の送信

カード名義人の銀行に証拠を送信します。 証拠を送信する前に、Square は利用可能なすべての証拠を集めます。 これには、CreateDisputeEvidenceFile および CreateDisputeEvidenceText のエンドポイントを使用してアップロードされた証拠と、利用可能な場合は Square によって自動的に提供される証拠が含まれます。

パラメーター

名前 キー 必須 説明
Dispute ID
dispute_id True string

紛争の識別子。

戻り値

名前 パス 説明
ID
dispute.id string

Square が発行した一意の識別子。

Amount
dispute.amount_money.amount integer

金額。

Currency
dispute.amount_money.currency string

通貨。

Reason
dispute.reason string

このオブジェクトの理由。

State
dispute.state string

現在の状態。

Due At
dispute.due_at string

次のアクションの期限 (RFC 3339 形式)。

Disputed Payments
dispute.disputed_payments array of object
Payment ID
dispute.disputed_payments.payment_id string

Square で生成された支払いの一意の ID。

Card Brand
dispute.card_brand string

カードのブランド。

Created At
dispute.created_at string

このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。

更新日時
dispute.updated_at string

このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。

Brand Dispute ID
dispute.brand_dispute_id string

カード ブランドによって生成された、カード ブランド システムの紛争の ID。

請求書の一覧表示

指定された場所の請求書の一覧を返します。

パラメーター

名前 キー 必須 説明
Location ID
location_id string

このオプション フィルターを指定して、特定の場所に属するレコードのみを取得できます。

Cursor
cursor string

このエンドポイントへの前回の呼び出しによって返されたページネーション カーソル。

Limit
limit integer

応答で返す数の上限。

戻り値

名前 パス 説明
Invoices
invoices array of object
ID
invoices.id string

Square が発行した一意の識別子。

Version
invoices.version integer

オブジェクトの現在のバージョン。

Location ID
invoices.location_id string

場所の識別子。

Order ID
invoices.order_id string

受注の ID。

Payment Requests
invoices.payment_requests array of object
UID
invoices.payment_requests.uid string

Square で生成された請求書の支払要求 ID。

Request Type
invoices.payment_requests.request_type string

支払要求の種類を識別します。 この種類は、支払要求金額の決定方法を定義します。

Due Date
invoices.payment_requests.due_date string

YYYY-MM-DD 形式の支払い要求の期限 (請求書のタイム ゾーン)。

Tipping Enabled
invoices.payment_requests.tipping_enabled boolean

true に設定すると、Square がホストする請求書ページ (請求書の public_url フィールド) に、顧客がチップを支払う場所が提供されます。

reminders
invoices.payment_requests.reminders array of object

Reminders

UID
invoices.payment_requests.reminders.uid string

InvoicePaymentRequest 内のアラームを一意に識別する Square によって割り当てられた ID。

Relative Scheduled Days
invoices.payment_requests.reminders.relative_scheduled_days integer

アラームが送信されるときの支払要求 due_date の前 (負の数) または後 (正の数) の日数。

Message
invoices.payment_requests.reminders.message string

アラーム メッセージ。

Status
invoices.payment_requests.reminders.status string

アラームのステータス。

Amount
invoices.payment_requests.computed_amount_money.amount integer

金額。

Currency
invoices.payment_requests.computed_amount_money.currency string

通貨。

Amount
invoices.payment_requests.total_completed_amount_money.amount integer

金額。

Currency
invoices.payment_requests.total_completed_amount_money.currency string

通貨。

Automatic Payment Source
invoices.payment_requests.automatic_payment_source string

自動支払の支払方法。

Percentage Requested
invoices.payment_requests.percentage_requested string

支払い要求の金額をパーセントで指定します。

Card ID
invoices.payment_requests.card_id string

支払い要求に対して請求するファイル上のクレジット カードまたはデビット カードの ID。

Invoice Number
invoices.invoice_number string

わかりやすい請求書番号。

Title
invoices.title string

請求書のタイトル。

Description
invoices.description string

説明。

Scheduled At
invoices.scheduled_at string

請求書の処理が予定されているときのタイムスタンプ (RFC 3339 形式)。 請求書が発行されると、Square は配信方法と支払要求の設定に従って、指定日に請求書を処理します。

Status
invoices.status string

このオブジェクトの現在の検証状態。

Timezone
invoices.timezone string

due_date など、請求書のカレンダーの日付を解釈するために使用されるタイムゾーン。 請求書が作成されると、このフィールドは販売担当者の場所に指定されたタイムゾーンに設定されます。 値は変更できません。

Created At
invoices.created_at string

イベント時刻 (ISO 8601 形式)。

Updated At
invoices.updated_at string

最終変更タイムスタンプ (RFC 3339 形式)

Customer ID
invoices.primary_recipient.customer_id string

カードと関連付ける顧客の ID。

Given Name
invoices.primary_recipient.given_name string

受信者の名。

Family Name
invoices.primary_recipient.family_name string

受信者の姓。

Email Address
invoices.primary_recipient.email_address string

受信者のメール アドレス。

Phone Number
invoices.primary_recipient.phone_number string

受信者の電話番号。

Card
invoices.accepted_payment_methods.card boolean

クレジット カードまたはデビット カード決済の可否を示します。

Square Gift Card
invoices.accepted_payment_methods.square_gift_card boolean

Square ギフト カード決済の可否を示します。

Bank Account
invoices.accepted_payment_methods.bank_account boolean

銀行振込決済の可否を示します。

Custom Fields
invoices.custom_fields array of object
Label
invoices.custom_fields.label string

カスタム フィールドのラベルまたはタイトル。

Value
invoices.custom_fields.value string

カスタム フィールドのテキスト。

Placement
invoices.custom_fields.placement string

請求書のカスタム フィールドの場所

Delivery Method
invoices.delivery_method string

Square が請求書、アラーム、領収書を顧客に送信するために使用する配信方法。

Sale or Service Date
invoices.sale_or_service_date string

販売日またはサービスの提供日 (YYYY-MM-DD 形式)。 このフィールドを使用して、請求書に表示される過去または将来の日付を指定できます。

Public URL
invoices.public_url string

Square がホストする請求書ページの URL。 PublishInvoice エンドポイントを使用して請求書を発行すると、Square は請求書ページをホストし、応答でページ URL を返します。

Amount
invoices.next_payment_amount_money.amount integer

金額。

Currency
invoices.next_payment_amount_money.currency string

通貨。

Cursor
cursor string

このエンドポイントへの後続の呼び出しにページネーション カーソルを含めて、元のクエリに関連付けられた次の結果セットを取得します。

請求書の作成

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

パラメーター

名前 キー 必須 説明
Idempotency Key
idempotency_key string

すべての要求の中でこの要求を一意に識別するために指定する値。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。

Location ID
location_id string

場所の識別子。

Order ID
order_id string

受注の ID。

Scheduled At
scheduled_at string

処理がスケジュールされたときのタイムスタンプ (RFC 3339 形式)。

Customer ID
customer_id string

受注に関連付けられた顧客 ID。

Delivery Method
delivery_method string

Square が請求書、アラーム、領収書を顧客に送信するために使用する配信方法。 請求書が発行されると、Square は配信方法と支払要求の設定に基づいて、即時または指定されている場合は、scheduled_at 日に請求書を処理します。

Request Type
request_type string

支払要求の種類を識別します。 この種類は、支払要求金額の決定方法を定義します。

Due Date
due_date string

支払要求の期限 (YYYY-MM-DD 形式)。

Tipping Enabled
tipping_enabled boolean

true に設定すると、顧客がチップを支払う場所が提供されます。

Automatic Payment Source
automatic_payment_source string

自動支払の支払方法。

Message
message string

メッセージ。

Relative Scheduled Days
relative_scheduled_days integer

アラームが送信されるときの支払要求 due_date の前 (負の数) または後 (正の数) の日数。

Invoice Number
invoice_number string

わかりやすい請求書番号。 値は場所内で一意です。 請求書の作成時に指定されていない場合、Square は値を割り当てます。

Title
title string

タイトル。

Description
description string

説明。

Card
card boolean

クレジット カードまたはデビット カード決済の可否を示します。

Square Gift Card
square_gift_card boolean

Square ギフト カード決済の可否を示します。

Bank Account
bank_account boolean

銀行振込決済の可否を示します。

Label
label string

カスタム フィールドのラベルまたはタイトル。

Value
value string

カスタム フィールドのテキスト。

Placement
placement string

請求書のカスタム フィールドの場所。

Sale or Service Date
sale_or_service_date string

販売日またはサービスの提供日 (YYYY-MM-DD 形式)。 このフィールドを使用して、請求書に表示される過去または将来の日付を指定できます。

戻り値

名前 パス 説明
ID
invoice.id string

Square が発行した一意の識別子。

Version
invoice.version integer

このオブジェクトの現在のバージョン。

Location ID
invoice.location_id string

場所の識別子。

Order ID
invoice.order_id string

受注の ID。

Payment Requests
invoice.payment_requests array of object
UID
invoice.payment_requests.uid string

Square で生成された ID。

Request Type
invoice.payment_requests.request_type string

支払要求の種類を識別します。 この種類は、支払要求金額の決定方法を定義します。

Due Date
invoice.payment_requests.due_date string

支払要求の期限 (YYYY-MM-DD 形式)。

Tipping Enabled
invoice.payment_requests.tipping_enabled boolean

true に設定すると、顧客がチップを支払う場所が提供されます。

Reminders
invoice.payment_requests.reminders array of object
UID
invoice.payment_requests.reminders.uid string

Square で割り当てられた ID。

Relative Scheduled Days
invoice.payment_requests.reminders.relative_scheduled_days integer

アラームが送信されるときの支払要求 due_date の前 (負の数) または後 (正の数) の日数。

Message
invoice.payment_requests.reminders.message string

メッセージ。

Status
invoice.payment_requests.reminders.status string

現在の状態。

Amount
invoice.payment_requests.computed_amount_money.amount integer

金額。

Currency
invoice.payment_requests.computed_amount_money.currency string

通貨。

Amount
invoice.payment_requests.total_completed_amount_money.amount integer

金額。

Currency
invoice.payment_requests.total_completed_amount_money.currency string

通貨。

Automatic Payment Source
invoice.payment_requests.automatic_payment_source string

自動支払の支払方法。

Invoice Number
invoice.invoice_number string

わかりやすい請求書番号。 値は場所内で一意です。 請求書の作成時に指定されていない場合、Square は値を割り当てます。

Title
invoice.title string

タイトル。

Description
invoice.description string

説明。

Scheduled At
invoice.scheduled_at string

処理がスケジュールされたときのタイムスタンプ (RFC 3339 形式)。

Status
invoice.status string

このオブジェクトの現在の検証状態。

Timezone
invoice.timezone string

カレンダーの日付を解釈するために使用されるタイム ゾーン。 請求書が作成されると、このフィールドは販売担当者の場所に指定されたタイムゾーンに設定されます。 値は変更できません。

Created At
invoice.created_at string

このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。

更新日時
invoice.updated_at string

このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。

Customer ID
invoice.primary_recipient.customer_id string

受注に関連付けられた顧客 ID。

Given Name
invoice.primary_recipient.given_name string

受信者の名。

Family Name
invoice.primary_recipient.family_name string

受信者の姓。

Email Address
invoice.primary_recipient.email_address string

受信者のメール アドレス。

Phone Number
invoice.primary_recipient.phone_number string

受信者の電話番号。

Card
invoice.accepted_payment_methods.card boolean

クレジット カードまたはデビット カード決済の可否を示します。

Square Gift Card
invoice.accepted_payment_methods.square_gift_card boolean

Square ギフト カード決済の可否を示します。

Bank Account
invoice.accepted_payment_methods.bank_account boolean

銀行振込決済の可否を示します。

Custom Fields
invoice.custom_fields array of object
Label
invoice.custom_fields.label string

カスタム フィールドのラベルまたはタイトル。

Value
invoice.custom_fields.value string

カスタム フィールドのテキスト。

Placement
invoice.custom_fields.placement string

請求書のカスタム フィールドの場所。

Delivery Method
invoice.delivery_method string

Square が請求書、アラーム、領収書を顧客に送信するために使用する配信方法。 請求書が発行されると、Square は配信方法と支払要求の設定に基づいて、即時または指定されている場合は、scheduled_at 日に請求書を処理します。

Sale or Service Date
invoice.sale_or_service_date string

販売日またはサービスの提供日 (YYYY-MM-DD 形式)。 このフィールドを使用して、請求書に表示される過去または将来の日付を指定できます。

請求書の削除

指定した請求書を削除します。 請求書が削除されると、関連する注文ステータスが CANCELED に変更されます。 削除できるのは下書き請求書のみです (処理が予定されている請求書を含め、発行済み請求書は削除できません)。

パラメーター

名前 キー 必須 説明
Invoice ID
invoice_id True string

請求書の識別子。

Version
version integer

削除する請求書のバージョン。

戻り値

response
object

請求書の取り消し

請求書をキャンセルします。 販売担当者は、キャンセルされた請求書の支払いを回収できません。

パラメーター

名前 キー 必須 説明
Invoice ID
invoice_id True string

請求書の識別子。

Version
version integer

バージョン。

戻り値

名前 パス 説明
ID
invoice.id string

Square が発行した一意の識別子。

Version
invoice.version integer

このオブジェクトの現在のバージョン。

Location ID
invoice.location_id string

場所の識別子。

Order ID
invoice.order_id string

受注の ID。

Payment Requests
invoice.payment_requests array of object
UID
invoice.payment_requests.uid string

Square で生成された ID。

Request Type
invoice.payment_requests.request_type string

支払要求の種類を識別します。 この種類は、支払要求金額の決定方法を定義します。

Due Date
invoice.payment_requests.due_date string

支払要求の期限 (YYYY-MM-DD 形式)。

Tipping Enabled
invoice.payment_requests.tipping_enabled boolean

true に設定すると、顧客がチップを支払う場所が提供されます。

Reminders
invoice.payment_requests.reminders array of object
UID
invoice.payment_requests.reminders.uid string

Square で割り当てられた ID。

Relative Scheduled Days
invoice.payment_requests.reminders.relative_scheduled_days integer

アラームが送信されるときの支払要求 due_date の前 (負の数) または後 (正の数) の日数。

Message
invoice.payment_requests.reminders.message string

メッセージ。

Status
invoice.payment_requests.reminders.status string

現在の状態。

Amount
invoice.payment_requests.computed_amount_money.amount integer

金額。

Currency
invoice.payment_requests.computed_amount_money.currency string

通貨。

Amount
invoice.payment_requests.total_completed_amount_money.amount integer

金額。

Currency
invoice.payment_requests.total_completed_amount_money.currency string

通貨。

Automatic Payment Source
invoice.payment_requests.automatic_payment_source string

自動支払の支払方法。

Invoice Number
invoice.invoice_number string

わかりやすい請求書番号。 値は場所内で一意です。 請求書の作成時に指定されていない場合、Square は値を割り当てます。

Title
invoice.title string

タイトル。

Description
invoice.description string

説明。

Scheduled At
invoice.scheduled_at string

処理がスケジュールされたときのタイムスタンプ (RFC 3339 形式)。

Status
invoice.status string

このオブジェクトの現在の検証状態。

Timezone
invoice.timezone string

カレンダーの日付を解釈するために使用されるタイム ゾーン。 請求書が作成されると、このフィールドは販売担当者の場所に指定されたタイムゾーンに設定されます。 値は変更できません。

Created At
invoice.created_at string

このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。

更新日時
invoice.updated_at string

このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。

Customer ID
invoice.primary_recipient.customer_id string

受注に関連付けられた顧客 ID。

Given Name
invoice.primary_recipient.given_name string

受信者の名。

Family Name
invoice.primary_recipient.family_name string

受信者の姓。

Email Address
invoice.primary_recipient.email_address string

受信者のメール アドレス。

Phone Number
invoice.primary_recipient.phone_number string

受信者の電話番号。

Card
invoice.accepted_payment_methods.card boolean

クレジット カードまたはデビット カード決済の可否を示します。

Square Gift Card
invoice.accepted_payment_methods.square_gift_card boolean

Square ギフト カード決済の可否を示します。

Bank Account
invoice.accepted_payment_methods.bank_account boolean

銀行振込決済の可否を示します。

Custom Fields
invoice.custom_fields array of object
Label
invoice.custom_fields.label string

カスタム フィールドのラベルまたはタイトル。

Value
invoice.custom_fields.value string

カスタム フィールドのテキスト。

Placement
invoice.custom_fields.placement string

請求書のカスタム フィールドの場所。

Delivery Method
invoice.delivery_method string

Square が請求書、アラーム、領収書を顧客に送信するために使用する配信方法。 請求書が発行されると、Square は配信方法と支払要求の設定に基づいて、即時または指定されている場合は、scheduled_at 日に請求書を処理します。

Sale or Service Date
invoice.sale_or_service_date string

販売日またはサービスの提供日 (YYYY-MM-DD 形式)。 このフィールドを使用して、請求書に表示される過去または将来の日付を指定できます。

請求書の取得

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

パラメーター

名前 キー 必須 説明
Invoice ID
invoice_id True string

請求書の識別子。

戻り値

名前 パス 説明
ID
invoice.id string

Square が発行した一意の識別子。

Version
invoice.version integer

このオブジェクトの現在のバージョン。

Location ID
invoice.location_id string

場所の識別子。

Order ID
invoice.order_id string

受注の ID。

Payment Requests
invoice.payment_requests array of object
UID
invoice.payment_requests.uid string

Square で生成された ID。

Request Type
invoice.payment_requests.request_type string

支払要求の種類を識別します。 この種類は、支払要求金額の決定方法を定義します。

Due Date
invoice.payment_requests.due_date string

支払要求の期限 (YYYY-MM-DD 形式)。

Tipping Enabled
invoice.payment_requests.tipping_enabled boolean

true に設定すると、顧客がチップを支払う場所が提供されます。

Reminders
invoice.payment_requests.reminders array of object
UID
invoice.payment_requests.reminders.uid string

Square で割り当てられた ID。

Relative Scheduled Days
invoice.payment_requests.reminders.relative_scheduled_days integer

アラームが送信されるときの支払要求 due_date の前 (負の数) または後 (正の数) の日数。

Message
invoice.payment_requests.reminders.message string

メッセージ。

Status
invoice.payment_requests.reminders.status string

現在の状態。

Amount
invoice.payment_requests.computed_amount_money.amount integer

金額。

Currency
invoice.payment_requests.computed_amount_money.currency string

通貨。

Amount
invoice.payment_requests.total_completed_amount_money.amount integer

金額。

Currency
invoice.payment_requests.total_completed_amount_money.currency string

通貨。

Automatic Payment Source
invoice.payment_requests.automatic_payment_source string

自動支払の支払方法。

Invoice Number
invoice.invoice_number string

わかりやすい請求書番号。 値は場所内で一意です。 請求書の作成時に指定されていない場合、Square は値を割り当てます。

Title
invoice.title string

タイトル。

Description
invoice.description string

説明。

Scheduled At
invoice.scheduled_at string

処理がスケジュールされたときのタイムスタンプ (RFC 3339 形式)。

Status
invoice.status string

このオブジェクトの現在の検証状態。

Timezone
invoice.timezone string

カレンダーの日付を解釈するために使用されるタイム ゾーン。 請求書が作成されると、このフィールドは販売担当者の場所に指定されたタイムゾーンに設定されます。 値は変更できません。

Created At
invoice.created_at string

このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。

更新日時
invoice.updated_at string

このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。

Customer ID
invoice.primary_recipient.customer_id string

受注に関連付けられた顧客 ID。

Given Name
invoice.primary_recipient.given_name string

受信者の名。

Family Name
invoice.primary_recipient.family_name string

受信者の姓。

Email Address
invoice.primary_recipient.email_address string

受信者のメール アドレス。

Phone Number
invoice.primary_recipient.phone_number string

受信者の電話番号。

Card
invoice.accepted_payment_methods.card boolean

クレジット カードまたはデビット カード決済の可否を示します。

Square Gift Card
invoice.accepted_payment_methods.square_gift_card boolean

Square ギフト カード決済の可否を示します。

Bank Account
invoice.accepted_payment_methods.bank_account boolean

銀行振込決済の可否を示します。

Custom Fields
invoice.custom_fields array of object
Label
invoice.custom_fields.label string

カスタム フィールドのラベルまたはタイトル。

Value
invoice.custom_fields.value string

カスタム フィールドのテキスト。

Placement
invoice.custom_fields.placement string

請求書のカスタム フィールドの場所。

Delivery Method
invoice.delivery_method string

Square が請求書、アラーム、領収書を顧客に送信するために使用する配信方法。 請求書が発行されると、Square は配信方法と支払要求の設定に基づいて、即時または指定されている場合は、scheduled_at 日に請求書を処理します。

Sale or Service Date
invoice.sale_or_service_date string

販売日またはサービスの提供日 (YYYY-MM-DD 形式)。 このフィールドを使用して、請求書に表示される過去または将来の日付を指定できます。

請求書の更新

フィールドを変更するか、フィールドをクリアするか、またはその両方を行うことで請求書を更新します。

パラメーター

名前 キー 必須 説明
Invoice ID
invoice_id True string

請求書の識別子。

Idempotency Key
idempotency_key string

すべての要求の中でこの要求を一意に識別するために指定する値。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。

UID
uid string

Square で生成された ID。

Tipping Enabled
tipping_enabled boolean

true に設定すると、顧客がチップを支払う場所が提供されます。

Fields to Clear
fields_to_clear array of string

戻り値

名前 パス 説明
ID
invoice.id string

Square が発行した一意の識別子。

Version
invoice.version integer

このオブジェクトの現在のバージョン。

Location ID
invoice.location_id string

場所の識別子。

Order ID
invoice.order_id string

受注の ID。

Payment Requests
invoice.payment_requests array of object
UID
invoice.payment_requests.uid string

Square で生成された ID。

Request Type
invoice.payment_requests.request_type string

支払要求の種類を識別します。 この種類は、支払要求金額の決定方法を定義します。

Due Date
invoice.payment_requests.due_date string

支払要求の期限 (YYYY-MM-DD 形式)。

Tipping Enabled
invoice.payment_requests.tipping_enabled boolean

true に設定すると、顧客がチップを支払う場所が提供されます。

Amount
invoice.payment_requests.computed_amount_money.amount integer

金額。

Currency
invoice.payment_requests.computed_amount_money.currency string

通貨。

Amount
invoice.payment_requests.total_completed_amount_money.amount integer

金額。

Currency
invoice.payment_requests.total_completed_amount_money.currency string

通貨。

Automatic Payment Source
invoice.payment_requests.automatic_payment_source string

自動支払の支払方法。

Invoice Number
invoice.invoice_number string

わかりやすい請求書番号。 値は場所内で一意です。 請求書の作成時に指定されていない場合、Square は値を割り当てます。

Title
invoice.title string

タイトル。

Description
invoice.description string

説明。

Scheduled At
invoice.scheduled_at string

処理がスケジュールされたときのタイムスタンプ (RFC 3339 形式)。

Status
invoice.status string

このオブジェクトの現在の検証状態。

Timezone
invoice.timezone string

カレンダーの日付を解釈するために使用されるタイム ゾーン。 請求書が作成されると、このフィールドは販売担当者の場所に指定されたタイムゾーンに設定されます。 値は変更できません。

Created At
invoice.created_at string

このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。

更新日時
invoice.updated_at string

このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。

Customer ID
invoice.primary_recipient.customer_id string

受注に関連付けられた顧客 ID。

Given Name
invoice.primary_recipient.given_name string

受信者の名。

Family Name
invoice.primary_recipient.family_name string

受信者の姓。

Email Address
invoice.primary_recipient.email_address string

受信者のメール アドレス。

Phone Number
invoice.primary_recipient.phone_number string

受信者の電話番号。

Amount
invoice.next_payment_amount_money.amount integer

金額。

Currency
invoice.next_payment_amount_money.currency string

通貨。

Card
invoice.accepted_payment_methods.card boolean

クレジット カードまたはデビット カード決済の可否を示します。

Square Gift Card
invoice.accepted_payment_methods.square_gift_card boolean

Square ギフト カード決済の可否を示します。

Bank Account
invoice.accepted_payment_methods.bank_account boolean

銀行振込決済の可否を示します。

Custom Fields
invoice.custom_fields array of object
Label
invoice.custom_fields.label string

カスタム フィールドのラベルまたはタイトル。

Value
invoice.custom_fields.value string

カスタム フィールドのテキスト。

Placement
invoice.custom_fields.placement string

請求書のカスタム フィールドの場所。

Delivery Method
invoice.delivery_method string

Square が請求書、アラーム、領収書を顧客に送信するために使用する配信方法。 請求書が発行されると、Square は配信方法と支払要求の設定に基づいて、即時または指定されている場合は、scheduled_at 日に請求書を処理します。

Sale or Service Date
invoice.sale_or_service_date string

販売日またはサービスの提供日 (YYYY-MM-DD 形式)。 このフィールドを使用して、請求書に表示される過去または将来の日付を指定できます。

請求書の検索

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

パラメーター

名前 キー 必須 説明
Location IDs
location_ids array of string
Customer IDs
customer_ids array of string
Field
field string

1 つ以上の顧客属性を並べ替えキーとして使用して、検索された顧客プロファイルを並べ替えます。

Order
order string

並べ替えフィールド値に基づいて結果を並べ替える順序を示します。 文字列は、標準のアルファベット比較を使用して順序を決定します。

Limit
limit integer

返す請求書の最大数 (200 が上限)。 指定しない場合、サーバーは既定値の上限である 100 件の請求書を使用します。

戻り値

名前 パス 説明
Invoices
invoices array of object
ID
invoices.id string

Square が発行した一意の識別子。

Version
invoices.version integer

オブジェクトの現在のバージョン。

Location ID
invoices.location_id string

場所の識別子。

Order ID
invoices.order_id string

受注の ID。

Payment Requests
invoices.payment_requests array of object
UID
invoices.payment_requests.uid string

Square で生成された請求書の支払要求 ID。

Request Type
invoices.payment_requests.request_type string

支払要求の種類を識別します。 この種類は、支払要求金額の決定方法を定義します。

Due Date
invoices.payment_requests.due_date string

YYYY-MM-DD 形式の支払い要求の期限 (請求書のタイム ゾーン)。

Tipping Enabled
invoices.payment_requests.tipping_enabled boolean

true に設定すると、Square がホストする請求書ページ (請求書の public_url フィールド) に、顧客がチップを支払う場所が提供されます。

reminders
invoices.payment_requests.reminders array of object

Reminders

UID
invoices.payment_requests.reminders.uid string

InvoicePaymentRequest 内のアラームを一意に識別する Square によって割り当てられた ID。

Relative Scheduled Days
invoices.payment_requests.reminders.relative_scheduled_days integer

アラームが送信されるときの支払要求 due_date の前 (負の数) または後 (正の数) の日数。

Message
invoices.payment_requests.reminders.message string

アラーム メッセージ。

Status
invoices.payment_requests.reminders.status string

アラームのステータス。

Amount
invoices.payment_requests.computed_amount_money.amount integer

金額。

Currency
invoices.payment_requests.computed_amount_money.currency string

通貨。

Amount
invoices.payment_requests.total_completed_amount_money.amount integer

金額。

Currency
invoices.payment_requests.total_completed_amount_money.currency string

通貨。

Automatic Payment Source
invoices.payment_requests.automatic_payment_source string

自動支払の支払方法。

Percentage Requested
invoices.payment_requests.percentage_requested string

支払い要求の金額をパーセントで指定します。

Card ID
invoices.payment_requests.card_id string

支払い要求に対して請求するファイル上のクレジット カードまたはデビット カードの ID。

Invoice Number
invoices.invoice_number string

わかりやすい請求書番号。

Title
invoices.title string

請求書のタイトル。

Description
invoices.description string

説明。

Scheduled At
invoices.scheduled_at string

請求書の処理が予定されているときのタイムスタンプ (RFC 3339 形式)。 請求書が発行されると、Square は配信方法と支払要求の設定に従って、指定日に請求書を処理します。

Status
invoices.status string

このオブジェクトの現在の検証状態。

Timezone
invoices.timezone string

due_date など、請求書のカレンダーの日付を解釈するために使用されるタイムゾーン。 請求書が作成されると、このフィールドは販売担当者の場所に指定されたタイムゾーンに設定されます。 値は変更できません。

Created At
invoices.created_at string

イベント時刻 (ISO 8601 形式)。

Updated At
invoices.updated_at string

最終変更タイムスタンプ (RFC 3339 形式)

Customer ID
invoices.primary_recipient.customer_id string

カードと関連付ける顧客の ID。

Given Name
invoices.primary_recipient.given_name string

受信者の名。

Family Name
invoices.primary_recipient.family_name string

受信者の姓。

Email Address
invoices.primary_recipient.email_address string

受信者のメール アドレス。

Phone Number
invoices.primary_recipient.phone_number string

受信者の電話番号。

Card
invoices.accepted_payment_methods.card boolean

クレジット カードまたはデビット カード決済の可否を示します。

Square Gift Card
invoices.accepted_payment_methods.square_gift_card boolean

Square ギフト カード決済の可否を示します。

Bank Account
invoices.accepted_payment_methods.bank_account boolean

銀行振込決済の可否を示します。

Custom Fields
invoices.custom_fields array of object
Label
invoices.custom_fields.label string

カスタム フィールドのラベルまたはタイトル。

Value
invoices.custom_fields.value string

カスタム フィールドのテキスト。

Placement
invoices.custom_fields.placement string

請求書のカスタム フィールドの場所

Delivery Method
invoices.delivery_method string

Square が請求書、アラーム、領収書を顧客に送信するために使用する配信方法。

Sale or Service Date
invoices.sale_or_service_date string

販売日またはサービスの提供日 (YYYY-MM-DD 形式)。 このフィールドを使用して、請求書に表示される過去または将来の日付を指定できます。

Public URL
invoices.public_url string

Square がホストする請求書ページの URL。 PublishInvoice エンドポイントを使用して請求書を発行すると、Square は請求書ページをホストし、応答でページ URL を返します。

Amount
invoices.next_payment_amount_money.amount integer

金額。

Currency
invoices.next_payment_amount_money.currency string

通貨。

Cursor
cursor string

このエンドポイントへの後続の呼び出しにページネーション カーソルを含めて、元のクエリに関連付けられた次の結果セットを取得します。

請求書の発行

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

パラメーター

名前 キー 必須 説明
Invoice ID
invoice_id True string

請求書の識別子。

Version
version integer

バージョン。

Idempotency Key
idempotency_key string

すべての要求の中でこの要求を一意に識別するために指定する値。 有効なべき等キーを作成する一般的な方法は、汎用一意識別子 (UUID) を使用することです。

戻り値

名前 パス 説明
ID
invoice.id string

Square が発行した一意の識別子。

Version
invoice.version integer

このオブジェクトの現在のバージョン。

Location ID
invoice.location_id string

場所の識別子。

Order ID
invoice.order_id string

受注の ID。

Payment Requests
invoice.payment_requests array of object
UID
invoice.payment_requests.uid string

Square で生成された ID。

Request Type
invoice.payment_requests.request_type string

支払要求の種類を識別します。 この種類は、支払要求金額の決定方法を定義します。

Due Date
invoice.payment_requests.due_date string

支払要求の期限 (YYYY-MM-DD 形式)。

Tipping Enabled
invoice.payment_requests.tipping_enabled boolean

true に設定すると、顧客がチップを支払う場所が提供されます。

Reminders
invoice.payment_requests.reminders array of object
UID
invoice.payment_requests.reminders.uid string

Square で割り当てられた ID。

Relative Scheduled Days
invoice.payment_requests.reminders.relative_scheduled_days integer

アラームが送信されるときの支払要求 due_date の前 (負の数) または後 (正の数) の日数。

Message
invoice.payment_requests.reminders.message string

メッセージ。

Status
invoice.payment_requests.reminders.status string

現在の状態。

Amount
invoice.payment_requests.computed_amount_money.amount integer

金額。

Currency
invoice.payment_requests.computed_amount_money.currency string

通貨。

Amount
invoice.payment_requests.total_completed_amount_money.amount integer

金額。

Currency
invoice.payment_requests.total_completed_amount_money.currency string

通貨。

Automatic Payment Source
invoice.payment_requests.automatic_payment_source string

自動支払の支払方法。

Invoice Number
invoice.invoice_number string

わかりやすい請求書番号。 値は場所内で一意です。 請求書の作成時に指定されていない場合、Square は値を割り当てます。

Title
invoice.title string

タイトル。

Description
invoice.description string

説明。

Scheduled At
invoice.scheduled_at string

処理がスケジュールされたときのタイムスタンプ (RFC 3339 形式)。

Status
invoice.status string

このオブジェクトの現在の検証状態。

Timezone
invoice.timezone string

カレンダーの日付を解釈するために使用されるタイム ゾーン。 請求書が作成されると、このフィールドは販売担当者の場所に指定されたタイムゾーンに設定されます。 値は変更できません。

Created At
invoice.created_at string

このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。

更新日時
invoice.updated_at string

このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。

Customer ID
invoice.primary_recipient.customer_id string

受注に関連付けられた顧客 ID。

Given Name
invoice.primary_recipient.given_name string

受信者の名。

Family Name
invoice.primary_recipient.family_name string

受信者の姓。

Email Address
invoice.primary_recipient.email_address string

受信者のメール アドレス。

Phone Number
invoice.primary_recipient.phone_number string

受信者の電話番号。

Public URL
invoice.public_url string

Square がホストする請求書ページの URL。 PublishInvoice エンドポイントを使用して請求書を発行すると、Square は請求書ページをホストし、応答でページ URL を返します。

Card
invoice.accepted_payment_methods.card boolean

クレジット カードまたはデビット カード決済の可否を示します。

Square Gift Card
invoice.accepted_payment_methods.square_gift_card boolean

Square ギフト カード決済の可否を示します。

Bank Account
invoice.accepted_payment_methods.bank_account boolean

銀行振込決済の可否を示します。

Custom Fields
invoice.custom_fields array of object
Label
invoice.custom_fields.label string

カスタム フィールドのラベルまたはタイトル。

Value
invoice.custom_fields.value string

カスタム フィールドのテキスト。

Placement
invoice.custom_fields.placement string

請求書のカスタム フィールドの場所。

Delivery Method
invoice.delivery_method string

Square が請求書、アラーム、領収書を顧客に送信するために使用する配信方法。 請求書が発行されると、Square は配信方法と支払要求の設定に基づいて、即時または指定されている場合は、scheduled_at 日に請求書を処理します。

Sale or Service Date
invoice.sale_or_service_date string

販売日またはサービスの提供日 (YYYY-MM-DD 形式)。 このフィールドを使用して、請求書に表示される過去または将来の日付を指定できます。

顧客からグループを削除

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

パラメーター

名前 キー 必須 説明
Customer ID
customer_id True string

顧客の識別子。

Group ID
group_id True string

グループの識別子。

戻り値

response
object

顧客にグループを追加

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

パラメーター

名前 キー 必須 説明
Customer ID
customer_id True string

顧客の識別子。

Group ID
group_id True string

グループの識別子。

戻り値

response
object

顧客の一覧表示

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

パラメーター

名前 キー 必須 説明
Cursor
cursor string

このエンドポイントへの前回の呼び出しによって返されたページネーション カーソル。

Limit
limit integer

応答で返す数の上限。

Sort Field
sort_field string

顧客の並べ替え方法を示します。 既定値は DEFAULT です。

Sort Order
sort_order string

返された一覧を、指定された順序でカードが作成された日時で並べ替えます。

戻り値

名前 パス 説明
Customers
customers array of object
ID
customers.id string

Square が発行した一意の識別子。

Created At
customers.created_at string

イベント時刻 (ISO 8601 形式)。

Updated At
customers.updated_at string

最終変更タイムスタンプ (RFC 3339 形式)

Given Name
customers.given_name string

顧客プロファイルに関連付けられた名 (つまり、下の名前)。

Family Name
customers.family_name string

顧客プロファイルに関連付けられた姓 (つまり、苗字)。

Email Address
customers.email_address string

顧客プロファイルに関連付けられたメール アドレス。

Address Line 1
customers.address.address_line_1 string

住所の 1 行目。

Address Line 2
customers.address.address_line_2 string

住所の 2 行目 (存在する場合)。

Locality
customers.address.locality string

住所の市区町村。

Administrative District Level 1
customers.address.administrative_district_level_1 string

住所の国内にある市民エンティティ。 米国では、これは州です。

Postal Code
customers.address.postal_code string

住所の郵便番号。

Country
customers.address.country string

住所の国 (ISO 3166-1-alpha-2 形式)。

Phone Number
customers.phone_number string

顧客プロファイルに関連付けられた 11 桁の電話番号。

Reference ID
customers.reference_id string

顧客プロファイルを別のシステムのエンティティに関連付けるために使用されるオプションの 2 番目の ID。

Note
customers.note string

顧客プロファイルに関連付けられたカスタム メモ。

Email Unsubscribed
customers.preferences.email_unsubscribed boolean

顧客がマーケティング キャンペーンのメール購読を解除したかどうかを示します。 true の値は、顧客が現在の Square 販売担当者またはすべての Square 販売担当者からのメール マーケティングを停止することを選択したことを意味します。 この値は、Customers API からの読み取り専用です。

Creation Source
customers.creation_source string

作成ソースは、顧客プロファイルの作成に使用される方法を表します。

Group IDs
customers.group_ids array of string
Segment IDs
customers.segment_ids array of string
Version
customers.version integer

オブジェクトの現在のバージョン。

顧客の作成

ビジネスの新規顧客を作成します。

パラメーター

名前 キー 必須 説明
Given Name
given_name string

顧客プロファイルに関連付けられた名 (つまり、下の名前)。

Family Name
family_name string

顧客プロファイルに関連付けられた苗字 (つまり、姓)。

Email Address
email_address string

顧客プロファイルに関連付けられたメール アドレス。

Company Name
company_name string

顧客プロファイルに関連付けられた事業所名。

Nickname
nickname string

顧客プロファイルのニックネーム。

Address Line 1
address_line_1 string

住所の 1 行目。

Address Line 2
address_line_2 string

住所の 2 行目 (存在する場合)。

Locality
locality string

住所の市区町村。

Administrative District Level 1
administrative_district_level_1 string

住所の国内にある市民エンティティ。 米国では、これは州です。

Postal Code
postal_code string

住所の郵便番号。

Country
country string

ISO 3166 Alpha-2 国コード。

Phone Number
phone_number string

顧客プロファイルに関連付けられた 11 桁の電話番号。

Reference ID
reference_id string

顧客プロファイルを別のシステムのエンティティに関連付けるために使用されるオプションの 2 番目の ID。

Note
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 形式)。

Given Name
customer.given_name string

顧客プロファイルに関連付けられた名 (つまり、下の名前)。

Family Name
customer.family_name string

顧客プロファイルに関連付けられた姓 (つまり、苗字)。

Email Address
customer.email_address string

顧客プロファイルに関連付けられたメール アドレス。

Company Name
customer.company_name string

顧客プロファイルに関連付けられた事業所名。

Nickname
customer.nickname string

顧客プロファイルのニックネーム。

Address Line 1
customer.address.address_line_1 string

住所の 1 行目。 address_line で始まるフィールドは、番地、通りの名前、建物名など、住所の最も具体的な詳細を指定します。

Address Line 2
customer.address.address_line_2 string

住所の 2 行目 (存在する場合)。

Locality
customer.address.locality string

住所の市区町村。

Administrative District Level 1
customer.address.administrative_district_level_1 string

住所の国内にある市民エンティティ。 米国では、これは州です。

Postal Code
customer.address.postal_code string

住所の郵便番号。

Country
customer.address.country string

住所の国 (ISO 3166-1-alpha-2 形式)。

Phone Number
customer.phone_number string

顧客プロファイルに関連付けられた 11 桁の電話番号。

Reference ID
customer.reference_id string

オプションのユーザー定義参照 ID。

Note
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 日の誕生日を表します。

Email Unsubscribed
customer.preferences.email_unsubscribed boolean

顧客がマーケティング キャンペーンのメール購読を解除したかどうかを示します。 true の値は、顧客が現在の Square 販売担当者またはすべての Square 販売担当者からのメール マーケティングを停止することを選択したことを意味します。

Creation Source
customer.creation_source string

作成ソースは、顧客プロファイルの作成に使用される方法を表します。

Version
customer.version integer

このオブジェクトの現在のバージョン。

顧客の削除

ビジネスから顧客プロファイルを削除します。 この操作では、ファイル上の関連カードのリンクも解除されます。

パラメーター

名前 キー 必須 説明
Customer ID
customer_id True string

顧客の識別子。

戻り値

response
object

顧客の取得

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

パラメーター

名前 キー 必須 説明
Customer ID
customer_id True string

顧客の識別子。

戻り値

名前 パス 説明
ID
customer.id string

Square が発行した一意の識別子。

Created At
customer.created_at string

このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。

更新日時
customer.updated_at string

このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。

Given Name
customer.given_name string

顧客プロファイルに関連付けられた名 (つまり、下の名前)。

Family Name
customer.family_name string

顧客プロファイルに関連付けられた姓 (つまり、苗字)。

Email Address
customer.email_address string

顧客プロファイルに関連付けられたメール アドレス。

Address Line 1
customer.address.address_line_1 string

住所の 1 行目。 address_line で始まるフィールドは、番地、通りの名前、建物名など、住所の最も具体的な詳細を指定します。

Address Line 2
customer.address.address_line_2 string

住所の 2 行目 (存在する場合)。

Locality
customer.address.locality string

住所の市区町村。

Administrative District Level 1
customer.address.administrative_district_level_1 string

住所の国内にある市民エンティティ。 米国では、これは州です。

Postal Code
customer.address.postal_code string

住所の郵便番号。

Country
customer.address.country string

住所の国 (ISO 3166-1-alpha-2 形式)。

Phone Number
customer.phone_number string

顧客プロファイルに関連付けられた 11 桁の電話番号。

Reference ID
customer.reference_id string

オプションのユーザー定義参照 ID。

Note
customer.note string

顧客プロファイルに関連付けられたカスタム メモ。

Email Unsubscribed
customer.preferences.email_unsubscribed boolean

顧客がマーケティング キャンペーンのメール購読を解除したかどうかを示します。 true の値は、顧客が現在の Square 販売担当者またはすべての Square 販売担当者からのメール マーケティングを停止することを選択したことを意味します。

Creation Source
customer.creation_source string

作成ソースは、顧客プロファイルの作成に使用される方法を表します。

Group IDs
customer.group_ids array of string
Segment IDs
customer.segment_ids array of string
Version
customer.version integer

このオブジェクトの現在のバージョン。

顧客の更新

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

パラメーター

名前 キー 必須 説明
Customer ID
customer_id True string

顧客の識別子。

戻り値

名前 パス 説明
ID
customer.id string

Square が発行した一意の識別子。

Created At
customer.created_at string

このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。

更新日時
customer.updated_at string

このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。

Given Name
customer.given_name string

顧客プロファイルに関連付けられた名 (つまり、下の名前)。

Family Name
customer.family_name string

顧客プロファイルに関連付けられた姓 (つまり、苗字)。

Email Address
customer.email_address string

顧客プロファイルに関連付けられたメール アドレス。

Address Line 1
customer.address.address_line_1 string

住所の 1 行目。 address_line で始まるフィールドは、番地、通りの名前、建物名など、住所の最も具体的な詳細を指定します。

Address Line 2
customer.address.address_line_2 string

住所の 2 行目 (存在する場合)。

Locality
customer.address.locality string

住所の市区町村。

Administrative District Level 1
customer.address.administrative_district_level_1 string

住所の国内にある市民エンティティ。 米国では、これは州です。

Postal Code
customer.address.postal_code string

住所の郵便番号。

Country
customer.address.country string

住所の国 (ISO 3166-1-alpha-2 形式)。

Reference ID
customer.reference_id string

オプションのユーザー定義参照 ID。

Note
customer.note string

顧客プロファイルに関連付けられたカスタム メモ。

Email Unsubscribed
customer.preferences.email_unsubscribed boolean

顧客がマーケティング キャンペーンのメール購読を解除したかどうかを示します。 true の値は、顧客が現在の Square 販売担当者またはすべての Square 販売担当者からのメール マーケティングを停止することを選択したことを意味します。

Creation Source
customer.creation_source string

作成ソースは、顧客プロファイルの作成に使用される方法を表します。

Version
customer.version integer

このオブジェクトの現在のバージョン。

顧客の検索

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

パラメーター

名前 キー 必須 説明
Fuzzy
fuzzy string

ファジー フィルターを使用して、属性が指定されたクエリとファジーな方法で一致する顧客を選択します。 ファジー オプションを使用する場合、検索クエリがトークン化され、各クエリ トークンが検索された属性のどこかに一致する必要があります。 1 つのトークン クエリの場合、これは実質的に部分一致操作と同じ動作です。

Values
values array of string
Rule
rule string

フィルター条件に一致する顧客プロファイルを結果に含めるか、結果から除外するかを示します。

Start At
start_at string

時間範囲の開始時刻を示す RFC 3339 形式の datetime 値。

End At
end_at string

時間範囲の終了時刻を示す RFC 3339 形式の datetime 値。

All
all array of string
Field
field string

1 つ以上の顧客属性を並べ替えキーとして使用して、検索された顧客プロファイルを並べ替えます。

Order
order string

並べ替えフィールド値に基づいて結果を並べ替える順序を示します。 文字列は、標準のアルファベット比較を使用して順序を決定します。

Limit
limit integer

1 ページに返される結果の数の制限。 制限は推奨値であり、実装によって返される結果が増減する可能性があります。 指定された制限が負、ゼロ、または最大制限の 1,000 より大きい場合、無視されます。

戻り値

名前 パス 説明
Customers
customers array of object
ID
customers.id string

Square が発行した一意の識別子。

Created At
customers.created_at string

イベント時刻 (ISO 8601 形式)。

Updated At
customers.updated_at string

最終変更タイムスタンプ (RFC 3339 形式)

Given Name
customers.given_name string

顧客プロファイルに関連付けられた名 (つまり、下の名前)。

Family Name
customers.family_name string

顧客プロファイルに関連付けられた姓 (つまり、苗字)。

Email Address
customers.email_address string

顧客プロファイルに関連付けられたメール アドレス。

Address Line 1
customers.address.address_line_1 string

住所の 1 行目。

Address Line 2
customers.address.address_line_2 string

住所の 2 行目 (存在する場合)。

Locality
customers.address.locality string

住所の市区町村。

Administrative District Level 1
customers.address.administrative_district_level_1 string

住所の国内にある市民エンティティ。 米国では、これは州です。

Postal Code
customers.address.postal_code string

住所の郵便番号。

Country
customers.address.country string

住所の国 (ISO 3166-1-alpha-2 形式)。

Phone Number
customers.phone_number string

顧客プロファイルに関連付けられた 11 桁の電話番号。

Reference ID
customers.reference_id string

顧客プロファイルを別のシステムのエンティティに関連付けるために使用されるオプションの 2 番目の ID。

Email Unsubscribed
customers.preferences.email_unsubscribed boolean

顧客がマーケティング キャンペーンのメール購読を解除したかどうかを示します。 true の値は、顧客が現在の Square 販売担当者またはすべての Square 販売担当者からのメール マーケティングを停止することを選択したことを意味します。 この値は、Customers API からの読み取り専用です。

Creation Source
customers.creation_source string

作成ソースは、顧客プロファイルの作成に使用される方法を表します。

Group IDs
customers.group_ids array of string
Segment IDs
customers.segment_ids array of string
Version
customers.version integer

オブジェクトの現在のバージョン。

Note
customers.note string

顧客プロファイルに関連付けられたカスタム メモ。

Cursor
cursor string

このエンドポイントへの後続の呼び出しにページネーション カーソルを含めて、元のクエリに関連付けられた次の結果セットを取得します。

顧客グループの一覧表示

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

戻り値

名前 パス 説明
Groups
groups array of object
ID
groups.id string

Square が発行した一意の識別子。

Name
groups.name string

オブジェクトの名前。

Created At
groups.created_at string

イベント時刻 (ISO 8601 形式)。

Updated At
groups.updated_at string

最終変更タイムスタンプ (RFC 3339 形式)

顧客グループの作成

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

パラメーター

名前 キー 必須 説明
Name
name string

オブジェクトの名前。

戻り値

名前 パス 説明
ID
group.id string

Square が発行した一意の識別子。

Name
group.name string

オブジェクトの名前。

Created At
group.created_at string

このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。

更新日時
group.updated_at string

このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。

顧客グループの削除

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

パラメーター

名前 キー 必須 説明
Group ID
group_id True string

グループの識別子。

戻り値

response
object

顧客グループの取得

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

パラメーター

名前 キー 必須 説明
Group ID
group_id True string

グループの識別子。

戻り値

名前 パス 説明
ID
group.id string

Square が発行した一意の識別子。

Name
group.name string

オブジェクトの名前。

Created At
group.created_at string

このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。

更新日時
group.updated_at string

このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。

顧客グループの更新

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

パラメーター

名前 キー 必須 説明
Group ID
group_id True string

グループの識別子。

Name
name string

オブジェクトの名前。

戻り値

名前 パス 説明
ID
group.id string

Square が発行した一意の識別子。

Name
group.name string

オブジェクトの名前。

Created At
group.created_at string

このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。

更新日時
group.updated_at string

このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。

顧客区分の一覧表示

ビジネスの顧客区分の一覧を取得します。

パラメーター

名前 キー 必須 説明
Cursor
cursor string

このエンドポイントへの前回の呼び出しによって返されたページネーション カーソル。

Limit
limit integer

応答で返す数の上限。

戻り値

名前 パス 説明
Segments
segments array of object
ID
segments.id string

Square が発行した一意の識別子。

Name
segments.name string

オブジェクトの名前。

Created At
segments.created_at string

イベント時刻 (ISO 8601 形式)。

Updated At
segments.updated_at string

最終変更タイムスタンプ (RFC 3339 形式)

顧客区分の取得

特定の顧客区分を取得します。

パラメーター

名前 キー 必須 説明
Segment ID
segment_id True string

区分の識別子。

戻り値

名前 パス 説明
ID
segment.id string

Square が発行した一意の識別子。

Name
segment.name string

オブジェクトの名前。

Created At
segment.created_at string

このオブジェクトの作成時刻を指定するタイムスタンプ (RFC 3339 形式)。

更新日時
segment.updated_at string

このオブジェクトの最新更新時刻を指定するタイムスタンプ (RFC 3339 形式)。

定義

オブジェクト

’オブジェクト’ という種類です。