Our Square integration is currently in Closed Beta. As such, the info in this article may change.
Interested in participating in the beta? Get in touch with us.
| Release Status | Closed Beta | Availability | Free |
| Status Page | Square Status Page | Default Historical Sync | 1 year |
| Whitelist Tables/Columns | Unsupported/Unsupported | Default Replication Frequency | 30 minutes |
| Full Table Endpoints | 9 | Incremental Endpoints | 8 |
| Destination Incompatibilities | None | ||
Connecting Square
Connecting your Square data to Stitch a four-step process:
- Add Square as a Stitch data source
- Define the Historical Sync
- Define the Replication Frequency
- Authorize Stitch to access Square
Add Square as a Stitch Data Source
- On the Stitch Dashboard page, click the Add an Integration button.
-
Click the Square icon.
-
Enter a name for the integration. This is the name that will display on the for the integration; it’ll also be used to create the schema in your data warehouse.
For example, the name “Stitch Square” would create a schema called
stitch_squarein the data warehouse. This schema is where all the tables for this integration will be stored.
Defining the Historical Sync
The Sync Historical Data setting will define the starting date for your Square integration. This means that data equal to or newer than this date will be replicated to your data warehouse.
Change this setting if you want to sync data beyond Square’s default setting of 1 year. For a detailed look at historical syncs, check out the Syncing Historical SaaS Data article.
Define the Replication Frequency
The Replication Frequency controls how often Stitch will attempt to replicate data from your Square integration. By default the frequency is set to 30 minutes, but you can change it to better suit your needs.
Before setting the Replication Frequency, note that:
- The more often Square is set to replicate, the higher the number of replicated rows.
-
The number of rows in the source may not equal the number of rows replicated by Stitch. Tables that use Full Table Replication will result in a higher number of replicated rows.
- If you’re using a data warehouses that doesn’t natively support nested structures, you’ll see a higher number of replicated rows due to the de-nesting Stitch performs.
To help prevent overages, we recommend setting the Replication Frequency to something less frequent - like 6 hours instead of 30 minutes. For tips on reducing your row count, check out the Reducing Your Row Count section of our Billing Guide.
After selecting a Replication Frequency, click Save Integration.
Authorizing 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.
Square’s Intial Sync
After you finish setting up Square, you might see its Sync Status 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 sync for the integration. This may take some time to complete.
Square Schema
Stitch's Square integration includes these tables:
- bank_accounts
- cash_drawer_shifts
- categories
- discounts
- employees
- fees
- inventory
- items
- location
- modifier_lists
- orders
- pages
- payments
- refunds
- roles
- settlements
- timecards
bank_accounts
Replication Method: Full Table
Primary Key: id
Contains Nested Structures?:
No
bank_accounts table contains non-confidential info - this means no full bank account numbers - about a location’s associated bank accounts.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
cash_drawer_shifts
Replication Method: Incremental
Primary Key: id
Contains Nested Structures?:
Yes
cash_drawer_shifts table contains the details for all of a location’s cash drawer shifts.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 *
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
categories
Replication Method: Full Table
Primary Key: id
Contains Nested Structures?:
No
categories table contains info about a location’s item categories.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
discounts
Replication Method: Full Table
Primary Key: id
Contains Nested Structures?:
No
discounts table contains info about a location’s discounts.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
employees
Replication Method: Incremental
Primary Key: id
Contains Nested Structures?:
No
employees table contains summary info for all of a business’s employees.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
fees
Replication Method: Full Table
Primary Key: id
Contains Nested Structures?:
No
fees table contains info on a location’s fees, or tax items.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
inventory
Replication Method: Full Table
Primary Key: id
Contains Nested Structures?:
No
inventory table contains inventory info for all of a merchant’s inventory-enabled variations.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
items
Replication Method: Full Table
Primary Key: id
Contains Nested Structures?:
Yes
items table contains info about a location’s items.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 *
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
location
Replication Method: Full Table
Primary Key: id
Contains Nested Structures?:
No
location table contains details for a business’s locations.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
*
modifier_lists
Replication Method: Full Table
Primary Key: id
Contains Nested Structures?:
No
modifier_lists table contains info about modifications for specific items.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
*
orders
Replication Method: Incremental
Primary Key: id
Contains Nested Structures?:
Yes
orders table contains summary information for a merchant’s online store orders.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.
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
pages
Replication Method: Full Table
Primary Key: id
Contains Nested Structures?:
Yes
pages table contains info about favorites pages created in the iPad version of Square Register.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 *
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
payments
Replication Method: Incremental
Primary Key: id
Contains Nested Structures?:
Yes
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.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.
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
*
refunds
Replication Method: Incremental
Primary Key: payment_id:created_at
Contains Nested Structures?:
No
refunds table contains the details for all refunds initiated by a merchant or any of the merchant’s mobile staff.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
roles
Replication Method: Incremental
Primary Key: id
Contains Nested Structures?:
Yes
roles table contains summary info for all of a business’s employee roles.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 *
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
settlements
Replication Method: Incremental
Primary Key: id
Contains Nested Structures?:
No
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.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
timecards
Replication Method: Incremental
Primary Key: id
Contains Nested Structures?:
No
timecards table contains summary info for all of a business’s employee timecards.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, please reach out to us.