This is a Jitsu.Classic documentation. For the lastest version, please visit docs.jitsu.com. Read about differences here.

📜 Configuration

Configuration UI

Jitsu Internals

Jitsu Server

Square

Overview

The Square Source can sync data from the Square API: Items, Categories, Discounts, Taxes, ModifierLists, Payments, Refunds, Locations, Team Members, List Team Member Wages, Customers, Shifts, Orders

The source is using Airbyte docker image (@airbyte/source-square). Learn more how Airbyte-based sources work

How to connect

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

Connection Parameters

ParameterDocumentation
api_key*
string
(required)
The API key for a Square application
is_sandbox*
boolean
(required)
Determines the sandbox (true) or production (false) API version
start_date
string
(not required)
The start date to sync data. Leave blank for full sync. Format: YYYY-MM-DD.
include_deleted_objects
boolean
(not required)
In some streams there is and option to include deleted objects (Items, Categories, Discounts, Taxes)