Overview
The Lyftron Provider for Square offers the most natural way to access Square data from Lyftron with ease and also enables to connect with BI, MDM & ML tools, Data warehouses, Databases and other SAAS based applications with zero code and zero infrastructure requirements. The provider wraps the complexity of accessing Square data into easy-to-integrate relational fully managed ANSI Sql format. Make faster and better business decisions with Lyftron’s Square data provider and automatically build your data migration pipelines in minutes, not months
The provider hides the complexity of accessing data and provides additional powerful security features, smart caching, batching, socket management, and more.
Key Features
- Comprehensive Delta load mechanism.
- Real-time access to Square.
- Comprehensive full support of ANSI Sql to query data with ease.
- Collaborative query processing.
Prerequisites
The user must have credentials for Square, Lyftron and your destination data warehouse, lake or database to perform the data pipeline operation with Lyftron
Establishing a Connection with Lyftron's Quickstart Steps
Create your Square connection with Lyftron by following the 5 easy steps show below:
Step1. Add your connection
Click on Connect section on the left panel → Click on Add Connection button
Step2. Select your connector
In the connector selection panel, search and click Square for your connection
Step3. Enter your connection details
In the Connection String section enter the values of the below parameters. The following connection string is required to establish Square connection with Lyftron.
InitiateOAuth=GETANDREFRESH;OAuthClientId=[your_ApplicationId];OAuthClientSecret=[your_ApplicationSecret];CallbackURL=[your_URL];LocationId=MyDefaultLocation;
| Key | Value | Field |
| Connection Name | Enter your connection details | Required |
| InitiateOAuth | GETANDREFRESH | Required |
| OAuthClientId | You Square OAuthClientId | Required |
| OAuthClientSecret | Your Square OAuthClientSecret | Required |
| CallbackURL | Enter URL | Required |
| Logfile** | Use the logfile option to debug your job and provide your connection name to generate the log file. [ConnectionConfigurationPath]\Connection_name_log.tx | Optional |
| Verbosity** | Choose verbosity 1-5 based on the severity of debugging | Optional |
** For more information, check the Lyftron logging and debugging section.
If you want more detailed information about how to establish a connection with Lyftron, click on Lyftron Connection Quick Start guide.
Step4. Test your connection
Once you are done entering your connection details, simply click on the Test Connection button to test the connectivity. In case your connection fails, add Logfile and Verbosity parameters and check the Lyftron logging and debugging section, to debug the error.
Step5. Save your connection
Hurray! Now you have successfully connected with the Lyftron Square connector and can utilize the connector to Extract, Warehouse, Analyze, Visualize and Share your data.
Data Model
You can work with all the tables in your account using the provider. The provider connects to Square and gets the list of tables and the metadata for the tables by calling the appropriate Web services. Any changes you make to your Wasabi account, such as adding a new table, adding new columns, or changing the data type of a column, will immediately be reflected when you connect using the provider.
| Name | Type | Description |
| Categories | Tables | Create, update, delete, and query available categories in Square. |
| Cells | Tables | Query, update and delete Cells of a favorite page in Square Point of Sale. |
| Discounts | Tables | Create, update, delete, and query Discounts for a merchant. |
| Fees | Tables | Create, update, delete, and query the Fees or taxes for a merchant. |
| Items | Tables | Create, update, delete, and query the available Items. |
| ItemVariations | Tables | Create, update, delete, and query Item Variations of an existing item. |
| ModifierLists | Tables | Create, update, delete, and query the Modifier Lists of a merchant. |
| ModifierOptions | Tables | Create, update, delete, and query all of the Modifier Options for a merchant. |
| Pages | Tables | Create, update, delete, and query all of the Favorites Pages in Square Point of Sale for a Merchant. |
| Refunds | Tables | Create and query the details for all Refunds initiated by a merchant or any of the mobile staff of the merchant during a date range. |
| CatalogItems | Tables | Query the available items. |
| CatalogItemVariations | Tables | Query the available item variations. |
| CustomerCards | Tables | Create, update, delete, and query the available CustomerCards in Square. |
| Customers | Tables | Create, update, delete, and query the available customers in Square. |
| InventoryChanges | Tables | Query historical physical counts and adjustments on inventory items. |
| BankAccounts | Views | Query the Bank Accounts of the merchant. |
| Customers | Views | Query the available customers in Square. |
| Employees | Views | Query the available Employees in Square. |
| Inventory | Views | Query Inventory information for all of the inventory-enabled item variations for a merchant. |
| Locations | Views | Query Location information for a Merchant. |
| PaymentItemizations | Views | Query the items of a payment. |
| Payments | Views | Query the available Payments in Square. |
| Settlements | Views | Query summary information for deposits and withdrawals initiated by Square to the Bank Account of a Merchant. |
| Transactions | Views | Query transactions processed with Square. |
| TransactionTenders | Views | Query transaction tenders processed with Square. |
|
CatalogCategories |
Views | Query the available catalog categories. |
| CatalogDiscounts | Views | Query the available catalog discounts. |
| CatalogImages | Views | Query the available catalog images. |
| CatalogModifierLists | Views | Query the available catalog modifier lists. |
| CatalogModifiers | Views | Query the available catalog modifiers. |
| CatalogTaxes | Views | Query the available catalog taxes. |
| Locations | Views | Query Location information for a Merchant. |
| Merchants | Views | Query the available merchants in Square. |
| OrderItems | Views | The order items included in the order. Every order has at least one order item. |
| Orders | Views | Orders specify products for purchase, along with discounts, taxes, and other settings to apply to the purchase. |
| Transactions | Views | Query transactions processed with Square. |
| TransactionTenders | Views | Query transaction tenders processed with Square. |
Advanced Settings
To view a detailed advanced settings options, go to Square Advanced Settings. Complete list of the parameters you can configure in the connection string can be found by clicking Connection String Parameters.