Square

Overview

The Square Source can sync data from the Square API

Useful links:

Output schema

This Source is capable of syncing the following Streams:

Data type mapping

Integration Type

Airbyte Type

Notes

string

string

integer

integer

array

array

object

object

boolean

boolean

Features

Feature

Supported?

Full Refresh Sync

Yes

Incremental - Append Sync

Yes

Namespaces

No

Requirements

  • api_key - The Square API key token

  • is_sandbox - the switch between sandbox (true) and production (false) environments

Setup guide

To get the API key for your square application follow Geting started and Access token guides

Performance considerations

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.

Some Square API endpoints has different page size limitation

  • Items - 1000

  • Categories - 1000

  • Discounts - 1000

  • Taxes - 1000

  • ModifierLists - 1000

  • Payments - 100

  • Refunds - 100

  • TeamMembers - 100

  • ListTeamMemberWages - 200

  • Shifts - 200

  • Orders - 500

Changelog

Version

Date

Pull Request

Subject

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