How to pipe BigCommerce Data to CSV in PowerShell

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

Creating a Connection to Your BigCommerce Data

BigCommerce authentication is based on the standard OAuth flow. To authenticate, you must initially create an app via the Big Commerce developer platform where you can obtain an OAuthClientId, OAuthClientSecret, and CallbackURL. These three parameters will be set as connection properties to your driver.

Additionally, in order to connect to your BigCommerce Store, you will need your StoreId. To find your Store Id please follow these steps:

1. Log in to your BigCommerce account.
2. From the Home Page, select Advanced Settings > API Accounts.
3. Click Create API Account.
4. A text box named API Path will appear on your screen.
5. Inside you can see a URL of the following structure: https://api.bigcommerce.com/stores/{Store Id}/v3.
6. As demonstrated above, your Store Id will be between the 'stores/' and '/v3' path paramters.
7. Once you have retrieved your Store Id you can either click Cancel or proceed in creating an API Account in case you do not have one already.

$conn = Connect-BigCommerce -OAuthClientId "$OAuthClientId" -OAuthClientSecret "$OAuthClientSecret" -StoreId "$StoreId" -CallbackURL "$CallbackURL" -InitiateOAuth "$InitiateOAuth"

Selecting Data

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

Select-BigCommerce -Connection $conn -Table Customers | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myCustomersData.csv -NoTypeInformation

You will notice that we piped the results from Select-BigCommerce 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-BigCommerce -Connection $conn -Table Customers -Where "FirstName = Bob" | Remove-BigCommerce

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 BigCommerce, checking first whether a record already exists and needs to be updated instead of inserted.

Import-Csv -Path C:\MyCustomersUpdates.csv | %{
 $record = Select-BigCommerce -Connection $BigCommerce -Table Customers -Where ("Id = `'"+$_.Id+"`'")
 if($record){
 Update-BigCommerce -Connection $bigcommerce -Table Customers -Columns ("FirstName","LastName") -Values ($_.FirstName, $_.LastName) -Where ("Id = `'"+$_.Id+"`'")
 }else{
 Add-BigCommerce -Connection $bigcommerce -Table Customers -Columns ("FirstName","LastName") -Values ($_.FirstName, $_.LastName)
 }
}

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!