Establishing a Connection

With the CData Cmdlets users can install a data module, set the connection properties, and start scripting. This section provides examples of using our BigCommerce Cmdlets with native PowerShell cmdlets, like the CSV import and export cmdlets.

Installing and Connecting

If you have PSGet, installing the cmdlets can be accomplished from the PowerShell Gallery with the following command. You can also obtain a setup from the CData site.

Install-Module BigCommerceCmdlets

The following line is then added to your profile, loading the cmdlets on the next session:

Import-Module BigCommerceCmdlets;

You can then use the Connect-BigCommerce cmdlet to create a connection object that can be passed to other cmdlets:

$conn = Connect-BigCommerce -OAuthClientId -OAuthClientSecret -CallbackURL 'http://localhost:33333' -StoreId 'YoUrSToREId'

Connecting to BigCommerce

BigCommerce authentication is based on the standard OAuth flow.

Obtain the Store ID

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

Log in to your BigCommerce account.
From the Home Page, select Advanced Settings > API Accounts.
Click Create API Account > Create V2/V3 API Token.
A text box named API Path appears on your screen.
Inside you can see a URL with the following structure: https://api.bigcommerce.com/stores/{Store Id}/v3.
As demonstrated above, your Store Id is located between the 'stores/' and '/v3' path paramters.
Once you have retrieved your Store Id you can either click Cancel or proceed to creating an API Account if you do not have one.

Obtain a Personal Access Token

Additionally, you must obtain a personal token to test and to access your own data. To obtain the personal token, follow the steps below:

Log in to your BigCommerce account.
From the Home Page, select Advanced Settings > API Accounts.
Click Create API Account > Create V2/V3 API Token.
Enter the name of your account.
Choose the OAuth Scopes for the API Account you are creating. The cmdlet cannot access data marked as "None" and cannot modify data marked as "read-only".
Click Save.

Authenticating to BigCommerce

There are two ways to authenticate to BigCommerce:

Using OAuthAccess tokens generated from the BigCommerce User Interface (UI)
Using OAuth credentials created by a custom BigCommerce application

Big Commerce UI

Generating an OAuthAccess Token from BigCommerce describes how to obtain the credentials to connect to BigCommerce. The access token authorizes specific account information to be shared. In this flow, there is no web browser required during execution because you explicitly create and accept permissions for your application directly in the BigCommerce UI. This is the easiest way to connect and is recommended for users who are just accessing their personal or company data.

Generating an Access Token

To obtain an OAuthAccessToken directly from your BigCommerce account's UI:

Log in to your BigCommerce account.
From the Home Page, select Advanced Settings > API Accounts.
Selectc Create API Account > Create V2/V3 API Token.
Enter the name of your account.
Choose the OAuth Scopes for the API Account you are creating. The driver cannot access data marked as "None" and cannot modify data marked as "read-only".
Click Save.

Your newly created app's Access Token, and Store Id are displayed on the screen. Make sure to copy them, since this is the only time you have access to these credentials. You can now use these credentials to connect to BigCommerce by setting the following connection properties:

AuthScheme: Personal access token
StoreId: Set this to your StoreId. For additional information on how to find your BigCommerce's Store Id, please see Establishing a Connection.
OAuthAccessToken: Access token

For additional information on how to find your BigCommerce's Store Id, please see Establishing a Connection.

BigCommerce Custom App

Creating a BigCommerce App describes how to create a custom app to connect to BigCommerce. This method details how to create an application for distribution and is required for each of the following sections:

Desktop applications
Web applications
Headless machines

Note that in all these cases, you must set the AuthScheme to OAuth. The following sections assume that you have done so.

Creating an app is more complicated than generating a single OAuthAccess Token, but may be more desireable for client integrations where your design is to connect or allow access to multiple clients, or an administrative scenario where the admin creates an app to be authorized individually by multiple individual users.

Desktop Apps

Follow the steps below to authenticate with the credentials for a custom OAuth app. See "Generating an Access Token" above for more information.

Get an OAuth Access Token

After setting the following properties, you are ready to connect:

OAuthClientId: Set this to the Client Id in your app settings.
OAuthClientSecret: Set this to the Client secret in your app settings.
CallbackURL: Set this to the Redirect URL in your app settings.
StoreId: Set this to your StoreId. For additional information on how to find your BigCommerce's Store Id, please see Establishing a Connection. .

When you connect the cmdlet opens the OAuth endpoint in your default browser. Log in and grant permissions to the application.

Headless Machines

To configure the driver to use OAuth with a user account on a headless machine, you need to authenticate on another device that has an internet browser.

Choose one of these two options:
- Option 1: Obtain the OAuthVerifier value as described in "Obtain and Exchange a Verifier Code" below.
- Option 2: Install the cmdlet on another machine and transfer the OAuth authentication values after you authenticate through the usual browser-based flow, as described in "Transfer OAuth Settings" below.
Then configure the cmdlet to automatically refresh the access token from the headless machine.

Option 1: Obtain and Exchange a Verifier Code

To obtain a verifier code, you must authenticate at the OAuth authorization URL.

Follow the steps below to authenticate from the machine with an internet browser and obtain the OAuthVerifier connection property.

Choose one of these options:
- If you are using the Embedded OAuth Application click BigCommerce OAuth endpoint to open the endpoint in your browser.
- If you are using a custom OAuth application, create the Authorization URL by setting the following properties:
  - InitiateOAuth: Set to OFF.
  - OAuthClientId: Set to the client Id assigned when you registered your application.
  - OAuthClientSecret: Set to the client secret assigned when you registered your application.
  Then call the GetOAuthAuthorizationURL stored procedure with the appropriate CallbackURL. Open the URL returned by the stored procedure in a browser.
Log in and grant permissions to the cmdlet. You are then redirected to the callback URL, which contains the verifier code.
Save the value of the verifier code. Later you will set this in the OAuthVerifier connection property.

Next, you need to exchange the OAuth verifier code for OAuth refresh and access tokens. Set the following properties:

On the headless machine, set the following connection properties to obtain the OAuth authentication values:

InitiateOAuth: Set this to REFRESH.
OAuthVerifier: Set this to the verifier code.
OAuthClientId: (custom applications only) Set this to the client Id in your custom OAuth application settings.
OAuthClientSecret: (custom applications only) Set this to the client secret in the custom OAuth application settings.
OAuthSettingsLocation: Set this to the location of the file where the driver saves the OAuth token values that persist across connections.

After the OAuth settings file is generated, you need to re-set the following properties to connect:

InitiateOAuth: Set this to REFRESH.
OAuthClientId: (custom applications only) Set this to the client Id assigned when you registered your application.
OAuthClientSecret: (custom applications only) Set this to the client secret assigned when you registered your application.
OAuthSettingsLocation: Set this to the location containing the encrypted OAuth authentication values. Make sure this location grants read and write permissions to the cmdlet to enable the automatic refreshing of the access token.

Option 2: Transfer OAuth Settings

Prior to connecting on a headless machine, you need to create and install a connection with the driver on a device that supports an internet browser. Set the connection properties as described in "Desktop Applications" above.

After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the location specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.

Once you have successfully tested the connection, copy the OAuth settings file to your headless machine.

On the headless machine, set the following connection properties to connect to data:

InitiateOAuth: Set this to REFRESH.
OAuthClientId: (custom applications only) Set this to the client Id assigned when you registered your application.
OAuthClientSecret: (custom applications only) Set this to the client secret assigned when you registered your application.
OAuthSettingsLocation: Set this to the location of your OAuth settings file. Make sure this location gives read and write permissions to the cmdlet to enable the automatic refreshing of the access token.

Retrieving Data

The Select-BigCommerce cmdlet provides a native PowerShell interface for retrieving data:

$results = Select-BigCommerce -Connection $conn -Table "Customers" -Columns @("FirstName, LastName") -Where "Column2='Bob'"

The Invoke-BigCommerce cmdlet provides an SQL interface. This cmdlet can be used to execute an SQL query via the Query parameter.

Piping Cmdlet Output

The cmdlets return row objects to the pipeline one row at a time. The following line exports results to a CSV file:

Select-BigCommerce -Connection $conn -Table Customers -Where "Column2 = 'Bob'" | 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 object in the result set, and we do not necessarily want that information in our CSV file.

However, this makes it easy to pipe the output of one cmdlet to another. The following is an example of converting a result set to JSON:

 
PS C:\> $conn  = Connect-BigCommerce -OAuthClientId -OAuthClientSecret -CallbackURL 'http://localhost:33333' -StoreId 'YoUrSToREId'
PS C:\> $row = Select-BigCommerce -Connection $conn -Table "Customers" -Columns (FirstName, LastName) -Where "Column2 = 'Bob'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Customers",
  "Columns":  [

  ],
  "FirstName":  "MyFirstName",
  "LastName":  "MyLastName"
}

Deleting Data

The following line deletes any records that match the criteria:

Select-BigCommerce -Connection $conn -Table Customers -Where "Column2 = 'Bob'" | Remove-BigCommerce

Modifying 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 $conn -Table Customers -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-BigCommerce -Connection $conn -Table Customers -Columns @("FirstName","LastName") -Values @($_.FirstName, $_.LastName) -Where "Id  = `'$_.Id`'"
  }else{
    Add-BigCommerce -Connection $conn -Table Customers -Columns @("FirstName","LastName") -Values @($_.FirstName, $_.LastName)
  }
}

Cmdlets for BigCommerce