Integrate iPaaS.com with Square to enable data synchronization for customers, orders, and products.
How to Connect
Prerequisites
Before configuring the subscription in iPaaS.com, set up the following in Square:
A Square account with an application. In the Square Developer Dashboard, open Settings > App Integrations, find your application, and click Manage to open its Credentials page.
An access token. On the Credentials page, select Sandbox or Production (the credentials differ per environment) and copy the Access Token. This is the credential you enter when creating the subscription.
Permission to authorize the application. After the subscription is created, you complete a one-time authorization in Square that grants iPaaS.com an access token and a refresh token (see Authentication Methods).
Configuration Details
You will need the following values to connect:
API URL: the Square API base URL for your environment. Production is
https://connect.squareup.com; sandbox ishttps://connect.squareupsandbox.com.Access Token: the access token copied from your Square application's Credentials page. Sandbox and production access tokens are different.
Configure Subscription Settings
Field | Description | Required | Example |
API URL | The Square API base URL for your environment. | Yes |
|
Access Token | The access token from your Square application's Credentials page, used to authorize API calls. Sandbox and production tokens differ. | Yes | Your Square access token |
Enable Version Control | When True, the integration fetches the latest product and variant versions from Square before applying an update, so the update is applied to the current catalog state and version-mismatch errors are avoided. When blank or False, version control is inactive. | No | False |
Match Different Case Product Options and Values | When True, product options and values are matched to Square case-insensitively: existing Square option and value names are reused to prevent duplicates, and existing option-value colors are preserved when the incoming data does not include them. When blank or False, matching is case-sensitive and a casing difference can cause Square to report a duplicate. | No | False |
API Throttle Limit | The maximum number of API requests the integration may run within the throttle window. Pre-populated by the integration. | Yes | 500 |
API Throttle Seconds | The time window over which the API Throttle Limit is measured. | Yes | 60 |
Concurrent Connections | The maximum number of simultaneous API connections to Square. | Yes | 5 |
Concurrent Batch Executions | The maximum number of simultaneous batch executions for the integration. | Yes | 5 |
Authentication Methods
Square uses OAuth 2.0. After the subscription is created and the settings are applied, complete the one-time authorization:
Open the Square subscription and click the Authentication icon in the top toolbar. A new browser window opens.
Sign in to your Square account and choose the application to authorize. Square displays an access-authorization screen.
Click Allow. Square confirms the authorization is complete.
Close the authorization page and refresh the subscription page. The Refresh and Access tokens are then present on the subscription.
iPaaS.com stores the resulting access token and refresh token. Square access tokens are short-lived; when the access token expires, the integration uses the stored refresh token to obtain a new one automatically, so no periodic re-authorization is required. If the refresh token is removed or the authorization is revoked in Square, repeat the steps above to re-authorize.
Initialization Support
Initialization (a bulk import of existing records on first connect) is not supported for Square in iPaaS.com. Records are transferred by the mapping collections as they are created or updated, and on demand from the Manual Sync page. To load a large set of existing records, use the supported bulk sync using Postman workflow.
Throttling
The throttle fields on the subscription — API Throttle Limit, API Throttle Seconds, Concurrent Connections, and Concurrent Batch Executions — are pre-populated by the integration and limit how many requests the integration sends to Square within a time window, so transfers stay within Square's request limits. Adjust them only if needed for your volume. For details on how these fields behave, see the Subscription Configuration – Edit article.