Articles in this section

See more

Square

Overview

Square simplifies credit card processing for your business by providing the hardware and software you need to manage your plastic transactions. This article will give you an overview of the Square/Grow integration.

Contents in This Article

Features

Acquisition Method

State
  Data Warehouse

  Alpha

  Direct Query

   Supported

 

How to Connect

Before you get started you will need your Square login credentials.

  1. Click on the Data tab at the top left of the global navigation. Then click on "Connections" in the Data Library section.
  2. Click on the blue "Connect" button and search for Square.
  3. Click on the Square logo.
  4. A window will pop up to log in with your Square credentials. After entering your credentials you will see a green confirmation message that the connection has been made.
    If you didn't see a window to enter your credentials but you still got a green success message, then that means you were already logged in with your Google account (likely in another tab) and Grow used that account to connect.

Data Warehouse

Square is on the Grow Data Warehouse, which we highly recommend you use. For more information about warehousing your data, visit the Data Warehouse Help Article.

Suggested Tables

The following suggested tables are available in Grow. These are toggled on by default when you sync your data for the first time.

  • Customers
    • Derived Table: Customers (Formatted)
  • Orders
    • Derived Tables:

      • Orders (Formatted)

      • Order Line Items

      • Order Taxes

      • Order Discounts

      • Order Service Charges

      • Order Fulfillments

      • Order Returns

      • Order Return Discounts

      • Order Return Line Items

      • Order Return Service Charges

      • Order Return Taxes

      • Order Tenders

      • Order Refunds

      • Order Rewards

      • Order Line Item Applied Discounts

      • Order Line Item Applied Taxes

      • Order Line Item Modifiers

      • Order Return Line Item Applied Discounts

      • Order Return Line Item Applied Taxes

      • Order Line Item Modifiers

  • Payments
    • Derived Tables:
      • Payments (Formatted)
      • Payment Processing Fees
  • Refunds
    • Derived Tables:
      • Payments (Formatted)
      • Payment Processing Fees

Screen_Shot_2022-02-01_at_2.18.56_PM.png

How to Warehouse your Data

  1. Starting with the Connections Overview Page, navigate to your Square connection and click on it to open the Connection Details page.
  2. Select the “Manage Connection” button inside the Connection Details section to open the warehouse table selection flow.
  3. If your data source isn't already connected, refer to the How to Connect section of this article for more details. If your data source is already connected, you can immediately select which tables of data you want to warehouse.
  4. Once you have finished selecting the data that you want stored in Grow’s Data Warehouse, click the “Sync & Store” button at the bottom of the Manage Connection page. This will begin the initial population of your warehouse with the tables you defined. Populating your data warehouse for the first time may take a while, even up to several hours.
  5. While your data is "In Queue" or "Processing", you may continue working within the app.

Sync Interval

Full Sync

The default sync interval is 12 hours per table for all warehoused tables.

Incremental Sync

When incremental sync is available, the default incremental sync interval is 1 hour, while the default full sync interval is 1 week. Incremental sync is not currently enabled for any warehoused tables.

To learn more about sync intervals and how to adjust the default settings, please visit this section of the Data Warehouse help article.

Direct Query

A direct query connection can be used to pull data into Grow. With abnormal usage, Direct Query can run into API limitations depending on the data source. For this reason, we recommend that you use Grow's Data Warehouse for a more performant, reliable experience.

Support Status

Direct Query

Currently supported with no projection to stop maintaining

 

Endpoints

Below is a list of the endpoints that the Square/Grow integration offers, along with a short description of each.

  • Orders: All transactions for the specified Square location and date range, including order ID, created date, location, quantity of items, item name, item amount, currency, processing fee, payment type, status, card last 4, and other information.
  • Refunds: All refunds processed (not pending) for the specified location and date range, including transaction ID, tender ID, created date, reason, amount, currency, status, processing fee, location name, among other information
  • Customers: All customers, including customer ID, created date, updated date, name, phone, email subscription preferences, group IDs and names, among other information.

API Documentation

https://developer.squareup.com/reference/square 

This is for reference only; you should not need to consult this to use the connection in Grow.

FAQs + Tips and Tricks

What does Location ID refer to?

When an endpoint from Square has Location ID as a field, it is referring to the physical business location the app is acting on behalf of. One or more locations must be selected before pulling a transaction or a refund.

Why am I not seeing all refunds?

Refunds with a “pending” status will not be pulled from the Refunds endpoint.

Why are amounts listed in cents rather than dollars?

Square's platform supports numerous currencies, including zero-decimal currencies. Because of this, Square's API returns monetary amounts in the base unit of the currency associated with the Country of Activation. For USD, for example, the base unit is in cents. For more information, please follow this link to view Square's API documentation. To convert cents to dollars, we recommend using the Calculated Columns Transform in the Builder.

Related articles