Cmdlets for Amazon Marketplace

Build 24.0.9060

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 AmazonMarketplace 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 AmazonMarketplaceCmdlets

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

Import-Module AmazonMarketplaceCmdlets;

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

$conn = Connect-AmazonMarketplace -InitiateOAuth "GETANDREFRESH" -Marketplace "United States"

Connecting to Amazon Marketplace

The following properties are required:

  • Schema: Set this to SellerCentral.
  • InitiateOAuth: Set this to GETANDREFRESH.
  • Marketplace: Set this to the Marketplace region that you are registered to sell in.

Authenticate to Amazon Marketplace

OAuth

Amazon Marketplace uses the OAuth authentication standard.

To authenticate using OAuth, you must either use the embedded application or create a new custom OAuth app. The embedded application supports desktop applications and headless machines. Web applications require that you create a custom OAuth application.

You can use a custom OAuth application to authenticate with a service account or a user account. See Creating a Custom OAuth App for more information.

Downloading Embedded Credentials

Because Amazon Marketplace requires that embedded credentials rotate every six months, CData credentials are hosted on oa.cdata.com. If you do not specify custom credentials, the embedded credentials are downloaded from our web service and saved in the location specified in OAuthClientLocation by default. NOTE: Make sure your firewall does not block oa.cdata.com.

Desktop Apps

You can use the embedded application or create a custom OAuth application. The key difference is that you must set additional connection properties if you use a custom application.

Get and Refresh the OAuth Access Token

After setting the following, you are ready to connect:

  • Marketplace: Set this to the Marketplace region that you are registered to sell in.
  • AppId: Set this to the application Id for the Selling Partner application you created.
  • Schema: Set this to SellerCentral to connect to Seller Central API.
  • AWSAccessKey: This is the Access Key tied to the AWS user that is associated with the OAuthClientId.
  • AWSSecretKey: This is the Secret Key tied to the AWS user that is associated with the OAuthClientId.
  • OAuthClientId (custom applications only): Set this to the client Id assigned when you registered your app.
  • OAuthClientSecret (custom applications only): Set this to the client secret assigned when you registered your app.
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, use OAuth with a user account on a headless machine. You need to authenticate on another device that has an internet browser with a user account or serviced account.

  1. 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.

  2. Then configure the cmdlet to automatically refresh the access token from the headless machine.

Option 1: Obtain and Exchange a Verifier Code

Follow these steps to authenticate from another machine and obtain the OAuthVerifier connection property:

  1. Choose one of these options:
    • If you are using the Embedded OAuth Application, call the GetOAuthAuthorizationURL stored procedure. Open the URL returned by the stored procedure in a browser.
    • If you are using a custom OAuth application, set the following properties:
      • InitiateOAuth: Set this to OFF.
      • OAuthClientId (custom applications only): Set this to the Client Id in your application settings.
      • OAuthClientSecret (custom applications only): Set this to the Client Secret in your application settings.

        Then call the GetOAuthAuthorizationURL stored procedure with the appropriate CallbackURL. Open the URL returned by the stored procedure in a browser.

  2. Log in and grant permissions to the cmdlet. You are then redirected to the callback URL, which contains the verifier code as the value for 'spapi_oauth_code'. Save the value of the verifier code. You must set this in the OAuthVerifier connection property later.

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

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

  • OAuthClientId (custom applications only): Set this to the consumer key in your application settings.
  • OAuthClientSecret (custom applications only): Set this to the consumer secret in your application settings.
  • OAuthVerifier: Set this to the verifier code.
  • OAuthSettingsLocation: Set this to persist the encrypted OAuth authentication values to the specified location.
  • InitiateOAuth: Set this to REFRESH.

After the OAuth settings file is generated, set the following properties to connect to data:

  • OAuthClientId (custom applications only): Set this to the consumer key in your application settings.
  • OAuthClientSecret (custom applications only): Set this to the consumer secret in your application settings.
  • OAuthSettingsLocation: Set this to the location containing the encrypted OAuth authentication values. Make sure this location gives read and write permissions to the provider to enable the automatic refreshing of the access token.
  • InitiateOAuth: Set this to REFRESH.
  • Marketplace: Set this to the Marketplace region that you are registered to sell in.
  • Schema: Set this to SellerCentral to connect to Seller Central API.
  • AppId: Application Id for Selling Partner application you created.
  • AWSAccessKey: This is the Access Key tied to the AWS user that is associated with the OAuthClientId.
  • AWSSecretKey: This is the Secret Key tied to the AWS user that is associated with the OAuthClientId.

Option 2: Transfer OAuth Settings

Follow the steps below to install the cmdlet on another machine, authenticate, and then transfer the resulting OAuth values.

On a second machine, install the cmdlet and connect with the following properties set:

  • OAuthSettingsLocation: Set this to a writable location.
  • OAuthClientId (custom applications only): Set this to the client Id assigned when you registered your app.
  • OAuthClientSecret (custom applications only): Set this to the client secret assigned when you registered your app.

Test the connection to authenticate. The resulting authentication values are encrypted and written to a file located in the path specified by OAuthSettingsLocation. After 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 consumer key in your application settings.
  • OAuthClientSecret (custom applications only): Set this to the consumer secret in your application settings.
  • 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.
  • Marketplace: Set this to the Marketplace region that you are registered to sell in.
  • Schema: Set this to SellerCentral to connect to Seller Central API.
  • AppId: Application Id for Selling Partner application you created.
  • AWSAccessKey: This is the Access Key tied to the AWS user that is associated with the OAuthClientId.
  • AWSSecretKey: This is the Secret Key tied to the AWS user that is associated with the OAuthClientId.

Retrieving Data

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

$results = Select-AmazonMarketplace -Connection $conn -Table "Orders" -Columns @("Id, SellerOrderId") -Where "BuyerEmail='[email protected]'"
The Invoke-AmazonMarketplace 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-AmazonMarketplace -Connection $conn -Table Orders -Where "BuyerEmail = '[email protected]'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myOrdersData.csv -NoTypeInformation

You will notice that we piped the results from Select-AmazonMarketplace 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-AmazonMarketplace -InitiateOAuth "GETANDREFRESH" -Marketplace "United States" 
PS C:\> $row = Select-AmazonMarketplace -Connection $conn -Table "Orders" -Columns (Id, SellerOrderId) -Where "BuyerEmail = '[email protected]'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Orders",
  "Columns":  [

  ],
  "Id":  "MyId",
  "SellerOrderId":  "MySellerOrderId"
}

Deleting Data

The following line deletes any records that match the criteria: 

Select-AmazonMarketplace -Connection $conn -Table Orders -Where "BuyerEmail = '[email protected]'" | Remove-AmazonMarketplace

Modifying Data

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

Import-Csv -Path C:\MyOrdersUpdates.csv | %{
  $record = Select-AmazonMarketplace -Connection $conn -Table Orders -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-AmazonMarketplace -Connection $conn -Table Orders -Columns @("Id","SellerOrderId") -Values @($_.Id, $_.SellerOrderId) -Where "Id  = `'$_.Id`'"
  }else{
    Add-AmazonMarketplace -Connection $conn -Table Orders -Columns @("Id","SellerOrderId") -Values @($_.Id, $_.SellerOrderId)
  }
}

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060