Information note
Square extraction is supported by Stitch
This integration is certified by Stitch.
For support, contact 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.
Indicates if Replication Methods can be defined by you for tables in the integration.
Configurable Replication Methods are not supported for this integration. Stitch will use pre-defined replication methods for tables you set to replicate.
Unsupported
DATA SELECTION
Table selection
The ability to select individual tables for replication in the Stitch interface. If table selection is unavailable, all tables and all the columns they contain will be set to replicate by default.
Table selection is not supported for this integration. All available table and fields will be automatically selected for replication.
Unsupported
Column selection
The ability to select individual columns for replication in the Stitch interface. If column selection is unavailable, all columns will be set to replicate by default.
Column selection is not supported for this integration. All available columns in tables set to replicate will be selected.
Unsupported
Select all
Indicates if the integration supports selecting all available tables and columns.
As this integration doesn't support table or column selection, all available tables and columns are automatically replicated.
Reports detailing the Loading phase of the replication process for a given integration. Includes the number of rows loaded for each table and error info, should an error occur.
This feature is supported for this version of the integration.
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_square in 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
Information note
Replication schedules affect the time Extraction begins, not the time to data loaded. Refer to the Replication Scheduling documentation for more information.
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:
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.
Information note
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.
Information noteReplication will continue after the seven days are over. If you’re no longer interested in this source, be sure to pause or delete the integration to prevent unwanted usage.
Square table reference
Information note
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_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.
Full Table Replication is a replication method in which all rows in a table - including new, updated, and existing - are replicated during every replication job.
Primary Key:id Contains Nested Structures?:
No
The square_categories table contains info about a location’s item categories.
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
Full Table Replication is a replication method in which all rows in a table - including new, updated, and existing - are replicated during every replication job.
Primary Key:id Contains Nested Structures?:
No
The square_discounts table contains info about a location’s discounts.
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
Key-based Incremental Replication is a replication method in which Stitch identifies new and updated data using a column called a Replication Key.
Primary Key:id Contains Nested Structures?:
No
The square_employees table contains summary info for all of a business’s employees.
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
Full Table Replication is a replication method in which all rows in a table - including new, updated, and existing - are replicated during every replication job.
Primary Key:id Contains Nested Structures?:
No
The square_fees table contains info on a location’s fees, or tax items.
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
Full Table Replication is a replication method in which all rows in a table - including new, updated, and existing - are replicated during every replication job.
Primary Key:id Contains Nested Structures?:
No
The square_inventory table contains inventory info for all of a merchant’s inventory-enabled variations.
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
Full Table Replication is a replication method in which all rows in a table - including new, updated, and existing - are replicated during every replication job.
Primary Key:id Contains Nested Structures?:
Yes
If your destination doesn't natively support nested structures, Stitch will de-nest them and create subtables. See Table Info for details.
The square_items table contains info about a location’s items.
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.
Full Table Replication is a replication method in which all rows in a table - including new, updated, and existing - are replicated during every replication job.
Primary Key:id Contains Nested Structures?:
No
The square_location table contains details for a business’s locations.
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
Full Table Replication is a replication method in which all rows in a table - including new, updated, and existing - are replicated during every replication job.
Primary Key:id Contains Nested Structures?:
No
The square_modifier_lists table contains info about modifications for specific items.
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
Key-based Incremental Replication is a replication method in which Stitch identifies new and updated data using a column called a Replication Key.
Primary Key:id Contains Nested Structures?:
Yes
If your destination doesn't natively support nested structures, Stitch will de-nest them and create subtables. See Table Info for details.
The square_orders table contains summary information for a merchant’s online store orders.
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.
Full Table Replication is a replication method in which all rows in a table - including new, updated, and existing - are replicated during every replication job.
Primary Key:id Contains Nested Structures?:
Yes
If your destination doesn't natively support nested structures, Stitch will de-nest them and create subtables. See Table Info for details.
The square_pages table contains info about favorites pages created in the iPad version of Square Register.
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.
Key-based Incremental Replication is a replication method in which Stitch identifies new and updated data using a column called a Replication Key.
Primary Key:id Contains Nested Structures?:
Yes
If your destination doesn't natively support nested structures, Stitch will de-nest them and create subtables. See Table Info for details.
The 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.
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.
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
Key-based Incremental Replication is a replication method in which Stitch identifies new and updated data using a column called a Replication Key.
Primary Key:id Contains Nested Structures?:
Yes
If your destination doesn't natively support nested structures, Stitch will de-nest them and create subtables. See Table Info for details.
The square_roles table contains summary info for all of a business’s employee roles.
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
Key-based Incremental Replication is a replication method in which Stitch identifies new and updated data using a column called a Replication Key.
Primary Key:id Contains Nested Structures?:
No
The 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.
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
Key-based Incremental Replication is a replication method in which Stitch identifies new and updated data using a column called a Replication Key.
Primary Key:id Contains Nested Structures?:
No
The square_square_timecards table contains summary info for all of a business’s employee timecards.
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
square_bank_accounts
Replication Method: Full Table
Full Table Replication is a replication method in which all rows in a table - including new, updated, and existing - are replicated during every replication job.
Primary Key:id Contains Nested Structures?:
No
The square_bank_accounts table contains non-confidential info - this means no full bank account numbers - about a location’s associated bank accounts.
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
Did this page help you?
If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!
