Create ODBC Data Source (DSN) based on ZappySys API Driver

Step-by-step instructions

To get data from Amazon Selling Partner (SP-API) using SAP Crystal Reports we first need to create a DSN (Data Source) which will access data from Amazon Selling Partner (SP-API). We will later be able to read data using SAP Crystal Reports. Perform these steps:

1. Download and install ODBC PowerPack.

2. Open ODBC Data Sources (x64):

   

3. Create a User data source (User DSN) based on ZappySys API Driver:

   ZappySys API Driver

   
   • Create and use User DSN if the client application is run under a User Account. This is an ideal option in design-time, when developing a solution, e.g. in Visual Studio 2019. Use it for both type of applications - 64-bit and 32-bit.
   • Create and use System DSN if the client application is launched under a System Account, e.g. as a Windows Service. Usually, this is an ideal option to use in a production environment. Use ODBC Data Source Administrator (32-bit), instead of 64-bit version, if Windows Service is a 32-bit application.

4. When the Configuration window appears give your data source a name if you haven't done that already, then select "Amazon Selling Partner (SP-API)" from the list of Popular Connectors. If "Amazon Selling Partner (SP-API)" is not present in the list, then click "Search Online" and download it. Then set the path to the location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:

   AmazonSellingPartnerSpApiDSN

   Amazon Selling Partner (SP-API)

   

5. Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). More info is available in the Authentication section.

   Private app

   Amazon Selling Partner (SP-API) authentication

   Amazon Sellers can use SP-API to set up private integrations and build solutions exclusively for their Amazon store. Private app is available only to your organization and is self-authorized. A private developer builds application(s) that integrate their own company with Amazon APIs. [API reference]

   Perform the following steps to authenticate calls using Amazon SP-API Private app:

   1. Register as an Amazon Private SP-API Developer. You may need to wait for a day or two to get approved (check approval status).
   2. Once your developer account is approved, login to your account, visit developer console and click Add new app client button to create a Private app:
   3. Continue by naming your application in the App name field, choose SP API as API Type, and select the Roles for your app (i.e. permissions):
   4. Once you do that, click View link in LWA credentials column to copy Client identifier and Client secret (we will use them later):
   5. Now it's time to Authorize your app:
   6. Finish authorizing it by presing Authorize app button:
   7. Finally, copy the Refresh Token (we will use it in the next step):
   8. Now go to SSIS package or ODBC data source and use Private app authentication configuration:
      • In the ClientId field paste the Client identifier value you copied in the previous step.
      • In the ClientSecret field paste the Client secret value you copied in the previous step.
      • Leave the default value in the TokenUrl field.
      • In the Refresh Token field paste the Refresh Token value you copied in the previous step.
   9. Click Test Connection to confirm the connection is working.
   10. Done! Now you are ready to use Amazon Selling Partner (SP-API) Connector!

   API Connection Manager configuration

   Just perform these simple steps to finish authentication configuration:

   1. Set Authentication Type to Private app [OAuth]
   2. Optional step. Modify API Base URL if needed (in most cases default will work).
   3. Fill in all the required parameters and set optional parameters if needed.
   4. Press Generate Token button to generate the tokens.
   5. Finally, hit OK button:

   AmazonSellingPartnerSpApiDSN

   Amazon Selling Partner (SP-API)

   Private app [OAuth]

   https://sellingpartnerapi-na.amazon.com

   Required Parameters
   ClientId	Fill-in the parameter...
   ClientSecret	Fill-in the parameter...
   TokenUrl	Fill-in the parameter...
   Optional Parameters
   TokenUIMode	OnlyRefreshToken
   AuthUrl (Do not Use for Private app - Self Authorization)	https://sellercentral.amazon.com/apps/authorize/consent?application_id=[YOUR-APPLICATION-ID]&version=beta
   OrdersApiVersion	v0
   SellerApiVersion	v1
   ShippingApiVersion	v1
   ServicesApiVersion	v1
   FbaApiVersion	v1
   SalesApiVersion	v1
   ReportsApiVersion	2021-06-30
   ProductsFeesApiVersion	v0
   ProductPricingApiVersion	v0
   CatalogItemsApiVersion	2022-04-01
   VendorOrdersApiVersion	v1
   RetryMode	RetryWhenStatusCodeMatch
   RetryStatusCodeList	429
   RetryCountMax	5
   RetryMultiplyWaitTime	True

   

6. Once the data source connection has been configured, it's time to configure the SQL query. Select the Preview tab and then click Query Builder button to configure the SQL query:

   

   ZappySys API Driver - Amazon Selling Partner (SP-API)

   Amazon Selling Partner Connector (SP-API) can be used to integrated SP-API that helps Amazon sellers to programmatically exchange data on listings, orders, payments, reports, and more.

   AmazonSellingPartnerSpApiDSN

   

7. Start by selecting the Table or Endpoint you are interested in and then configure the parameters. This will generate a query that we will use in SAP Crystal Reports to retrieve data from Amazon Selling Partner (SP-API). Hit OK button to use this query in the next step.

   SELECT * FROM Orders
   --WHERE AmazonOrderId='902-1845936-5435065'		
   WITH(
   	  CreatedAfter='1900-01-01T00:00:00'
   --	, CreatedBefore='1900-01-01T00:00:00'
   --	, LastUpdatedAfter='1900-01-01T00:00:00'
   --	, LastUpdatedBefore='1900-01-01T00:00:00'
   --	, OrderStatuses='Pending~Unshipped~PartiallyShipped~PendingAvailability~Shipped~Canceled~Unfulfillable'
   --	, MarketplaceIds='ATVPDKIKX0DER~A2Q3Y263D00KWC~A2EUQ1WTGCTBG2'
   --	, FulfillmentChannels='AFN~MFN'
   --	, PaymentMethods='COD~CVS~Other'
   --	, AmazonOrderIds='1111111,222222,333333'
   )
   --CONNECTION(
   --	ServiceUrl='https://sellingpartnerapi-na.amazon.com'
   --)

   
   Some parameters configured in this window will be passed to the Amazon Selling Partner (SP-API) API, e.g. filtering parameters. It means that filtering will be done on the server side (instead of the client side), enabling you to get only the meaningful data much faster.

8. Now hit Preview Data button to preview the data using the generated SQL query. If you are satisfied with the result, use this query in SAP Crystal Reports:

   

   ZappySys API Driver - Amazon Selling Partner (SP-API)

   Amazon Selling Partner Connector (SP-API) can be used to integrated SP-API that helps Amazon sellers to programmatically exchange data on listings, orders, payments, reports, and more.

   AmazonSellingPartnerSpApiDSN

   SELECT * FROM Orders
   --WHERE AmazonOrderId='902-1845936-5435065'		
   WITH(
   	  CreatedAfter='1900-01-01T00:00:00'
   --	, CreatedBefore='1900-01-01T00:00:00'
   --	, LastUpdatedAfter='1900-01-01T00:00:00'
   --	, LastUpdatedBefore='1900-01-01T00:00:00'
   --	, OrderStatuses='Pending~Unshipped~PartiallyShipped~PendingAvailability~Shipped~Canceled~Unfulfillable'
   --	, MarketplaceIds='ATVPDKIKX0DER~A2Q3Y263D00KWC~A2EUQ1WTGCTBG2'
   --	, FulfillmentChannels='AFN~MFN'
   --	, PaymentMethods='COD~CVS~Other'
   --	, AmazonOrderIds='1111111,222222,333333'
   )
   --CONNECTION(
   --	ServiceUrl='https://sellingpartnerapi-na.amazon.com'
   --)

   
   You can also access data quickly from the tables dropdown by selecting <Select table>.
   A WHERE clause, LIMIT keyword will be performed on the client side, meaning that the whole result set will be retrieved from the Amazon Selling Partner (SP-API) API first, and only then the filtering will be applied to the data. If possible, it is recommended to use parameters in Query Builder to filter the data on the server side (in Amazon Selling Partner (SP-API) servers).

9. Click OK to finish creating the data source.

Video Tutorial

Read data in SAP Crystal Reports from the ODBC data source

1. First of all, open SAP Crystal Reports and create the new Crystal Report.

   

2. And it will open the new data source selection window. Under ODBC(RDO) double click on the Make New Connection and Select the desired ODBC DSN, in our case we need to select AmazonSellingPartnerSpApiDSN which we created in upper section. And Click on Next.

   AmazonSellingPartnerSpApiDSN

   

3. Expand the Connection and under the data select the desired table(s) or view(s) and click Add > button and click on Next.

   AmazonSellingPartnerSpApiDSN

   AmazonSellingPartnerSpApiDSN

   

4. Add the desired Fields to Display in the Reports. Here we are adding all fields and click on Finish.

   

5. That's it and you will be able to load the data in the Report.

   

Using ZappySys Driver Custom Views and Stored Procedure in SAP Crystal Report

You can create parameterized Stored Procedure and Virtual Tables on the same Data Source (ODBC DSN or Data Gateway Data Source). Please refer to this article for the same. You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.

Using Custom Views in the SAP Crystal Report

After establishing the connection with AmazonSellingPartnerSpApiDSN Data Source you can use the custom view in SQL Crystal Report.

Using Custom Stored Procedure in the SAP Crystal Report

1. First of all, create the custom stored procedure in the ZappySys Driver. Please refer to this article to create the custom stored procedure.
   
2. After establishing the connection with AmazonSellingPartnerSpApiDSN Data Source you can use the custom Stored Procedure in SQL Crystal Report. Same way you can write custom queries also in the query box.
   AmazonSellingPartnerSpApiDSN

   

Centralized data access via Data Gateway

In some situations, you may need to provide Amazon Selling Partner (SP-API) data access to multiple users or services. Configuring the data source on a Data Gateway creates a single, centralized connection point for this purpose.

This configuration provides two primary advantages:

• Centralized data access
  The data source is configured once on the gateway, eliminating the need to set it up individually on each user's machine or application. This significantly simplifies the management process.
• Centralized access control
  Since all connections route through the gateway, access can be governed or revoked from a single location for all users.

	Data Gateway	Local ODBC data source
Simple configuration
Installation	Single machine	Per machine
Connectivity	Local and remote	Local only
Connections limit	Limited by License	Unlimited
Central data access
Central access control
More flexible cost

If you need any of these requirements, you will have to create a data source in Data Gateway to connect to Amazon Selling Partner (SP-API), and to create an ODBC data source to connect to Data Gateway in SAP Crystal Reports.

Let's not wait and get going!

Creating Amazon Selling Partner (SP-API) data source in Gateway

In this section we will create a data source for Amazon Selling Partner (SP-API) in Data Gateway. Let's follow these steps to accomplish that:

1. Search for gateway in Windows Start Menu and open ZappySys Data Gateway Configuration:

   

2. Go to Users tab and follow these steps to add a Data Gateway user:

   • Click Add button
   • In Login field enter username, e.g., john
   • Then enter a Password
   • Check Is Administrator checkbox
   • Click OK to save
   

3. Now we are ready to add a data source:

   • Click Add button
   • Give Datasource a name (have it handy for later)
   • Then select Native - ZappySys API Driver
   • Finally, click OK
   AmazonSellingPartnerSpApiDSN

   ZappySys API Driver

   

4. When the ZappySys API Driver configuration window opens, configure the Data Source the same way you configured it in ODBC Data Sources (64-bit), in the beginning of this article.

5. Very important step. Now, after creating or modifying the data source make sure you:

   • Click the Save button to persist your changes.
   • Hit Yes, once asked if you want to restart the Data Gateway service.

   This will ensure all changes are properly applied:

   
   Skipping this step may result in the new settings not taking effect and, therefore you will not be able to connect to the data source.

Creating ODBC data source for Data Gateway

In this part we will create ODBC data source to connect to Data Gateway from SAP Crystal Reports. To achieve that, let's perform these steps:

1. Open ODBC Data Sources (x64):

   

2. Create a User data source (User DSN) based on ODBC Driver 17 for SQL Server:

   ODBC Driver 17 for SQL Server

   
   If you don't see ODBC Driver 17 for SQL Server driver in the list, choose a similar version driver.

3. Then set a Name of the data source (e.g. Gateway) and the address of the Data Gateway:

   GatewayDSN

   localhost,5000

   
   Make sure you separate the hostname and port with a comma, e.g. localhost,5000.

4. Proceed with authentication part:

   • Select SQL Server authentication
   • In Login ID field enter the user name you used in Data Gateway, e.g., john
   • Set Password to the one you configured in Data Gateway
   

5. Then set the default database property to AmazonSellingPartnerSpApiDSN (the one we used in Data Gateway):

   AmazonSellingPartnerSpApiDSN

   

6. Continue by checking Trust server certificate option:

   

7. Once you do that, test the connection:

   

8. If connection is successful, everything is good:

   

9. Done!

We are ready to move to the final step. Let's do it!

Accessing data in SAP Crystal Reports via Data Gateway

Finally, we are ready to read data from Amazon Selling Partner (SP-API) in SAP Crystal Reports via Data Gateway. Follow these final steps:

1. Go back to SAP Crystal Reports.

2. First of all, open SAP Crystal Reports and create the new Crystal Report.

   

3. And it will open the new data source selection window. Under ODBC(RDO) double click on the Make New Connection and Select the desired ODBC DSN, in our case we need to select GatewayDSN which we created in upper section. And Click on Next.

   GatewayDSN

   

4. Read the data the same way we discussed at the beginning of this article.

5. That's it!

Now you can connect to Amazon Selling Partner (SP-API) data in SAP Crystal Reports via the Data Gateway.

Actions supported by Amazon Selling Partner (SP-API) Connector

Learn how to perform common Amazon Selling Partner (SP-API) actions directly in SAP Crystal Reports with these how-to guides:

• Download Report File to Local Disk
• Get FBA Inventory Summaries (Fulfilled By Amazon)
• Get Market Place Participations
• Get Order (Single)
• Get Order Items (For Single Order)
• Get Orders
• Get Orders Items (For All Orders **Slow**)
• Get Report Data - Comma Separated File (CSV)
• Get Report Data - JSON File
• Get Report Data - Tab Separated File (TSV)
• Get Report Data - XML File
• Get Report Filters
• Get Report Options
• Get Report Types
• Get Vendor PurchaseOrder Items
• Get Vendor PurchaseOrders
• Search Catalog Items
• Make Generic API Request
• Make Generic API Request (Bulk Write)

Conclusion

In this article we showed you how to connect to Amazon Selling Partner (SP-API) in SAP Crystal Reports and integrate data without any coding, saving you time and effort.

We encourage you to download Amazon Selling Partner (SP-API) Connector for SAP Crystal Reports and see how easy it is to use it for yourself or your team.

If you have any questions, feel free to contact ZappySys support team. You can also open a live chat immediately by clicking on the chat icon below.

Download Amazon Selling Partner (SP-API) Connector for SAP Crystal Reports Documentation

More integrations

Other connectors for SAP Crystal Reports

Other application integration scenarios for Amazon Selling Partner (SP-API)