Square

Availability:

Airbyte Cloud Airbyte OSS PyAirbyte

Support Level:

community

Connector Version:

1.6.5(Last updated 11 hours ago)

CDK Version:

0.81.4

Sync Success Rate:

Usage Rate:

This page contains the setup guide and reference information for the Square source connector.

Prerequisites

To set up the Square source connector with Airbyte, you'll need to create your Square Application and use Personal token or Oauth access token.

Setup guide

Step 1: Set up Square

1. Create Square Application
2. Obtain Personal token or Oauth access token.

Step 2: Set up the Square connector in Airbyte

For Airbyte Cloud:

1. Log into your Airbyte Cloud account.
2. In the left navigation bar, click Sources. In the top-right corner, click + New source.
3. On the Set up the source page, enter the name for the Square connector and select Square from the Source type dropdown.
4. Choose authentication method:
   • Api-Key
     • Fill in API key token with "Access token" from Square Application settings page (Credentials on the left)
   • Oauth authentication
     • Fill in Client ID and Client secret with data from Square Application settings page (Oauth on the left)
     • Fill in refresh token with one obtained during the authentication process
5. Choose if your account is sandbox
6. Choose start date
7. Choose if you would like to include Deleted objects (for streams: Items, Categories, Discounts, Taxes)

For Airbyte OSS:

1. Navigate to the Airbyte Open Source dashboard.
2. Set the name for your source.
3. On the Set up the source page, enter the name for the Square connector and select Square from the Source type dropdown.
4. Choose authentication method:
   • Api-Key
     • Fill in API key token with "Access token" from Square Application settings page (Credentials on the left)
   • Oauth authentication
     • Fill in Client ID and Client secret with data from Square Application settings page (Oauth on the left)
     • Fill in refresh token with one obtained during the authentication process
5. Choose if your account is sandbox
6. Choose start date
7. Choose if you would like to include Deleted objects (for streams: Items, Categories, Discounts, Taxes)

Supported sync modes

The Square source connector supports the following sync modes:

• Full Refresh - Overwrite
• Full Refresh - Append
• Incremental - Append
• Incremental - Append + Deduped

Supported Streams

• Items (Incremental)
• Categories (Incremental)
• Discounts (Incremental)
• Taxes (Incremental)
• ModifierLists (Incremental)
• Payments (Incremental)
• Refunds (Incremental)
• Locations
• Team Members
• List Team Member Wages
• Customers
• Shifts
• Inventory
• Orders
• Cash drawers
• Loyalty

Connector-specific features & highlights

Useful links:

• Square API Explorer
• Square API Docs
• Square Developer Dashboard

Performance considerations (if any)

No defined API rate limits were found in Square documentation however considering this information it has 10 QPS limits. The connector doesn't handle rate limits exceptions, but no errors were raised during testing. Exponential Backoff strategy recommended.

Data type map

Integration Type	Airbyte Type	Notes
string	string
integer	integer
array	array
object	object
boolean	boolean

Reference

Config fields reference

Field

Type

Property name

boolean

is_sandbox

object

credentials

string

start_date

boolean

include_deleted_objects

Changelog

Expand to review

Version	Date	Pull Request	Subject
1.6.4	2024-06-12	30315	Fix customer stream pagination limit
1.6.3	2024-06-14	39377	Add error handlers, migrate to inline schemas, move spec to manifest
1.6.2	2024-05-03	37800	Migrate to Poetry. Replace custom components with default classes
1.6.1	2023-11-07	31481	Fix duplicate records for Payments and Refunds stream
1.6.0	2023-10-18	31115	Add customer_id field to Payments and Orders streams
1.5.0	2023-10-16	31045	Added New Stream bank_accounts
1.4.0	2023-10-13	31106	Add new stream Loyalty
1.3.0	2023-10-12	31107	Add new stream Inventory
1.2.0	2023-10-10	31065	Add new stream Cash drawers shifts
1.1.3	2023-10-10	30960	Update airbyte-cdk version to >=0.51.31
1.1.2	2023-07-10	28019	fix display order of spec fields
1.1.1	2023-06-28	27762	Update following state breaking changes
1.1.0	2023-05-24	26485	Remove deprecated authSpecification in favour of advancedAuth
1.0.1	2023-05-03	25784	Fix Authenticator
1.0.0	2023-05-03	25784	Fix Authenticator
0.2.2	2023-03-22	22867	Specified date formatting in specification
0.2.1	2023-03-06	23231	Publish using low-code CDK Beta version
0.2.0	2022-11-14	19369	Migrate to low code (YAML); update API to version 2022-10-19; update docs
0.1.4	2021-12-02	6842	Added oauth support
0.1.3	2021-12-06	8425	Update title, description fields in spec
0.1.2	2021-11-08	7499	Remove base-python dependencies
0.1.1	2021-07-09	4645	Update _send_request method due to Airbyte CDK changes
0.1.0	2021-06-30	4439	Initial release supporting the Square API