Skip to main content

Square

Availability:
Available Airbyte CloudAvailable Airbyte OSSAvailable PyAirbyte
Support Level:
Marketplace
Connector Version:
1.6.12(Last updated 4 days ago)
CDK Version:
0.90.0
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:

Supported Streams​

Connector-specific features & highlights​

Useful links:

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 TypeAirbyte TypeNotes
stringstring
integerinteger
arrayarray
objectobject
booleanboolean

Reference​

Config fields reference

Field
Type
Property name
boolean
is_sandbox
object
credentials
string
start_date
boolean
include_deleted_objects

Changelog​

Expand to review
VersionDatePull RequestSubject
1.6.122024-07-2042226Update dependencies
1.6.112024-07-1341913Update dependencies
1.6.102024-07-1041502Update dependencies
1.6.92024-07-0941124Update dependencies
1.6.82024-07-0640989Update dependencies
1.6.72024-06-2540313Update dependencies
1.6.62024-06-2240027Update dependencies
1.6.52024-06-0639206[autopull] Upgrade base image to v1.2.2
1.6.42024-06-1230315Fix customer stream pagination limit
1.6.32024-06-1439377Add error handlers, migrate to inline schemas, move spec to manifest
1.6.22024-05-0337800Migrate to Poetry. Replace custom components with default classes
1.6.12023-11-0731481Fix duplicate records for Payments and Refunds stream
1.6.02023-10-1831115Add customer_id field to Payments and Orders streams
1.5.02023-10-1631045Added New Stream bank_accounts
1.4.02023-10-1331106Add new stream Loyalty
1.3.02023-10-1231107Add new stream Inventory
1.2.02023-10-1031065Add new stream Cash drawers shifts
1.1.32023-10-1030960Update airbyte-cdk version to >=0.51.31
1.1.22023-07-1028019fix display order of spec fields
1.1.12023-06-2827762Update following state breaking changes
1.1.02023-05-2426485Remove deprecated authSpecification in favour of advancedAuth
1.0.12023-05-0325784Fix Authenticator
1.0.02023-05-0325784Fix Authenticator
0.2.22023-03-2222867Specified date formatting in specification
0.2.12023-03-0623231Publish using low-code CDK Beta version
0.2.02022-11-1419369Migrate to low code (YAML); update API to version 2022-10-19; update docs
0.1.42021-12-026842Added oauth support
0.1.32021-12-068425Update title, description fields in spec
0.1.22021-11-087499Remove base-python dependencies
0.1.12021-07-094645Update _send_request method due to Airbyte CDK changes
0.1.02021-06-304439Initial release supporting the Square API
Was this page helpful?