eBay Analytics Connection

See the Connector Marketplace topic. Please request your administrator to start a trial or subscribe to the Premium eBay Analytics connector.

eBay Analytics provides analytical tools and insights for sellers on the eBay marketplace.

This topic describes how to authenticate to eBay Analytics and configure any necessary connection properties in the eBay Analytics connection connector.

Connection Configuration #

Each connection property available in the eBay Analytics connector is explained below.

Connection Name #

The name of the connection to be created should be provided. This is the name that will display on the list of available connections.

Auth Scheme #

The scheme used for authentication. Accepted entries are OAuth and OAuthClient.

Possible Values

• OAuth: Set to this to perform OAuth authentication with the code grant type.

• OAuthClient: Set to this to perform OAuth with the client credentials grant type.

Client ID #

The client ID assigned when you register your application with an OAuth authorization server.

Client Secret #

The client secret assigned when you register your application with an OAuth authorization server.

Refresh Token #

The OAuth refresh token for the corresponding OAuth access token.

Marketplace Id #

The identification number for the eBay Marketplace.

By default, it has no value assigned to it, this means that to query the reports: CustomerServiceMetricByCategory, CustomerServiceMetricByShippingRegion, TrafficReportByDay and TrafficReportByListing, you must specify the MarketplaceId/s in the query criteria.

You should note that each report is supported in distinct marketplaces, as outlined below:

• CustomerServiceMetricByCategory: Australia (EBAY_AU), Canada (EBAY_CA), France (EBAY_FR), Germany (EBAY_DE), Great Britain (EBAY_GB), Italy (EBAY_IT), Spain (EBAY_ES), United States (EBAY_US).

• CustomerServiceMetricByShippingRegion: Australia (EBAY_AU), Canada (EBAY_CA), France (EBAY_FR), Germany (EBAY_DE), Great Britain (EBAY_GB), Italy (EBAY_IT), Spain (EBAY_ES), United States (EBAY_US).

• TrafficReportByDay: Australia (EBAY_AU), Germany (EBAY_DE), Great Britain (EBAY_GB), United States (EBAY_US).

• TrafficReportByListing: Australia (EBAY_AU), Germany (EBAY_DE), Great Britain (EBAY_GB), United States (EBAY_US).

OAuth Grant Type #

The grant type for the OAuth flow.

The following options are available: CODE, CLIENT.

Use Sandbox #

A boolean indicating if you are using a sandbox account.

RuName #

The Redirect URL name used for validation.

It is not necessary when refreshing the Access Token. This property is only needed when performing the Code grant type OAuth flow to get an Access Token.

You can obtain this by clicking User Tokens from your developer account, clicking Get a Token from eBay via Your Application, and then clicking Add eBay Redirect URL.

Enable SSL #

Option to enable SSL. This field sets whether the connector will attempt to negotiate TLS/SSL connections to the server. By default, the connector checks the server’s certificate against the system’s trusted certificate store.

Upload Keystore File #

If SSL is enabled, a keystore file has to be uploaded using this option.

Add Configuration: Additional properties can be added using this option as key-value pairs.

After entering all the details, click on the TEST button.

If the connection service identification and authentication details are provided correctly, a success message stating “connection available” is generated.

Click on the CREATE button to save the changes.

If the details are incorrect or the server is down, you will get a message “Connection unavailable”.