Skip to main content

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

Features

FeatureSupported?
Full Refresh SyncYes
Incremental - Append SyncYes
NamespacesNo

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

VersionDatePull RequestSubject
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