- Getting started
- Account management
- Security
- Destinations
- Integrations
- SaaS
- Overview
- 3PL Central
- ActiveCampaign
- AdRoll
- Amplitude
- AppsFlyer
- Asana
- Autopilot
- BigCommerce
- Braintree
- Bronto
- Campaign Manager
- Campaign Monitor
- Chargebee
- Chargify
- CircleCI
- Close.io
- Club Speed
- Codat
- COVID-19 Public Data
- Crossbeam
- Darksky
- Deputy
- Desk
- Dixa
- Doorbell.io
- eBay
- Eloqua
- Facebook Ads
- Freshdesk
- Front
- FullStory
- GitHub
- GitLab
- Google Ads
- Google Ads (AdWords)
- Google Analytics
- Google Analytics (AdWords)
- Google Analytics 360
- Google Analytics 4
- Google ECommerce
- Google Search Console
- Google Sheets
- Harvest
- Harvest Forecast
- Heap
- Help Scout
- HubSpot
- iLEVEL
- Impact
- Intacct
- Intercom
- Invoiced
- Iterable
- JIRA
- Klaviyo
- Kustomer
- Lever
- LinkedIn Ads
- Listrak
- LivePerson
- Looker
- LookML
- MailChimp
- Mailshake
- Mambu
- Marketo
- Microsoft Advertising
- Microsoft Teams
- Mixpanel
- NetSuite
- NetSuite Suite Analytics
- Onfleet
- Outbrain
- Outreach
- Pardot
- Pendo
- Pepperjam
- Pipedrive
- Quick Base
- QuickBooks
- Recharge
- Recurly
- Referral SaaSquatch
- Revinate
- RingCentral
- SaaSOptics
- Sailthru
- Salesforce
- Salesforce Marketing Cloud
- Selligent
- SendGrid Core
- ShipHero
- Shippo
- Shopify
- Slack
- Snapchat Ads
- Square
- Stripe
- SurveyMonkey
- Taboola
- TikTok Ads
- Toggl
- Trello
- Twilio
- Twitter Ads
- Typeform
- UJET
- Urban Airship
- UserVoice
- Wootric
- Workday RaaS
- Xero
- Yotpo
- Zendesk Chat
- Zendesk Support
- Zoom
- Zuora
- Databases
- Overview
- Amazon Aurora MySQL RDS
- Amazon Aurora PostgreSQL RDS
- Amazon DynamoDB
- Amazon Microsoft SQL Server RDS
- Amazon MySQL RDS
- Amazon Oracle RDS
- Amazon PostgreSQL RDS
- Amazon S3 CSV
- Google CloudSQL MySQL
- Google CloudSQL PostgreSQL
- Heroku
- Magento
- MariaDB
- Microsoft Azure MySQL
- Microsoft Azure SQL Database
- Microsoft SQL Server
- MongoDB
- MongoDB Atlas
- MySQL
- Oracle
- PostgreSQL
- Responsys
- SFTP
- Webhooks
- All integrations
- Connection cloning
- Connect other data sources
- SaaS
- Extracting data
- Loading data
- Analysis tools
- Troubleshooting
- Developers
- Changelog
- version 2 (Latest)
- version 1 (Deprecated)
- version 04-05-2016 (Deprecated)
Get started with a free trial today
Already have an account? Sign in
Square (v2)
This integration is powered bySinger's Square tap and certified by Stitch.Check out and contribute to the repo on GitHub.
For support, contactSupport.
Square integration summary
Stitch’s Square integration replicates data using theSquare API version 2023-06-08. Refer to theSchema section for a list of objects available for replication.
Square feature snapshot
A high-level look at Stitch's Square (v2) integration, including release status, useful links, and the features supported in Stitch.
| STITCH | |||
| Release status | Released on July 19, 2023 | Supported by | |
| Stitch plan | Standard | API availability | Available |
| Singer GitHub repository | |||
| REPLICATION SETTINGS | |||
| Anchor Scheduling | Supported | Advanced Scheduling | Supported |
| Table-level reset | Unsupported | Configurable Replication Methods | Unsupported |
| DATA SELECTION | |||
| Table selection | Supported | Column selection | Supported |
| Select all | Supported | ||
| TRANSPARENCY | |||
| Extraction Logs | Supported | Loading Reports | Supported |
Connecting Square
Square setup requirements
To set up Square in Stitch, you need:
To log into your Square sandbox environment, if you’re connecting a sandbox. To allow Stitch to successfully access the sandbox, you must be logged into it prior to setting up the Square integration in Stitch.
If you’re connecting a production environment, start withStep 2 of this guide.
Step 1: Login to your Square sandbox environment
To connect to your Square sandbox environment, you’ll need to login to your sandbox environment before completing the next step. This is required to grant Stitch authorization to access the sandbox environment. For more info, refer to theSquare documentation.
Step 2: Add Square as a Stitch data source
- Sign into your Stitch account.
On the Stitch Dashboard page, click theAdd Integration button.
Click theSquare 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.- Check theConnect to a sandbox environment if choosing to connect to your Square sandbox.Note: Make sure you completedStep 1 before continuing.
Step 3: Define the historical replication start date
The Sync Historical Data setting defines the starting date for your Square integration. This means that dataequal to or newer than this date will be replicated to your data warehouse.
Change this setting if you want to replicate data beyond Square’s default setting of1 year. For a detailed look at historical replication jobs, check out theSyncing Historical SaaS Data guide.
Step 4: Create a replication schedule
In theReplication Frequency section, you’ll create the integration’sreplication 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:
Advanced Scheduling using Cron (Advanced or Premium plans only)
To keep your row usage low, consider setting the integration to replicate less frequently. See theUnderstanding and Reducing Your Row Usage guide for tips on reducing your usage.
Step 5: Authorizing Stitch to Access Square
Lastly, you’ll be directed to Square’s website to complete the setup.
- Enter your Square credentials and clickLogin.
- After the authorization process successfully completes, you’ll be redirected back to Stitch.
- ClickAll Done.
Step 6: Set objects to replicate
The last step is to select the tables and columns you want to replicate.Learn about the available tables for this integration.
Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.
For Square integrations, you can select:
Individual tables and columns
All tables and columns
Click the tabs to view instructions for each selection method.
- In the integration’sTables to Replicate tab, locate a table you want to replicate.
To track a table, click thecheckbox next to the table’s name. A blue checkmark means the table is set to replicate.
To track a column, click thecheckbox next to the column’s name. A blue checkmark means the column is set to replicate.
- Repeat this process for all the tables and columns you want to replicate.
- When finished, click theFinalize Your Selections button at the bottom of the screen to save your selections.
- Click into the integration from the Stitch Dashboard page.
Click theTables to Replicate tab.
- In the list of tables, click the box next to theTable Names column.
In the menu that displays, clickTrack all Tables and Fields:
- Click theFinalize Your Selections button at the bottom of the page to save your data selections.
Initial and historical replication jobs
After you finish setting up Square, itsSync Status may show asPending on either the Stitch Dashboard or in the Integration Details page.
For a new integration, aPending 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 theAnchor 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 forversion 2 of this integration.
This is the latest version of the Square integration.
Table and column names in your destination
Depending on your destination, table and column names may not appear as they are outlined below.
For example: Object names are lowercased in Redshift (CusTomERs >customers), while case is maintained in PostgreSQL destinations (CusTomERs >CusTomERs). Refer to theLoading Guide for your destination for more info.
bank_accounts
Thebank_accounts contains information about a merchant’s bank account in Square.
Note: This table can’t be replicated if theConnect to a sandbox environment box is checked in theintegration’s settings due to limits imposed by Square.
Full Table | |
Primary Key | id |
| Useful links |
| Join bank_accounts with | on |
|---|---|
| categories | bank_accounts.id = categories.absent_at_location_ids |
| discounts | bank_accounts.id = discounts.absent_at_location_ids |
| team_members | bank_accounts.id = team_members.assigned_locations.location_ids |
| inventories | bank_accounts.id = inventories.location_id |
| items | bank_accounts.id = items.absent_at_location_ids bank_accounts.id = items.item_data.variations.item_variation_data.location_overrides.location_id bank_accounts.id = items.item_data.variations.present_at_location_ids bank_accounts.id = items.present_at_location_ids |
| locations | bank_accounts.id = locations.id |
| modifier_lists | bank_accounts.id = modifier_lists.absent_at_location_ids |
| orders | bank_accounts.id = orders.id bank_accounts.id = orders.refunds.id bank_accounts.id = orders.tenders.id |
| payments | bank_accounts.id = payments.id |
| refunds | bank_accounts.id = refunds.id |
| shifts | bank_accounts.id = shifts.id |
| taxes | bank_accounts.id = taxes.absent_at_location_ids |
account_number_suffix STRING |
account_type STRING |
bank_name STRING |
country STRING |
creditable BOOLEAN |
currency STRING |
debit_mandate_reference_id STRING |
debitable BOOLEAN |
holder_name STRING |
id STRING |
location_id STRING |
primary_bank_identification_number STRING |
reference_id STRING |
secondary_bank_identification_number STRING |
status STRING |
version INTEGER |
cash_drawer_shifts
Thecash_drawer_shifts table contains infomration about cash transactions in Square.
Full Table | |
| Useful links |
closed_at DATE-TIME | ||
closed_cash_money OBJECT
| ||
created_at DATE-TIME | ||
description STRING | ||
ended_at DATE-TIME | ||
expected_cash_money OBJECT
| ||
id STRING | ||
location_id STRING | ||
opened_at DATE-TIME | ||
opened_cash_money OBJECT
| ||
state STRING | ||
updated_at DATE-TIME |
categories
Thecategories table contains information about item categories for a given location in Square.
Key-based Incremental | |
Primary Key | id |
Replication Key | updated_at |
| Useful links |
| Join categories with | on |
|---|---|
| items | categories.id = items.item_data.category_id categories.absent_at_location_ids = items.absent_at_location_ids categories.absent_at_location_ids = items.item_data.variations.item_variation_data.location_overrides.location_id categories.absent_at_location_ids = items.item_data.variations.present_at_location_ids categories.absent_at_location_ids = items.present_at_location_ids |
| bank_accounts | categories.absent_at_location_ids = bank_accounts.id |
| discounts | categories.absent_at_location_ids = discounts.absent_at_location_ids |
| team_members | categories.absent_at_location_ids = team_members.assigned_locations.location_ids |
| inventories | categories.absent_at_location_ids = inventories.location_id |
| locations | categories.absent_at_location_ids = locations.id |
| modifier_lists | categories.absent_at_location_ids = modifier_lists.absent_at_location_ids |
| orders | categories.absent_at_location_ids = orders.id categories.absent_at_location_ids = orders.refunds.id categories.absent_at_location_ids = orders.tenders.id |
| payments | categories.absent_at_location_ids = payments.id |
| refunds | categories.absent_at_location_ids = refunds.id |
| shifts | categories.absent_at_location_ids = shifts.id |
| taxes | categories.absent_at_location_ids = taxes.absent_at_location_ids |
absent_at_location_ids ARRAY | |
category_data OBJECT
| |
id STRING | |
is_deleted BOOLEAN | |
present_at_all_locations BOOLEAN | |
type STRING | |
updated_at DATE-TIME | |
version INTEGER |
customers
Thecustomers contains information about customer profiles associated with your Square account.
Key-based Incremental | |
Replication Key | updated_at |
| Useful links |
address OBJECT
| ||||||||||||||
birthday DATE-TIME STRING | ||||||||||||||
company_name STRING | ||||||||||||||
created_at DATE-TIME | ||||||||||||||
creation_source STRING | ||||||||||||||
email_address STRING | ||||||||||||||
family_name STRING | ||||||||||||||
given_name STRING | ||||||||||||||
group_ids ARRAY | ||||||||||||||
id STRING | ||||||||||||||
nickname STRING | ||||||||||||||
note STRING | ||||||||||||||
phone_number STRING | ||||||||||||||
preferences OBJECT
| ||||||||||||||
reference_id STRING | ||||||||||||||
segment_ids ARRAY | ||||||||||||||
tax_ids OBJECT
| ||||||||||||||
updated_at DATE-TIME | ||||||||||||||
version INTEGER |
discounts
Thediscounts table contains information about discounts for a given location in Square.
Key-based Incremental | |
Primary Key | id |
Replication Key | updated_at |
| Useful links |
| Join discounts with | on |
|---|---|
| bank_accounts | discounts.absent_at_location_ids = bank_accounts.id |
| categories | discounts.absent_at_location_ids = categories.absent_at_location_ids |
| team_members | discounts.absent_at_location_ids = team_members.assigned_locations.location_ids |
| inventories | discounts.absent_at_location_ids = inventories.location_id |
| items | discounts.absent_at_location_ids = items.absent_at_location_ids discounts.absent_at_location_ids = items.item_data.variations.item_variation_data.location_overrides.location_id discounts.absent_at_location_ids = items.item_data.variations.present_at_location_ids discounts.absent_at_location_ids = items.present_at_location_ids |
| locations | discounts.absent_at_location_ids = locations.id |
| modifier_lists | discounts.absent_at_location_ids = modifier_lists.absent_at_location_ids |
| orders | discounts.absent_at_location_ids = orders.id discounts.absent_at_location_ids = orders.refunds.id discounts.absent_at_location_ids = orders.tenders.id |
| payments | discounts.absent_at_location_ids = payments.id |
| refunds | discounts.absent_at_location_ids = refunds.id |
| shifts | discounts.absent_at_location_ids = shifts.id |
| taxes | discounts.absent_at_location_ids = taxes.absent_at_location_ids |
absent_at_location_ids ARRAY | ||||||||||
discount_data OBJECT
| ||||||||||
id STRING | ||||||||||
is_deleted BOOLEAN | ||||||||||
present_at_all_locations BOOLEAN | ||||||||||
type STRING | ||||||||||
updated_at DATE-TIME | ||||||||||
version INTEGER |
inventories
Theinventories table contains info about the current calculated stock count for a Square location.
Full Table | |
Append-Only | |
| Useful links |
| Join inventories with | on |
|---|---|
| bank_accounts | inventories.location_id = bank_accounts.id |
| categories | inventories.location_id = categories.absent_at_location_ids |
| discounts | inventories.location_id = discounts.absent_at_location_ids |
| team_members | inventories.location_id = team_members.assigned_locations.location_ids |
| items | inventories.location_id = items.absent_at_location_ids inventories.location_id = items.item_data.variations.item_variation_data.location_overrides.location_id inventories.location_id = items.item_data.variations.present_at_location_ids inventories.location_id = items.present_at_location_ids |
| locations | inventories.location_id = locations.id |
| modifier_lists | inventories.location_id = modifier_lists.absent_at_location_ids |
| orders | inventories.location_id = orders.id inventories.location_id = orders.refunds.id inventories.location_id = orders.tenders.id |
| payments | inventories.location_id = payments.id |
| refunds | inventories.location_id = refunds.id |
| shifts | inventories.location_id = shifts.id |
| taxes | inventories.location_id = taxes.absent_at_location_ids |
calculated_at DATE-TIME |
catalog_object_id STRING |
catalog_object_type STRING |
location_id STRING |
quantity STRING |
state STRING |
items
Theitems table contains information about items for a given location in Square.
Key-based Incremental | |
Primary Key | id |
Replication Key | updated_at |
| Useful links |
| Join items with | on |
|---|---|
| categories | items.item_data.category_id = categories.id items.absent_at_location_ids = categories.absent_at_location_ids items.item_data.variations.item_variation_data.location_overrides.location_id = categories.absent_at_location_ids items.item_data.variations.present_at_location_ids = categories.absent_at_location_ids items.present_at_location_ids = categories.absent_at_location_ids |
| bank_accounts | items.absent_at_location_ids = bank_accounts.id items.item_data.variations.item_variation_data.location_overrides.location_id = bank_accounts.id items.item_data.variations.present_at_location_ids = bank_accounts.id items.present_at_location_ids = bank_accounts.id |
| discounts | items.absent_at_location_ids = discounts.absent_at_location_ids items.item_data.variations.item_variation_data.location_overrides.location_id = discounts.absent_at_location_ids items.item_data.variations.present_at_location_ids = discounts.absent_at_location_ids items.present_at_location_ids = discounts.absent_at_location_ids |
| team_members | items.absent_at_location_ids = team_members.assigned_locations.location_ids items.item_data.variations.item_variation_data.location_overrides.location_id = team_members.assigned_locations.location_ids items.item_data.variations.present_at_location_ids = team_members.assigned_locations.location_ids items.present_at_location_ids = team_members.assigned_locations.location_ids |
| inventories | items.absent_at_location_ids = inventories.location_id items.item_data.variations.item_variation_data.location_overrides.location_id = inventories.location_id items.item_data.variations.present_at_location_ids = inventories.location_id items.present_at_location_ids = inventories.location_id |
| locations | items.absent_at_location_ids = locations.id items.item_data.variations.item_variation_data.location_overrides.location_id = locations.id items.item_data.variations.present_at_location_ids = locations.id items.present_at_location_ids = locations.id |
| modifier_lists | items.absent_at_location_ids = modifier_lists.absent_at_location_ids items.item_data.variations.item_variation_data.location_overrides.location_id = modifier_lists.absent_at_location_ids items.item_data.variations.present_at_location_ids = modifier_lists.absent_at_location_ids items.present_at_location_ids = modifier_lists.absent_at_location_ids items.item_data.modifier_list_info.modifier_list_id = modifier_lists.id items.item_data.modifier_list_info.modifier_list_id = modifier_lists.modifier_list_data.modifiers.modifier_data.modifier_list_id |
| orders | items.absent_at_location_ids = orders.id items.item_data.variations.item_variation_data.location_overrides.location_id = orders.id items.item_data.variations.present_at_location_ids = orders.id items.present_at_location_ids = orders.id items.absent_at_location_ids = orders.refunds.id items.item_data.variations.item_variation_data.location_overrides.location_id = orders.refunds.id items.item_data.variations.present_at_location_ids = orders.refunds.id items.present_at_location_ids = orders.refunds.id items.absent_at_location_ids = orders.tenders.id items.item_data.variations.item_variation_data.location_overrides.location_id = orders.tenders.id items.item_data.variations.present_at_location_ids = orders.tenders.id items.present_at_location_ids = orders.tenders.id |
| payments | items.absent_at_location_ids = payments.id items.item_data.variations.item_variation_data.location_overrides.location_id = payments.id items.item_data.variations.present_at_location_ids = payments.id items.present_at_location_ids = payments.id |
| refunds | items.absent_at_location_ids = refunds.id items.item_data.variations.item_variation_data.location_overrides.location_id = refunds.id items.item_data.variations.present_at_location_ids = refunds.id items.present_at_location_ids = refunds.id |
| shifts | items.absent_at_location_ids = shifts.id items.item_data.variations.item_variation_data.location_overrides.location_id = shifts.id items.item_data.variations.present_at_location_ids = shifts.id items.present_at_location_ids = shifts.id |
| taxes | items.absent_at_location_ids = taxes.absent_at_location_ids items.item_data.variations.item_variation_data.location_overrides.location_id = taxes.absent_at_location_ids items.item_data.variations.present_at_location_ids = taxes.absent_at_location_ids items.present_at_location_ids = taxes.absent_at_location_ids items.item_data.tax_ids = taxes.id |
absent_at_location_ids ARRAY | ||||||||||||||||||||||||||||||||||||||||||||
id STRING | ||||||||||||||||||||||||||||||||||||||||||||
is_deleted BOOLEAN | ||||||||||||||||||||||||||||||||||||||||||||
item_data OBJECT
| ||||||||||||||||||||||||||||||||||||||||||||
present_at_all_locations BOOLEAN | ||||||||||||||||||||||||||||||||||||||||||||
present_at_location_ids ARRAY | ||||||||||||||||||||||||||||||||||||||||||||
type STRING | ||||||||||||||||||||||||||||||||||||||||||||
updated_at DATE-TIME | ||||||||||||||||||||||||||||||||||||||||||||
version INTEGER |
locations
Thelocations table contains information about all of your business locations in Square.
Full Table | |
| Useful links |
| Join locations with | on |
|---|---|
| bank_accounts | locations.id = bank_accounts.id |
| categories | locations.id = categories.absent_at_location_ids |
| discounts | locations.id = discounts.absent_at_location_ids |
| team_members | locations.id = team_members.assigned_locations.location_ids |
| inventories | locations.id = inventories.location_id |
| items | locations.id = items.absent_at_location_ids locations.id = items.item_data.variations.item_variation_data.location_overrides.location_id locations.id = items.item_data.variations.present_at_location_ids locations.id = items.present_at_location_ids |
| modifier_lists | locations.id = modifier_lists.absent_at_location_ids |
| orders | locations.id = orders.id locations.id = orders.refunds.id locations.id = orders.tenders.id |
| payments | locations.id = payments.id |
| refunds | locations.id = refunds.id |
| shifts | locations.id = shifts.id |
| taxes | locations.id = taxes.absent_at_location_ids |
address OBJECT
| ||||||||||||||
business_email STRING | ||||||||||||||
business_hours OBJECT
| ||||||||||||||
business_name STRING | ||||||||||||||
capabilities ARRAY | ||||||||||||||
coordinates OBJECT
| ||||||||||||||
country STRING | ||||||||||||||
created_at DATE-TIME | ||||||||||||||
currency STRING | ||||||||||||||
description STRING | ||||||||||||||
facebook_url STRING | ||||||||||||||
full_format_logo_url STRING | ||||||||||||||
id STRING | ||||||||||||||
instagram_username STRING | ||||||||||||||
language_code STRING | ||||||||||||||
logo_url STRING | ||||||||||||||
mcc STRING | ||||||||||||||
merchant_id STRING | ||||||||||||||
name STRING | ||||||||||||||
phone_number STRING | ||||||||||||||
pos_background_url STRING | ||||||||||||||
status STRING | ||||||||||||||
timezone STRING | ||||||||||||||
twitter_username STRING | ||||||||||||||
type STRING | ||||||||||||||
website_url STRING |
modifier_lists
Themodifier_lists table contains information about modifier lists for a given location in Square.
Key-based Incremental | |
Primary Key | id |
Replication Key | updated_at |
| Useful links |
| Join modifier_lists with | on |
|---|---|
| bank_accounts | modifier_lists.absent_at_location_ids = bank_accounts.id |
| categories | modifier_lists.absent_at_location_ids = categories.absent_at_location_ids |
| discounts | modifier_lists.absent_at_location_ids = discounts.absent_at_location_ids |
| team_members | modifier_lists.absent_at_location_ids = team_members.assigned_locations.location_ids |
| inventories | modifier_lists.absent_at_location_ids = inventories.location_id |
| items | modifier_lists.absent_at_location_ids = items.absent_at_location_ids modifier_lists.absent_at_location_ids = items.item_data.variations.item_variation_data.location_overrides.location_id modifier_lists.absent_at_location_ids = items.item_data.variations.present_at_location_ids modifier_lists.absent_at_location_ids = items.present_at_location_ids modifier_lists.id = items.item_data.modifier_list_info.modifier_list_id modifier_lists.modifier_list_data.modifiers.modifier_data.modifier_list_id = items.item_data.modifier_list_info.modifier_list_id |
| locations | modifier_lists.absent_at_location_ids = locations.id |
| orders | modifier_lists.absent_at_location_ids = orders.id modifier_lists.absent_at_location_ids = orders.refunds.id modifier_lists.absent_at_location_ids = orders.tenders.id |
| payments | modifier_lists.absent_at_location_ids = payments.id |
| refunds | modifier_lists.absent_at_location_ids = refunds.id |
| shifts | modifier_lists.absent_at_location_ids = shifts.id |
| taxes | modifier_lists.absent_at_location_ids = taxes.absent_at_location_ids |
absent_at_location_ids ARRAY | ||||||||||||||||||
id STRING | ||||||||||||||||||
is_deleted BOOLEAN | ||||||||||||||||||
modifier_list_data OBJECT
| ||||||||||||||||||
present_at_all_locations BOOLEAN | ||||||||||||||||||
type STRING | ||||||||||||||||||
updated_at DATE-TIME | ||||||||||||||||||
version INTEGER |
orders
Theorders table contains information about order updates in Square.
Key-based Incremental | |
Replication Key | updated_at |
| Useful links |
| Join orders with | on |
|---|---|
| bank_accounts | orders.id = bank_accounts.id orders.refunds.id = bank_accounts.id orders.tenders.id = bank_accounts.id |
| categories | orders.id = categories.absent_at_location_ids orders.refunds.id = categories.absent_at_location_ids orders.tenders.id = categories.absent_at_location_ids |
| discounts | orders.id = discounts.absent_at_location_ids orders.refunds.id = discounts.absent_at_location_ids orders.tenders.id = discounts.absent_at_location_ids |
| team_members | orders.id = team_members.assigned_locations.location_ids orders.refunds.id = team_members.assigned_locations.location_ids orders.tenders.id = team_members.assigned_locations.location_ids |
| inventories | orders.id = inventories.location_id orders.refunds.id = inventories.location_id orders.tenders.id = inventories.location_id |
| items | orders.id = items.absent_at_location_ids orders.refunds.id = items.absent_at_location_ids orders.tenders.id = items.absent_at_location_ids orders.id = items.item_data.variations.item_variation_data.location_overrides.location_id orders.refunds.id = items.item_data.variations.item_variation_data.location_overrides.location_id orders.tenders.id = items.item_data.variations.item_variation_data.location_overrides.location_id orders.id = items.item_data.variations.present_at_location_ids orders.refunds.id = items.item_data.variations.present_at_location_ids orders.tenders.id = items.item_data.variations.present_at_location_ids orders.id = items.present_at_location_ids orders.refunds.id = items.present_at_location_ids orders.tenders.id = items.present_at_location_ids |
| locations | orders.id = locations.id orders.refunds.id = locations.id orders.tenders.id = locations.id |
| modifier_lists | orders.id = modifier_lists.absent_at_location_ids orders.refunds.id = modifier_lists.absent_at_location_ids orders.tenders.id = modifier_lists.absent_at_location_ids |
| payments | orders.id = payments.id orders.refunds.id = payments.id orders.tenders.id = payments.id orders.id = payments.order_id orders.returns.source_order_id = payments.order_id orders.refunds.id = payments.order_id orders.refunds.id = payments.refund_ids |
| refunds | orders.id = refunds.id orders.refunds.id = refunds.id orders.tenders.id = refunds.id orders.id = refunds.order_id orders.returns.source_order_id = refunds.order_id orders.tenders.id = refunds.payment_id |
| shifts | orders.id = shifts.id orders.refunds.id = shifts.id orders.tenders.id = shifts.id |
| taxes | orders.id = taxes.absent_at_location_ids orders.refunds.id = taxes.absent_at_location_ids orders.tenders.id = taxes.absent_at_location_ids |
closed_at DATE-TIME | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_at DATE-TIME | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
discounts ARRAY
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fulfillments ARRAY
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id STRING | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
line_items ARRAY
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
location_id STRING | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
net_amount_due_money OBJECT
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
net_amounts OBJECT
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pricing_options OBJECT
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reference_id STRING | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
refunds ARRAY
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
return_amounts OBJECT
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
returns ARRAY
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
service_charges ARRAY
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
source OBJECT
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
state STRING | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
taxes ARRAY
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tenders ARRAY
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total_discount_money OBJECT
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total_money OBJECT
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total_service_charge_money OBJECT
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total_tax_money OBJECT
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total_tip_money OBJECT
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_at DATE-TIME | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
version INTEGER |
payments
Thepayments table contains information about all payments taken in Square.
Key-based Incremental | |
Replication Key | updated_at,created_at |
| Useful links |
| Join payments with | on |
|---|---|
| bank_accounts | payments.id = bank_accounts.id |
| categories | payments.id = categories.absent_at_location_ids |
| discounts | payments.id = discounts.absent_at_location_ids |
| team_members | payments.id = team_members.assigned_locations.location_ids |
| inventories | payments.id = inventories.location_id |
| items | payments.id = items.absent_at_location_ids payments.id = items.item_data.variations.item_variation_data.location_overrides.location_id payments.id = items.item_data.variations.present_at_location_ids payments.id = items.present_at_location_ids |
| locations | payments.id = locations.id |
| modifier_lists | payments.id = modifier_lists.absent_at_location_ids |
| orders | payments.id = orders.id payments.id = orders.refunds.id payments.id = orders.tenders.id payments.order_id = orders.id payments.order_id = orders.returns.source_order_id payments.order_id = orders.refunds.id payments.refund_ids = orders.refunds.id |
| refunds | payments.id = refunds.id payments.order_id = refunds.order_id payments.id = refunds.payment_id payments.order_id = refunds.id payments.refund_ids = refunds.id |
| shifts | payments.id = shifts.id |
| taxes | payments.id = taxes.absent_at_location_ids |
amount_money OBJECT
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
app_fee_money OBJECT
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
application_details OBJECT
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
approved_money OBJECT
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
bank_account_details OBJECT
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
billing_address OBJECT
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
buy_now_pay_later_details OBJECT
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
buyer_email_address STRING | ||||||||||||||||||||||||||||||||||||||||||||||||||||
capabilities ARRAY | ||||||||||||||||||||||||||||||||||||||||||||||||||||
card_details OBJECT
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
cash_details OBJECT
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
created_at DATE-TIME | ||||||||||||||||||||||||||||||||||||||||||||||||||||
customer_id STRING | ||||||||||||||||||||||||||||||||||||||||||||||||||||
delay_action STRING | ||||||||||||||||||||||||||||||||||||||||||||||||||||
delay_duration STRING | ||||||||||||||||||||||||||||||||||||||||||||||||||||
delayed_until DATE-TIME | ||||||||||||||||||||||||||||||||||||||||||||||||||||
device_details OBJECT
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
external_details OBJECT
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
id STRING | ||||||||||||||||||||||||||||||||||||||||||||||||||||
location_id STRING | ||||||||||||||||||||||||||||||||||||||||||||||||||||
note STRING | ||||||||||||||||||||||||||||||||||||||||||||||||||||
order_id STRING | ||||||||||||||||||||||||||||||||||||||||||||||||||||
processing_fee ARRAY
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
receipt_number STRING | ||||||||||||||||||||||||||||||||||||||||||||||||||||
receipt_url STRING | ||||||||||||||||||||||||||||||||||||||||||||||||||||
reference_id STRING | ||||||||||||||||||||||||||||||||||||||||||||||||||||
refund_ids ARRAY | ||||||||||||||||||||||||||||||||||||||||||||||||||||
refunded_money OBJECT
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
risk_evaluation OBJECT
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
shipping_address OBJECT
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
source_type STRING | ||||||||||||||||||||||||||||||||||||||||||||||||||||
statement_description_identifier STRING | ||||||||||||||||||||||||||||||||||||||||||||||||||||
status STRING | ||||||||||||||||||||||||||||||||||||||||||||||||||||
team_member_id STRING | ||||||||||||||||||||||||||||||||||||||||||||||||||||
tip_money OBJECT
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
total_money OBJECT
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
updated_at DATE-TIME | ||||||||||||||||||||||||||||||||||||||||||||||||||||
version_token STRING | ||||||||||||||||||||||||||||||||||||||||||||||||||||
wallet_details OBJECT
|
payouts
Thepayouts table contains information about all payouts made in Square.
Full Table | |
| Useful links |
amount_money OBJECT
| |||||
arrival_date DATE-TIME | |||||
created_at DATE-TIME | |||||
destination OBJECT
| |||||
end_to_end_id STRING | |||||
id STRING | |||||
location_id STRING | |||||
payout_fee ARRAY
| |||||
status STRING | |||||
type STRING | |||||
updated_at DATE-TIME | |||||
version INTEGER |
refunds
Therefunds table contains information about refunds on items in Square.
Full Table | |
| Useful links |
| Join refunds with | on |
|---|---|
| bank_accounts | refunds.id = bank_accounts.id |
| categories | refunds.id = categories.absent_at_location_ids |
| discounts | refunds.id = discounts.absent_at_location_ids |
| team_members | refunds.id = team_members.assigned_locations.location_ids |
| inventories | refunds.id = inventories.location_id |
| items | refunds.id = items.absent_at_location_ids refunds.id = items.item_data.variations.item_variation_data.location_overrides.location_id refunds.id = items.item_data.variations.present_at_location_ids refunds.id = items.present_at_location_ids |
| locations | refunds.id = locations.id |
| modifier_lists | refunds.id = modifier_lists.absent_at_location_ids |
| orders | refunds.id = orders.id refunds.id = orders.refunds.id refunds.id = orders.tenders.id refunds.order_id = orders.id refunds.order_id = orders.returns.source_order_id refunds.payment_id = orders.tenders.id |
| payments | refunds.id = payments.id refunds.order_id = payments.order_id refunds.payment_id = payments.id refunds.id = payments.order_id refunds.id = payments.refund_ids |
| shifts | refunds.id = shifts.id |
| taxes | refunds.id = taxes.absent_at_location_ids |
amount_money OBJECT
| ||||||||||||||||||||||||||||||||||
app_fee_money OBJECT
| ||||||||||||||||||||||||||||||||||
created_at DATE-TIME | ||||||||||||||||||||||||||||||||||
destination_details OBJECT
| ||||||||||||||||||||||||||||||||||
destination_type STRING | ||||||||||||||||||||||||||||||||||
id STRING | ||||||||||||||||||||||||||||||||||
location_id STRING | ||||||||||||||||||||||||||||||||||
order_id STRING | ||||||||||||||||||||||||||||||||||
payment_id STRING | ||||||||||||||||||||||||||||||||||
processing_fee ARRAY
| ||||||||||||||||||||||||||||||||||
reason STRING | ||||||||||||||||||||||||||||||||||
status STRING | ||||||||||||||||||||||||||||||||||
team_member_id STRING | ||||||||||||||||||||||||||||||||||
unlinked BOOLEAN | ||||||||||||||||||||||||||||||||||
updated_at DATE-TIME |
roles
Theroles table contains information about employees’ roles in Square.
Note: This table can’t be replicated if theConnect to a sandbox environment box is checked in theintegration’s settings due to limits imposed by Square.
Full Table | |
Primary Key | id |
| Useful links |
created_at DATE-TIME |
id STRING |
is_owner BOOLEAN |
name STRING |
permissions ARRAY |
updated_at DATE-TIME |
shifts
Theshifts table contains information about employee’s shifts in Square.
Key-based Incremental | |
Replication Key | updated_at |
| Useful links |
| Join shifts with | on |
|---|---|
| team_members | shifts.team_member_id = team_members.id shifts.id = team_members.assigned_locations.location_ids |
| bank_accounts | shifts.id = bank_accounts.id |
| categories | shifts.id = categories.absent_at_location_ids |
| discounts | shifts.id = discounts.absent_at_location_ids |
| inventories | shifts.id = inventories.location_id |
| items | shifts.id = items.absent_at_location_ids shifts.id = items.item_data.variations.item_variation_data.location_overrides.location_id shifts.id = items.item_data.variations.present_at_location_ids shifts.id = items.present_at_location_ids |
| locations | shifts.id = locations.id |
| modifier_lists | shifts.id = modifier_lists.absent_at_location_ids |
| orders | shifts.id = orders.id shifts.id = orders.refunds.id shifts.id = orders.tenders.id |
| payments | shifts.id = payments.id |
| refunds | shifts.id = refunds.id |
| taxes | shifts.id = taxes.absent_at_location_ids |
breaks ARRAY
| |||||||
created_at DATE-TIME | |||||||
end_at DATE-TIME | |||||||
id STRING | |||||||
location_id STRING | |||||||
start_at DATE-TIME | |||||||
status STRING | |||||||
team_member_id STRING | |||||||
timezone STRING | |||||||
updated_at DATE-TIME | |||||||
version INTEGER | |||||||
wage OBJECT
|
taxes
Thetaxes table contains information about taxes enabled on your items in Square.
Key-based Incremental | |
Primary Key | id |
Replication Key | updated_at |
| Useful links |
| Join taxes with | on |
|---|---|
| bank_accounts | taxes.absent_at_location_ids = bank_accounts.id |
| categories | taxes.absent_at_location_ids = categories.absent_at_location_ids |
| discounts | taxes.absent_at_location_ids = discounts.absent_at_location_ids |
| team_members | taxes.absent_at_location_ids = team_members.assigned_locations.location_ids |
| inventories | taxes.absent_at_location_ids = inventories.location_id |
| items | taxes.absent_at_location_ids = items.absent_at_location_ids taxes.absent_at_location_ids = items.item_data.variations.item_variation_data.location_overrides.location_id taxes.absent_at_location_ids = items.item_data.variations.present_at_location_ids taxes.absent_at_location_ids = items.present_at_location_ids taxes.id = items.item_data.tax_ids |
| locations | taxes.absent_at_location_ids = locations.id |
| modifier_lists | taxes.absent_at_location_ids = modifier_lists.absent_at_location_ids |
| orders | taxes.absent_at_location_ids = orders.id taxes.absent_at_location_ids = orders.refunds.id taxes.absent_at_location_ids = orders.tenders.id |
| payments | taxes.absent_at_location_ids = payments.id |
| refunds | taxes.absent_at_location_ids = refunds.id |
| shifts | taxes.absent_at_location_ids = shifts.id |
absent_at_location_ids ARRAY | ||||||||
id STRING | ||||||||
is_deleted BOOLEAN | ||||||||
present_at_all_locations BOOLEAN | ||||||||
tax_data OBJECT
| ||||||||
type STRING | ||||||||
updated_at DATE-TIME | ||||||||
version INTEGER |
team_members
Key-based Incremental | |
Replication Key | updated_at |
| Useful links |
| Join team_members with | on |
|---|---|
| shifts | team_members.id = shifts.team_member_id team_members.assigned_locations.location_ids = shifts.id |
| bank_accounts | team_members.assigned_locations.location_ids = bank_accounts.id |
| categories | team_members.assigned_locations.location_ids = categories.absent_at_location_ids |
| discounts | team_members.assigned_locations.location_ids = discounts.absent_at_location_ids |
| inventories | team_members.assigned_locations.location_ids = inventories.location_id |
| items | team_members.assigned_locations.location_ids = items.absent_at_location_ids team_members.assigned_locations.location_ids = items.item_data.variations.item_variation_data.location_overrides.location_id team_members.assigned_locations.location_ids = items.item_data.variations.present_at_location_ids team_members.assigned_locations.location_ids = items.present_at_location_ids |
| locations | team_members.assigned_locations.location_ids = locations.id |
| modifier_lists | team_members.assigned_locations.location_ids = modifier_lists.absent_at_location_ids |
| orders | team_members.assigned_locations.location_ids = orders.id team_members.assigned_locations.location_ids = orders.refunds.id team_members.assigned_locations.location_ids = orders.tenders.id |
| payments | team_members.assigned_locations.location_ids = payments.id |
| refunds | team_members.assigned_locations.location_ids = refunds.id |
| taxes | team_members.assigned_locations.location_ids = taxes.absent_at_location_ids |
assigned_locations OBJECT
| ||
created_at DATE-TIME | ||
email_address STRING | ||
family_name STRING | ||
given_name STRING | ||
id STRING | ||
is_owner BOOLEAN | ||
phone_number STRING | ||
reference_id STRING | ||
status STRING | ||
updated_at DATE-TIME |
| Related | Troubleshooting |
Questions? Feedback?
Did this article help? If you have questions or feedback, feel free tosubmit a pull request with your suggestions,open an issue on GitHub, orreach out to us.