Square
Connect Square to sanda: what to prepare, the fields the connection form asks for, and how its data lands in your warehouse.
Connect Square
- Open the catalogue. In the console, go to Data · Connections and press New connection.
- Choose Square. It is listed under finance and payments; you can also search for it by name.
- Fill in the form. Enter the fields below. Credentials go straight to sanda’s sync engine and are never stored in sanda’s database.
- Choose what to sync. Pick the streams you want, and a sync mode for each. See choose what to sync.
- Run the first sync. sanda tests the connection, then lands each stream as a table in your warehouse.
Configuration fields
What the connection form asks for. Required fields are marked; the rest are optional.
| Field | Type | Required | Description |
|---|---|---|---|
| Authentication | one of 2 options | No | Choose how to authenticate to Square. |
| Sandbox | boolean | Yes | Determines whether to use the sandbox or production environment. Default false. |
| Start Date | string | No | UTC date in the format YYYY-MM-DD. Any data before this date will not be replicated. If not set, all data will be replicated. Default 2021-01-01. |
| Include Deleted Objects | boolean | No | In some streams there is an option to include deleted objects (Items, Categories, Discounts, Taxes). Default false. |
Authentication
Choose how to authenticate to Square.
Choose one of the following. Each asks for its own fields.
Oauth authentication
| Field | Type | Required | Description |
|---|---|---|---|
| Client ID | string, secret | Yes | The Square-issued ID of your application. |
| Client Secret | string, secret | Yes | The Square-issued application secret for your application. |
| Refresh Token | string, secret | Yes | A refresh token generated using the above client ID and secret. |
API key
| Field | Type | Required | Description |
|---|---|---|---|
| API key token | string, secret | Yes | The API key for a Square application. |
Related
Something unclear or out of date? Tell us, and we will fix the page.