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 toTrue
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 theOAuthAccessToken
.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:
- The connector obtains an access token from eBay and uses it to request data.
- 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:
-
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. -
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 recommededhttps://oauth.cdata.com/oauth/
as your "auth accepted URL", the value will be BASE64 encoded and will need to be decoded before proceeding. -
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.
Note
Auth'n'Auth tokens expire after 18 months. You will need to generate a new token after the token expires.
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.
OAuthClientId
(App ID)DevID
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:
- Go to your Developer Account Dashboard and open the
User Access Tokens
page. - 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.
- Select
- 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. - Click
Sign in to Sandbox
orSign in to Production
depending on the environment, and log in with credentials for either your sandbox or production eBay account.
Note
To enable OAuth authentication, you should check the OAuth Enabled
checkbox under Your eBay Sign-in Settings
for the RuName (eBay Redirect URL name) that you will be using to sign-in. If it is not enabled, then only the Auth'n'Auth authentication method will be supported. See the "Set Up an OAuth App" section for more information.
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:
- Go to your Developer Account Dashboard and open the
User Access Tokens
page. - 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.
- Select
- Underneath
Your eBay Sign-in Settings
in theGet a Token from eBay via Your Application
section, add a new RuName (eBay Redirect URL) by clicking onAdd eBay Redirect URL
or expand the tab for the RuName that you will be using to authenticate. - Check the
OAuth Enabled
checkbox for your RuName. If it is not enabled, then only the Auth'n'Auth authentication method will be supported. - Set
Your auth accepted URL
tohttps://oauth.cdata.com/oauth/
since the eBay requires a secure Redirect URI (https) and does not accept a localhost URI. - Click
Save
to save your changes. - Select
OAuth
, then clickTest 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 Jitterbit 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.
Note
If you're using the Auth'n'Auth authentication scheme, there are some tables and views you cannot access. See AuthNAuth Limitations for a list 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
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¶
Name | Description |
---|---|
ItemListing | Update, delete, and query Item Listings for sellers. |
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.) |
Tasks | Retrieves all the tasks for the marketplace you specify using the MarketplaceId query parameter. |
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¶
Name | Type | ReadOnly | Description |
---|---|---|---|
ItemId [KEY] | String | False | The ID that uniquely identifies the item listing. The ID is generated by eBay after an item is listed. You cannot choose or revise this value. |
Title | String | False | Name of the item as it appears in the listing or search results. |
AutoPay | Boolean | False | If true, the seller requests immediate payment for the item. |
BuyerProtection | String | False | Flag to indicate the eligibility of an item for the PayPal Buyer Protection program. |
BuyItNowPrice | Decimal | False | This field is only applicable for auction listings. By specifying a Buy It Now price, a seller is allowing prospective buyers the opportunity to purchase the item in the auction listing at this price immediately. |
ConditionDescription | String | False | This string field is used by the seller to more clearly describe the condition of items that are not brand new. |
Country | String | False | Defines the 2-letter ISO 3166 country code. |
Currency | String | False | Currency associated with the price information of the item. 3-letter ISO 4217 currency code. |
Description | String | False | The description of the item by the seller. In listing requests, you can use CDATA tags to submit your description if you want to use HTML or XML-reserved characters in the description. |
HideFromSearch | Boolean | False | Whether the listing is hidden from all searches occurring on eBay. |
HitCount | Integer | False | The number of page views for the item. |
Adult | Boolean | False | If true, the item is listed in a Mature category. |
BestOfferAutoAcceptPrice | Decimal | False | The price at which Best Offers are automatically accepted. Similar in use to MinimumBestOfferPrice. |
CheckoutEnabled | Boolean | False | This flag indicates whether or not the Checkout Enabled preference of the seller is turned on (at account level or at listing level). |
StartTime | Datetime | False | The StartTime for when the item was listed. |
EndTime | Datetime | False | Time stamp (in GMT) when the listing is scheduled to end (calculated based on the values of StartTime and ListingDuration), or the actual end time if the item has ended. |
MinimumBestOfferPrice | Decimal | False | Specifies the minimum acceptable Best Offer price. If a buyer submits a Best Offer that is below this value, the offer is automatically declined by the seller. |
ViewItemURL | String | False | The URL of the Web page where a user can view the listing. On the U.S. site, this is called the View Item page. |
ViewItemURLForNaturalSearch | String | False | This URL takes you to the same View Item page as ViewItemURL, but this URL is optimized to support natural search. That is, this URL is designed to make items on eBay easier to find via popular Internet search engines. |
ListingDuration | String | False | Describes the number of days the seller wants the listing to be active (available for bidding/buying). |
ListingType | String | False | The format of the listing the seller wants to use, such as Chinese auction or fixed price. |
Location | String | False | Indicates the geographical location of the item (along with Country). When you revise a listing, you can add or change this value only if the listing has no bids (or no items have sold), and it does not end within 12 hours. |
CategoryId | String | False | Category ID for the first (or only) category in which the item is listed (or will be listed, if the item is new). |
CategoryName | String | False | This string value is the display name of the eBay primary category, as it would appear on the eBay website. |
PrivateListing | Boolean | False | If true, designates the listing as private. |
Quantity | Integer | False | The meaning of this value depends on the context. |
QuantityAvailableHint | String | False | Indicates the type of message that will be returned describing the quantity available for the item. |
QuantityThreshold | Integer | False | The quantity threshold above which the seller prefers not to show the actual quantity available. |
ReservePrice | Decimal | False | The lowest price at which the seller is willing to sell the item. |
Refund | String | False | Display string that buyer applications can use to present RefundOption in a more user-friendly format to buyers. |
RefundOption | String | False | Indicates how the seller will compensate the buyer for a returned item. |
ReturnsAccepted | String | False | Display string that buyer applications can use to present ReturnsAcceptedOption in a more user-friendly format to buyers. |
ReturnsAcceptedOption | String | False | Indicates whether the seller allows the buyer to return the item. One of the following values: ReturnsAccepted or ReturnsNotAccepted. If you specify ReturnsNotAccepted, the View Item page will indicate that returns are not accepted instead. |
ReturnsWithin | String | False | Display string that buyer applications can use to present ReturnsWithinOption in a more user-friendly format to buyers. |
ReturnsWithinOption | String | False | The buyer can return the item within this period of time from the day they receive the item. |
ShippingCostPaidBy | String | False | Display string that buyer applications can use to present ShippingCostPaidByOption in a more user-friendly format to buyers. |
ShippingCostPaidByOption | String | False | The party who pays the shipping cost for a returned item. |
ItemRevised | Boolean | False | This field is returned as true if the original listing has been revised. |
SellerName | String | False | The name of the seller. This field is used as part of the address. |
CurrentPrice | Decimal | False | The current price of the item in the original listing currency. |
ListingStatus | String | False | Specifies an active or ended listing status in the processing workflow. |
PromotionalEndTime | Datetime | False | End time of a discount for an item whose price a seller has reduced with the Promotional Price Display feature. |
PromotionalOriginalPrice | Decimal | False | Original price of an item whose price a seller has reduced with the Promotional Price Display feature. |
PromotionalStartTime | Datetime | False | Start time of a discount for an item whose price a seller has reduced with the Promotional Price Display feature. |
QuantitySold | Integer | False | The total number of items purchased so far in the lifetime of the listing. Subtract this from Quantity to determine the quantity available. |
ReserveMet | Boolean | False | Indicates whether the reserve price has been met for the listing. Returns true if the reserve price was met or no reserve price was specified. |
SecondChanceEligible | Boolean | False | Part of the Second Chance Offer feature, which indicates whether the seller can extend a second chance offer for the item. |
Site | String | False | The name of the site on which the item is listed. |
SKU | String | False | A SKU (stock keeping unit) is an identifier defined by a seller. |
StartPrice | Decimal | False | The original price of the item at listing or relisting time. If this value changes when the item is revised, the new value becomes the original price. |
TimeLeft | String | False | Time left before the listing ends. The duration is represented in the ISO 8601 duration format (PnYnMnDTnHnMnS). |
TotalQuestionCount | Integer | False | The number of questions asked about this item. Applies to eBay Motors Pro applications only. |
WatchCount | Integer | False | The number of watches placed on this item from the My eBay accounts of the buyers. |
StoreCategoryId | Long | False | Unique identifier of a primary custom category in which to list the item. |
StoreCategoryId2 | Long | False | Unique identifier for the secondary custom category in which to list the item. |
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.
Name | Type | Description |
---|---|---|
AdminEndedItemsOnly | String | Specifies whether to return only items that were administratively ended based on a policy violation. |
EndTimeFrom | Datetime | Specifies the earliest (oldest) date to use in a date range filter based on item end time. Specify either an end-time range or a start-time range filter. Each of the time ranges must be a value less than 120 days. |
EndTimeTo | Datetime | Specifies the latest (most recent) date to use in a date range filter based on item end time. Specify either an end-time range or a start-time range filter. Each of the time ranges must be a value less than 120 days. |
GranularityLevel | String | Specifies the subset of item and user fields to return. |
StartTimeFrom | Datetime | Specifies the earliest (oldest) date to use in a date range filter based on item start time. |
StartTimeTo | Datetime | Specifies the latest (most recent) date to use in a date range filter based on item start time. Must be specified if StartTimeFrom is specified. |
UserId | String | Specifies the seller whose items will be returned. UserId is an optional input. If not specified, retrieves listings for the user identified by the authentication token passed in the request. |
DetailLevel | String | Detail levels are instructions that define standard subsets of data to return for particular tables. The allowed values are ReturnAll. |
EndingReason | String | Indicates the reason the seller ended the listing early. |
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¶
Name | Type | ReadOnly | Description |
---|---|---|---|
ItemId [KEY] | String | False | The ID that uniquely identifies the item listing. The ID is generated by eBay after an item is listed. You cannot choose or revise this value. |
VariationSpecificsAggregate [KEY] | String | False | A list of name/value pairs that uniquely identify the variation within the listing. All variations must specify the same set of names. For example, if the items vary by color and size, then every variation must specify Color and Size as names, and no two variations can specify the same combination of color and size values. |
StartPrice | Decimal | False | The price of the item at listing or relisting time. If this value changes when the item is revised, the new value becomes this price. |
Currency | String | False | Currency associated with the price information of the item. 3-letter ISO 4217 currency code. |
Quantity | Integer | False | This value indicates the quantity of items in the specific variation that are available for purchase. |
QuantitySold | Integer | False | The total number of items purchased so far. Subtract this from Quantity to determine the quantity available. |
SKU | String | False | A SKU (stock keeping unit) is an identifier defined by a seller. It is only intended for the use of the seller (not for buyers). |
EAN | String | False | This field is used if the seller wishes to identify each product variation within a multivariation listing by an EAN (European Article Number) value. |
ISBN | String | False | This field is used if the seller wishes to identify each product variation within a multivariation listing by an ISBN (International Standard Book Number) value. |
UPC | String | False | This field is used if the seller wishes to identify each product variation within a multivariation listing by a UPC (Universal Product Code) value. |
ListingStatus | String | False | Specifies a listing with an active or ended status in the eBay processing workflow. |
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¶
Name | Type | ReadOnly | Description |
---|---|---|---|
TaskId [KEY] | String | True | The ID of the task that was submitted in the request. |
Status | String | True | The enumeration value that indicates the state of the task that was submitted in the request. |
FeedType | String | False | The feed type associated with the task. |
CreationDate | Datetime | True | The date the task was created. |
UploadSummaryAggr | String | True | This container provides summary information on an upload feed (not applicable for download feed types). |
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.
Name | Type | Description |
---|---|---|
MarketplaceID | String | MarketplaceID of your Ebay account. |
SchemaVersion | String | The schema version number associated with the task. |
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¶
Name | Description |
---|---|
Bidders | Query eBay users that bid on a specified listing, regardless of whether the listing has ended. |
Categories | Query eBay Categories. |
CategoryFeatures | Query the settings supported by eBay Categories. |
CategorySubtree | Retrieve all nodes of the category tree hierarchy (the subtree) below a specified category in a specified category tree. |
CategorySuggestions | Return an array of suggested categories that eBay has determined correspond to keywords that describe an item. |
CategoryTree | Retrieve the complete category tree corresponding to a specified category tree ID. |
CompatibilityProperties | Retrieve an array of parts compatibility aspects that are used to describe compatible vehicles. |
CompatibilityPropertyValues | Retrieve an array of parts compatibility aspect values that are used to describe compatible vehicles. |
Countries | Lists the country code and associated name of the countries supported by the eBay system, regardless of the site specified in the request. |
Currencies | Query the supported Currencies in eBay. |
DefaultCategoryTreeId | Retrieve the default category tree reference for a specific eBay marketplace. |
FulfillmentPolicies | Retrieves all the fulfillment policies configured for the marketplace you specify using the MarketplaceId query parameter. |
HighestBidder | Query the Highest Bidder of the eBay users who bid on a specified listing, regardless of whether the listing has ended. |
ItemAspectsForCategory | Retrieve an array of aspects that are appropriate for describing items in a specified category. |
ItemCompatibilityList | Query compatability categories and possible compatability values for a specific item. |
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. |
ItemSpecifics | Query item specifics for a specific item. |
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). |
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. |
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. |
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. |
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. |
PaymentPolicies | Retrieves all the payment policies configured for the marketplace you specify using the MarketplaceId query parameter. |
ReturnPolicies | Retrieves all the return policies configured for the marketplace you specify using the MarketplaceId query parameter. |
ShippingCarriers | Query Shipping Carriers supported by the specified site. |
ShippingCategories | A shipping service category supported for the site. |
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. |
ShippingServices | Query Shipping Services supported by the specified eBay site. |
Sites | Lists all available eBay sites and their associated SiteID numbers. |
SuggestedCategories | Query eBay list of categories with the highest number of listings. |
TopSellingProducts | Query your eBay Top Selling Products. |
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. |
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. |
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. |
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. |
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. |
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¶
Name | Type | Description |
---|---|---|
Action | String | Indicates the type of offer being made on the specified listing. |
MaxBid | Decimal | Amount of the offer placed. For auction listings, the amount bid on the item (subject to outbid by other buyers). For fixed-price listings, the fixed sale price at which the item is purchased. For auction listings with an active Buy It Now option, this amount will be either the Buy It Now price for purchase or the amount of a bid, depending on the offer type. |
Currency | String | The three-digit currency code for the Max Bid. |
ConvertedPrice | Decimal | The price in the currency specified. |
ConvertedPriceCurrency | String | The three-digit currency ID of the converted price. |
HighestBid | Decimal | Amount the highest bidder has bid on the item. Applicable to only auction listings where there is progressive bidding and winning bidders are determined based on the highest bid. |
HighestBidCurrency | String | The three-digit currency code for the highest bid. |
Quantity | Integer | Specifies the number of items the user tendering the offer intends to purchase, bid on, or make a Best Offer on. |
SecondChanceEnabled | Boolean | Indicates whether user is willing to be the recipient of second chance offers. |
SiteCurrency | String | Unique ID identifying the currency in which the localized offer amounts are expressed. |
TimeBid | Datetime | Date and time the offer or bid was placed. |
UserId | String | Unique eBay user ID for the user. |
UserCountry | String | The two-digit code representing the country of the user. |
UserFeedbackScore | Integer | The aggregate feedback score for a user. A feedback score for a user is the net positive feedback minus the net negative feedback left for the user. |
ItemId | String | The ID of the item. The bidders who bid on this item are returned. |
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.
Name | Type | Description |
---|---|---|
ListMode | String | Specifies which bidder information to return. EndedListing returns all nonwinning bidders for ended listings only. It can be used only by a seller. SecondChanceEligibleEndedListing returns all nonwinning bidders for an ended listing who have not yet received a Second Chance Offer and noted interest in receiving a Second Chance Offer. It can be used only by a seller. ViewAll returns all bidders for an ended or still-active listing. It can be used by any user. The allowed values are EndedListing, SecondChanceEligibleEndedListing, ViewAll. |
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¶
Name | Type | Description |
---|---|---|
CategoryId [KEY] | String | This string value is the unique identifier of an eBay category. |
AutoPayEnabled | Boolean | Specifies that the corresponding category supports immediate payment for listings. |
B2BVATEnabled | Boolean | Specifies that the corresponding category supports business-to-business (B2B) VAT listings. This feature is applicable to the eBay Germany (DE), Austria (AT), and Switzerland (CH) sites only. |
BestOfferEnabled | Boolean | Specifies that the corresponding category supports Best Offers. |
CategoryLevel | Integer | This integer value indicates the level where the category fits in the category hierarchy of the eBay site. For example, if this field has a value of 2, then the category is two levels below the root category. |
CategoryName | String | This string value is the display name of the eBay primary category, as it would appear on the eBay website. |
CategoryParentId | String | This string value is the category ID of the parent category of the primary category indicated in the CategoryId field. |
Expired | Boolean | Specifies that the corresponding category is no longer a valid eBay category on the site, and items may not be listed in this category. |
LeafCategory | Boolean | Specifies that the corresponding category is an eBay leaf category, a category in which items may be listed. |
LSD | Boolean | Lot Size Disabled. Specifies that the corresponding category does not support lot listings. A lot listing is a listing that features multiple related items that must be purchased by one buyer in one transaction. |
ORPA | Boolean | Override Reserve Price Allowed: Specifies that the corresponding category is an exception to the standard Reserve Price policy on auction listings for the eBay site. |
ORRA | Boolean | Override Reduce Reserve Allowed: Specifies that the corresponding category is an exception to the standard Reduce Reserve Price (on active auction listing) policy. |
Virtual | Boolean | Specifies that the corresponding category is an eBay virtual category, a category in which items may not be listed. |
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.
Name | Type | Description |
---|---|---|
CategorySiteId | String | The ID of the U.S. eBay site for the category. |
LevelLimit | String | Specifies the maximum depth of the category hierarchy to retrieve, where the top-level categories (metacategories) are at level 1. If not specified, categories are retrieved at all applicable levels. |
ViewAllNodes | String | This value controls whether all eBay categories or only leaf categories that satisfy any WHERE clause restrictions are returned. You can only list items in leaf categories. The default value is true. |
DetailLevel | String | Detail levels are instructions that define subsets of data to return for particular tables. Possible values: ItemReturnAttributes, ItemReturnCategories, ItemReturnDescription, ReturnAll, ReturnHeaders, ReturnMessages, and ReturnSummary. |
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¶
Name | Type | Description |
---|---|---|
CategoryId | String | The unique identifier of the category that the setting belongs to. |
BestOfferAutoAcceptEnabled | Boolean | Indicates whether the category supports the Best Offer Automatic Accept feature for fixed-price listings. |
BestOfferAutoDeclineEnabled | Boolean | Indicates whether the category supports the Best Offer Auto Decline feature. |
BestOfferCounterEnabled | Boolean | Indicates whether the category supports sellers offering a counter offer against the Best Offer from a buyer, or a buyer offering a counter offer against the counter offer of the seller. This field is only applicable to fixed-price listings. |
BestOfferEnabled | Boolean | Indicates whether the category supports the Best Offer feature for fixed-price listings. |
BrandMPNIdentifierEnabled | Boolean | Indicates whether the category supports the capability to identify a product using the brand/manufacturer part number combination. |
ConditionEnabled | String | Indicates whether the category supports (or requires) conditions to be specified. |
ConditionValuesAggregate | String | The valid condition Ids for this category. |
EANEnabled | String | Indicates whether or not European Article Numbers (EANs) can be used to help create a listing. |
FreeGalleryPlusEnabled | Boolean | Indicates whether the category supports free, automatic upgrades for Gallery Plus, which enhances pictures in search results. |
FreePicturePackEnabled | Boolean | Indicates whether the category supports free, automatic upgrades for Picture Pack, a discount package that includes super-sizing of pictures. |
GlobalShippingEnabled | Boolean | Specifies whether or not the corresponding category supports the Global Shipping Program (GSP). |
Group1MaxFlatShippingCost | Double | Returns the applicable max. cap per shipping cost for shipping service group 1. |
Group2MaxFlatShippingCost | Double | Returns the applicable max. cap per shipping cost for shipping service group 2. |
Group3MaxFlatShippingCost | Double | Returns the applicable max. cap per shipping cost for shipping service group 3. |
HandlingTimeEnabled | Boolean | If false, listings in this category require a handling time when flat or calculated shipping is specified. A handling time is not required for local pickup or for freight shipping. see DispatchTimeMax in AddItem. |
HomePageFeaturedEnabled | Boolean | Indicates whether or not it is possible to enhance a listing by putting it into a rotation for display on a special area of the eBay home page. Support for this feature varies by site. Item or feedback restrictions may apply. |
INEscrowWorkflowTimeline | String | Indicates the escrow workflow version that applies to the category on the India site: Default Workflow, Workflow A, or Workflow B. |
ISBNEnabled | String | Indicates whether or not International Standard Book Numbers (ISBNs) can be used to help create a listing. |
ItemCompatibilityEnabled | String | Indicates whether the category supports parts compatibility by application (ByApplication), by specification (BySpecification), or not at all (Disabled). |
ItemSpecificsEnabled | String | Indicates whether the category supports custom Item Specifics. |
ListingDurations | String | The listing types and listing durations in days that are supported for the category. |
MaxFlatShippingCost | Double | The maximum cost the seller can charge for the first domestic flat rate shipping service. The total shipping cost is the base flat rate shipping cost plus the cost of insurance, if insurance is required. Mutually exclusive with GroupNMaxFlatShippingCost. |
MaxGranularFitmentCount | Integer | Indicates the maximum fitment count. |
MaxItemCompatibility | Integer | Specifies the maximum number of parts compatibilities. |
MinimumReservePrice | Double | Indicates whether a Minimum Reserve Price is enabled for this category. On the Germany, Austria, Belgium French, and Belgium Dutch sites, Minimum Reserve Price is supported for the Art and Antiques, Watches and Jewelry, and Motorbikes categories. |
MinItemCompatibility | Integer | This field specifies the minimum number of parts compatibilities for listing items. |
NonSubscription | String | The value in this field indicates whether the category supports Motors Local Market listings if the seller does not have a vehicle subscription. |
PaisaPayFullEscrowEnabled | Boolean | Indicates whether the category supports the PaisaPayEscrow payment method. This feature is only applicable to the India site. |
PaymentMethods | String | Indicates the acceptable payment methods that can be used when adding, revising, or relisting an item in the corresponding category. |
PaymentProfileCategoryGroup | String | Indicates the Business Policies category group that can be used for Payment profiles. Only returned when this value (or the setting of this category) overrides the value inherited from the parent category. |
PayPalBuyerProtectionEnabled | Boolean | Whether then buyer protection is allowed for this category. |
PayPalRequired | Boolean | Indicates whether the category requires PayPal as a payment method. |
PickupDropOffEnabled | Boolean | A true value in this field indicates that items listed in the category can be enabled with the Click and Collect feature. With the Click and Collect feature, a buyer can purchase certain items on eBay and collect them at a local store. Buyers are notified by eBay once their items are available. |
PremiumSubscription | String | The value in this field indicates whether the category supports Motors Local Market listings if the seller has a Premium vehicle subscription. |
ProductCreationEnabled | String | Indicates whether a category supports (or requires) product creation in listings. Use this to determine whether it is mandatory to specify the product ID when adding, revising, or relisting. |
ProPackEnabled | Boolean | Indicates whether the category supports the Pro Pack Bundle listing upgrade. |
ReturnPolicyEnabled | Boolean | Only returned when this value (or the setting of this category) overrides the value inherited from the parent of the category. |
ReturnPolicyProfileCategoryGroup | String | Indicates the Business Policies category group that can be used for Return Policy profiles. Only returned when this value (or the setting of this category) overrides the value inherited from the parent of the category. |
RevisePriceAllowed | Boolean | Indicates if the category allows the seller to revise the price of a fixed-price listing. |
ReviseQuantityAllowed | Boolean | Indicates if the category allows the seller to revise the quantity of a multiquantity, active listing. |
SafePaymentRequired | Boolean | Indicates whether listings in this category need to have a safe payment method. |
SellerContactDetailsEnabled | Boolean | Indicates whether this category supports seller-level contact information for Classified Ad listings. |
SellerProvidedTitleSupported | Boolean | This boolean field indicates whether a category supports Seller Provided Titles in listings. |
ShippingProfileCategoryGroup | String | Indicates the Business Policies category group that can be used for Shipping profiles. Only returned when this value (or the setting of this category) overrides the value inherited from the parent of the category. |
ShippingTermsRequired | Boolean | Indicates whether the category requires sellers to specify shipping details at listing time. |
SpecialitySubscription | String | The value in this field indicates whether the category supports Motors Local Market listings if the seller has a Specialty vehicle subscription. |
ListingDurationsAggregate | String | Provides additional listings durations that are available to eBay Store owners. The extended listing durations provided here in this element should be merged in with the baseline listing durations provided in the ListingDurations column. Applies to fixed-price Listings. |
TransactionConfirmationRequestEnabled | Boolean | Defines if transaction confirmation requests are enabled in a given category. |
UPCEnabled | String | Indicates whether or not Universal Product Codes (UPCs) can be used to help create a listing. |
UserConsentRequired | Boolean | Indicates whether a bidder must consent to the bid by confirming that he or she read and agrees to the terms in the privacy policy of eBay. |
ValueCategory | Boolean | Some eBay sites may select a few categories and designate them as value categories. These are typically selected from categories where buyers can find great deals. This designation can change over time. |
ValuePackEnabled | Boolean | Indicates whether the category supports the Value Pack bundle listing upgrade. |
VariationsEnabled | Boolean | If true, you can create multiple-variation listings when you list a fixed-price item in this category. |
VINSupported | Boolean | Indicates if the category supports the use of the VIN (Vehicle Identification Number) field to identify a motor vehicle and create a listing. VINs are supported on the US, Canada, Canada-French, and Australia sites. |
VRMSupported | Boolean | Indicates if the category supports the use of the VRM (Vehicle Registration Mark) field to identify a motor vehicle and create a listing. VRMs are only supported on the UK site. |
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.
Name | Type | Description |
---|---|---|
AllFeaturesForCategory | String | Use this switch to view all of the feature settings for a specific category. All feature settings are returned, regardless of the site default settings. This element works in conjunction with CategoryId--refer to the notes for that element for more details. If you also set FeatureId, eBay returns the status of the specified features only for the specified category. Default: false. |
FeatureId | String | Use this field if you want to know if specific features are enabled at the site or root category level. Multiple FeatureId elements can be used in the request. |
LevelLimit | String | A level of depth in the category hierarchy. Retrieves all category nodes with a CategoryLevel less than or equal to the LevelLimit value. The root category is 0. The allowed values are 1. |
ViewAllNodes | String | If set, eBay returns the site defaults along with all the categories that override the feature settings they inherit. That is, this column contains only the features that the category has overridden from its parent category. |
DetailLevel | String | Detail levels are instructions that define subsets of data to return for particular tables. Possible values: ItemReturnAttributes, ItemReturnCategories, ItemReturnDescription, ReturnAll, ReturnHeaders, ReturnMessages, and ReturnSummary. |
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¶
Name | Type | Description |
---|---|---|
CategoryTreeId [KEY] | String | The unique identifier of the eBay category tree to which this subtree belongs. |
categoryTreeVersion | String | The version of the category tree identified by categoryTreeId. |
categorySubtreeNode | String | Contains details of all nodes of the category subtree hierarchy below a specified node. This is a recursive structure. |
category | String | Contains details about the current category tree node. |
categoryName | String | The name of the category identified by categoryId. |
categoryTreeNodeLevel | Integer | The absolute level of the current category tree node in the hierarchy of its category tree. |
childCategoryTreeNodes | String | An array of one or more category tree nodes that are the immediate children of the current category tree node, as well as their children, recursively down to the leaf nodes. |
category | String | Contains details about the current category tree node. |
categoryName | String | The name of the category identified by categoryId. |
categoryTreeNodeLevel | Integer | The absolute level of the current category tree node in the hierarchy of its category tree. |
childCategoryTreeNodes | String | An array of one or more category tree nodes that are the immediate children of the current category tree node, as well as their children, recursively down to the leaf nodes. |
category | String | Contains details about the current category tree node. |
categoryName | String | The name of the category identified by categoryId. |
categoryTreeNodeLevel | Integer | The absolute level of the current category tree node in the hierarchy of its category tree. |
childCategoryTreeNodes | String | An array of one or more category tree nodes that are the immediate children of the current category tree node, as well as their children, recursively down to the leaf nodes. |
leafCategoryTreeNode | Boolean | A value of true indicates that the current category tree node is a leaf node (it has no child nodes). A value of false indicates that the current node has one or more child nodes, which are identified by the childCategoryTreeNodes array. |
parentCategoryTreeNodeHref | String | The href portion of the getCategorySubtree call that retrieves the subtree below the parent of this category tree node. |
leafCategoryTreeNode | Boolean | A value of true indicates that the current category tree node is a leaf node (it has no child nodes). A value of false indicates that the current node has one or more child nodes, which are identified by the childCategoryTreeNodes array. |
parentCategoryTreeNodeHref | String | The href portion of the getCategorySubtree call that retrieves the subtree below the parent of this category tree node. |
leafCategoryTreeNode | Boolean | A value of true indicates that the current category tree node is a leaf node (it has no child nodes). A value of false indicates that the current node has one or more child nodes, which are identified by the childCategoryTreeNodes array. |
parentCategoryTreeNodeHref | String | The href portion of the getCategorySubtree call that retrieves the subtree below the parent of this category tree node. |
CategoryId | String | The unique identifier of the category at the top of the subtree being requested. |
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¶
Name | Type | Description |
---|---|---|
CategoryTreeId [KEY] | String | The unique identifier of the eBay category tree from which suggestions are returned. |
categoryTreeVersion | String | The version of the category tree identified by categoryTreeId. |
categorySuggestions | String | Contains details about one or more suggested categories that correspond to the provided keywords. |
category | String | Contains details about the suggested category. |
categoryId | String | The unique identifier of the eBay category within its category tree. |
categoryName | String | The name of the category identified by categoryId. |
categoryTreeNodeAncestors | String | An ordered list of category references that describes the location of the suggested category in the specified category tree. |
categoryId | String | The unique identifier of the eBay ancestor category. |
categoryName | String | The name of the ancestor category identified by categoryId. |
categorySubtreeNodeHref | String | The href portion of the getCategorySubtree call that retrieves the subtree below the ancestor category node. |
categoryTreeNodeLevel | String | The absolute level of the ancestor category node in the hierarchy of its category tree. |
categoryTreeNodeLevel | Integer | The absolute level of the category tree node in the hierarchy of its category tree. |
relevancy | String | This field is reserved for internal or future use. |
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.
Name | Type | Description |
---|---|---|
Q | String | A quoted string that describes or characterizes the item being offered for sale. |
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¶
Name | Type | Description |
---|---|---|
CategoryTreeId [KEY] | String | The unique identifier of the eBay category tree for the specified marketplace. |
categoryTreeVersion | String | The version of the category tree identified by categoryTreeId. |
applicableMarketplaceIds | String | A list of one or more identifiers of the eBay marketplaces that use this category tree. |
rootCategoryNode | String | Contains details of all nodes of the category tree hierarchy, starting with the root node and down to the leaf nodes. |
category | String | Contains details about the current category tree node. |
categoryId | String | The unique identifier of the eBay category within its category tree. |
categoryName | String | The name of the category identified by categoryId. |
categoryTreeNodeLevel | Integer | The absolute level of the current category tree node in the hierarchy of its category tree. |
childCategoryTreeNodes | String | An array of one or more category tree nodes that are the immediate children of the current category tree node, as well as their children, recursively down to the leaf nodes. |
category | String | Contains details about the current category tree node. |
categoryId | String | The unique identifier of the eBay category within its category tree. |
categoryName | String | The name of the category identified by categoryId. |
categoryTreeNodeLevel | Integer | The absolute level of the current category tree node in the hierarchy of its category tree. |
childCategoryTreeNodes | String | An array of one or more category tree nodes that are the immediate children of the current category tree node, as well as their children, recursively down to the leaf nodes. |
category | String | Contains details about the current category tree node. |
categoryId | String | The unique identifier of the eBay category within its category tree. |
categoryName | String | The name of the category identified by categoryId. |
categoryTreeNodeLevel | Integer | The absolute level of the current category tree node in the hierarchy of its category tree. |
childCategoryTreeNodes | String | An array of one or more category tree nodes that are the immediate children of the current category tree node, as well as their children, recursively down to the leaf nodes. |
leafCategoryTreeNode | Boolean | A value of true indicates that the current category tree node is a leaf node (it has no child nodes). A value of false indicates that the current node has one or more child nodes, which are identified by the childCategoryTreeNodes array. |
parentCategoryTreeNodeHref | String | The href portion of the getCategorySubtree call that retrieves the subtree below the parent of this category tree node. |
leafCategoryTreeNode | Boolean | A value of true indicates that the current category tree node is a leaf node (it has no child nodes). A value of false indicates that the current node has one or more child nodes, which are identified by the childCategoryTreeNodes array. |
parentCategoryTreeNodeHref | String | The href portion of the getCategorySubtree call that retrieves the subtree below the parent of this category tree node. |
leafCategoryTreeNode | Boolean | A value of true indicates that the current category tree node is a leaf node (it has no child nodes). A value of false indicates that the current node has one or more child nodes, which are identified by the childCategoryTreeNodes array. |
parentCategoryTreeNodeHref | String | The href portion of the getCategorySubtree call that retrieves the subtree below the parent of this category tree node. |
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¶
Name | Type | Description |
---|---|---|
CategoryTreeId [KEY] | String | This is the unique identifier of category tree. |
CategoryId | String | The unique identifier of an eBay category. |
CompatibilityPropertyName | String | This is the actual name of the compatible vehicle property as it is known on the specified eBay marketplace and in the eBay category. |
CompatibilityPropertyLocalizedName | String | This is the localized name of the compatible vehicle property. |
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¶
Name | Type | Description |
---|---|---|
CategoryTreeId [KEY] | String | This is the unique identifier of category tree. |
CompatibilityProperty [KEY] | String | This is the actual name of the compatible vehicle property as it is known on the specified eBay marketplace and in the eBay category. |
CategoryId [KEY] | String | The unique identifier of an eBay category. |
CompatibilityPropertyValues | String | Each value field shows one applicable compatible vehicle property value. |
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¶
Name | Type | Description |
---|---|---|
Country | String | Two-letter code representing a country. These two-letter codes are typically used in Add/Revise/Relist calls when referring to a country. |
Description | String | Full country name for display purposes. May be similar to (but not necessarily identical to) CountryName in addresses (e.g., User.RegistrationAddress.CountryName in GetUser). |
DetailVersion | String | Returns the latest version number for this field. The version can be used to determine if and when to refresh cached client data. |
UpdateTime | Datetime | Gives the time in GMT that the feature flags for the details were last updated. This timestamp can be used to determine if and when to refresh cached client data. |
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.
Name | Type | Description |
---|---|---|
DetailName | String | A designation of what kind of information you wish returned for the specified eBay site. The allowed values are CountryDetails. |
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¶
Name | Type | Description |
---|---|---|
Currency | String | The three-digit currency code as defined in ISO 4217. |
Description | String | Full currency name for display purposes. |
DetailVersion | String | Returns the latest version number for this field. |
UpdateTime | Datetime | Gives the time in GMT that the feature fields for the details were last updated. |
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.
Name | Type | Description |
---|---|---|
DetailName | String | If set to a value of CurrencyDetails, additional currency details are returned. The allowed values are CurrencyDetails. |
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¶
Name | Type | Description |
---|---|---|
CategoryTreeId [KEY] | String | The unique identifier of the eBay category tree for the specified marketplace. |
CategoryTreeVersion | String | The version of the category tree identified by categoryTreeId. |
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.
Name | Type | Description |
---|---|---|
MarketplaceId | String | The ID of the eBay marketplace for which the category tree ID is being requested. |
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¶
Name | Type | Description |
---|---|---|
FulfillmentPolicyId [KEY] | String | A unique eBay-assigned ID for the fulfillment policy. This ID is generated when the policy is created. |
Name | String | A user-defined name for this fulfillment policy. Names must be unique for policies assigned to the same marketplace. |
Description | String | An optional seller-defined description of the fulfillment policy for internal use (this value is not displayed to end users). |
CategoryTypesAggr | String | The CategoryTypeEnum value to which this policy applies. Used to discern accounts that sell motor vehicles from those that don't. (Currently, each policy can be set to only one categoryTypes value at a time.) |
MarketplaceId | String | The ID of the eBay marketplace to which this fulfillment policy applies. |
FreightShipping | Boolean | If set to true, the seller offers freight shipping. Freight shipping can be used for large items over 150 lbs. |
GlobalShipping | Boolean | Indicates if the seller has opted-in to the eBay Global Shipping Program and that they use that service for their international shipments. |
HandlingTimeValue | Integer | The maximum number of business days the seller commits to for preparing and shipping an order after receiving a cleared payment for the order. |
HandlingTimeUnit | String | A time-measurement unit that specifies a singular period of time used for HandlingTimeValue. |
LocalPickup | Boolean | Identifies if the shipping is offered by this policy and the seller offers only local pickup of the item (normally from a non-business location). |
PickupDropOff | Boolean | If set to true, the seller offers the |
ShipToLocationsAggr | String | This object contains the regionIncluded and regionExcluded fields, which define the geographical regions that a seller does and does not cover by the associated shipping policy. |
ShippingOptionsAggr | String | A list that defines the seller's shipping configurations for DOMESTIC and INTERNATIONAL order shipments. |
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¶
Name | Type | Description |
---|---|---|
ItemId | String | The ID of the item. The bidders who bid on this item are returned. |
HighBidder | String | eBay user ID for the user with the highest bid (or the earliest timestamp, in the event of a tie); a second chance offer candidate. |
HighestBid | Decimal | Bid amount offered by the highest bidder. |
Currency | String | Currency code of the bid. |
ListingStatus | String | Specifies the status of an active or ended listing in the processing workflow of the eBay system. If a listing ends with a sale (or sales), eBay needs to update the sale details (e.g., total price and buyer/high bidder) and the final value fee. This processing can take several minutes. If you retrieve a sold item and no details about the buyer/high bidder are returned or no final value fee is available, use this listing status information to determine whether eBay has finished processing the listing. |
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.
Name | Type | Description |
---|---|---|
ListMode | String | Specifies which bidder information to return. EndedListing returns all nonwinning bidders for ended listings only. It can be used only by a seller. SecondChanceEligibleEndedListing returns all nonwinning bidders for an ended listing who have not yet received a Second Chance Offer and noted interest in receiving a Second Chance Offer. It can be used only by a seller. ViewAll returns all bidders for an ended or still-active listing. It can be used by any user. The allowed values are EndedListing, SecondChanceEligibleEndedListing, ViewAll. |
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¶
Name | Type | Description |
---|---|---|
CategoryTreeId [KEY] | String | The unique identifier of the eBay category tree from which the specified category's aspects are being requested. |
aspects | String | A list of item aspects (for example, color) that are appropriate or necessary for accurately describing items in a particular leaf category. |
aspectConstraint | String | Information about the formatting, occurrence, and support of this aspect. |
aspectApplicableTo | String | This value indicate if the aspect identified by the aspects.localizedAspectName field is a product aspect or an item/instance aspect. |
aspectDataType | String | The data type of this aspect. |
aspectEnabledForVariations | Boolean | A value of true indicates that this aspect can be used to help identify item variations. |
aspectFormat | String | Returned only if the value of aspectDataType identifies a data type that requires specific formatting. |
aspectMaxLength | Integer | The maximum length of the item/instance aspect's value. |
aspectMode | String | The manner in which values of this aspect must be specified by the seller (as free text or by selecting from available options). |
aspectRequired | Boolean | A value of true indicates that this aspect is required when offering items in the specified category. |
aspectUsage | String | The enumeration value returned in this field will indicate if the corresponding aspect is recommended or optional. |
expectedRequiredByDate | String | The expected date after which the aspect will be required. |
itemToAspectCardinality | String | Indicates whether this aspect can accept single or multiple values for items in the specified category. |
aspectValues | String | A list of valid values for this aspect (for example: Red, Green, and Blue), along with any constraints on those values. |
localizedValue | String | The localized value of this aspect. |
valueConstraints | String | Not returned if the value of the localizedValue field can always be selected for this aspect of the specified category. |
applicableForLocalizedAspectName | String | The name of the control aspect on which the current aspect value depends. |
applicableForLocalizedAspectValues | String | Contains a list of the values of the control aspect on which this aspect's value depends. |
localizedAspectName | String | The localized name of this aspect (for example: Colour on the eBay UK site). |
relevanceIndicator | String | The relevance of this aspect. This field is returned if eBay has data on how many searches have been performed for listings in the category using this item aspect. |
searchCount | Integer | The number of recent searches (based on 30 days of data) for the aspect. |
CategoryId | String | The unique identifier of an eBay category. |
ItemCompatibilityList¶
Query compatability categories and possible compatability values for a specific item.
Columns¶
Name | Type | Description |
---|---|---|
ItemId [KEY] | String | The ID that uniquely identifies the item listing. The ID is generated by eBay after an item is listed. You cannot choose or revise this value. |
CompatibilityAttributes | String | A list of all potential compatability catagories for the specified item. |
PossibleCompatibilities | String | A list of all possible compatability values for the specified item. |
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.
Name | Type | Description |
---|---|---|
IncludeItemCompatibilityList | String | This is used to include ItemCompatibilityList items and should not be set manually. |
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¶
Name | Type | Description |
---|---|---|
ItemId | String | The item ID that uniquely identifies the item listing for which to retrieve the data. Required input. |
DestinationCountryCode | String | Destination country code. If DestinationCountryCode is US, a postal code is required and it represents the U.S. ZIP code. Default: US. |
ExpeditedService | Boolean | Indicates whether the service is an expedited shipping service. |
FreeShipping | Boolean | Specifies that the seller wants to offer free shipping. This applies only to the first specified domestic shipping service and is ignored if set for any other shipping service. |
ImportCharge | Decimal | The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties. |
Currency | String | Currency Id |
ShippingService | String | A shipping service option being offered by the seller to ship an item to a buyer. For a list of valid ShippingService values, call GeteBayDetails with DetailName set to ShippingServiceDetails. The ShippingServiceDetails.ValidForSellingFlow flag must also be present. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing. |
ShippingInsuranceCost | Decimal | The insurance cost associated with shipping a single item with this shipping service. |
ShippingServiceAdditionalCost | Decimal | A shipping service option being offered by the seller to ship an item to a buyer. For a list of valid ShippingService values, call GeteBayDetails with DetailName set to ShippingServiceDetails. The ShippingServiceDetails.ValidForSellingFlow flag must also be present. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing. |
ShippingServiceCost | Decimal | The base cost of shipping the item using the shipping service specified in the ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field shows the cost to ship each additional item if the buyer purchases multiple quantity of the same line item. |
ShippingServicePriority | Integer | Controls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page. |
ShippingTimeMax | Integer | The maximum guaranteed number of days the shipping carrier will take to ship an item (not including the time it takes the seller to deliver the item to the shipping carrier). |
ShippingTimeMin | Integer | The minimum guaranteed number of days in which the shipping carrier can ship an item (not including the time it takes the seller to deliver the item to the shipping carrier). |
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.
Name | Type | Description |
---|---|---|
QuantitySold | String | Number of items sold to a single buyer and to be shipped together. |
DestinationPostalCode | String | Destination country postal code (or ZIP code for U.S.). Ignored if no country code is provided. Optional tag for some countries. More likely to be required for large countries. |
ItemSpecifics¶
Query item specifics for a specific item.
Columns¶
Name | Type | Description |
---|---|---|
ItemId | String | The ID that uniquely identifies the item listing. The ID is generated by eBay after an item is listed. You cannot choose or revise this value. |
Attribute | String | The name of the attribute for the specified item. |
Specifics | String | Comma separated list of values for the specified item attribute. |
Source | String | Enumerated value indicating whether the Item Specific was manually input or selected during listing/revision/re-listing time, or if the Item Specific name-value pair came from an eBay catalog product that the listing is associated with. |
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.
Name | Type | Description |
---|---|---|
IncludeItemSpecifics | String | This is used to include ItemSpecifics items and should not be set manually. |
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¶
Name | Type | Description |
---|---|---|
OrderLineItemId [KEY] | String | A unique identifier for an eBay order line item. This field is created as soon as there is a commitment to buy from the seller, and its value is based upon the concatenation of ItemId and TransactionId with a hyphen in between these two Ids. |
TransactionId | String | The unique identifier for a transaction that was made for a specific item. If a TransactionId is provided, any specified time filter is ignored. |
ItemId | String | Unique identifier for an eBay item listing. |
HandlingCost | Decimal | The handling cost that the seller has charged for the order line item. This field is only returned after checkout is complete. The value of this field is returned as zero dollars (0.0) if the seller did not specify a handling cost for the listing. |
ShippingCost | Decimal | The shipping cost paid by the buyer for the order line item. This field is only returned after checkout is complete. |
AdjustmentAmount | Decimal | Adjustment amount entered by the buyer. A positive amount indicates the amount is an extra charge being paid to the seller by the buyer. A negative value indicates this amount is a credit given to the buyer by the seller. |
AmountPaid | Decimal | The total amount the buyer paid for the order line item. |
Currency | String | A standard 3-digit ISO 4217 currency code for currency used in countries around the world. |
BestOfferSale | Boolean | Indicates whether or not the order line item was created as the result of the seller accepting a Best Offer from a buyer. |
BuyerId | String | Unique eBay user ID for the user. |
BuyerCheckoutMessage | String | This field is returned if a buyer left a comment for the seller during the checkout flow. |
CreatedDate | Datetime | Indicates the creation time of the order line item. |
DepositType | String | This value indicates whether or not the seller requires a deposit for the vehicle. This field is only applicable to U.S. eBay Motors listings. Otherwise, this field is returned as an empty value. |
EBayPlusTransaction | Boolean | If true, this transaction is for an item that was purchased under the eBay Plus program. |
ExtendedOrderId | String | A unique identifier for an eBay order. |
FinalValueFee | Decimal | A Final Value Fee is calculated and charged to the account of a seller immediately upon creation of an order line item. |
Gift | Boolean | This boolean field is returned as true if the seller is giving a digital gift card to another individual as a gift. This field is only applicable for digital gift card order line items. |
GiftSummaryMessage | String | This free-form text contains the message that the purchaser of the digital gift card left for the recipient of the gift card. |
IntangibleItem | Boolean | This flag indicates whether or not the order line item is an intangible good such as an MP3 track or a mobile phone ringtone. Intangible items are not eligible for the PayPal Seller Protection program, so the seller will not be able to open an Unpaid Item case against the buyer. |
InvoiceSentTime | Datetime | This field indicates the date and time that an order invoice was sent from the seller to the buyer. This field is only returned if an invoice (containing the order line item) was sent to the buyer. |
IsMultiLegShipping | Boolean | If IsMultilegShipping is true, the Global Shipping Program (GSP) will be used to ship the order line item to an international buyer. |
LogisticsPlanType | String | This field will be returned only if the buyer purchased a digital gift card, which is delivered by email, or if the buyer purchased an item that is enabled with the Click and Collect feature. |
PaidTime | Datetime | Indicates the time when the order was marked paid. This field is not returned until payment has been made by the buyer. This field will not be returned for orders where the buyer has received partial or full refunds. |
QuantityPurchased | Integer | This value indicates the number of identical items purchased at the same time by the same buyer from one listing. |
ShippedTime | Datetime | Indicates the time when the items associated with the order were marked as shipped. This value will only be visible to the user on either side of the order. An order can be marked as shipped in My eBay, Selling Manager Pro, or programmatically by the seller through the CompleteSale stored procedure. |
ShippingConvenienceCharge | Decimal | The amount that the seller is being charged for the convenience of an eBay Now delivery. |
ExpeditedService | Boolean | Indicates whether the service is an expedited shipping service. |
ShippingServiceImportCharge | Decimal | The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. This amount is calculated and supplied for each item by the international shipping provider when a buyer views the item properties. |
ShippingInsuranceCost | Decimal | The insurance cost associated with shipping a single item with this shipping service. |
ShippingPackageInfo | String | If the order is being delivered through eBay Now, it contains information on the status of the order, the unique identifier of the store where the order is originating from, and the expected and actual delivery times. |
ShippingService | String | A shipping service option being offered by the seller to ship an item to a buyer. |
ShippingServiceAdditionalCost | Decimal | The cost of shipping each additional item if the same buyer purchases one or more of the same line item. |
ShippingServiceCost | Decimal | The base cost using the shipping service specified in the ShippingService field to ship the item. In the case of a multiple quantity, fixed-price listing, the ShippingServiceAdditionalCost field shows the cost to ship each additional item if the buyer purchases one or more of the same line item. |
ShippingServicePriority | Integer | This integer value controls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page. |
ShippingTimeMax | Integer | The maximum guaranteed number of days the shipping carrier will take to ship an item (not including the time it takes the seller to deliver the item to the shipping carrier). |
ShippingTimeMin | Integer | The minimum guaranteed number of days in which the shipping carrier can ship an item (not including the time it takes the seller to deliver the item to the shipping carrier). |
BuyerSelectedShipping | Boolean | Indicates whether the buyer has selected shipping details during checkout. |
CheckoutStatus | String | Indicates the current status of the checkout flow for the order. |
CompleteStatus | String | Indicates whether checkout is complete, incomplete, or pending for an order. |
DigitalStatus | String | The current state of a purchased digital gift card. |
EBayPaymentStatus | String | Indicates the success or failure of the online payment for an order by the buyer. |
InquiryStatus | String | This field gives the status of an Item Not Received (INR) Inquiry by the buyer. This field is only returned if the buyer has created an INR Inquiry. |
LastTimeModified | Datetime | Indicates date and time the status of an order was last updated (in GMT). |
PaymentHoldStatus | String | This field indicates the type and/or status of a payment hold on the item. |
PaymentInstrument | String | The payment method used by a German buyer who was offered the Pay Upon Invoice option. This field will only be returned if a German buyer was offered the Pay Upon Invoice option. Otherwise, the payment method selected by the buyer is returned in the PaymentMethodUsed field. |
PaymentMethodUsed | String | The payment method that the buyer selected to pay for the order. If checkout is not yet complete, PaymentMethodUsed is set to whatever the buyer selected as his or her preference on the Review Your Purchase page. |
ReturnStatus | String | This field gives the status of a return request from the buyer. This field is only returned if the buyer has initiated a return request or has escalated an existing return request into a return case. |
TransactionPrice | Decimal | The price of the order line item (transaction). |
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.
Name | Type | Description |
---|---|---|
ModTimeFrom | String | The ModTimeFrom and ModTimeTo fields specify a date range for retrieving order line items associated with the specified ItemId. The ModTimeFrom field is the starting date range. |
ModTimeTo | String | The ModTimeFrom and ModTimeTo fields specify a date range for retrieving order line items associated with the specified ItemId. The ModTimeTo field is the ending date range. |
NumberOfDays | String | This time filter specifies the number of days (24-hour periods) in the past to search for order line items. |
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¶
Name | Type | Description |
---|---|---|
ItemId [KEY] | String | The ID that uniquely identifies the item listing. The ID is generated by eBay after an item is listed. |
Title | String | Name of the item as it appears in the listing or search results. |
Subtitle | String | Subtitle of the item. Only returned if the seller included a subtitle for the listing. |
WatchCount | Integer | The number of watches placed on this item from the My eBay accounts of the buyers. |
BidCount | Integer | The number of bids that have been placed on the item. |
BuyItNowPrice | Decimal | The Buy It Now Price of the item (if any), in the currency of the site on which the item was listed. |
Currency | String | The 3-digit ISO 4217 currency codes for the currency used by the site. |
OriginalRetailPrice | Decimal | The actual retail price set by the manufacturer (OEM). |
PricingTreatment | String | Using OriginalRetailPrice, MinimumAdvertisedPrice, and StartPrice values, eBay identifies whether the listing falls under MAP or STP (aka OriginalRetailPrice). |
SoldOffEbay | Boolean | Used by the eBay UK and eBay Germany (DE) sites, this flag indicates that the discount price (specified as StartPrice) is the price for which the seller offered the same (or similar) item for sale on a Web site or offline store other than eBay in the previous 30 days. The discount price is always in reference to the price for the item set by the seller. |
SoldOnEbay | Boolean | Used by the eBay UK and eBay Germany (DE) sites, this flag indicates that the discount price (specified as StartPrice) is the price for which the seller offered the same (or similar) item for sale on eBay in the previous 30 days. The discount price is always in reference to the price for the item set by the seller. |
GlobalId | String | The site upon which the item is listed. Returns a Global Id, which is a unique identifier for combinations of site, language, and territory. |
ImageURL | String | URL for a picture used as the Gallery thumbnail, if any. The image uses one of the following graphics formats: JPEG, BMP, TIF, or GIF. Only returned if the seller chose to show a gallery image. |
OriginalPrice | Decimal | Original price of an item whose price a seller has reduced with the Promotional Price Display feature. Only returned if the price has been revised. |
PrimaryCategoryId | String | Numeric ID of the first (or only) category in which the item is listed. (Listings can appear in more than one category.) |
PrimaryCategoryName | String | Display name of the first (or only) category in which the item is listed. This is a fully qualified category breadcrumb (e.g., Computers & Networking:Laptops, Notebooks). |
ShippingCost | Decimal | The shipping cost associated with the first shipping service. Only returned when ShippingType is flat. |
ShippingType | String | The shipping cost model offered by the seller. |
TimeLeft | String | Time left before the item listing ends. The duration is represented in the ISO 8601 duration format (PnDTnHnMnS). For ended listings, the time left is P0DT0H0M0S (zero days, zero hours, zero minutes, and zero seconds). |
ViewItemURL | String | The URL of the Web page where a user can view the listing. On the U.S. site, this is called the View Item page. If you enabled affiliate tracking in the call, ViewItemURL contains a string that includes affiliate tracking information (see the eBay Partner Network). |
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.
Name | Type | Description |
---|---|---|
CategoryId | String | Specifies the category from which to retrieve item listings. |
AffiliateCustomId | String | Need not be specified. You can define an AffiliateCustomId to better monitor your marketing efforts. If you are using the eBay Partner Network, and you provide an AffiliateCustomId, the tracking URL returned by the eBay Partner Network will contain the AffiliateUserId. |
AffiliateNetworkId | String | Specifies your tracking partner for affiliate commissions. |
AffiliateTrackingId | String | The value you specify is obtained from your tracking partner. |
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¶
Name | Type | Description |
---|---|---|
PaymentId [KEY] | String | A unique transaction ID for the payment. |
OrderId | String | A unique identifier for an eBay order. |
FeeOrCreditAmount | Decimal | Fee Amount is a positive value and Credit Amount is a negative value. |
Payee | String | The person or organization who is to receive the payment allocation. |
Payer | String | This field indicates the eBay user or eBay partner who submitted the payment. |
PaymentAmount | Decimal | The amount of the payment that is allocated to the payee. |
PaymentStatus | String | The current status of a buyer payment that is allocated to a specified payee. |
PaymentTime | Datetime | The date and time when the payment is received by the payee. |
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.
Name | Type | Description |
---|---|---|
CreateTimeFrom | Datetime | Specifies the start of the date range for which to retrieve payment details of the orders created within this date range. |
CreateTimeTo | Datetime | Specifies the end of the date range for which to retrieve payment details of the orders created within this date range. |
ModTimeFrom | Datetime | Specifies the start of the date range for which to retrieve payment details of the orders modified within this date range. The maximum time range that may be specified is 30 days. |
ModTimeTo | Datetime | Specifies the end of the date range for which to retrieve payment details of the orders modified within this date range. The maximum time range that may be specified is 30 days. |
NumberOfDays | Integer | All eBay payment details of the orders that were either created or modified within this period are returned in the output. Min: 1. Max: 30. |
OrderRole | String | Filters the returned payment details of the orders based on the role of the user. The user's role is either buyer or seller. |
OrderStatus | String | Filters the returned payment details of the orders based on the status of the order. Applicable Values: Active, All, Completed, Inactive. |
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¶
Name | Type | Description |
---|---|---|
OrderId [KEY] | String | A unique identifier for an eBay order. |
ExtendedOrderId | String | The unique identifier of the order in legacy format, as traditionally used by the Trading API. |
BuyerUserId | String | eBay user ID of the order's buyer. |
SellerUserId | String | This is the eBay user ID of the order's seller. |
OrderStatus | String | This enumeration value indicates the current status of the order. Applicable Values: Active, All, Cancelled, Completed, Inactive. |
AdjustmentAmount | Decimal | This value indicates the dollar amount by which the buyer has adjusted the order total. |
AmountPaid | Decimal | This value indicates the total amount of the order. |
AmountSaved | Decimal | This value indicates the shipping discount experienced by the buyer as a result of creating a Combined Invoice order. |
CreatedTime | Datetime | Timestamp that indicates the date and time that the order was created. |
ShippedTime | Datetime | Timestamp indicating the date and time of order shipment. This field is not returned until the order has been marked as shipped. |
PaymentMethod | String | The payment method that the buyer selected to pay for the order. |
PaymentStatus | String | This value indicates the payment status of an order. |
CheckoutStatus | String | Container consisting of details related to the current checkout status of the order. |
SellerEmail | String | The email address of the seller involved in the order. The email address of the seller is only returned if it is the same seller making the call. |
SubTotal | Decimal | The subtotal amount for the order is the total cost of all order line items. This value does not include any shipping/handling, shipping insurance, or sales tax costs. |
Total | Decimal | The Total amount equals the Subtotal value plus the shipping/handling, shipping insurance, and sales tax costs. |
CancelCompleteDate | Datetime | Timestamp indicating when the cancellation process of an eBay order has been completed. |
CancelInitiationDate | Datetime | This timestamp indicates when the cancellation of the eBay order was initiated. |
CancelInitiator | String | This value indicates which party initiated the cancellation of the eBay order. |
CancelReason | String | This value indicates the reason why the order cancellation was initiated. |
CancelStatus | String | The current status for the order cancellation request if it exists. |
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.
Name | Type | Description |
---|---|---|
CreateTimeFrom | Datetime | Specifies the start of the date range for which to retrieve orders created within this date range. |
CreateTimeTo | Datetime | Specifies the end of the date range for which to retrieve orders created within this date range. |
ModTimeFrom | Datetime | Specifies the start of the date range for which to retrieve orders modified within this date range. The maximum time range that may be specified is 30 days. |
ModTimeTo | Datetime | Specifies the end of the date range for which to retrieve orders modified within this date range. The maximum time range that may be specified is 30 days. |
NumberOfDays | Integer | All eBay orders that were either created or modified within this period are returned in the output. Min: 1. Max: 30. |
OrderRole | String | Filters the returned orders based on the role of the user. The user's role is either buyer or seller. |
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¶
Name | Type | Description |
---|---|---|
OrderId [KEY] | String | The ID that uniquely identifies the item listing. The ID is generated by eBay after an item is listed. You cannot choose or revise this value. |
AddressId | String | Unique ID for a user's address in the eBay database. |
CityName | String | The name of the user's city. |
Country | String | The two-digit code representing the country of the user. |
CountryName | String | The name of the user's country. |
AddressName | String | User's name for the address. |
Phone | String | User's primary phone number. |
PostalCode | String | User's postal code. |
StateOrProvince | String | The state or province of the user's address. Whether it's a state or a province will depend on the region and/or country. |
Street1 | String | The first line of the user's street address. |
Street2 | String | The second line of the user's street address (such as an apartment number or suite number). |
ShippingCharge | Decimal | The dollar value in this field indicates the amount that the seller is being charged (at order level) for the convenience of an eBay On Demand Delivery. |
ExpeditedService | Boolean | Indicates whether the service is an expedited shipping service. |
ShippingImportCharge | Decimal | The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. |
ShippingInsuranceCost | Decimal | The insurance cost associated with shipping a single item with this shipping service. |
ShippingServiceAdditionalCost | Decimal | The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. |
ShippingServiceCost | Decimal | The base cost of shipping the item using the shipping service specified in the ShippingService field. |
ActualDeliveryTime | Datetime | This timestamp indicates when the order was actually delivered to the buyer. |
EstimatedDeliveryTimeMax | Datetime | The EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax timestamps indicate the window during which the buyer can expect delivery. |
EstimatedDeliveryTimeMin | Datetime | The EstimatedDeliveryTimeMin and EstimatedDeliveryTimeMax timestamps indicate the window during which the buyer can expect delivery. |
HandleByTime | Datetime | This timestamp indicates the latest date/time that the seller should ship the package to ensure that the package arrives to the buyer within the estimated delivery window. |
ScheduledDeliveryTimeMax | Datetime | The ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax timestamps indicate the delivery window for which the buyer can expect to receive the order. |
ScheduledDeliveryTimeMin | Datetime | The ScheduledDeliveryTimeMin and ScheduledDeliveryTimeMax timestamps indicate the delivery window for which the buyer can expect to receive the order. |
ShippingTrackingEvent | String | This enumeration value indicates whether or not the order has been picked up from the store indicated by the StoreID value. |
StoreId | String | The unique identifier of the store from where the order will be delivered. |
SalesTaxAmount | Decimal | The amount of sales tax, calculated for an order based on the SalesTaxPercent and pricing information. |
SalesTaxPercent | Float | Percent of an item's price to be charged as the sales tax for the order. |
SalesTaxState | String | State or jurisdiction for which the sales tax is being collected. Only returned if the seller specified a value. |
ShipmentTrackingNumbers | String | The tracking numbers assigned by the shipping carriers. |
ShippingCarriers | String | The name of the shipping carriers used to ship the items. |
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.
Name | Type | Description |
---|---|---|
CreateTimeFrom | Datetime | Specifies the start of the date range for which to retrieve shipping details of the orders created within this date range. |
CreateTimeTo | Datetime | Specifies the end of the date range for which to retrieve shipping details of the orders created within this date range. |
ModTimeFrom | Datetime | Specifies the start of the date range for which to retrieve shipping details of the orders modified within this date range. The maximum time range that may be specified is 30 days. |
ModTimeTo | Datetime | Specifies the end of the date range for which to retrieve shipping details of the orders modified within this date range. The maximum time range that may be specified is 30 days. |
NumberOfDays | Integer | All eBay shipping details of the orders that were either created or modified within this period are returned in the output. Min: 1. Max: 30. |
OrderRole | String | Filters the returned shipping details of the orders based on the role of the user. The user's role is either buyer or seller. |
OrderStatus | String | Filters the returned shipping details of the orders based on the status of the order. Applicable Values: Active, All, Completed, Inactive. |
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¶
Name | Type | Description |
---|---|---|
PaymentPolicyId [KEY] | String | A unique eBay-assigned ID for a payment policy. This ID is generated when the policy is created. |
Description | String | The Description of the payment policy. |
Name | String | The Description of the payment policy. |
CategoryTypesName | String | The Category Type name value to which this policy applies. Used to discern accounts that sell motor vehicles from those that don't. |
DepositAggr | String | Amounts and due dates for deposits on motor vehicle listings on eBay Motors. Is applicable only if the categoryTypes.name field is set to MOTORS_VEHICLES. |
MarketplaceId | String | The ID of the eBay marketplace to which the payment policy applies. |
ImmediatePay | Boolean | If set to true, payment is due upon receipt (eBay generates a receipt when the buyer agrees to purchase an item). |
PaymentMethodAggr | String | If the seller is not opted-in to managed payments, this container returns a list of the payment methods accepted by the seller. |
RecipientAccountReferenceId | String | Contains the PayPal email address of the recipient (buyer) if referenceType is set to PAYPAL_EMAIL. |
RecipientAccountReferenceType | String | A reference a recipient's account. Currently only PAYPAL_EMAIL is valid. |
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¶
Name | Type | Description |
---|---|---|
ReturnPolicyId [KEY] | String | A unique eBay-assigned ID for this policy. |
Description | String | The seller-defined description of the return policy for internal use (this value is not displayed to end users). |
Name | String | The category type to which the policy applies (motor vehicles or non-motor vehicles). |
CategoryTypesName | String | The category type to which the policy applies (motor vehicles or non-motor vehicles). |
MarketplaceId | String | The ID of the eBay marketplace to which this return policy applies. |
ExtendedHolidayReturnsOffered | String | If set to true, the seller offers an Extended Holiday Returns policy for their listings. |
InternationalOverrideAggr | String | If populated, specifies the seller's policies for international returns (items that require postage via an international shipping service). |
RefundMethod | String | Indicates the method the seller uses to compensate the buyer for returned items. The return method specified applies only to remorse returns. |
RestockingFeePercentage | String | For sellers who accept returns, this field is filled if they charge buyers a restocking fee when items are returned. |
ReturnInstructions | String | Contains the seller's detailed explanation for their return policy and is displayed in the Return Policy section of the View Item page. |
ReturnMethod | String | Valid in the US marketplace only, this optional field indicates additional services (other than money-back) that sellers can offer buyers for remorse returns. |
ReturnPeriodValue | String | Specifies the amount of time the buyer has to return an item. |
ReturnPeriodUnit | String | Specifies the unit of measure of amount of time the buyer has to return an item. |
ReturnsAccepted | Boolean | If set to true, the seller accepts returns. |
ReturnShippingCostPayer | String | This field indicates who is responsible for paying for the shipping charges for returned items. The field can be set to either BUYER or SELLER. |
ShippingCarriers¶
Query Shipping Carriers supported by the specified site.
Columns¶
Name | Type | Description |
---|---|---|
ShippingCarrierId | Integer | Numeric identifier. |
Description | String | Display string that applications can use to present a list of shipping carriers in a more user-friendly format (such as in a drop-down list). |
DetailVersion | String | Returns the latest version number for this field. |
ShippingCarrier | String | The code for the shipping carrier. |
UpdateTime | Datetime | Gives the time in GMT that the feature flags for the details were last updated. |
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.
Name | Type | Description |
---|---|---|
DetailName | String | A designation of what kind of information you wish returned for the specified eBay site. The allowed values are ShippingCarrierDetails. |
ShippingCategories¶
A shipping service category supported for the site.
Columns¶
Name | Type | Description |
---|---|---|
ShippingCategory [KEY] | String | Indicates the shipping category. Shipping categories include the following: ECONOMY, STANDARD, EXPEDITED, ONE_DAY, PICKUP, OTHER, and NONE. International shipping services are generally grouped into the NONE category. For more information on these shipping categories, and which services fall into which category, see the Shipping Basics page on the eBay Shipping Center site. |
Description | String | Display string that applications can use to present a list of shipping categories in a more user-friendly format (such as in a drop-down list). This field is localized per site. |
DetailVersion | String | Returns the latest version number for this field. The version can be used to determine if and when to refresh cached client data. |
UpdateTime | Datetime | Gives the time in GMT that the feature flags for the details were last updated. This timestamp can be used to determine if and when to refresh cached client data. |
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.
Name | Type | Description |
---|---|---|
DetailName | String | A designation of what kind of information you wish returned for the specified eBay site. The allowed values are ShippingCategoryDetails. |
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¶
Name | Type | Description |
---|---|---|
ShippingLocation [KEY] | String | Short name or abbreviation for a region (e.g., Asia) or location (e.g. Japan). |
Description | String | Display string that applications can use to present a list of shipping locations in a more user-friendly format (such as in a drop-down list). This field is localized in the language of the site. |
DetailVersion | String | Returns the latest version number for this field. The version can be used to determine if and when to refresh cached client data. |
UpdateTime | Datetime | Gives the time in GMT that the feature flags for the details were last updated. This timestamp can be used to determine if and when to refresh cached client data. |
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.
Name | Type | Description |
---|---|---|
DetailName | String | A designation of what kind of information you wish returned for the specified eBay site. The allowed values are ShippingLocationDetails. |
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¶
Name | Type | Description |
---|---|---|
ShippingServiceId [KEY] | Integer | Numeric identifier. A value greater than 50000 represents an international shipping service. |
CODService | Boolean | This flag is returned as true if the corresponding ShippingService value is a COD (Cash-On-Delivery) service. |
CostGroupFlat | Boolean | If returned, this is the shipping service group to which the shipping service belongs. |
Description | String | A user-friendly description of shipping service options. |
DetailVersion | String | Returns the latest version number for this field. |
DimensionsRequired | Boolean | Whether the shipping service option requires that package dimensions are provided by the seller. |
ExpeditedService | Boolean | Indicates whether the shipping service is an expedited shipping service. Only returned for sites for which the Get It Fast feature is enabled and only if true. |
InternationalService | Boolean | Indicates whether the shipping service is an international shipping service. |
MappedToShippingServiceId | Integer | The ID of another shipping service that will be used when a shipping service is deprecated. |
ShippingCategory | String | Indicates the shipping category. Shipping categories include the following: ECONOMY, STANDARD, EXPEDITED, ONE_DAY, PICKUP, OTHER, and NONE. International shipping services are generally grouped into the NONE category. |
ShippingService | String | The name of the shipping service option. If the ValidForSellingFlow column is not true, this particular shipping service option is no longer valid and cannot be offered to buyers through a listing. |
ShippingTimeMax | Integer | The maximum guaranteed number of days the shipping carrier will take to ship an item (not including the time it takes the seller to deliver the item to the shipping carrier). Always returned when ExpeditedService is true or if defined for a particular service. |
ShippingTimeMin | Integer | The minimum guaranteed number of days the shipping carrier will take to ship an item (not including the time it takes the seller to deliver the item to the shipping carrier). Always returned when ExpeditedService is true or if defined for a particular service. |
SurchargeApplicable | Boolean | True if a surcharge applies for any region that this service ships to. |
UpdateTime | Datetime | Gives the time in GMT that the feature flags for the details were last updated. |
ValidForSellingFlow | Boolean | If this field is returned as true, the shipping service option can be used. If this field is returned as false, the shipping service option is not currently supported. |
WeightRequired | Boolean | If true, a seller who selects this package type for the listing and then offers this shipping service must specify WeightMajor and WeightMinor in the item definition. If not returned, WeightRequired is false. |
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.
Name | Type | Description |
---|---|---|
DetailName | String | A designation of what kind of information you wish returned for the specified eBay site. The allowed values are ShippingServiceDetails. |
Sites¶
Lists all available eBay sites and their associated SiteID numbers.
Columns¶
Name | Type | Description |
---|---|---|
SiteID | Integer | Numeric identifier for an eBay site. If you are using the SOAP API, you use numeric site IDs in the request URL. If you are using the XML API, you use numeric site IDs in the X-EBAY-API-SITEID header. |
SiteName | String | Short name that identifies an eBay site. Usually, an eBay site is associated with a particular country or region (e.g., US or Belgium_French). Specialty sites (e.g., eBay Stores) use the same site ID as their associated main eBay site. The US eBay Motors site is an exception to this convention. |
DetailVersion | String | Returns the latest version number for this field. The version can be used to determine if and when to refresh cached client data. |
UpdateTime | Datetime | Gives the time in GMT that the feature flags for the details were last updated. This timestamp can be used to determine if and when to refresh cached client data. |
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.
Name | Type | Description |
---|---|---|
DetailName | String | A designation of what kind of information you wish returned for the specified eBay site. The allowed values are SiteDetails. |
SuggestedCategories¶
Query eBay list of categories with the highest number of listings.
Columns¶
Name | Type | Description |
---|---|---|
CategoryId | Integer | This string value is the unique identifier of an eBay category. |
CategoryName | String | This string value is the display name of the eBay primary category, as it would appear on the eBay website. |
CategoryParentId | String | This string value is the category ID of the parent category of the primary category indicated in the CategoryId field. |
CategoryParentName | String | This string value is the display name of the eBay primary category, as it would appear on the eBay website. |
PercentItemFound | Integer | Percentage of the matching items that were found in this category, relative to other categories in which matching items were also found. Indicates the distribution of matching items across the suggested categories. |
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.
Name | Type | Description |
---|---|---|
Query | String | This field is used to specify the search query, consisting of one or more keywords to search for in listing titles and descriptions. The words and and or are treated like any other word. |
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¶
Name | Type | Description |
---|---|---|
Title | String | The title of the product, as specified in the catalog. |
ProductId | String | The eBay or external Ids associated with the product. Use this value as input to search for the same product in the future, or use the ISBN, EAN, or UPC value (if returned). The ProductId values can be used to retrieve products, item listings, or guides and reviews. Max length: 4000. |
ProductURL | String | Fully qualified URL for optional information about the product, such as the description or film credits for a movie. This information is hosted through the eBay website and it cannot be edited. Portions of the content are protected by copyright. This link allows users to view additional descriptive details about the product. |
ImageURL | String | Fully qualified URL for a stock image (if any) associated with the eBay catalog product. The URL is for the image eBay usually displays in product search results (usually 70px tall). It may be helpful to calculate the dimensions of the photo programmatically before displaying it. Only returned if a URL is available for the product. |
CatalogName | String | Name of the catalog the product is in. Only returned if product is in a catalog. |
ReviewCount | Long | The total number of reviews available for this product on the eBay website. |
HighestPrice | Decimal | The highest price for items listed as this product. |
LowestPrice | Decimal | The lowest price for items listed as this product. |
Currency | String | The three-digit currency code as defined in ISO 4217. |
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.
Name | Type | Description |
---|---|---|
AffiliateCustomId | String | Need not be specified. You can use this pseudo column if you want to leverage it to better monitor your marketing efforts. If you are using the eBay Partner Network, and you provide an AffiliateCustomId, the tracking URL returned by the eBay Partner Network will contain the AffiliateUserId. |
AffiliateNetworkId | String | Specifies your tracking partner for affiliate commissions. |
AffiliateTrackingId | String | The value you specify is obtained from your tracking partner. |
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¶
Name | Type | Description |
---|---|---|
ID [KEY] | String | The unique identifier of the linked order line item. |
TransactionId | String | Unique identifier for an eBay sales transaction. |
OrderId | String | The unique identifier of the order to which the linked line item belongs. |
EstimatedDeliveryTimeMax | Datetime | Indicates the latest date and time to receive the order. |
EstimatedDeliveryTimeMin | Datetime | Indicates the earliest date and time to receive the order. |
SellerUserID | String | The eBay user ID of the seller who sold the linked line item. |
ItemName | String | Depending on the call and context, this value is either a name of an Item/Variation Specific, or a Parts Compatibility name. |
ItemValue | String | Depending on the call and context, this value is either the value of an Item/Variation Specific, a Parts Compatibility value, or a product identifier. |
ItemsTitle | String | This field is used to specify the title of the listing. |
CreateTimeFrom | Datetime | Specifies the start of the date range for which to retrieve payment details of the transactions in orders created within this date range. By default the date range is 90 days. |
CreateTimeTo | Datetime | Specifies the end of the date range for which to retrieve payment details of the transactions in orders created within this date range. By default the date range is 90 days. |
ModTimeFrom | Datetime | Specifies the start of the date range for which to retrieve payment details of the transactions in orders modified within this date range. The maximum time range that may be specified is 30 days. |
ModTimeTo | Datetime | Specifies the end of the date range for which to retrieve payment details of the transactions in orders modified within this date range. The maximum time range that may be specified is 30 days. |
NumberOfDays | Integer | All eBay payment details of the transactions in orders that were either created or modified within this period are returned in the output. Min: 1. Max: 30. |
OrderRole | String | Filters the returned payment details of the transactions based on the role of the user. The user's role is either buyer or seller. |
OrderStatus | String | Filters the returned payment details of the transactions based on the status of the order. Applicable Values: Active, All, Completed, Inactive. |
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¶
Name | Type | Description |
---|---|---|
TransactionReferenceId [KEY] | String | A unique transaction ID for the payment. |
TransactionId | String | The unique identifier of the transaction the payment has been made for. |
OrderId | String | The unique identifier of the order the payment has been made for. |
FeeOrCreditAmount | Decimal | Fee Amount is a positive value and Credit Amount is a negative value. |
Payee | String | The person or organization who is to receive the payment allocation. |
Payer | String | This field indicates the eBay user or eBay partner who submitted the payment. |
PaymentAmount | Decimal | The amount of the payment that is allocated to the payee. |
PaymentStatus | String | The current status of a buyer payment that is allocated to a specified payee. |
PaymentTime | Datetime | The date and time when the payment is received by the payee. |
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.
Name | Type | Description |
---|---|---|
CreateTimeFrom | Datetime | Specifies the start of the date range for which to retrieve payment details of the transactions in orders created within this date range. By default the date range is 90 days. |
CreateTimeTo | Datetime | Specifies the end of the date range for which to retrieve payment details of the transactions in orders created within this date range. By default the date range is 90 days. |
ModTimeFrom | Datetime | Specifies the start of the date range for which to retrieve payment details of the transactions in orders modified within this date range. The maximum time range that may be specified is 30 days. |
ModTimeTo | Datetime | Specifies the end of the date range for which to retrieve payment details of the transactions in orders modified within this date range. The maximum time range that may be specified is 30 days. |
NumberOfDays | Integer | All eBay payment details of the transactions in orders that were either created or modified within this period are returned in the output. Min: 1. Max: 30. |
OrderRole | String | Filters the returned payment details of the transactions based on the role of the user. The user's role is either buyer or seller. |
OrderStatus | String | Filters the returned payment details of the transactions based on the status of the order. Applicable Values: Active, All, Completed, Inactive. |
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¶
Name | Type | Description |
---|---|---|
ReferenceId [KEY] | String | This dollar value is the amount of the refund to the buyer for this specific refund transaction. |
TransactionId | String | The unique identifier of the transaction the payment has been made for. |
OrderId | String | The unique identifier of the order the payment has been made for. |
FeeOrCreditAmount | Decimal | Fee Amount is a positive value and Credit Amount is a negative value. |
RefundTo | String | This field is the eBay user ID of the buyer who is receiving the refund or store credit from the merchant. |
RefundType | String | This value indicates whether the merchant refunded or provided a store credit to the buyer for the returned In-Store Pickup item. |
RefundAmount | Decimal | This dollar value is the amount of the refund to the buyer for this specific refund transaction. |
RefundStatus | String | This value indicates the success or failure of the attempt by the merchant to refund or provide store credit to the buyer for a returned In-Store Pickup item. |
RefundTime | Datetime | This date/time value is the timestamp for the refund transaction. This field is not returned if the refund was not successful (RefundStatus=FAILED). |
CreateTimeFrom | Datetime | Specifies the start of the date range for which to retrieve payment details of the transactions in orders created within this date range. By default the date range is 90 days. |
CreateTimeTo | Datetime | Specifies the end of the date range for which to retrieve payment details of the transactions in orders created within this date range. By default the date range is 90 days. |
ModTimeFrom | Datetime | Specifies the start of the date range for which to retrieve payment details of the transactions in orders modified within this date range. The maximum time range that may be specified is 30 days. |
ModTimeTo | Datetime | Specifies the end of the date range for which to retrieve payment details of the transactions in orders modified within this date range. The maximum time range that may be specified is 30 days. |
NumberOfDays | Integer | All eBay payment details of the transactions in orders that were either created or modified within this period are returned in the output. Min: 1. Max: 30. |
OrderRole | String | Filters the returned payment details of the transactions based on the role of the user. The user's role is either buyer or seller. |
OrderStatus | String | Filters the returned payment details of the transactions based on the status of the order. Applicable Values: Active, All, Completed, Inactive. |
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¶
Name | Type | Description |
---|---|---|
TransactionId [KEY] | String | Unique identifier for an eBay order line item. An order line item is created once there is a commitment from a buyer to purchase an item. |
OrderId | String | The ID that uniquely identifies the item listing. The ID is generated by eBay after an item is listed. You cannot choose or revise this value. |
ItemId | String | The unique identifier of the eBay listing. This identifier is generated by eBay and returned in the response of an Add call if an item is successfully listed. |
ItemSite | String | The name of the site on which the item is listed. |
ItemTitle | String | This field is used to specify the title of the listing. |
ActualHandlingCost | Decimal | The handling cost that the seller has charged for the order line item. |
ActualShippingCost | Decimal | The shipping cost paid by the buyer for the order line item. This field is only returned after checkout is complete. |
BuyerEmail | String | Email address for the user. |
BuyerFirstName | String | The first name of the buyer who purchased the order. |
BuyerLastName | String | The last name of the buyer who purchased the order. |
CreatedDate | Datetime | Indicates the creation time of the order line item. |
Price | Decimal | The price of the order line item. |
SiteId | String | The site upon which the order line item (transaction) was created. |
PaidTime | Datetime | Indicates the time when the order was marked paid. |
DigitalRecipientEmail | String | This field displays the email address of the sender/purchaser of the digital gift card. |
DigitalRecipientName | String | This field displays the actual name (not the eBay user ID) of the sender/purchaser of the digital gift card. |
DigitalSenderEmail | String | This field displays the email address of the sender/purchaser of the digital gift card. |
DigitalSenderName | String | This field displays the actual name (not the eBay user ID) of the sender/purchaser of the digital gift card |
DigitalDeliveryMethod | String | This value indicates the method in which the digital gift card will be delivered to the buyer. |
EBayPlusTransaction | Boolean | If true, this transaction is for an item that was purchased under the eBay Plus program. |
FinalValueFee | Decimal | A Final Value Fee is calculated and charged to a seller's account immediately upon creation of an order line item. |
GuaranteedDelivery | Boolean | This field is returned as true if the order line item is qualified for eBay Guaranteed Delivery, or false if it is not eligible. |
GuaranteedShipping | Boolean | This field is returned as true if the seller chose to use eBay's Guaranteed Shipping feature at listing time. |
InvoiceSentTime | Datetime | This field indicates the date/time that an order invoice was sent from the seller to the buyer. |
DigitalStatus | String | This enumeration value indicates the current state of a purchased digital gift card. |
InquiryStatus | String | This field gives the status of a buyer's Item Not Received (INR) Inquiry. |
ReturnStatus | String | This field gives the status of a buyer's return request. |
TotalTaxAmount | Decimal | This value indicates the total tax amount for the order line item, including the sales tax on the item, the sales tax on shipping and handling, and any electronic waste recycling fee. |
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.
Name | Type | Description |
---|---|---|
CreateTimeFrom | Datetime | Specifies the start of the date range for which to retrieve transactions of orders created within this date range. |
CreateTimeTo | Datetime | Specifies the end of the date range for which to retrieve transactions of orders created within this date range. |
ModTimeFrom | Datetime | Specifies the start of the date range for which to retrieve transactions of orders modified within this date range. The maximum time range that may be specified is 30 days. |
ModTimeTo | Datetime | Specifies the end of the date range for which to retrieve transactions of orders modified within this date range. The maximum time range that may be specified is 30 days. |
NumberOfDays | Integer | All eBay transactions that were either created or modified within this period are returned in the output. Min: 1. Max: 30. |
OrderRole | String | Filters the returned transactions based on the role of the user. The user's role is either buyer or seller. |
OrderStatus | String | Filters the returned transactions based on the status of the order. Applicable Values: Active, All, Completed, Inactive. |
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¶
Name | Type | Description |
---|---|---|
TransactionId [KEY] | String | Unique identifier for the transaction. |
OrderId | String | Unique identifier for the order. |
InternationalPackagingHandlingCosts | Decimal | Fees a seller might assess for the shipping of the item (in addition to whatever the shipping service might charge). |
OriginatingPostalCode | String | Postal code for the location from which the package will be shipped. |
PackagingHandlingCosts | Decimal | Fees a seller might assess for the shipping of the item (in addition to whatever the shipping service might charge). |
ShippingIrregular | Boolean | This boolean field indicates that the shipping package is considered an irregular shape and/or size by the shipping carrier, and thus requires special handling. |
ExpeditedService | Boolean | Indicates whether the service is an expedited shipping service. |
ShippingImportCharge | Decimal | The total cost of customs and taxes for the international leg of an order shipped using the Global Shipping Program. |
ShippingInsuranceCost | Decimal | The insurance cost associated with shipping a single item with this shipping service. |
ShippingServiceAdditionalCost | Decimal | The cost of shipping each additional item if the same buyer purchases multiple quantity of the same line item. |
ShippingServiceCost | Decimal | The base cost of shipping the item using the shipping service specified in the ShippingService field. |
ShippingPackageInfo | String | This aggregate contains all shipping package info. |
ShipmentTrackingNumbers | String | The tracking numbers assigned by the shipping carriers. |
ShippingCarriers | String | The name of the shipping carriers used to ship the items. |
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.
Name | Type | Description |
---|---|---|
CreateTimeFrom | Datetime | Specifies the start of the date range for which to retrieve shipping details of the transactions in orders created within this date range. By default the date range is 90 days. |
CreateTimeTo | Datetime | Specifies the end of the date range for which to retrieve shipping details of the transactions in orders created within this date range. By default the date range is 90 days. |
ModTimeFrom | Datetime | Specifies the start of the date range for which to retrieve shipping details of the transactions in orders modified within this date range. The maximum time range that may be specified is 30 days. |
ModTimeTo | Datetime | Specifies the end of the date range for which to retrieve shipping details of the transactions in orders modified within this date range. The maximum time range that may be specified is 30 days. |
NumberOfDays | Integer | All eBay shipping details of the transactions in orders that were either created or modified within this period are returned in the output. Min: 1. Max: 30. |
OrderRole | String | Filters the returned shipping details of the transactions based on the role of the user. The user's role is either buyer or seller. |
OrderStatus | String | Filters the returned shipping details of the transactions based on the status of the order. Applicable Values: Active, All, Completed, Inactive. |
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¶
Name | Description |
---|---|
AddItem | Create and publish a new Item Listing on an eBay site. |
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. |
CreateInventoryTask | This procedure creates an inventory-related download task for a specified feed type with optional filter criteria. |
CreateOrderTask | This procedure creates an order download task with filter criteria for the order report. |
GetOAuthAccessToken | Gets the OAuth access token from eBay. |
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. |
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). |
RefreshOAuthAccessToken | Refreshes the OAuth access token used for authentication with EBay. |
SetUserNotes | Add, replace, and delete My eBay notes for items that are being tracked in the My eBay Selling and Buying areas. |
UploadFile | Uploads a file to the EBay account. |
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:
-
Use the Categories view to select a top-level category; for example, Books. You can use the following query:
SELECT * FROM Categories
-
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'
-
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.
Note
This procedure makes use of indexed parameters.
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¶
Name | Type | Required | Description |
---|---|---|---|
Title | String | False | Name of the item as it appears in the listing or search results. |
Description | String | False | The description of the item by the seller. In listing requests, you can use CDATA tags to submit your description if you want to use HTML or XML-reserved characters in the description. |
CategoryId | String | False | Category ID for the first (or only) category in which the item is listed (or will be listed, if the item is new). |
StartPrice | String | False | The original price of the item at listing or relisting time. If this value changes when the item is revised, the new value becomes the original price. |
ConditionId | String | False | An identifier for the condition of the item. For example, 1000 for New or 3000 for Used. |
Country | String | False | Defines the 2-letter ISO 3166 country code. |
Currency | String | False | Currency associated with the price information of the item. 3-letter ISO 4217 currency code. |
DispatchTimeMax | String | False | Specifies the maximum number of business days the seller commits to for preparing an item to be shipped after receiving a cleared payment. This time does not include the shipping time (the transit time of the carrier). Including this field fulfills 'Handling time' being required for input. |
ListingDuration | String | False | Describes the number of days the seller wants the listing to be active (available for bidding/buying). |
ListingType | String | False | The format of the listing the seller wants to use, such as Chinese auction or fixed price. |
Location | String | False | Indicates the geographical location of the item (along with Country). When you revise a listing, you can add or change this value only if the listing has no bids (or no items have sold), and it does not end within 12 hours. |
ReturnsAcceptedOption | String | False | Indicates whether the seller allows the buyer to return the item. One of the following values: ReturnsAccepted or ReturnsNotAccepted. If you specify ReturnsNotAccepted, the View Item page will indicate that returns are not accepted instead. |
SubTitle | String | False | Subtitle to use in addition to the title. |
Quantity | String | False | The Quantity value for auction listings must always be 1. For a fixed-price listing, the Quantity value indicates the number of identical items the seller has available for sale in the listing. |
Sku | String | False | A SKU (Stock Keeping Unit) value is a seller-defined identifier for a product. |
UUID | String | False | Universally unique constraint tag. Use UUID to ensure that you only list a particular item once, particularly if you are listing many items at once. |
ScheduleTime | String | False | Allows the user to specify the time that the listing becomes active on eBay. |
PaymentMethod | String | False | Identifies the payment method (such as PayPal) that the seller will accept when the buyer pays for the item. Use the CategoryFeatures view to find the available payment methods for a category. |
PayPalEmailAddress | String | False | The PayPal email address of the seller. |
LiveAuction | String | False | This field must be included and set to true if the listing will be a part of a Live Auction. This boolean field is returned as true in the ItemList table if the listing is part of a Live Auction. See the eBay Live Auctions home page for more information about Live Auctions on eBay.com. |
LotSize | String | False | A lot is a set of two or more similar items included in a single listing that must be purchased together in a single order line item. The LotSize value is the number of items in the lot. This field is required if two or more items are including in one listing. |
PostalCode | String | False | Postal code of the place where the item is located. This value is used for proximity searches. |
TaxCategory | String | False | Tax exception category code. |
UseTaxTable | String | False | Indicates whether the tax table of the seller is to be used when applying and calculating sales tax for an order line item. |
VIN | String | False | This field displays the Vehicle Identification Number, which is a unique serial number for a motor vehicle. |
VRM | String | False | Vehicle Registration Mark, which is a unique identifier for a motor vehicle in the UK. |
CategoryMappingAllowed | String | False | Controls how eBay handles cases in which the category no longer exists in the current category structure: If true, eBay will use the new ID for the listing; if false, an error is returned. |
UseRecommendedProduct | String | False | If true, and the item details in the request match a product in the eBay catalog, the matching product is used to list the item. |
ShippingType | String | False | The shipping cost model offered by the seller. |
ShippingService | String | False | A shipping service option being offered by the seller to ship an item to a buyer. For a list of valid ShippingService values, query the ShippingServices view; the ShippingService returned must have a value of true in the ValidForSellingFlow column. |
ShippingServicePriority | String | False | This integer value controls the order (relative to other shipping services) in which the corresponding ShippingService will appear in the View Item and Checkout page. Sellers can specify up to four domestic shipping services. |
ShippingServiceCost | String | False | The base cost of shipping the item by using the shipping service specified in the ShippingService field, if one was specified. This column includes the packaging and handling cost for flat and calculated shipping. If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code. This value reflects savings from a promotional shipping service option. Also applicable to Half.com. |
ShippingServiceAdditionalCost | String | False | The cost of shipping each additional item if the same buyer purchases multiple quantities of the same line item. If less than ShippingServiceCost, this column gives the buyer a shipping discount. This field is required when creating a multiple-quantity fixed-price listing. This field is not applicable for single-quantity listings. |
FreeShipping | String | False | Specifies that the seller wants to offer free shipping. This applies only to the first specified domestic shipping service and is ignored if set for any other shipping service. |
OriginatingPostalCode | String | False | Postal code for the location from which the package will be shipped. Required for calculated shipping. Use Item.PostalCode to specify the location of the item used for searches by location. |
ShippingPackage | String | False | The nature of the package used to ship the item(s). Required for calculated shipping only. |
ShippingIrregular | String | False | Whether a package is irregular and therefore cannot go through the stamping machine at the shipping service office and thus requires special or fragile handling. |
MeasurementUnit | String | False | Specifies the unit type of the weight and dimensions of a shipping package. If MeasurementUnit is used, it overrides the system specified by measurementSystem. If MeasurementUnit and measurementSystem are not specified, the following defaults will be used: English: US Metric: CA, CAFR, AU. |
MeasurementSystem | String | False | System of Measurement for PackageDepth, PackageLength, PackageWidth, WeightMajor, and WeightMinor (English or Metric). |
PackageDepth | String | False | Depth of the package needed to ship the item. |
PackageDepthUnit | String | False | Unit of measurement for PackageDepth (e.g., in, cm). |
PackageLength | String | False | Length of the package needed to ship the item. |
PackageLengthUnit | String | False | Unit of measurement for PackageLength (e.g., in, cm). |
PackageWidth | String | False | Width of the package needed to ship the item. |
PackageWidthUnit | String | False | Unit of measurement for PackageWidth (e.g., in, cm). |
WeightMajor | String | False | The major unit used to specify the weight of a shipping package. For example, lbs. |
WeightMajorUnit | String | False | Unit of measurement for WeightMajor. |
WeightMinor | String | False | The minor unit used to specify the weight of a shipping package. For example, oz. |
WeightMinorUnit | String | False | Unit of measurement for WeightMinor. |
BestOfferEnabled | String | False | This field indicates whether or not the Best Offer feature is enabled for this item. |
ShipToRegistrationCountry | String | False | The seller includes and sets this field to true as a mechanism to block bidders who reside (according to their eBay primary shipping address) in countries that are on the ship-to exclusion list. |
StoreCategoryId | String | False | Unique identifier of a primary custom category in which to list the item. |
StoreCategoryName | String | False | Category name of a primary custom category in which to list the item. |
StoreCategoryId2 | String | False | Unique identifier for the secondary custom category in which to list the item. |
StoreCategoryName2 | String | False | Name of the secondary custom category in which to list the item. |
DaysToFullPayment | String | False | This integer value indicates the number of days that a buyer has (after he/she commits to buy) to make full payment to the seller and close the remaining balance on a motor vehicle. Valid values are 3, 7 (default), 10, and 14. |
Brand | String | False | The brand of the product. eBay searches against the names that are publicly available in its product catalogs. This means you can specify the well-known brand name that an average user would recognize. Both Brand and MPN must be specified if the BrandMPN column is used. |
BrandMPN | String | False | The manufacturer part number of the product. Use the value specified by the manufacturer. |
EAN | String | False | Applicable for listing use cases only (not buy-side searching). EAN is a unique 8 or 13 digit identifier that many industries (such as book publishers) use to identify products. |
IncludeeBayProductDetails | String | False | This boolean field controls whether or not an eBay catalog product is used to help create or revise an item listing. |
IncludeStockPhotoURL | String | False | If true, indicates that the item listing includes the stock photo. |
ISBN | String | False | Applicable for listing use cases only (not buy-side searching). ISBN is a unique identifer for books (an international standard). Specify a 10 or 13 character ISBN. |
ProductReferenceId | String | False | The short global reference ID for a catalog product. |
UPC | String | False | Applicable for listing use cases only (not buy-side searching). UPC is a unique, 12-character identifier that many industries use to identify products. |
UseStockPhotoURLAsGallery | String | False | If true, indicates that the stock photo for an item (if available) is used as the gallery thumbnail. IncludeStockPhotoURL must also be true and Item. |
MinimumRemnantSet | String | False | Enables you (the seller) to avoid being left with 1 item in your listing. A typical use case is event tickets in reserved, adjacent seats, or items that typically only sell if more than 1 can be purchased at once. |
PaymentProfileId | String | False | The unique identifier of a Business Policies payment profile. A PaymentProfileId or PaymentProfileName can be specified. |
PaymentProfileName | String | False | The name of a Business Policies payment profile. A PaymentProfileId or PaymentProfileName can be specified. |
ReturnProfileId | String | False | The unique identifier of a Business Policies return policy profile. A ReturnProfileId or ReturnProfileName can be specified. |
ReturnProfileName | String | False | The name of a Business Policies return policy profile. A ReturnProfileId or ReturnProfileName can be specified. |
ShippingProfileId | String | False | The unique identifier of a Business Policies shipping policy profile. A ShippingProfileId or ShippingProfileName can be specified. |
ShippingProfileName | String | False | The name of a Business Policies shipping policy profile. A ShippingProfileId or ShippingProfileName can be specified. |
BusinessSeller | String | False | If true, this indicates that the seller is a business user and intends to use listing features that are offered to business users only. |
RestrictedToBusiness | String | False | If true, this indicates that the seller elects to offer the item exclusively to business users. If false or not specified, this indicates that the seller elects to offer the item to all users. |
VATPercent | String | False | VAT rate for the item, if any. |
PhotoDisplay | String | False | Specifies the type of image display used in a listing. Some options are only available if images are hosted through eBay Picture Services (EPS). |
PictureUrl# | String | False | Source of the picture. Use this input to add multiple pictures. PictureUrl#1, PictureUrl#2, PictureUrl#3 etc. |
GalleryURL | String | False | This field is used internally only. The Gallery image is always the first PictureURL passed in and this field is set to that value. |
ItemSpecificName# | String | False | Item specifics' name (for example ItemSpecificName#1 Release Title, ItemSpecificName#2 Publisher...). Combine this with ItemSpecificValue. |
ItemSpecificValue# | String | False | Item specifics' value (for example ItemSpecificValue#1 Title, ItemSpecificValue#2 PublisherName...). Combine this with ItemSpecificName. |
ProductCompliancePolicyId | String | False | This field is used if the seller wants to apply one or more seller-created global product compliance policies that will be used in a listing. |
ProductCountryPolicy | String | False | Defines the 2-letter country code set. |
ProductCountryPolicyId | String | False | The policy ID specifying product compliance policy information. |
TakeBackCountryPolicy | String | False | Defines the 2-letter country code set. |
TakeBackCountryPolicyId | String | False | The policy ID specifying take-back policy information. |
TakeBackPolicyId | String | False | This field is used if the seller wants to apply a global take-back policy to the listing. |
ConditionAdditionalInfo | String | False | This text provides additional information about a condition descriptor. |
ConditionName | String | False | A numeric ID is passed in this field. This numeric ID maps to the name of a condition descriptor. |
ConditionValue | String | False | A numeric ID is passed in this field. This numeric ID maps to the value associated with a condition descriptor name. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
ItemId | String | The unique identifier of the created item. |
StartTime | String | Starting date and time for the new listing. |
EndTime | String | Date and time when the new listing is scheduled to end based on the start time and the listing duration value that was set in the ListingDuration field at listing time. |
FeesAggregate | String | An array of fees associated with the creation of the listing. |
DiscountReason | String | One or more listing fee/upgrade discount types being offered by eBay to the seller. Applicable values: CustomCode, Promotion, SpecialOffer. |
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¶
Name | Type | Required | Description |
---|---|---|---|
FeedbackCommentText | String | False | Textual comment that explains, clarifies, or justifies the Feedback rating specified in FeedbackCommentType. This field is required if feedback is left. |
FeedbackCommentType | String | False | This value indicates the Feedback rating for the user specified in the FeedbackTargetUser field. This field is required if feedback is left.For example, positive or negative. |
FeedbackTargetUser | String | False | Username of the target user. |
ItemId | String | False | ID of the item sold. |
OrderId | String | False | A unique identifier that identifies a single line item or multiple line item order. |
OrderLineItemId | String | False | A unique identifier for an eBay order line item based upon the concatenation of ItemId and TransactionId with a hyphen in between these two Ids. For a single line item order, the OrderLineItemId value can be passed into the OrderId field. |
Paid | String | False | Whether the buyer has paid for the order. True or False. |
ShipmentTrackingNumber | String | False | The tracking number assigned by the shipping carrier to the item shipment. This field and the ShippingCarrierUsed field are mutually dependent. When you submit ShipmentTrackingNumber, you must also supply a value for ShippingCarrierUsed. When you submit ShippingCarrierUsed, you must also supply a value for ShipmentTrackingNumber. |
ShippingCarrierUsed | String | False | The name of the shipping carrier used to ship the item. This field and the ShipmentTrackingNumber field are mutually dependent. When you submit ShippingCarrierUsed, you must also supply a value for ShipmentTrackingNumber. When you submit ShipmentTrackingNumber, you must also supply a value for ShippingCarrierUsed. |
ShippedTime | String | False | The date and time that the seller handed off the packages to the shipping carrier. If this field is not included in the call, the timestamp of the call execution is used as the shipped time. |
Shipped | String | False | The seller includes and sets this field to true if the order has been shipped. If the call is successful, the order line items are marked as Shipped in My eBay. For example, true or false. |
TransactionId | String | False | Unique identifier for an eBay order line item (transaction). |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Success | String | This value shows a boolean indication of whether the operation was successful or not. |
CreateInventoryTask¶
This procedure creates an inventory-related download task for a specified feed type with optional filter criteria.
Input¶
Name | Type | Required | Description |
---|---|---|---|
SchemaVersion | String | False | Optional. The schemaVersion/version number of the file format (use the schema version of the API to which you are programming). LMS Version or Seller Hub feed schema version. For Seller Hub feed types, set the value of schemaVersion to '1.0'. |
FeedType | String | False | Optional. The feed type associated with the task. Defaults to LMS_ACTIVE_INVENTORY_REPORT. |
ListingFormat | String | False | Optional. The type of buying option for the order. Possible values are AUCTION, FIXED_PRICE. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Success | String | True or false depending on whether the procedure was successful. |
TaskId | String | The ID of the created download task. |
Description | String | Extra details on the procedure's success or failure. |
CreateOrderTask¶
This procedure creates an order download task with filter criteria for the order report.
Input¶
Name | Type | Required | Description |
---|---|---|---|
SchemaVersion | String | True | Required. The schema version of the LMS OrderReport. For the LMS_ORDER_REPORT feed type, see the OrderReport reference page https://developer.ebay.com/devzone/merchant-data/CallRef/OrderReport.html to see the present schema version. The schemaVersion value is the version number shown at the top left of the OrderReport page. |
FeedType | String | False | Optional. The feed type associated with the task. Defaults to LMS_ORDER_REPORT. |
CreationDateRangeFrom | String | False | Optional. The creation date range of the orders you want returned. Set the date range so it contains less than 10 days (maximum). If you do not specify a DateRange, results from the last 10 days will be returned by default. Example: 2022-11-18T19:09:02.768Z. |
CreationDateRangeTo | String | False | Optional. The end date for the date range, which is inclusive. If the parent type is included, both the from and/or the to fields become conditionally required. Example: 2022-11-26T19:09:02.768Z. |
OrderStatus | String | False | Optional. The order status of the orders returned. If the filter is omitted from createOrderTask call, orders that are in both ACTIVE and COMPLETED states are returned. Possible values are ACTIVE or COMPLETED. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Success | String | True or false depending on whether the procedure was successful. |
TaskId | String | The ID of the created download task. |
Description | String | Extra details on the procedure's success or failure. |
GetOAuthAccessToken¶
Gets the OAuth access token from eBay.
Input¶
Name | Type | Required | Description |
---|---|---|---|
Verifier | String | False | The verifier token returned by EBay after using the URL obtained with GetOAuthAuthorizationURL. Required for only the Web AuthMode. |
CallbackUrl | String | False | The URL the user will be redirected to after authorizing your application. |
RuName | String | False | The Redirect URL name on the Token from eBay via your Application section of the User Tokens page. |
SessionId | String | False | The session ID needed to authenticate when using Auth and Auth. |
Scope | String | False | The scope or permissions you are requesting. The default value is https://api.ebay.com/oauth/api_scope https://api.ebay.com/oauth/api_scope/sell.marketing.readonly https://api.ebay.com/oauth/api_scope/sell.marketing https://api.ebay.com/oauth/api_scope/sell.inventory.readonly https://api.ebay.com/oauth/api_scope/sell.inventory https://api.ebay.com/oauth/api_scope/sell.account.readonly https://api.ebay.com/oauth/api_scope/sell.account https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly https://api.ebay.com/oauth/api_scope/sell.fulfillment https://api.ebay.com/oauth/api_scope/sell.analytics.readonly. |
AuthMode | String | False | The type of authentication mode to use. Select App for getting authentication tokens via a desktop app. Select Web for getting authentication tokens via a Web app. The allowed values are APP, WEB. The default value is APP. |
State | String | False | An opaque value used by the client to maintain state between the request and callback. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
OAuthAccessToken | String | The OAuth token. |
OAuthRefreshToken | String | The OAuth refresh token. |
ExpiresIn | String | The remaining lifetime for the access token in seconds. |
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¶
Name | Type | Required | Description |
---|---|---|---|
CallbackUrl | String | False | The URL that eBay will return to after the user has authorized your app. Set this if you're using theOAuth AuthScheme andYour auth accepted URL in your eBay Sign-in Settings is set tohttps://oauth.cdata.com/oauth/ . |
RuName | String | False | The Redirect URL name on the Token from eBay via your Application section of the User Tokens page. |
State | String | False | An opaque value used by the client to maintain state between the request and callback. |
Scope | String | False | The scope or permissions you are requesting. Required only for the OAuth authentication. The default value is https://api.ebay.com/oauth/api_scope https://api.ebay.com/oauth/api_scope/sell.marketing.readonly https://api.ebay.com/oauth/api_scope/sell.marketing https://api.ebay.com/oauth/api_scope/sell.inventory.readonly https://api.ebay.com/oauth/api_scope/sell.inventory https://api.ebay.com/oauth/api_scope/sell.account.readonly https://api.ebay.com/oauth/api_scope/sell.account https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly https://api.ebay.com/oauth/api_scope/sell.fulfillment https://api.ebay.com/oauth/api_scope/sell.analytics.readonly. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
URL | String | The URL to be entered into a Web browser to obtain the verifier token, which you will need to submit back with the GetOAuthAccessToken stored procedure. |
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¶
Name | Type | Required | Accepts Output Streams | Description |
---|---|---|---|---|
TaskId | String | False | False | Required. The ID of the task associated with the file you want to download. This ID was generated when the task was created. |
DownloadPath | String | False | False | Local path to save the generated report to. |
FileStream | String | False | True | If the DownloadPath is left blank, downloaded file content will be streamed. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Success | String | This value shows a boolean indication of whether the operation was successful or not. |
FileName | String | The name of the generated file as generated by the API. |
FileData | String | If the DownloadPath is left blank, the downloaded file's content will be output as a BASE64 encoded string. |
RefreshOAuthAccessToken¶
Refreshes the OAuth access token used for authentication with EBay.
Input¶
Name | Type | Required | Description |
---|---|---|---|
OAuthRefreshToken | String | False | The old token to be refreshed. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
OAuthAccessToken | String | The authentication token returned from EBay. |
ExpiresIn | String | The remaining lifetime on the access token. |
SetUserNotes¶
Add, replace, and delete My eBay notes for items that are being tracked in the My eBay Selling and Buying areas.
Note
This procedure makes use of indexed parameters.
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¶
Name | Type | Required | Description |
---|---|---|---|
Action | String | True | The seller must include this field and set it to 'AddOrUpdate' to add a new user note or update an existing user note, or set it to 'Delete' to delete an existing user note. |
ItemId | String | False | Unique identifier of the listing to which the My eBay note will be attached. Notes can only be added to items that are currently being tracked in My eBay. |
NoteText | String | False | This field is needed if the Action is AddOrUpdate. The text supplied in this field will completely replace any existing My eBay note for the specified item. |
OrderLineItemId | String | False | A unique identifier for an eBay order line item. This field is created as soon as there is a commitment to buy from the seller, and its value is based upon the concatenation of ItemID and TransactionID, with a hyphen in between these two IDs. OrderLineItemID can be used in the input instead of an ItemID/TransactionID pair to identify an order line item. |
SKU | String | False | SKU value of the item variation to which the My eBay note will be attached. Notes can only be added to items that are currently being tracked in My eBay. A SKU (stock keeping unit) value is defined by and used by the seller to identify a variation within a fixed-price, multiple- variation listing. The SKU value is assigned to a variation of an item through the Variations.Variation.SKU element. |
TransactionId | String | False | Unique identifier for the order line item to which the My eBay note will be attached. Notes can only be added to order line items that are currently being tracked in My eBay. Buyers can view user notes made on order line items in the PrivateNotes field of the WonList container in GetMyeBayBuying, and sellers can view user notes made on order line items in the PrivateNotes field of the SoldList and DeletedFromSoldList containers in GetMyeBaySellinging. |
VariationSpecificName# | String | False | Depending on the call and context, this value is either a name of an Item/Category/Variation Specific, or a Parts Compatibility name. |
VariationSpecificValue# | String | False | Depending on the call and context, this value is either the value of an Item/Category/Variation Specific, a Parts Compatibility value, or a product identifier. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Success | String | This value shows a boolean indication of whether the operation was successful or not. |
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:
-
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')
-
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'
-
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)); } } }
-
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¶
Name | Type | Required | Accepts Input Streams | Description |
---|---|---|---|---|
TaskID | String | True | False | The task_id associated with the file that will be uploaded. This ID was generated when the specified task was created. |
FilePath | String | False | False | The absolute path of the file to be uploaded. |
Content | String | False | True | The file's content that you wish to upload should be a stream of input and the FilePath field should be kept blank. |
FileName | String | False | False | The name of the uploaded file. It should be specified only when uploading the content as InputStream. (With extension) |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Success | String | This parameter sets whether the operation was successful or not. |
Description | String | Description message of the upload operation. It might be an error message or a successful message. |
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¶
Name | Type | Description |
---|---|---|
CatalogName | String | The database name. |
sys_schemas¶
Lists the available schemas.
The following query retrieves all available schemas:
SELECT * FROM sys_schemas
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The database name. |
SchemaName | String | The schema name. |
sys_tables¶
Lists the available tables.
The following query retrieves the available tables and views:
SELECT * FROM sys_tables
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The database containing the table or view. |
SchemaName | String | The schema containing the table or view. |
TableName | String | The name of the table or view. |
TableType | String | The table type (table or view). |
Description | String | A description of the table or view. |
IsUpdateable | Boolean | Whether the table can be updated. |
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¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the table or view. |
SchemaName | String | The schema containing the table or view. |
TableName | String | The name of the table or view containing the column. |
ColumnName | String | The column name. |
DataTypeName | String | The data type name. |
DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
Length | Int32 | The storage size of the column. |
DisplaySize | Int32 | The designated column's normal maximum width in characters. |
NumericPrecision | Int32 | The maximum number of digits in numeric data. The column length in characters for character and date-time data. |
NumericScale | Int32 | The column scale or number of digits to the right of the decimal point. |
IsNullable | Boolean | Whether the column can contain null. |
Description | String | A brief description of the column. |
Ordinal | Int32 | The sequence number of the column. |
IsAutoIncrement | String | Whether the column value is assigned in fixed increments. |
IsGeneratedColumn | String | Whether the column is generated. |
IsHidden | Boolean | Whether the column is hidden. |
IsArray | Boolean | Whether the column is an array. |
IsReadOnly | Boolean | Whether the column is read-only. |
IsKey | Boolean | Indicates whether a field returned from sys_tablecolumns is the primary key of the table. |
sys_procedures¶
Lists the available stored procedures.
The following query retrieves the available stored procedures:
SELECT * FROM sys_procedures
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The database containing the stored procedure. |
SchemaName | String | The schema containing the stored procedure. |
ProcedureName | String | The name of the stored procedure. |
Description | String | A description of the stored procedure. |
ProcedureType | String | The type of the procedure, such as PROCEDURE or FUNCTION. |
sys_procedureparameters¶
Describes stored procedure parameters.
The following query returns information about all of the input parameters for the AddItem stored procedure:
SELECT * FROM sys_procedureparameters WHERE ProcedureName='AddItem' AND Direction=1 OR Direction=2
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the stored procedure. |
SchemaName | String | The name of the schema containing the stored procedure. |
ProcedureName | String | The name of the stored procedure containing the parameter. |
ColumnName | String | The name of the stored procedure parameter. |
Direction | Int32 | An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters. |
DataTypeName | String | The name of the data type. |
DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
Length | Int32 | The number of characters allowed for character data. The number of digits allowed for numeric data. |
NumericPrecision | Int32 | The maximum precision for numeric data. The column length in characters for character and date-time data. |
NumericScale | Int32 | The number of digits to the right of the decimal point in numeric data. |
IsNullable | Boolean | Whether the parameter can contain null. |
IsRequired | Boolean | Whether the parameter is required for execution of the procedure. |
IsArray | Boolean | Whether the parameter is an array. |
Description | String | The description of the parameter. |
Ordinal | Int32 | The index of the parameter. |
sys_keycolumns¶
Describes the primary and foreign keys.
The following query retrieves the primary key for the ItemListing table:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='ItemListing'
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
IsKey | Boolean | Whether the column is a primary key in the table referenced in the TableName field. |
IsForeignKey | Boolean | Whether the column is a foreign key referenced in the TableName field. |
PrimaryKeyName | String | The name of the primary key. |
ForeignKeyName | String | The name of the foreign key. |
ReferencedCatalogName | String | The database containing the primary key. |
ReferencedSchemaName | String | The schema containing the primary key. |
ReferencedTableName | String | The table containing the primary key. |
ReferencedColumnName | String | The column name of the primary key. |
sys_foreignkeys¶
Describes the foreign keys.
The following query retrieves all foreign keys which refer to other tables:
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
PrimaryKeyName | String | The name of the primary key. |
ForeignKeyName | String | The name of the foreign key. |
ReferencedCatalogName | String | The database containing the primary key. |
ReferencedSchemaName | String | The schema containing the primary key. |
ReferencedTableName | String | The table containing the primary key. |
ReferencedColumnName | String | The column name of the primary key. |
ForeignKeyType | String | Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key. |
sys_primarykeys¶
Describes the primary keys.
The following query retrieves the primary keys from all tables and views:
SELECT * FROM sys_primarykeys
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
KeySeq | String | The sequence number of the primary key. |
KeyName | String | The name of the primary key. |
sys_indexes¶
Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.
The following query retrieves all indexes that are not primary keys:
SELECT * FROM sys_indexes WHERE IsPrimary='false'
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the index. |
SchemaName | String | The name of the schema containing the index. |
TableName | String | The name of the table containing the index. |
IndexName | String | The index name. |
ColumnName | String | The name of the column associated with the index. |
IsUnique | Boolean | True if the index is unique. False otherwise. |
IsPrimary | Boolean | True if the index is a primary key. False otherwise. |
Type | Int16 | An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3). |
SortOrder | String | The sort order: A for ascending or D for descending. |
OrdinalPosition | Int16 | The sequence number of the column in the index. |
sys_connection_props¶
Returns information on the available connection properties and those set in the connection string.
When querying this table, the config connection string should be used:
jdbc:cdata:ebay:config:
This connection string enables you to query this table without a valid connection.
The following query retrieves all connection properties that have been set in the connection string or set through a default value:
SELECT * FROM sys_connection_props WHERE Value <> ''
Columns¶
Name | Type | Description |
---|---|---|
Name | String | The name of the connection property. |
ShortDescription | String | A brief description. |
Type | String | The data type of the connection property. |
Default | String | The default value if one is not explicitly set. |
Values | String | A comma-separated list of possible values. A validation error is thrown if another value is specified. |
Value | String | The value you set or a preconfigured default. |
Required | Boolean | Whether the property is required to connect. |
Category | String | The category of the connection property. |
IsSessionProperty | String | Whether the property is a session property, used to save information about the current connection. |
Sensitivity | String | The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms. |
PropertyName | String | A camel-cased truncated form of the connection property name. |
Ordinal | Int32 | The index of the parameter. |
CatOrdinal | Int32 | The index of the parameter category. |
Hierarchy | String | Shows dependent properties associated that need to be set alongside this one. |
Visible | Boolean | Informs whether the property is visible in the connection UI. |
ETC | String | Various miscellaneous information about the property. |
sys_sqlinfo¶
Describes the SELECT query processing that the connector can offload to the data source.
Discovering the Data Source's SELECT Capabilities¶
Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.
Name | Description | Possible Values |
---|---|---|
AGGREGATE_FUNCTIONS | Supported aggregation functions. | AVG , COUNT , MAX , MIN , SUM , DISTINCT |
COUNT | Whether COUNT function is supported. | YES , NO |
IDENTIFIER_QUOTE_OPEN_CHAR | The opening character used to escape an identifier. | [ |
IDENTIFIER_QUOTE_CLOSE_CHAR | The closing character used to escape an identifier. | ] |
SUPPORTED_OPERATORS | A list of supported SQL operators. | = , > , < , >= , <= , <> , != , LIKE , NOT LIKE , IN , NOT IN , IS NULL , IS NOT NULL , AND , OR |
GROUP_BY | Whether GROUP BY is supported, and, if so, the degree of support. | NO , NO_RELATION , EQUALS_SELECT , SQL_GB_COLLATE |
STRING_FUNCTIONS | Supported string functions. | LENGTH , CHAR , LOCATE , REPLACE , SUBSTRING , RTRIM , LTRIM , RIGHT , LEFT , UCASE , SPACE , SOUNDEX , LCASE , CONCAT , ASCII , REPEAT , OCTET , BIT , POSITION , INSERT , TRIM , UPPER , REGEXP , LOWER , DIFFERENCE , CHARACTER , SUBSTR , STR , REVERSE , PLAN , UUIDTOSTR , TRANSLATE , TRAILING , TO , STUFF , STRTOUUID , STRING , SPLIT , SORTKEY , SIMILAR , REPLICATE , PATINDEX , LPAD , LEN , LEADING , KEY , INSTR , INSERTSTR , HTML , GRAPHICAL , CONVERT , COLLATION , CHARINDEX , BYTE |
NUMERIC_FUNCTIONS | Supported numeric functions. | ABS , ACOS , ASIN , ATAN , ATAN2 , CEILING , COS , COT , EXP , FLOOR , LOG , MOD , SIGN , SIN , SQRT , TAN , PI , RAND , DEGREES , LOG10 , POWER , RADIANS , ROUND , TRUNCATE |
TIMEDATE_FUNCTIONS | Supported date/time functions. | NOW , CURDATE , DAYOFMONTH , DAYOFWEEK , DAYOFYEAR , MONTH , QUARTER , WEEK , YEAR , CURTIME , HOUR , MINUTE , SECOND , TIMESTAMPADD , TIMESTAMPDIFF , DAYNAME , MONTHNAME , CURRENT_DATE , CURRENT_TIME , CURRENT_TIMESTAMP , EXTRACT |
REPLICATION_SKIP_TABLES | Indicates tables skipped during replication. | |
REPLICATION_TIMECHECK_COLUMNS | A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication. | |
IDENTIFIER_PATTERN | String value indicating what string is valid for an identifier. | |
SUPPORT_TRANSACTION | Indicates if the provider supports transactions such as commit and rollback. | YES , NO |
DIALECT | Indicates the SQL dialect to use. | |
KEY_PROPERTIES | Indicates the properties which identify the uniform database. | |
SUPPORTS_MULTIPLE_SCHEMAS | Indicates if multiple schemas may exist for the provider. | YES , NO |
SUPPORTS_MULTIPLE_CATALOGS | Indicates if multiple catalogs may exist for the provider. | YES , NO |
DATASYNCVERSION | The Data Sync version needed to access this driver. | Standard , Starter , Professional , Enterprise |
DATASYNCCATEGORY | The Data Sync category of this driver. | Source , Destination , Cloud Destination |
SUPPORTSENHANCEDSQL | Whether enhanced SQL functionality beyond what is offered by the API is supported. | TRUE , FALSE |
SUPPORTS_BATCH_OPERATIONS | Whether batch operations are supported. | YES , NO |
SQL_CAP | All supported SQL capabilities for this driver. | SELECT , INSERT , DELETE , UPDATE , TRANSACTIONS , ORDERBY , OAUTH , ASSIGNEDID , LIMIT , LIKE , BULKINSERT , COUNT , BULKDELETE , BULKUPDATE , GROUPBY , HAVING , AGGS , OFFSET , REPLICATE , COUNTDISTINCT , JOINS , DROP , CREATE , DISTINCT , INNERJOINS , SUBQUERIES , ALTER , MULTIPLESCHEMAS , GROUPBYNORELATION , OUTERJOINS , UNIONALL , UNION , UPSERT , GETDELETED , CROSSJOINS , GROUPBYCOLLATE , MULTIPLECATS , FULLOUTERJOIN , MERGE , JSONEXTRACT , BULKUPSERT , SUM , SUBQUERIESFULL , MIN , MAX , JOINSFULL , XMLEXTRACT , AVG , MULTISTATEMENTS , FOREIGNKEYS , CASE , LEFTJOINS , COMMAJOINS , WITH , LITERALS , RENAME , NESTEDTABLES , EXECUTE , BATCH , BASIC , INDEX |
PREFERRED_CACHE_OPTIONS | A string value specifies the preferred cacheOptions. | |
ENABLE_EF_ADVANCED_QUERY | Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. | YES , NO |
PSEUDO_COLUMNS | A string array indicating the available pseudo columns. | |
MERGE_ALWAYS | If the value is true, The Merge Mode is forcibly executed in Data Sync. | TRUE , FALSE |
REPLICATION_MIN_DATE_QUERY | A select query to return the replicate start datetime. | |
REPLICATION_MIN_FUNCTION | Allows a provider to specify the formula name to use for executing a server side min. | |
REPLICATION_START_DATE | Allows a provider to specify a replicate startdate. | |
REPLICATION_MAX_DATE_QUERY | A select query to return the replicate end datetime. | |
REPLICATION_MAX_FUNCTION | Allows a provider to specify the formula name to use for executing a server side max. | |
IGNORE_INTERVALS_ON_INITIAL_REPLICATE | A list of tables which will skip dividing the replicate into chunks on the initial replicate. | |
CHECKCACHE_USE_PARENTID | Indicates whether the CheckCache statement should be done against the parent key column. | TRUE , FALSE |
CREATE_SCHEMA_PROCEDURES | Indicates stored procedures that can be used for generating schema files. |
The following query retrieves the operators that can be used in the WHERE clause:
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.
Columns¶
Name | Type | Description |
---|---|---|
NAME | String | A component of SQL syntax, or a capability that can be processed on the server. |
VALUE | String | Detail on the supported SQL or SQL syntax. |
sys_identity¶
Returns information about attempted modifications.
The following query retrieves the Ids of the modified rows in a batch operation:
SELECT * FROM sys_identity
Columns¶
Name | Type | Description |
---|---|---|
Id | String | The database-generated ID returned from a data modification operation. |
Batch | String | An identifier for the batch. 1 for a single operation. |
Operation | String | The result of the operation in the batch: INSERTED, UPDATED, or DELETED. |
Message | String | SUCCESS or an error message if the update in the batch failed. |
Advanced Configurations Properties¶
The advanced configurations properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure. Click the links for further details.
Property | Description |
---|---|
AuthScheme | The scheme used for authentication. Accepted entries are OAuth and AuthNAuth. |
DevID | Your Developer Id, as registered with the eBay Developers Program. |
SiteID | The ID of the eBay site to which you want to send the request. By default this is 0, (U.S.). |
UseSandbox | A boolean indicating if you are using a sandbox account. |
RuName | The Redirect URL name used for validation. This property is only needed if you are using the provider to allow other users to access their own data. |
Property | Description |
---|---|
InitiateOAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
OAuthClientId | The client ID assigned when you register your application with an OAuth authorization server. |
OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
OAuthAccessToken | The access token for connecting using OAuth. |
OAuthSettingsLocation | The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://' . |
CallbackURL | The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings. |
OAuthVerifier | The verifier code returned from the OAuth authorization URL. |
OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
OAuthExpiresIn | The lifetime in seconds of the OAuth AccessToken. |
OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
Property | Description |
---|---|
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
Property | Description |
---|---|
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC. |
Property | Description |
---|---|
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
Other | These hidden properties are used only in specific use cases. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
Authentication¶
This section provides a complete list of authentication properties you can configure.
Property | Description |
---|---|
AuthScheme | The scheme used for authentication. Accepted entries are OAuth and AuthNAuth. |
DevID | Your Developer Id, as registered with the eBay Developers Program. |
SiteID | The ID of the eBay site to which you want to send the request. By default this is 0, (U.S.). |
UseSandbox | A boolean indicating if you are using a sandbox account. |
RuName | The Redirect URL name used for validation. This property is only needed if you are using the provider to allow other users to access their own data. |
AuthScheme¶
The scheme used for authentication. Accepted entries are OAuth and AuthNAuth.
Possible Values¶
Auto
, OAuth
, AuthNAuth
Data Type¶
string
Default Value¶
AuthNAuth
Remarks¶
- Auto: Lets the driver decide automatically based on the other connection properties you have set.
- OAuth: Set this to perform OAuth authentication.
- AuthNAuth: Set to this to perform the traditional Auth'n'Auth authentication method used by the eBay APIs.
DevID¶
Your Developer Id, as registered with the eBay Developers Program.
Data Type¶
string
Default Value¶
""
Remarks¶
Your Developer Id, as registered with the eBay Developers Program.
SiteID¶
The ID of the eBay site to which you want to send the request. By default this is 0, (U.S.).
Data Type¶
string
Default Value¶
0
Remarks¶
The ID of the eBay site to which you want to send the request. By default this is 0, (U.S.)
UseSandbox¶
A boolean indicating if you are using a sandbox account.
Data Type¶
bool
Default Value¶
false
Remarks¶
A boolean indicating if you are using a sandbox account.
RuName¶
The Redirect URL name used for validation. This property is only needed if you are using the provider to allow other users to access their own data.
Data Type¶
string
Default Value¶
""
Remarks¶
The Redirect URL name used for validation. This property is only needed if you are using the connector to allow other users to access their own data. 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.
OAuth¶
This section provides a complete list of OAuth properties you can configure.
Property | Description |
---|---|
InitiateOAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
OAuthClientId | The client ID assigned when you register your application with an OAuth authorization server. |
OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
OAuthAccessToken | The access token for connecting using OAuth. |
OAuthSettingsLocation | The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://' . |
CallbackURL | The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings. |
OAuthVerifier | The verifier code returned from the OAuth authorization URL. |
OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
OAuthExpiresIn | The lifetime in seconds of the OAuth AccessToken. |
OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
InitiateOAuth¶
Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
Possible Values¶
OFF
, GETANDREFRESH
, REFRESH
Data Type¶
string
Default Value¶
OFF
Remarks¶
The following options are available:
OFF
: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.GETANDREFRESH
: Indicates that the entire OAuth Flow will be handled by the connector. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.REFRESH
: Indicates that the connector will only handle refreshing the OAuthAccessToken. The user will never be prompted by the connector to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.
OAuthClientId¶
The client ID assigned when you register your application with an OAuth authorization server.
Data Type¶
string
Default Value¶
""
Remarks¶
As part of registering an OAuth application, you will receive the OAuthClientId
value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.
OAuthClientSecret¶
The client secret assigned when you register your application with an OAuth authorization server.
Data Type¶
string
Default Value¶
""
Remarks¶
As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret
property.
OAuthAccessToken¶
The access token for connecting using OAuth.
Data Type¶
string
Default Value¶
""
Remarks¶
The OAuthAccessToken
property is used to connect using OAuth. The OAuthAccessToken
is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.
The access token is used in place of your user name and password. The access token protects your credentials by keeping them on the server.
OAuthSettingsLocation¶
The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'
.
Data Type¶
string
Default Value¶
%APPDATA%\CData\Acumatica Data Provider\OAuthSettings.txt
Remarks¶
When InitiateOAuth is set to GETANDREFRESH
or REFRESH
, the driver saves OAuth values to avoid requiring the user to manually enter OAuth connection properties and to allow the credentials to be shared across connections or processes.
Instead of specifying a file path, you can use memory storage. Memory locations are specified by using a value starting with 'memory://'
followed by a unique identifier for that set of credentials (for example, memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike file-based storage, where credentials persist across connections, memory storage loads the credentials into static memory, and the credentials are shared between connections using the same identifier for the life of the process. To persist credentials outside the current process, you must manually store the credentials prior to closing the connection. This enables you to set them in the connection when the process is started again. You can retrieve OAuth property values with a query to the sys_connection_props
system table. If there are multiple connections using the same credentials, the properties are read from the previously closed connection.
The default location is "%APPDATA%\CData\Acumatica Data Provider\OAuthSettings.txt" with %APPDATA%
set to the user's configuration directory. The default values are
- Windows: "
register://%DSN
" - Unix: "%AppData%..."
where DSN is the name of the current DSN used in the open connection.
The following table lists the value of %APPDATA%
by OS:
Platform | %APPDATA% |
---|---|
Windows | The value of the APPDATA environment variable |
Linux | ~/.config |
CallbackURL¶
The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
Data Type¶
string
Default Value¶
""
Remarks¶
During the authentication process, the OAuth authorization server redirects the user to this URL. This value must match the callback URL you specify in your app settings.
OAuthVerifier¶
The verifier code returned from the OAuth authorization URL.
Data Type¶
string
Default Value¶
""
Remarks¶
The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.
Authentication on Headless Machines¶
See to obtain the OAuthVerifier
value.
Set OAuthSettingsLocation along with OAuthVerifier
. When you connect, the connector exchanges the OAuthVerifier
for the OAuth authentication tokens and saves them, encrypted, to the specified location. Set InitiateOAuth to GETANDREFRESH to automate the exchange.
Once the OAuth settings file has been generated, you can remove OAuthVerifier
from the connection properties and connect with OAuthSettingsLocation set.
To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.
OAuthRefreshToken¶
The OAuth refresh token for the corresponding OAuth access token.
Data Type¶
string
Default Value¶
""
Remarks¶
The OAuthRefreshToken
property is used to refresh the OAuthAccessToken when using OAuth authentication.
OAuthExpiresIn¶
The lifetime in seconds of the OAuth AccessToken.
Data Type¶
string
Default Value¶
""
Remarks¶
Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.
OAuthTokenTimestamp¶
The Unix epoch timestamp in milliseconds when the current Access Token was created.
Data Type¶
string
Default Value¶
""
Remarks¶
Pair with OAuthExpiresIn to determine when the AccessToken will expire.
SSL¶
This section provides a complete list of SSL properties you can configure.
Property | Description |
---|---|
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
SSLServerCert¶
The certificate to be accepted from the server when connecting using TLS/SSL.
Data Type¶
string
Default Value¶
""
Remarks¶
If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.
This property can take the following forms:
Description | Example |
---|---|
A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
A path to a local file containing the certificate | C:\\cert.cer |
The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
The MD5 Thumbprint (hex values can also be either space or colon separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
The SHA1 Thumbprint (hex values can also be either space or colon separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
If not specified, any certificate trusted by the machine is accepted.
Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
Schema¶
This section provides a complete list of schema properties you can configure.
Property | Description |
---|---|
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC. |
Location¶
A path to the directory that contains the schema files defining tables, views, and stored procedures.
Data Type¶
string
Default Value¶
%APPDATA%\Ebay Data Provider\Schema
Remarks¶
The path to a directory which contains the schema files for the connector (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location
property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is "%APPDATA%\Ebay Data Provider\Schema" with %APPDATA%
being set to the user's configuration directory:
Platform | %APPDATA% |
---|---|
Windows | The value of the APPDATA environment variable |
Mac | ~/Library/Application Support |
Linux | ~/.config |
BrowsableSchemas¶
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Data Type¶
string
Default Value¶
""
Remarks¶
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
Tables¶
This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Data Type¶
string
Default Value¶
""
Remarks¶
Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the connector.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
Views¶
Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Data Type¶
string
Default Value¶
""
Remarks¶
Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the connector.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
Miscellaneous¶
This section provides a complete list of miscellaneous properties you can configure.
Property | Description |
---|---|
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
Other | These hidden properties are used only in specific use cases. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
MaxRows¶
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Data Type¶
int
Default Value¶
-1
Remarks¶
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other¶
These hidden properties are used only in specific use cases.
Data Type¶
string
Default Value¶
""
Remarks¶
The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.
Specify multiple properties in a semicolon-separated list.
Integration and Formatting¶
Property | Description |
---|---|
DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
ConvertDateTimeToGMT | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
PseudoColumns¶
This property indicates whether or not to include pseudo columns as columns to the table.
Data Type¶
string
Default Value¶
""
Remarks¶
This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".
Timeout¶
The value in seconds until the timeout error is thrown, canceling the operation.
Data Type¶
int
Default Value¶
60
Remarks¶
If Timeout
= 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.
If Timeout
expires and the operation is not yet complete, the connector throws an exception.
UserDefinedViews¶
A filepath pointing to the JSON configuration file containing your custom views.
Data Type¶
string
Default Value¶
""
Remarks¶
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
Note that the specified path is not embedded in quotation marks.