This integration is certified by Stitch. For support, contact Stitch support.
Square integration summary
Stitch’s Square integration replicates data using the Square Connect v1 API. Refer to the Schema section for a list of objects available for replication.
Square feature snapshot
A high-level look at Stitch's Square (v04-05-2016) integration, including release status, useful links, and the features supported in Stitch.
| STITCH | |||
| Release status |
Deprecated on August 27, 2020 |
Supported by | |
| Stitch plan |
Standard |
API availability |
Not available |
| Singer GitHub repository |
Not applicable |
||
| REPLICATION SETTINGS | |||
| Anchor Scheduling |
Supported |
Advanced Scheduling |
Unsupported |
| Table-level reset |
Unsupported |
Configurable Replication Methods |
Unsupported |
| DATA SELECTION | |||
| Table selection |
Unsupported |
Column selection |
Unsupported |
| Select all |
Unsupported |
||
| TRANSPARENCY | |||
| Extraction Logs |
Unsupported |
Loading Reports |
Supported |
Connecting Square
Step 1: Add Square as a Stitch data source
- Sign into your Stitch account.
-
On the Stitch Dashboard page, click the Add Integration button.
-
Click the Square icon.
-
Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.
For example, the name “Stitch Square” would create a schema called
stitch_squarein the destination. Note: Schema names cannot be changed after you save the integration.
Step 2: Define the historical replication start date
The Sync Historical Data setting defines the starting date for your Square integration. This means that:
- For tables using Key-based Incremental Replication, data equal to or newer than this date will be replicated to your destination.
- For tables using Full Table Replication, all data - including records that are older, equal to, or newer than this date - will be replicated to your destination.
Change this setting if you want to replicate data beyond Square’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.
Step 3: Create a replication schedule
In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.
Square integrations support the following replication scheduling methods:
To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.
Step 4: Authorize Stitch to Access Square
Lastly, you’ll be directed to Square’s website to complete the setup.
- Enter your Square credentials and click Login.
- After the authorization process successfully completes, you’ll be redirected back to Stitch.
- Click All Done.
Initial and historical replication jobs
After you finish setting up Square, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.
For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.
Initial replication jobs with Anchor Scheduling
If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
Free historical data loads
The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.
Square table reference
Schemas and versioning
Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.
The schema and info displayed below is for version 04-05-2016 of this integration.
square_bank_accounts
Replication Method: Full Table
Primary Key: id
Contains Nested Structures?:
No
square_bank_accounts table contains non-confidential info - this means no full bank account numbers - about a location’s associated bank accounts.square_bank_accounts Attributes
While we try to include everything Square has here, this may not be a full list of attributes. Refer to Square's documentation for a full list and description of each attribute.
Bank Account ID (
id)location_id
merchant_id
bank_name
name
type
routing_number
account_number_suffix
currency_code
square_cash_drawer_shifts
Replication Method: Key-based Incremental
Primary Key: id
Contains Nested Structures?:
Yes
square_cash_drawer_shifts table contains the details for all of a location’s cash drawer shifts.square_cash_drawer_shifts & Nested Structures
This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.
These items are marked with a *
square_cash_drawer_shifts Attributes
While we try to include everything Square has here, this may not be a full list of attributes. Refer to Square's documentation for a full list and description of each attribute.
Cash Drawer Shift ID (
id)location_id
cash_drawer_state
opened_at
ended_at
closed_at
employee_ids
opening_employee_id
ending_employee_id
closing_employee_id
description
starting_cash_money
cash_payment_money
cash_refunds_money
cash_paid_in_money
cash_paid_out_money
expected_cash_money
closed_cash_money
device
square_categories
Replication Method: Full Table
Primary Key: id
Contains Nested Structures?:
No
square_categories table contains info about a location’s item categories.square_categories Attributes
While we try to include everything Square has here, this may not be a full list of attributes. Refer to Square's documentation for a full list and description of each attribute.
Category ID (
id)name
location_id
square_discounts
Replication Method: Full Table
Primary Key: id
Contains Nested Structures?:
No
square_discounts table contains info about a location’s discounts.square_discounts Attributes
While we try to include everything Square has here, this may not be a full list of attributes. Refer to Square's documentation for a full list and description of each attribute.
Discount ID (
id)location_id
name
rate
amount_money
discount_type
pin_required
color
square_employees
Replication Method: Key-based Incremental
Primary Key: id
Contains Nested Structures?:
No
square_employees table contains summary info for all of a business’s employees.square_employees Attributes
While we try to include everything Square has here, this may not be a full list of attributes. Refer to Square's documentation for a full list and description of each attribute.
Employee ID (
id)first_name
last_name
role_ids
authorized_location_ids
email
status
external_id
created_at
updated_at
square_fees
Replication Method: Full Table
Primary Key: id
Contains Nested Structures?:
No
square_fees table contains info on a location’s fees, or tax items.square_fees Attributes
While we try to include everything Square has here, this may not be a full list of attributes. Refer to Square's documentation for a full list and description of each attribute.
Fee ID (
id)location_id
name
rate
calculation_phase
adjustment_type
applies_to_custom_amounts
enabled
inclusion_type
type
square_inventory
Replication Method: Full Table
Primary Key: id
Contains Nested Structures?:
No
square_inventory table contains inventory info for all of a merchant’s inventory-enabled variations.square_inventory Attributes
While we try to include everything Square has here, this may not be a full list of attributes. Refer to Square's documentation for a full list and description of each attribute.
Variation ID (
id)location_id
quantity_on_hand
square_items
Replication Method: Full Table
Primary Key: id
Contains Nested Structures?:
Yes
square_items table contains info about a location’s items.square_items & Nested Structures
This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.
These items are marked with a *
square_items Attributes
While we try to include everything Square has here, this may not be a full list of attributes. Refer to Square's documentation for a full list and description of each attribute.
Item ID (
id)location_id
name
description
type
abbreviation
color
visibility
available_online
master_image
<a href=”https://docs.connect.squareup.com/api/connect/v1/#datatype-itemvariation target=”new”>variations</a>
*fees
*taxable
square_location
Replication Method: Full Table
Primary Key: id
Contains Nested Structures?:
No
square_location table contains details for a business’s locations.square_location Attributes
While we try to include everything Square has here, this may not be a full list of attributes. Refer to Square's documentation for a full list and description of each attribute.
Location ID (
id)name
email
country_code
currency_code
business_name
business_address__address_line_1
business_address__locality
business_address__administrative_district_level_1
business_address__postal_code
business_phone__calling_code
business_phone__number
business_type
shipping_address__address_line_1
shipping_address__locality
shipping_address__administrative_district_level_1
shipping_address__postal_code
account_type
location_details__nickname
market_url
account_capabilities
*
square_modifier_lists
Replication Method: Full Table
Primary Key: id
Contains Nested Structures?:
No
square_modifier_lists table contains info about modifications for specific items.square_modifier_lists Attributes
While we try to include everything Square has here, this may not be a full list of attributes. Refer to Square's documentation for a full list and description of each attribute.
Modifier ID (
id)name
selection_type
modifier_options
*
square_orders
Replication Method: Key-based Incremental
Primary Key: id
Contains Nested Structures?:
Yes
square_orders table contains summary information for a merchant’s online store orders.square_orders & Nested Structures
This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.
These items are marked with a *
Purchased Items & Orders
This table does not contain purchased items data. To view order data alongside purchased items data, use the payment_id column in this table to join it to the payments table.
square_orders Attributes
While we try to include everything Square has here, this may not be a full list of attributes. Refer to Square's documentation for a full list and description of each attribute.
Order ID (
id)state
buyer_email
recipient_name
recipient_phone_number
shipping_address
subtotal_money
total_shipping_money
total_price_money
total_discount_money
created_at
updated_at
expires_at
payment_id
buyer_note
completed_note
refunded_note
canceled_note
tender
promo_code
btc_receive_address
btc_price_satoshi
square_pages
Replication Method: Full Table
Primary Key: id
Contains Nested Structures?:
Yes
square_pages table contains info about favorites pages created in the iPad version of Square Register.square_pages & Nested Structures
This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.
These items are marked with a *
square_pages Attributes
While we try to include everything Square has here, this may not be a full list of attributes. Refer to Square's documentation for a full list and description of each attribute.
Page ID (
id)name
page_index
square_payments
Replication Method: Key-based Incremental
Primary Key: id
Contains Nested Structures?:
Yes
square_payments table contains summary info - including itemizations - for all payments taken by a merchant or the merchant’s mobile staff. Note that Square doesn't always include itemizations in payments when the payment amount is zero.square_payments & Nested Structures
This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.
These items are marked with a *
Payment Amounts & Itemizations
Square doesn’t always include itemizations in payments when the payment amount is zero. If you’re missing itzemization data, check the corresponding payment amounts to see if they’re greater than zero.
square_payments Attributes
While we try to include everything Square has here, this may not be a full list of attributes. Refer to Square's documentation for a full list and description of each attribute.
PaymentID (
id)merchant_id
created_at
creator_id
device
payment_url
receipt_url
inclusive_tax_money
additive_tax_money
tax_money
tip_money
discount_money
total_collected_money
processing_fee_money
net_total_money
refunded_money
tender
*
square_refunds
Replication Method: Key-based Incremental
Primary Key: payment_id:created_at
Contains Nested Structures?:
No
square_refunds table contains the details for all refunds initiated by a merchant or any of the merchant’s mobile staff.square_refunds Attributes
While we try to include everything Square has here, this may not be a full list of attributes. Refer to Square's documentation for a full list and description of each attribute.
payment_id
created_at
type
reason
refunded_money
processed_at
square_roles
Replication Method: Key-based Incremental
Primary Key: id
Contains Nested Structures?:
Yes
square_roles table contains summary info for all of a business’s employee roles.square_roles & Nested Structures
This table contains nested structures. If you use a data warehouse that doesn't natively support nested structures, some of the attributes listed below may be in a subtable.
These items are marked with a *
square_roles Attributes
While we try to include everything Square has here, this may not be a full list of attributes. Refer to Square's documentation for a full list and description of each attribute.
Role ID (
id)name
permissions
*is_owner
created_at
updated_at
square_square_settlements
Replication Method: Key-based Incremental
Primary Key: id
Contains Nested Structures?:
No
square_square_settlements table contains summary information for all deposits and withdraws initiated by Square to a merchant’s bank account. This table does not contain entry data, which lists the individual transactions that contribute to the settlement total.square_square_settlements Attributes
While we try to include everything Square has here, this may not be a full list of attributes. Refer to Square's documentation for a full list and description of each attribute.
Settlement ID (
id)status
bank_account_id
initiated_at
total_money__amount
total_money__currency_code
square_square_timecards
Replication Method: Key-based Incremental
Primary Key: id
Contains Nested Structures?:
No
square_square_timecards table contains summary info for all of a business’s employee timecards.square_square_timecards Attributes
While we try to include everything Square has here, this may not be a full list of attributes. Refer to Square's documentation for a full list and description of each attribute.
Timecard ID (
id)employee_id
deleted
clockin_time
clockout_time
clockin_location_id
clockout_location_id
created_at
updated_at
| Related | Troubleshooting |
Questions? Feedback?
Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.