Ready to get started?

Download a free trial of the Square Cmdlets to get started:

 Download Now

Learn more:

Square Icon Square Cmdlets

An easy-to-use set of PowerShell Cmdlets offering real-time access to Square data. The Cmdlets allow users to easily read, write, update, and delete live data - just like working with SQL server.

Pipe Square Data to CSV in PowerShell

Use standard PowerShell cmdlets to access Square tables.

The CData Cmdlets Module for Square is a standard PowerShell module offering straightforward integration with Square. Below, you will find examples of using our Square Cmdlets with native PowerShell cmdlets.

Creating a Connection to Your Square Data

Square uses the OAuth authentication standard. To authenticate using OAuth, you will need to register an app with Square to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL. See the "Getting Started" chapter of the help documentation for a guide to using OAuth.

Additionally, you must specify the LocationId. You can retrieve the Ids for your Locations by querying the Locations table. Alternatively, you can set the LocationId in the search criteria of your query.

$conn = Connect-Square  -OAuthClientId "$OAuthClientId" -OAuthClientSecret "$OAuthClientSecret" -CallbackURL "$CallbackURL" -LocationId "$LocationId"

Selecting Data

Follow the steps below to retrieve data from the Refunds table and pipe the result into to a CSV file:

Select-Square -Connection $conn -Table Refunds | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myRefundsData.csv -NoTypeInformation

You will notice that we piped the results from Select-Square into a Select-Object cmdlet and excluded some properties before piping them into an Export-Csv cmdlet. We do this because the CData Cmdlets append Connection, Table, and Columns information onto each "row" in the result set, and we do not necessarily want that information in our CSV file.

The Connection, Table, and Columns are appended to the results in order to facilitate piping results from one of the CData Cmdlets directly into another one.

Deleting Data

The following line deletes any records that match the criteria:

Select-Square -Connection $conn -Table Refunds -Where "Type = FULL" | Remove-Square

Inserting and Updating Data

The cmdlets make data transformation easy as well as data cleansing. The following example loads data from a CSV file into Square, checking first whether a record already exists and needs to be updated instead of inserted.

Import-Csv -Path C:\MyRefundsUpdates.csv | %{
  $record = Select-Square -Connection $Square -Table Refunds -Where ("Id = `'"+$_.Id+"`'")
    Update-Square -Connection $square -Table Refunds -Columns ("Reason","RefundedMoneyAmount") -Values ($_.Reason, $_.RefundedMoneyAmount) -Where ("Id = `'"+$_.Id+"`'")
    Add-Square -Connection $square -Table Refunds -Columns ("Reason","RefundedMoneyAmount") -Values ($_.Reason, $_.RefundedMoneyAmount)

As always, our goal is to simplify the way you connect to data. With cmdlets users can install a data module, set the connection properties, and start building. Download Cmdlets and start working with your data in PowerShell today!