eBay Connection Details¶

Introduction¶

Connector Version

This documentation is based on version 23.0.8803 of the connector.

Get Started¶

eBay Version Support

The connector allows a relational view of entities from the Trading, FileTransfer, BulkData, Feedback, and Merchandising APIs.

Establish a Connection¶

Connect to eBay APIs¶

Set the following to connect to eBay:

• SiteID: Set this to the eBay site ID. By default this is "0" (the U.S. site).
• UseSandbox: Set this to True to use a eBay sandbox account. By default, the connector connects to production environments.
• RuName: Set this to the RuName (eBay Redirect URL name) that you will use to sign-in. Find this in your eBay Sign-in Settings.

Authenticate to eBay¶

The connector can authenticate to eBay using either the OAuth 2.0 authentication standard or Auth'n'Auth, the traditional authentication used by the eBay APIs.

User Accounts (OAuth)¶

Set AuthScheme to OAuth.

Desktop Applications¶

You need to create a custom OAuth application. See Creating a Custom OAuth App for information about creating custom applications.

Get and Refresh the OAuth Access Token

After setting the following, you are ready to connect:

• InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
• OAuthClientId: Set this to the App ID (Client ID) in your keyset.
• OAuthClientSecret: Set this to the Cert ID (Client Secret) in your keyset.
• CallbackURL: Set to a URL containing the server name and port of the device running the connector. Any localhost address is usable. The default callback URL is: http://localhost:33333.

When you connect, the connector opens eBay's OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process:

1. The connector obtains an access token from eBay and uses it to request data.
2. The OAuth values are saved in the location specified in OAuthSettingsLocation, to be persisted across connections.

The connector refreshes the access token automatically when it expires.

User Accounts with Legacy Apps (Auth'n'Auth)¶

The connector can authenticate using eBay's legacy Auth'n'Auth protocol. Select this authentication scheme if you're using an older application that was built to use Auth'n'Auth.

Set AuthScheme to AuthNAuth.

You need to create a custom OAuth application. See Creating a Custom OAuth App for more information.

Access Token¶

An OAuthAccessToken is required when authenticating via Auth'n'Auth. Set the following connection properties to obtain the OAuthAccessToken:

• OAuthClientId: Set this to the App ID (Client ID) in your keyset.
• OAuthClientSecret: Set this to the Cert ID (Client Secret) in your keyset.
• DevID: Set this to the Developer ID from your keyset.

Then call stored procedures to complete the token exchange:

1. Call the GetOAuthAuthorizationURL stored procedure. Set the RuName input to the eBay Redirect URL you specified in your app settings. The stored procedure returns the URL to the OAuth endpoint.

2. Navigate to the URL that the stored procedure returned in Step 1. Log in, and authorize the web application. After authenticating, the browser redirects you to the redirect URI. There will be a parameter called sessionid appended to the redirect URI. Note the value of this parameter. If you are using the recommeded https://oauth.cdata.com/oauth/ as your "auth accepted URL", the value will be BASE64 encoded and will need to be decoded before proceeding.

3. Call the GetOAuthAccessToken stored procedure. Set the AuthMode input to WEB. Set the SessionId input parameter to either the value of the 'sessionid' in the query string of the authorization URL or the BASE64 decoded session ID from the callback URL.

Set the following connection properties to connect to data:

• OAuthClientId: Set this to the App ID (Client ID) in your keyset.

• OAuthClientSecret: Set this to the Cert ID (Client Secret) in your keyset.

• OAuthAccessToken: Set this to the Auth'n'Auth token returned by GetOAuthAccessToken.

• DevID: Set this to the Developer ID from your keyset.

Create a Custom OAuth App¶

There are two authentication methods available for connecting to eBay: using a token generated for accessing only personal data or using tokens that allow other users to access their own data. Both methods require you to join the eBay Developers Program.

Register and Get Your Keyset¶

After joining the eBay Developers Program, you can obtain the following values from the Developer Account Dashboard > Application Keysets page.

1. OAuthClientId (App ID)
2. DevID
3. OAuthClientSecret (Cert ID)

Create an OAuth App¶

You can create OAuth apps meant to be used by either a single or multiple users. These scenarios are detailed in the following sections.

Single User¶

If you are working with your own account, follow the steps below to generate a token from eBay's user interface:

1. Go to your Developer Account Dashboard and open the User Access Tokens page.
2. Select the environment for your app.
   • Select Production if you are searching for real items or listing real items to the live eBay site.
   • Select Sandbox if you are creating test listings in the sandbox.
3. Underneath Get a User Token Here, select the authentication method to use when generating a token. OAuth tokens are valid for all eBay APIs (RESTful APIs and Traditional APIs), while Auth'n'Auth tokens are only valid for the Traditional APIs.
4. Click Sign in to Sandbox or Sign in to Production depending on the environment, and log in with credentials for either your sandbox or production eBay account.

Multiple Users¶

eBay implements the OAuth authentication standard, which you can use to access your own data or allow other users to access their own data.

Follow the steps below to configure the user consent flow:

1. Go to your Developer Account Dashboard and open the User Access Tokens page.
2. Select the environment for your app.
   • Select Production if you are searching for real items or listing real items to the live eBay site.
   • Select Sandbox if you are creating test listings in the sandbox.
3. Underneath Your eBay Sign-in Settings in the Get a Token from eBay via Your Application section, add a new RuName (eBay Redirect URL) by clicking on Add eBay Redirect URL or expand the tab for the RuName that you will be using to authenticate.
4. Check the OAuth Enabled checkbox for your RuName. If it is not enabled, then only the Auth'n'Auth authentication method will be supported.
5. Set Your auth accepted URL to https://oauth.cdata.com/oauth/ since the eBay requires a secure Redirect URI (https) and does not accept a localhost URI.
6. Click Save to save your changes.
7. Select OAuth, then click Test Sign-In to verify that you can sign-in with your RuName.

Important Notes¶

Configuration Files and Their Paths¶

• All references to adding configuration files and their paths refer to files and locations on the Harmony Agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.

Advanced Features¶

This section details a selection of advanced features of the eBay connector.

User Defined Views

The connector allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Proxy

To configure the connector using Private Agent proxy settings, select the Use Proxy Settings checkbox on the connection configuration screen.

Query Processing

The connector offloads as much of the SELECT statement processing as possible to eBay and then processes the rest of the query in memory (client-side).

User Defined Views¶

The eBay connector allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from Jitterbit. The User Defined Views can be used to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.

There are two ways to create user defined views:

• Create a JSON-formatted configuration file defining the views you want.
• DDL statements.

Define Views Using a Configuration File¶

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
    "MyView": {
        "query": "SELECT * FROM ItemListing WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Define Views Using DDL Statements¶

The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.

Create a View¶

To create a new view using DDL statements, provide the view name and query as follows:

CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;

If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews connection property.

Alter a View¶

To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:

ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';

The view is then updated in the JSON configuration file.

Drop a View¶

To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.

DROP LOCAL VIEW [MyViewName]

This removes the view from the JSON configuration file. It can no longer be queried.

Schema for User Defined Views¶

User Defined Views are exposed in the UserViews schema by default. This is done to avoid the view's name clashing with an actual entity in the data model. You can change the name of the schema used for UserViews by setting the UserViewsSchemaName property.

Work with User Defined Views¶

For example, a SQL statement with a User Defined View called UserViews.RCustomers only lists customers in Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

An example of a query to the driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resulting in the effective query to the source:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

That is a very simple example of a query to a User Defined View that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.

SSL Configuration¶

Customize the SSL Configuration¶

By default, the connector attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Data Model¶

The eBay connector models entities in the eBay API as tables, views, and stored procedures. These are defined in schema files, which are simple, text-based configuration files.

API limitations and requirements are documented in this section; you can use the SupportEnhancedSQL feature, set by default, to circumvent most of these limitations.

Tables

The eBay connector models Item Listings in tables so that they can be easily queried, updated, and deleted. You can list items on your eBay store by calling the AddItem stored procedure.

Views

Views are tables that cannot be modified. Typically, read-only data are shown as views.

Stored Procedures

Stored Procedures are function-like interfaces to the data source. They can be used to search, update, and modify information in the data source.

AuthNAuth Limitations¶

If you use the Auth'n'Auth authentication scheme, the following tables/views are Unavailable:

• Sell API

  • Tables
    • Tasks
  • Views
    • FulfillmentPolicies
    • PaymentPolicies
    • ReturnPolicies
  • Stored Procedures
    • UploadFile
    • GetResultFile
    • CreateOrderTask
    • CreateInventoryTask
  • Commerce API
  • Views
    • CategorySuggestions
    • CategorySubtree
    • CompatibilityProperties
    • CompatibilityPropertyValues
    • CategoryTree
    • DefaultCategoryTreeId
    • ItemAspectsForCategory

Tables¶

The connector models the data in eBay as a list of tables in a relational database that can be queried using standard SQL statements.

eBay Connector Tables¶

ItemListing¶

Update, delete, and query Item Listings for sellers.

Table Specific Information¶

Select¶

The following query retrieves seller items. By default this query returns items that were added in the last 100 days.

SELECT * FROM ItemListing

ItemListing is the only table that supports ORDER BY. Only two columns can be used for ordering: StartTime and EndTime. The following query retrieves items that end between the specified time, ordered by the item ending soonest.

SELECT * FROM ItemListing WHERE EndTimeFrom = '2016-01-25' AND EndTimeTo = '2016-02-05' ORDER BY EndTime

INSERT¶

The AddItem stored procedure provides the functionality to add a new item.

Update¶

The inputs that are required for an update depend on the type of the item and its category. At least the ItemId and one property of the item must be provided in an update.

UPDATE ItemListing SET Title = 'My Awesome Item' WHERE ItemId = '123456789'

After one item in a multiquantity listing has been sold, sellers cannot change the values in the Title, Primary Category, Secondary Category, Listing Duration, and Listing Type fields. However, all other fields are still editable.

Delete¶

The ItemId and EndingReason must be specified to delete an item.

DELETE FROM ItemListing WHERE ItemId = '123456789' AND  EndingReason = 'LostOrBroken'

Columns¶

Pseudo-Columns¶

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

ItemVariations¶

Item Variations are multiple similar (but not identical) items in a single fixed-price listing. For example, a T-shirt listing could contain multiple items of the same brand that vary by color and size; each variation would specify a combination of one of these colors and sizes. Each variation can have a different quantity and price. You can buy multiple items from one variation at the same time. (That is, one order line item can contain multiple items from a single variation.)

Table Specific Information¶

Select¶

An item ID must be specified to get variations for the item which this ID represents.

SELECT * FROM ItemVariations WHERE ItemId = '110187147205'

Insert¶

The fields which are required for insert are ItemId, VariationSpecificsAggregate, StartPrice, and Quantity. VariationSpecificsAggregate should contain variation specifics structured in XML format. For instance, the following VariationSpecificsAggregate adds a large blue item:

<NameValueList>
  <Name>Color</Name>
  <Value>Blue</Value>
</NameValueList>
<NameValueList>
  <Name>Size</Name>
  <Value>L</Value>
</NameValueList>

The following query adds a variation of a large blue item with a StartPrice of 15 and a Quantity of 100.

INSERT INTO ItemVariations (ItemId, VariationSpecificsAggregate, Quantity, StartPrice) VALUES ('110188946596', '<NameValueList><Name>Color</Name><Value>Blue</Value></NameValueList><NameValueList><Name>Size</Name><Value>L</Value></NameValueList>', '100', '15')

Update¶

ItemId and VariationSpecificsAggregate are required for updating a variation. Optionally other details can be provided for variations, like StartPrice and Quantity. VariationSpecificsAggregate should be in XML format and should contain all specifics which identify a variation.

UPDATE ItemVariations SET Quantity = '5' WHERE ItemId = '110188946596' AND VariationSpecificsAggregate = '<NameValueList><Name>Color</Name><Value>Blue</Value></NameValueList><NameValueList><Name>Size</Name><Value>L</Value></NameValueList>'

Delete¶

ItemId and VariationSpecificsAggregate are required for deleting a variation.

DELETE FROM ItemVariations WHERE ItemId = '110188946596' AND VariationSpecificsAggregate = '<NameValueList><Name>Color</Name><Value>Blue</Value></NameValueList><NameValueList><Name>Size</Name><Value>L</Value></NameValueList>'

Columns¶

Tasks¶

Retrieves all the tasks for the marketplace you specify using the MarketplaceId query parameter.

Select¶

FeedType is required filter in the Select query. You can follow the query below to obtain the required values through SQL:

SELECT * FROM [Tasks] WHERE FeedType = 'LMS_ADD_ITEM'

Some of the fields are named with the suffix Aggr. These fields display the content of the JSON tag with the same name that is returned from the API endpoint.

Insert¶

FeedType, MarketplaceID and SchemaVersion are required in the Insert query. You can follow the query below to obtain the required values through SQL:

INSERT INTO [Tasks] (FeedType, MarketplaceID, SchemaVersion) VALUES ('LMS_ADD_ITEM', 'EBAY_US', '1149')

Columns¶

Pseudo-Columns¶

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Views¶

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

eBay Connector Views¶

Bidders¶

Query eBay users that bid on a specified listing, regardless of whether the listing has ended.

Table Specific Information¶

Select¶

The only supported columns for filtering are ItemId and ListMode. An ItemId must be specified for retrieving data from this view.

SELECT * FROM Bidders WHERE ItemId = '1234567'

SELECT * FROM Bidders WHERE ItemId = '1234567' AND ListMode = 'EndedListing'

Columns¶

Pseudo-Columns¶

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Categories¶

Query eBay Categories.

Table Specific Information¶

Select¶

The only columns supported for filtering are CategorySiteId, LevelLimit, and CategoryParentId.

SELECT * FROM Categories.

You can return more information about a specific category and its subcategories with the following query:

SELECT * FROM Categories WHERE LevelLimit = '2' AND CategoryParent = '267'

Columns¶

Pseudo-Columns¶

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

CategoryFeatures¶

Query the settings supported by eBay Categories.

Table Specific Information¶

Select¶

The only columns supported for filtering are CategoryId, LevelLimit, AllFeaturesForCategory, and FeatureId. If no CategoryId is specified , all features for top level categories will be returned.

SELECT * FROM CategoryFeatures WHERE LevelLimit = '2' AND CategoryId = '277'

Columns¶

Pseudo-Columns¶

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

CategorySubtree¶

Retrieve all nodes of the category tree hierarchy (the subtree) below a specified category in a specified category tree.

Table Specific Information¶

Select¶

The connector will use the eBay API to process WHERE clause conditions built with the following column and operator. The CategoryTreeId and CategoryId is required to make a request and the rest of the filter is executed client-side within the connector.

• CategoryTreeId supports the '=' comparison.
• CategoryId supports the '=' comparison.

For example:

SELECT * FROM CategorySubtree WHERE CategoryTreeId = 0 AND CategoryId = 11450

Columns¶

CategorySuggestions¶

Return an array of suggested categories that eBay has determined correspond to keywords that describe an item.

Table Specific Information¶

Select¶

The connector will use the eBay API to process WHERE clause conditions built with the following column and operator. The CategoryTreeId and Q is required to make a request and the rest of the filter is executed client-side within the connector.

• CategoryTreeId supports the '=' comparison.
• Q supports the '=' comparison.

For example:

SELECT * FROM CategorySuggestions WHERE CategoryTreeId = 0 AND Q = 'iphone'

Columns¶

Pseudo-Columns¶

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

CategoryTree¶

Retrieve the complete category tree corresponding to a specified category tree ID.

Table Specific Information¶

Select¶

The connector will use the eBay API to process WHERE clause conditions built with the following column and operator. The CategoryTreeId is required to make a request and the rest of the filter is executed client-side within the connector.

• CategoryTreeId supports the '=' comparison.

For example:

SELECT * FROM CategoryTree WHERE CategoryTreeId = 0

Columns¶

CompatibilityProperties¶

Retrieve an array of parts compatibility aspects that are used to describe compatible vehicles.

Table Specific Information¶

Select¶

The connector will use the eBay API to process WHERE clause conditions built with the following column and operator. The CategoryTreeId and CategoryId is required to make a request and the rest of the filter is executed client-side within the connector.

• CategoryTreeId supports the '=' comparison.
• CategoryId supports the '=' comparison.

For example:

SELECT * FROM CompatibilityProperties WHERE CategoryTreeId = 101 AND CategoryId = 33559

Columns¶

CompatibilityPropertyValues¶

Retrieve an array of parts compatibility aspect values that are used to describe compatible vehicles.

Table Specific Information¶

Select¶

The connector will use the eBay API to process WHERE clause conditions built with the following column and operator. The CategoryTreeId, CategoryId and CompatibilityProperty is required to make a request and the rest of the filter is executed client-side within the connector.

• CategoryTreeId supports the '=' comparison.
• CategoryId supports the '=' comparison.
• CompatibilityProperty supports the '=' comparison.

For example:

SELECT * FROM CompatibilityPropertyValues WHERE CategoryTreeId = 101 AND CategoryId = 33559 AND CompatibilityProperty = 'Trim'

Columns¶

Countries¶

Lists the country code and associated name of the countries supported by the eBay system, regardless of the site specified in the request.

Columns¶

Pseudo-Columns¶

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Currencies¶

Query the supported Currencies in eBay.

Table Specific Information¶

Select¶

Returns all supported currencies. No columns are supported for filtering.

SELECT * FROM Currencies

Columns¶

Pseudo-Columns¶

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

DefaultCategoryTreeId¶

Retrieve the default category tree reference for a specific eBay marketplace.

Table Specific Information¶

Select¶

The connector will use the eBay API to process WHERE clause conditions built with the following column and operator. The MarketplaceId is required to make a request and the rest of the filter is executed client-side within the connector.

• MarketplaceId supports the '=' comparison.

For example:

SELECT * FROM DefaultCategoryTreeId WHERE MarketplaceId = 'EBAY_US'

Columns¶

Pseudo-Columns¶

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

FulfillmentPolicies¶

Retrieves all the fulfillment policies configured for the marketplace you specify using the MarketplaceId query parameter.

Select¶

MarketplaceId is required filter in the Select query. You can follow the query below to obtain the required values through SQL:

SELECT * FROM FulfillmentPolicies WHERE MarketplaceId = 'EBAY_US'

Some of the fields are named with the suffix Aggr. These fields display the content of the JSON tag with the same name that is returned from the API endpoint.

Columns¶

HighestBidder¶

Query the Highest Bidder of the eBay users who bid on a specified listing, regardless of whether the listing has ended.

Table Specific Information¶

Select¶

The only supported columns for filtering are ItemId and ListMode. An ItemId must be specified for retrieving data from this view.

SELECT * FROM HighestBidder WHERE ItemId = '1234567'

SELECT * FROM HighestBidder WHERE ItemId = '1234567' AND ListMode = 'EndedListing'

Columns¶

Pseudo-Columns¶

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

ItemAspectsForCategory¶

Retrieve an array of aspects that are appropriate for describing items in a specified category.

Table Specific Information¶

Select¶

The connector will use the eBay API to process WHERE clause conditions built with the following column and operator. The CategoryTreeId and CategoryId is required to make a request and the rest of the filter is executed client-side within the connector.

• CategoryTreeId supports the '=' comparison.
• CategoryId supports the '=' comparison.

For example:

SELECT * FROM ItemAspectsForCategory WHERE CategoryTreeId = 101 AND CategoryId = 67726

Columns¶

ItemCompatibilityList¶

Query compatability categories and possible compatability values for a specific item.

Columns¶

Pseudo-Columns¶

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

ItemShipping¶

Query details pertinent to one or more items for which calculated shipping has been offered by the seller, such as package dimension, weight, and packaging/handling costs.

Table Specific Information¶

Select¶

The DestinationCountryCode and ItemId filters must be specified for retrieving data from this view. Also, the QuantitySold filter can be used but it is optional.

SELECT * FROM ItemShipping WHERE ItemId = '110177686055' AND DestinationCountryCode = 'US'

Columns¶

Pseudo-Columns¶

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

ItemSpecifics¶

Query item specifics for a specific item.

Columns¶

Pseudo-Columns¶

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

ItemTransactions¶

Query order line item (transaction) information for a specified listing. For auction listings, order line items are not created until the auction ends with a winning bidder, or if the Buy It Now feature is enabled for the listing and used by the buyer to purchase the item. For fixed-price listings, order line items are created after a buyer has committed to purchase the item(s).

Table Specific Information¶

Select¶

The ItemId column must be specified to retrieve transaction information.

Get all transactions related to a specific item:

SELECT * FROM ItemTransactions WHERE ItemId = '012345678901'

Filter the number of transactions returned by specifying the number of days in the past:

SELECT * FROM ItemTransactions WHERE ItemId = '012345678901' AND NumberOfDays = '25'

Get information for a specific transaction that was made for a specific item:

SELECT * FROM ItemTransactions WHERE ItemId = '012345678901' AND TransactionId = '0'

Columns¶

Pseudo-Columns¶

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

MostWatchedItems¶

Query items with the highest watch counts for the entire site or for a specific category. The top items are determined by the Watch Count totals from the preceding day. Ranking of the Most Watched Items is calculated with the latest Watch Count information.

Table Specific Information¶

Select¶

The only columns that can be used to filter are CategoryId, AffiliateCustomId, AffiliateNetworkId, and AffiliateTrackingId. These filters are optional.

SELECT * FROM MostWatchedItems

SELECT * FROM MostWatchedItems WHERE CategoryId = '277'

Columns¶

Pseudo-Columns¶

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

OrderPayments¶

Query all payments of the orders, in which the authenticated user is either the buyer or seller. By default, only payment details of orders made in the last 90 days are returned. Payment details of orders older than 90 days can be retrieved by specifying OrderId.

View Specific Information¶

Select¶

Examples of querying the OrderPayments view:

SELECT * FROM OrderPayments WHERE ModTimeFrom = '2/22/2018'

SELECT * FROM OrderPayments WHERE NumberOfDays = '30'

Columns¶

Pseudo-Columns¶

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Orders¶

Query all orders in which the authenticated user is either the buyer or seller. By default, only orders made in the last 90 days are returned. Orders older than 90 days can be retrieved by specifying OrderId.

View Specific Information¶

Select¶

Examples of querying the Orders view:

SELECT * FROM Orders WHERE OrderId = '110276240386-28854859001'

SELECT * FROM Orders WHERE OrderId IN ('110276240386-28854859001', '110277719772-28859911001')

SELECT * FROM Orders WHERE CreateTimeFrom = '2018-02-10' AND CreateTimeTo = '2018-03-16'

SELECT * FROM Orders WHERE OrderStatus = 'Active'

SELECT * FROM Orders WHERE NumberOfDays = '26'

Columns¶

Pseudo-Columns¶

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

OrderShipping¶

Query shipping details of the orders in which the authenticated user is either the buyer or seller. By default, only shipping details of orders made in the last 90 days are returned. Shipping details of orders older than 90 days can be retrieved by specifying OrderId.

View Specific Information¶

Select¶

Examples of querying the OrderShipping view:

SELECT * FROM OrderShipping WHERE NumberOfDays = '30'

SELECT * FROM OrderShipping WHERE CreateTimeFrom = '2018-02-10' AND CreateTimeTo = '2018-03-16'

Columns¶

Pseudo-Columns¶

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

PaymentPolicies¶

Retrieves all the payment policies configured for the marketplace you specify using the MarketplaceId query parameter.

Select¶

MarketplaceId is required filter in the Select query. You can follow the query below to obtain the required values through SQL:

SELECT * FROM PaymentPolicies WHERE MarketplaceId = 'EBAY_US'

Some of the fields are named with the suffix Aggr. These fields display the content of the JSON tag with the same name that is returned from the API endpoint.

Columns¶

ReturnPolicies¶

Retrieves all the return policies configured for the marketplace you specify using the MarketplaceId query parameter.

Select¶

MarketplaceId is required filter in the Select query. You can follow the query below to obtain the required values through SQL:

SELECT * FROM ReturnPolicies WHERE MarketplaceId = 'EBAY_US'

Some of the fields are named with the suffix Aggr. These fields display the content of the JSON tag with the same name that is returned from the API endpoint.

Columns¶

ShippingCarriers¶

Query Shipping Carriers supported by the specified site.

Columns¶

Pseudo-Columns¶

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

ShippingCategories¶

A shipping service category supported for the site.

Columns¶

Pseudo-Columns¶

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

ShippingLocations¶

Lists the regions and locations supported by eBay's shipping services. Returns all shipping locations supported by eBay, regardless of the site specified in the request.

Columns¶

Pseudo-Columns¶

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

ShippingServices¶

Query Shipping Services supported by the specified eBay site.

Table Specific Information¶

Select¶

The following query retrieves all available Shipping Services. There are no supported filters for this view.

SELECT * FROM ShippingServices

Columns¶

Pseudo-Columns¶

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Sites¶

Lists all available eBay sites and their associated SiteID numbers.

Columns¶

Pseudo-Columns¶

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

SuggestedCategories¶

Query eBay list of categories with the highest number of listings.

Columns¶

Pseudo-Columns¶

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

TopSellingProducts¶

Query your eBay Top Selling Products.

Table Specific Information¶

Select¶

The only columns that can be used to filter are AffiliateCustomId, AffiliateNetworkId, and AffiliateTrackingId. These filters are optional.

SELECT * FROM TopSellingProducts

SELECT * FROM TopSellingProducts WHERE AffiliateCustomId = '12345'

Columns¶

Pseudo-Columns¶

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

TransactionLinkedItems¶

Query all linked line items of the transactions in which the authenticated user is either the buyer or seller. By default, only linked line items of transactions made in the last 90 days are returned. Linked line items of the transactions in orders older than 90 days can be retrieved by specifying OrderIds.

Columns¶

TransactionPayments¶

Query all payments of the transactions in which the authenticated user is either the buyer or seller. By default, only payments of transactions made in the last 90 days are returned. Payments of the transactions in orders older than 90 days can be retrieved by specifying OrderIds.

View Specific Information¶

Select¶

Examples of querying the TransactionPayments view:

SELECT * FROM TransactionPayments WHERE OrderRole = 'Seller'

SELECT * FROM TransactionPayments WHERE OrderId = '110277719772-28859911001'

Columns¶

Pseudo-Columns¶

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

TransactionRefunds¶

Query all refunds of the transactions in which the authenticated user is either the buyer or seller. By default, only refunds of transactions made in the last 90 days are returned. Refunds of the transactions in orders older than 90 days can be retrieved by specifying OrderIds.

Columns¶

Transactions¶

Query all transactions in which the authenticated user is either the buyer or seller. By default, only transactions of orders made in the last 90 days are returned. Transactions of orders older than 90 days can be retrieved by specifying OrderId.

View Specific Information¶

Select¶

Examples of querying the Transactions view.

SELECT * FROM Transactions WHERE OrderRole = 'Seller'

SELECT * FROM Transactions WHERE OrderId = '110276240386-28854859001'

SELECT * FROM Transactions WHERE CreateTimeFrom = '2/10/2018' AND CreateTimeTo = '3/16/2018'

Columns¶

Pseudo-Columns¶

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

TransactionShipping¶

Query shipping details of the transactions in which the authenticated user is either the buyer or seller. By default, only shipping details of transaction made in the last 90 days are returned. Shipping details of the transactions in orders older than 90 days can be retrieved by specifying OrderIds.

View Specific Information¶

Select¶

Examples of querying the TransactionShipping view:

SELECT * FROM TransactionShipping WHERE ModTimeFrom = '2/22/2018' AND ModTimeTo = '3/4/2018'

SELECT * FROM TransactionShipping WHERE OrderId = '110277719772-28859911001'

SELECT * FROM TransactionShipping WHERE OrderId IN ('110277719772-28859911001', '110276240386-28854859001')

Columns¶

Pseudo-Columns¶

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Stored Procedures¶

Stored procedures are function-like interfaces that extend the functionality of the connector beyond simple SELECT/INSERT/UPDATE/DELETE operations with eBay.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from eBay, along with an indication of whether the procedure succeeded or failed.

eBay Connector Stored Procedures¶

AddItem¶

Create and publish a new Item Listing on an eBay site.

Stored Procedure Specific Information¶

Upon the successful creation of an Item Listing, an Item ID is returned in the response along with the estimated fees for listing the Item. After adding an item, you can use the ItemListing table to update, delete, and query.

The inputs required to add any item are the following: Title, Description, CategoryId, StartPrice, ConditionId, Country, Currency, DispatchTimeMax, ListingDuration, ListingType, PaymentMethod, PayPalEmailAddress, Quantity, Location, and ReturnsAcceptedOption.

You also need to specify several inputs required to select a shipping type: Flat or Calculated. Both shipping types require a ShippingService to be specified.

Add an Item¶

You can follow the procedure below to obtain the required values and add an item through SQL:

1. Use the Categories view to select a top-level category; for example, Books. You can use the following query:

   SELECT * FROM Categories
   

2. Use the Categories view to select a leaf category; for example, Fiction & Literature. A leaf category ID is required to add an item. You can use a query like the following:

   SELECT * FROM Categories WHERE CategoryParentId = '267'
   

3. Use the ShippingServices view to select a Shipping Service. The value of the ValidForSellingFlow column must be true; otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing.

Selecting Flat Shipping¶

The following inputs are required for the Flat shipping type: ShippingType, ShippingService, ShippingServicePriority, and ShippingServiceCost.

Selecting CalculatedShipping¶

The Calculated shipping type requires additional information related to package stats. The following inputs are required for this shipping type: ShippingType, WeightMajor, WeightMinor, OriginatingPostalCode, ShippingService, and ShippingServicePriority.

Indexed parameters facilitate providing multiple instances a single parameter as inputs for the procedure.

Suppose there is an input parameter named Param#. To input multiple instances of an indexed parameter like this, execute:

EXEC ProcedureName Param#1 = "value1", Param#2 = "value2", Param#3 = "value3"

In the table below, indexed parameters are denoted with a # character at the end of their names.

Input¶

Result Set Columns¶

CompleteSale¶

Do various tasks after the creation of a single line item or multiple line item order. For example, complete a sale and leave feedback.

Input¶

Result Set Columns¶

CreateInventoryTask¶

This procedure creates an inventory-related download task for a specified feed type with optional filter criteria.

Input¶

Result Set Columns¶

CreateOrderTask¶

This procedure creates an order download task with filter criteria for the order report.

Input¶

Result Set Columns¶

GetOAuthAccessToken¶

Gets the OAuth access token from eBay.

Input¶

Result Set Columns¶

GetOAuthAuthorizationURL¶

Gets the eBay authorization URL. Access the URL returned in the output in an Internet browser. This requests the access token that can be used as part of the connection string to eBay.

Input¶

Result Set Columns¶

GetResultFile¶

This procedure retrieves the generated file that is associated with the specified task ID. The response of this call is a compressed or uncompressed CSV, XML, or JSON file, with the applicable file extension (for example: csv.gz).

Input¶

Result Set Columns¶

RefreshOAuthAccessToken¶

Refreshes the OAuth access token used for authentication with EBay.

Input¶

Result Set Columns¶

SetUserNotes¶

Add, replace, and delete My eBay notes for items that are being tracked in the My eBay Selling and Buying areas.

Indexed parameters facilitate providing multiple instances a single parameter as inputs for the procedure.

Suppose there is an input parameter named Param#. To input multiple instances of an indexed parameter like this, execute:

EXEC ProcedureName Param#1 = "value1", Param#2 = "value2", Param#3 = "value3"

In the table below, indexed parameters are denoted with a # character at the end of their names.

Input¶

Result Set Columns¶

UploadFile¶

Uploads a file to the EBay account.

Stored Procedure Specific Information¶

This procedure associates the specified file with the specified task ID and uploads the input file. After the file has been uploaded, the processing of the file begins.

The inputs required to upload a file are the following: TaskID and FilePath.

Upload a file¶

You can follow the procedure below to submit a successful upload file procedure:

1. Use the Tasks table to create a new Task. You can use the following query:

   INSERT INTO [Tasks] (FeedType, MarketplaceID, SchemaVersion) VALUES ('LMS_ADD_ITEM', 'EBAY_US', '1149')
   

2. You can get newly generated TaskID either from the generated keys, or by using the Tasks table again to select.

       Statement stat = conn.createStatement();
       stat.executeUpdate("INSERT INTO [Tasks] (FeedType, MarketplaceID, SchemaVersion) VALUES ('LMS_ADD_ITEM', 'EBAY_US', '1149')", Statement.RETURN_GENERATED_KEYS);
       ResultSet rs = stat.getGeneratedKeys();
       while (rs.next()) {
         for (int i = 1; i <= rs.getMetaData().getColumnCount(); i++) {
           System.out.println(rs.getMetaData().getColumnName(i) + "=" + rs.getString(i));
         }
   }
   

   or

   SELECT * FROM [Tasks] WHERE FeedType = 'LMS_ADD_ITEM' AND CreationDate > '2021-11-16 09:19:00'
   

3. Use this task ID as input together with the FilePath of the file to be uploade, in the UploadFile stored procedure.

       CallableStatement callableStatement = conn.prepareCall("UploadFile");
       callableStatement.setString("TaskID", "task-5-1XXXXX");
       callableStatement.setString("FilePath", "C:\\Users\\User\\Documents\\upload.csv");
   
       boolean ret = callableStatement.execute();
       if (!ret) {
         int count = callableStatement.getUpdateCount();
         if (count != -1) {
           System.out.println("Affected rows: " + count);
         }
       } else {
         ResultSet rs = callableStatement.getResultSet();
         while (rs.next()) {
           for (int i = 1; i <= rs.getMetaData().getColumnCount(); i++) {
             System.out.println(rs.getMetaData().getColumnName(i) + "=" + rs.getString(i));
           }
         }
   }
   

4. Then your file should be processing. To track the status you can execute a SELECT query in the Tasks table with the TaskID, and check the Status column.

   SELECT Status FROM [Tasks] WHERE TaskID = '{Generated Task ID}'
   

Input¶

Result Set Columns¶

System Tables¶

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables¶

The following tables return database metadata for eBay:

• sys_catalogs: Lists the available databases.
• sys_schemas: Lists the available schemas.
• sys_tables: Lists the available tables and views.
• sys_tablecolumns: Describes the columns of the available tables and views.
• sys_procedures: Describes the available stored procedures.
• sys_procedureparameters: Describes stored procedure parameters.
• sys_keycolumns: Describes the primary and foreign keys.
• sys_indexes: Describes the available indexes.

Data Source Tables¶

The following tables return information about how to connect to and query the data source:

• sys_connection_props: Returns information on the available connection properties.
• sys_sqlinfo: Describes the SELECT queries that the connector can offload to the data source.

Query Information Tables¶

The following table returns query statistics for data modification queries:

• sys_identity: Returns information about batch operations or single updates.

sys_catalogs¶

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns¶

sys_schemas¶

Lists the available schemas.

The following query retrieves all available schemas:

SELECT * FROM sys_schemas

Columns¶

sys_tables¶

Lists the available tables.

The following query retrieves the available tables and views:

SELECT * FROM sys_tables

Columns¶

sys_tablecolumns¶

Describes the columns of the available tables and views.

The following query returns the columns and data types for the ItemListing table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='ItemListing'

Columns¶