転送元 - Square | TROCCO Docs

本ページでは、Squareからデータを取得するための設定（転送設定）について説明します。
接続に関する設定については、Square接続情報を参照ください。

設定項目

STEP1 基本設定

項目名	必須	デフォルト値	説明
取得対象	✓	支払い一覧	取得対象を選択します。

取得対象

支払い一覧

支払い一覧を取得します。
詳しくは、Square公式ドキュメント − List paymentsを参照ください。

設定項目

項目名	必須	デフォルト値	説明
店舗ID	-	-	指定した店舗の支払いのみを取得します。省略した場合は、メイン店舗の支払いを取得します。なお、店舗ID(`location_id`)は、Square Developer Portalで作成したアプリの`Locations`から確認できます。
開始時刻	-	-	指定した日時以降に作成された支払いを取得します。`YYYY-MM-DDTHH:MM:SSZ`形式で入力してください。省略した場合は、現在時刻の1年前が適用されます。
終了時刻	-	-	取得する支払いの作成日時の終了日時を指定できます。`YYYY-MM-DDTHH:MM:SSZ`形式で入力してください。

取得データ

カラム名	デフォルトのデータ型	補足事項
`id`	`string`	支払いID
`created_at`	`string`	作成日時（RFC 3339形式）
`updated_at`	`string`	更新日時（RFC 3339形式）
`amount_money`	`json`	支払い金額（チップを除く）
`tip_money`	`json`	チップ金額
`total_money`	`json`	合計金額（チップを含む）
`app_fee_money`	`json`	アプリケーション手数料
`approved_money`	`json`	承認済み金額
`processing_fee`	`json`	決済手数料
`refunded_money`	`json`	返金済み金額
`status`	`string`	支払いのステータス
`delay_duration`	`string`	支払い確定までの猶予期間
`delay_action`	`string`	猶予期間経過後のアクション
`delayed_until`	`string`	猶予期間の期限日時（RFC 3339形式）
`source_type`	`string`	支払い方法の種類
`card_details`	`json`	カード支払いの詳細
`cash_details`	`json`	現金支払いの詳細
`bank_account_details`	`json`	銀行口座支払いの詳細
`external_details`	`json`	外部支払いの詳細
`wallet_details`	`json`	ウォレット支払いの詳細
`buy_now_pay_later_details`	`json`	後払い決済の詳細
`square_account_details`	`json`	Squareアカウント支払いの詳細
`location_id`	`string`	店舗ID
`order_id`	`string`	注文ID
`reference_id`	`string`	外部システムの参照ID
`customer_id`	`string`	顧客ID
`team_member_id`	`string`	支払いを処理したスタッフのID
`refund_ids`	`json`	返金IDの一覧
`buyer_email_address`	`string`	購入者のメールアドレス
`billing_address`	`json`	請求先住所
`shipping_address`	`json`	配送先住所
`note`	`string`	メモ
`statement_description_identifier`	`string`	明細書に表示される識別子
`capabilities`	`json`	支払いに対して実行可能な操作
`receipt_number`	`string`	レシート番号
`receipt_url`	`string`	レシートのURL
`device_details`	`json`	支払いに使用されたデバイスの詳細
`application_details`	`json`	支払いを作成したアプリケーションの詳細
`is_offline_payment`	`boolean`	オフライン支払いかどうか
`offline_payment_details`	`json`	オフライン支払いの詳細
`version_token`	`string`	楽観的同時実行制御用のバージョントークン

返金一覧

返金一覧を取得します。
詳しくは、Square公式ドキュメント − List payment refundsを参照ください。

設定項目

項目名	必須	デフォルト値	説明
開始時刻	-	-	取得する返金の作成日時の開始日時を指定できます。`YYYY-MM-DDTHH:MM:SSZ`形式で入力してください。省略した場合は、現在時刻の1年前が適用されます。
終了時刻	-	-	取得する返金の作成日時の終了日時を指定できます。`YYYY-MM-DDTHH:MM:SSZ`形式で入力してください。

取得データ

カラム名	デフォルトのデータ型	補足事項
`id`	`string`	返金ID
`status`	`string`	返金のステータス
`location_id`	`string`	店舗ID
`unlinked`	`boolean`	支払いに紐づかない返金かどうか
`destination_type`	`string`	返金先の種類
`destination_details`	`json`	返金先の詳細
`amount_money`	`json`	返金金額
`app_fee_money`	`json`	アプリケーション手数料の返金額
`processing_fee`	`json`	決済手数料
`payment_id`	`string`	返金元の支払いID
`order_id`	`string`	注文ID
`reason`	`string`	返金理由
`created_at`	`string`	作成日時（RFC 3339形式）
`updated_at`	`string`	更新日時（RFC 3339形式）
`team_member_id`	`string`	返金を処理したスタッフのID

支払いリンク一覧

支払いリンク一覧を取得します。
詳しくは、Square公式ドキュメント − List payment linksを参照ください。

設定項目

設定項目はありません。

取得データ

カラム名	デフォルトのデータ型	補足事項
`id`	`string`	支払いリンクID
`version`	`long`	バージョン
`description`	`string`	説明
`order_id`	`string`	注文ID
`checkout_options`	`json`	チェックアウトのオプション
`pre_populated_data`	`json`	チェックアウト画面に事前入力されるデータ
`url`	`string`	支払いリンクの短縮URL
`long_url`	`string`	支払いリンクのURL
`created_at`	`string`	作成日時（RFC 3339形式）
`updated_at`	`string`	更新日時（RFC 3339形式）
`payment_note`	`string`	支払いに付与されるメモ

チャージバック一覧

チャージバック一覧を取得します。
詳しくは、Square公式ドキュメント − List disputesを参照ください。

設定項目

設定項目はありません。

取得データ

カラム名	デフォルトのデータ型	補足事項
`id`	`string`	チャージバックID
`amount_money`	`json`	チャージバックの対象金額
`reason`	`string`	チャージバックの理由
`state`	`string`	チャージバックのステータス
`due_at`	`string`	証拠の提出期限（RFC 3339形式）
`disputed_payment`	`json`	チャージバック対象の支払い情報
`card_brand`	`string`	カードブランド
`created_at`	`string`	作成日時（RFC 3339形式）
`updated_at`	`string`	更新日時（RFC 3339形式）
`brand_dispute_id`	`string`	カードブランドが発行したチャージバックID
`reported_at`	`string`	チャージバックが報告された日時（RFC 3339形式）
`version`	`long`	バージョン
`location_id`	`string`	店舗ID

チャージバック証拠一覧

指定したチャージバックの証拠一覧を取得します。
詳しくは、Square公式ドキュメント − List dispute evidenceを参照ください。

設定項目

項目名	必須	デフォルト値	説明
チャージバックID	✓	-	証拠を取得するチャージバックのID（`dispute_id`）を入力します。チャージバックIDは、チャージバック一覧から取得できます。

取得データ

カラム名	デフォルトのデータ型	補足事項
`id`	`string`	証拠ID
`dispute_id`	`string`	チャージバックID
`evidence_file`	`json`	証拠ファイルの情報
`evidence_text`	`string`	証拠のテキスト
`uploaded_at`	`string`	アップロード日時（RFC 3339形式）
`evidence_type`	`string`	証拠の種類

請求書一覧

指定した店舗の請求書一覧を取得します。
詳しくは、Square公式ドキュメント − List invoicesを参照ください。

設定項目

項目名	必須	デフォルト値	説明
店舗ID	✓	-	請求書を取得する店舗のIDを入力します。店舗ID(`location_id`)は、Square Developer Portalで作成したアプリの`Locations`から確認できます。

取得データ

カラム名	デフォルトのデータ型	補足事項
`id`	`string`	請求書ID
`version`	`long`	バージョン
`location_id`	`string`	店舗ID
`order_id`	`string`	注文ID
`primary_recipient`	`json`	請求先の顧客情報
`payment_requests`	`json`	支払い請求の情報
`delivery_method`	`string`	請求書の送付方法
`invoice_number`	`string`	請求書番号
`title`	`string`	タイトル
`description`	`string`	説明
`scheduled_at`	`string`	請求書の送付予定日時（RFC 3339形式）
`public_url`	`string`	請求書の公開URL
`next_payment_amount_money`	`json`	次回の支払い金額
`status`	`string`	請求書のステータス
`timezone`	`string`	タイムゾーン
`created_at`	`string`	作成日時（RFC 3339形式）
`updated_at`	`string`	更新日時（RFC 3339形式）
`accepted_payment_methods`	`json`	利用可能な支払い方法
`custom_fields`	`json`	カスタムフィールド
`subscription_id`	`string`	サブスクリプションID
`sale_or_service_date`	`string`	販売日またはサービス提供日
`payment_conditions`	`string`	支払い条件
`store_payment_method_enabled`	`boolean`	支払い方法の保存を許可するかどうか
`attachments`	`json`	添付ファイルの情報

カード一覧

カード一覧を取得します。
詳しくは、Square公式ドキュメント − List cardsを参照ください。

設定項目

項目名	必須	デフォルト値	説明
無効化されたカードを含める	-	OFF	ONにすると、無効化されたカードも取得します。詳しくは、List cardsを参照ください。

取得データ

カラム名	デフォルトのデータ型	補足事項
`id`	`string`	カードID
`card_brand`	`string`	カードブランド
`last_4`	`string`	カード番号の下4桁
`exp_month`	`long`	有効期限（月）
`exp_year`	`long`	有効期限（年）
`cardholder_name`	`string`	カード名義人
`billing_address`	`json`	請求先住所
`fingerprint`	`string`	カードを識別するためのフィンガープリント
`customer_id`	`string`	顧客ID
`merchant_id`	`string`	販売者ID
`reference_id`	`string`	外部システムの参照ID
`enabled`	`boolean`	カードが有効かどうか
`card_type`	`string`	カードの種類
`prepaid_type`	`string`	プリペイドカードの種類
`bin`	`string`	BIN（カード番号の先頭6桁）
`version`	`long`	バージョン
`card_co_brand`	`string`	コブランドカードのブランド

サブスクリプション一覧

サブスクリプション一覧を取得します。
詳しくは、Square公式ドキュメント − Search subscriptionsを参照ください。

設定項目

設定項目はありません。

取得データ

カラム名	デフォルトのデータ型	補足事項
`id`	`string`	サブスクリプションID
`location_id`	`string`	店舗ID
`plan_variation_id`	`string`	サブスクリプションプランのバリエーションID
`customer_id`	`string`	顧客ID
`start_date`	`string`	開始日（`YYYY-MM-DD`形式）
`canceled_date`	`string`	キャンセル日（`YYYY-MM-DD`形式）
`charged_through_date`	`string`	請求済みの期間の終了日（`YYYY-MM-DD`形式）
`status`	`string`	サブスクリプションのステータス
`tax_percentage`	`string`	税率
`invoice_ids`	`json`	請求書IDの一覧
`price_override_money`	`json`	プラン価格を上書きする金額
`version`	`long`	バージョン
`created_at`	`string`	作成日時（RFC 3339形式）
`card_id`	`string`	支払いに使用するカードのID
`timezone`	`string`	タイムゾーン
`phases`	`json`	サブスクリプションのフェーズ情報

注文一覧

指定した店舗の注文一覧を取得します。
詳しくは、Square公式ドキュメント − Search ordersを参照ください。

設定項目

項目名	必須	デフォルト値	説明
店舗ID	✓	-	注文を取得する店舗のIDを入力します。最大10件まで、複数の店舗IDを入力できます。店舗ID(`location_id`)は、Square Developer Portalで作成したアプリの`Locations`から確認できます。

取得データ

カラム名	デフォルトのデータ型	補足事項
`id`	`string`	注文ID
`location_id`	`string`	店舗ID
`reference_id`	`string`	外部システムの参照ID
`source`	`json`	注文の作成元
`line_items`	`json`	注文の明細
`taxes`	`json`	税金の情報
`discounts`	`json`	割引の情報
`service_charges`	`json`	サービス料の情報
`fulfillments`	`json`	受け渡し（配送・店頭受取など）の情報
`created_at`	`string`	作成日時（RFC 3339形式）
`updated_at`	`string`	更新日時（RFC 3339形式）
`closed_at`	`string`	完了日時（RFC 3339形式）
`state`	`string`	注文のステータス
`total_money`	`json`	合計金額
`total_tax_money`	`json`	税金の合計金額
`total_discount_money`	`json`	割引の合計金額
`total_tip_money`	`json`	チップの合計金額
`total_service_charge_money`	`json`	サービス料の合計金額
`pricing_options`	`json`	価格設定のオプション
`net_amount_due_money`	`json`	未払いの金額

カタログ一覧

カタログ（商品・カテゴリ・税金・割引など）の一覧を取得します。
詳しくは、Square公式ドキュメント − List catalogを参照ください。

設定項目

設定項目はありません。

取得データ

カラム名	デフォルトのデータ型	補足事項
`type`	`string`	カタログオブジェクトの種類
`id`	`string`	カタログオブジェクトID
`updated_at`	`string`	更新日時（RFC 3339形式）
`version`	`long`	バージョン
`is_deleted`	`boolean`	削除済みかどうか
`custom_attribute_values`	`json`	カスタム属性の値
`catalog_v1_ids`	`json`	旧Catalog API（v1）のID
`present_at_all_locations`	`boolean`	すべての店舗で利用可能かどうか
`present_at_location_ids`	`json`	利用可能な店舗IDの一覧
`absent_at_location_ids`	`json`	利用不可の店舗IDの一覧
`item_data`	`json`	商品の情報（`type`が`ITEM`の場合）
`category_data`	`json`	カテゴリの情報（`type`が`CATEGORY`の場合）
`item_variation_data`	`json`	商品バリエーションの情報（`type`が`ITEM_VARIATION`の場合）
`tax_data`	`json`	税金の情報（`type`が`TAX`の場合）
`discount_data`	`json`	割引の情報（`type`が`DISCOUNT`の場合）
`modifier_list_data`	`json`	オプションリストの情報（`type`が`MODIFIER_LIST`の場合）
`modifier_data`	`json`	オプションの情報（`type`が`MODIFIER`の場合）
`time_period_data`	`json`	期間の情報（`type`が`TIME_PERIOD`の場合）
`product_set_data`	`json`	商品セットの情報（`type`が`PRODUCT_SET`の場合）
`pricing_rule_data`	`json`	価格ルールの情報（`type`が`PRICING_RULE`の場合）
`image_data`	`json`	画像の情報（`type`が`IMAGE`の場合）
`measurement_unit_data`	`json`	計量単位の情報（`type`が`MEASUREMENT_UNIT`の場合）
`subscription_plan_data`	`json`	サブスクリプションプランの情報（`type`が`SUBSCRIPTION_PLAN`の場合）
`item_option_data`	`json`	商品オプションの情報（`type`が`ITEM_OPTION`の場合）
`item_option_value_data`	`json`	商品オプション値の情報（`type`が`ITEM_OPTION_VAL`の場合）
`custom_attribute_definition_data`	`json`	カスタム属性定義の情報（`type`が`CUSTOM_ATTRIBUTE_DEFINITION`の場合）
`subscription_plan_variation_data`	`json`	サブスクリプションプランバリエーションの情報（`type`が`SUBSCRIPTION_PLAN_VARIATION`の場合）
`availability_period_data`	`json`	提供可能期間の情報（`type`が`AVAILABILITY_PERIOD`の場合）

在庫数一覧

在庫数の一覧を取得します。
詳しくは、Square公式ドキュメント − Batch retrieve inventory countsを参照ください。

設定項目

設定項目はありません。

取得データ

カラム名	デフォルトのデータ型	補足事項
`catalog_object_id`	`string`	カタログオブジェクトID
`catalog_object_type`	`string`	カタログオブジェクトの種類
`state`	`string`	在庫の状態
`location_id`	`string`	店舗ID
`quantity`	`string`	在庫数
`calculated_at`	`string`	在庫数の算出日時（RFC 3339形式）

顧客一覧

顧客一覧を取得します。
詳しくは、Square公式ドキュメント − List customersを参照ください。

設定項目

設定項目はありません。

取得データ

カラム名	デフォルトのデータ型	補足事項
`id`	`string`	顧客ID
`created_at`	`string`	作成日時（RFC 3339形式）
`updated_at`	`string`	更新日時（RFC 3339形式）
`given_name`	`string`	名
`family_name`	`string`	姓
`nickname`	`string`	ニックネーム
`company_name`	`string`	会社名
`email_address`	`string`	メールアドレス
`address`	`json`	住所
`phone_number`	`string`	電話番号
`birthday`	`string`	誕生日
`reference_id`	`string`	外部システムの参照ID
`note`	`string`	メモ
`preferences`	`json`	顧客の設定（メール配信の可否など）
`creation_source`	`string`	顧客情報の作成元
`group_ids`	`json`	所属する顧客グループIDの一覧
`segment_ids`	`json`	所属する顧客セグメントIDの一覧
`version`	`long`	バージョン
`tax_ids`	`json`	税務IDの情報

顧客カスタムフィールド一覧

顧客カスタムフィールド（カスタム属性）の定義一覧を取得します。
詳しくは、Square公式ドキュメント − List customer custom attribute definitionsを参照ください。

設定項目

設定項目はありません。

取得データ

カラム名	デフォルトのデータ型	補足事項
`key`	`string`	カスタム属性のキー
`schema`	`json`	カスタム属性のデータ型を定義するスキーマ
`name`	`string`	カスタム属性名
`description`	`string`	説明
`visibility`	`string`	他のアプリケーションへの公開範囲
`version`	`long`	バージョン
`updated_at`	`string`	更新日時（RFC 3339形式）
`created_at`	`string`	作成日時（RFC 3339形式）

スタッフ一覧

スタッフ（チームメンバー）一覧を取得します。
詳しくは、Square公式ドキュメント − Search team membersを参照ください。

設定項目

設定項目はありません。

取得データ

カラム名	デフォルトのデータ型	補足事項
`id`	`string`	スタッフID
`reference_id`	`string`	外部システムの参照ID
`is_owner`	`boolean`	アカウントのオーナーかどうか
`status`	`string`	スタッフのステータス
`given_name`	`string`	名
`family_name`	`string`	姓
`email_address`	`string`	メールアドレス
`phone_number`	`string`	電話番号
`created_at`	`string`	作成日時（RFC 3339形式）
`updated_at`	`string`	更新日時（RFC 3339形式）
`assigned_locations`	`json`	担当店舗の情報