eBay Connector Reference

43 metrics60 dimensions

The eBay connector exposes 103 fields (43 metrics, 60 dimensions). Every field ID below can be passed to the Windsor.ai API in the fields parameter.


Available options


marketplace_id Marketplace ID

The eBay marketplace to report traffic for. Only applies to Traffic fields. When empty, the marketplace the seller account is registered on is used.

Possible values (8)
EBAY_USEBAY_MOTORS_USEBAY_GBEBAY_DEEBAY_FREBAY_ITEBAY_ESEBAY_AU

eBay Fields

eBay Campaign Performance fields

The Campaign Performance report of the eBay connector includes 11 fields.

ID Type Name Description
ad_group_id TEXT Ad Group ID The unique identifier of the ad group; only cost per click campaigns have ad groups.
ad_group_name TEXT Ad Group Name The name of the ad group; only cost per click campaigns have ad groups.
NUMERIC Promoted Listings Ad Fees The Promoted Listings fees charged for the campaign, in the listing site currency.
NUMERIC Promoted Listings Average Cost Per Sale Ad fees divided by attributed sales.
NUMERIC Promoted Listings Clicks The number of clicks on Promoted Listings of the campaign.
PERCENT Promoted Listings CTR Ad clicks divided by ad impressions.
TEXT Promoted Listings Currency The ISO 4217 currency of the ad fees and the sale amount.
NUMERIC Promoted Listings Impressions The number of times a Promoted Listing of the campaign was displayed.
NUMERIC Promoted Listings ROAS Attributed sale amount divided by ad fees.
NUMERIC Promoted Listings Sale Amount The total amount of the sales attributed to the campaign, in the listing site currency.
NUMERIC Promoted Listings Sales The number of sales attributed to the campaign within 30 days of a click.

eBay Campaigns fields

The Campaigns report of the eBay connector includes 13 fields.

ID Type Name Description
bid_percentage NUMERIC Bid Percentage The ad rate of a cost per sale campaign, as a percentage of the sale amount.
campaign_budget_status TEXT Campaign Budget Status The status of the daily budget, e.g. ACTIVE or EXHAUSTED.
campaign_channel TEXT Campaign Channel The advertising channel of the campaign: ON_SITE or OFF_SITE.
campaign_daily_budget NUMERIC Campaign Daily Budget The daily budget of a cost per click campaign.
campaign_daily_budget_currency TEXT Campaign Daily Budget Currency The ISO 4217 currency of the daily budget.
campaign_end_time TIMESTAMP Campaign End Time The date and time the campaign ends (UTC), empty for campaigns without an end date.
campaign_id TEXT Campaign ID The unique identifier of the Promoted Listings campaign.
campaign_name TEXT Campaign Name The seller-defined name of the campaign.
campaign_start_time TIMESTAMP Campaign Start Time The date and time the campaign starts (UTC).
campaign_status TEXT Campaign Status The status of the campaign, e.g. RUNNING, PAUSED or ENDED.
campaign_targeting_type TEXT Campaign Targeting Type Whether the campaign uses MANUAL or SMART targeting.
funding_model TEXT Funding Model How eBay charges the campaign: COST_PER_SALE or COST_PER_CLICK.
marketplace_id TEXT Marketplace ID The eBay marketplace the record belongs to, e.g. EBAY_US.

eBay Order Line Items fields

The Order Line Items report of the eBay connector includes 19 fields.

ID Type Name Description
discounted_line_item_cost NUMERIC Discounted Line Item Cost The cost of the line item after discounts.
item_location_country COUNTRY Item Location Country The country of the physical location of the item.
item_title TEXT Item Title The title of the listing.
legacy_item_id TEXT Legacy Item ID The legacy listing item ID of the line item.
legacy_variation_id TEXT Legacy Variation ID The variation ID within a multiple-variation listing.
line_item_cost NUMERIC Line Item Cost The selling price of the line item before discounts.
line_item_currency TEXT Line Item Currency Code The ISO 4217 currency of the line item amounts.
line_item_fulfillment_status TEXT Line Item Fulfillment Status The fulfillment status of the line item: NOT_STARTED, IN_PROGRESS or FULFILLED.
line_item_id TEXT Line Item ID The unique identifier of the order line item.
line_item_quantity NUMERIC Line Item Quantity Ordered The number of units of the line item in the order.
line_item_refund_amount NUMERIC Line Item Refund Amount The sum of all refunds issued for the line item.
line_item_shipping_cost NUMERIC Line Item Shipping Cost The total cost of shipping all units of the line item.
line_item_tax_amount NUMERIC Line Item Tax Amount The sum of all taxes applied to the line item.
line_item_total NUMERIC Line Item Total The total the buyer pays for the line item after all costs.
listing_marketplace_id TEXT Listing Marketplace ID The eBay marketplace where the line item was listed.
purchase_marketplace_id TEXT Purchase Marketplace ID The eBay marketplace where the line item was purchased.
sku TEXT SKU The seller-defined stock keeping unit of the line item.
sold_format TEXT Sold Format The listing type of the line item: AUCTION, FIXED_PRICE, OTHER or SECOND_CHANCE_OFFER.
sold_via_ad_campaign BOOLEAN Sold Via Ad Campaign Whether the line item was sold through a Promoted Listings campaign.

eBay Orders fields

The Orders report of the eBay connector includes 27 fields.

ID Type Name Description
buyer_country COUNTRY Buyer Country The country of the buyer's registration address.
buyer_username TEXT Buyer Username The eBay user ID of the buyer.
cancel_state TEXT Cancel State The cancellation state of the order: NONE_REQUESTED, IN_PROGRESS or CANCELED.
currency TEXT Currency The ISO 4217 currency of the order amounts.
delivery_cost NUMERIC Delivery Cost The total cost of delivering the order before discounts.
delivery_discount NUMERIC Delivery Discount The total delivery discounts applied to the order.
ebay_collect_and_remit_tax BOOLEAN eBay Collect And Remit Tax Whether eBay collects and remits the tax for the order.
legacy_order_id TEXT Legacy Order ID The legacy (Trading API) identifier of the order.
line_item_count NUMERIC Line Item Count The number of line items in the order.
order_adjustment NUMERIC Order Adjustment The total adjustments applied to the cost of the order.
order_creation_time TIMESTAMP Order Creation Time The date and time the order was created (UTC).
order_fee NUMERIC Order Fee The total special fees applied to the order, such as a tire recycling fee.
order_financial_status TEXT Order Payment Status The payment status of the order: PAID, PENDING, FAILED, PARTIALLY_REFUNDED or FULLY_REFUNDED.
order_fulfillment_status TEXT Order Fulfillment Status How far the order is fulfilled: NOT_STARTED, IN_PROGRESS or FULFILLED.
order_id TEXT Order ID The unique identifier of the order.
order_last_modified_time TIMESTAMP Order Last Modified Time The date and time the order was last modified (UTC).
order_tax NUMERIC Order Tax The total tax of the order.
order_total NUMERIC Order Total The total cost of the order after line items, delivery, tax and adjustments.
payment_count NUMERIC Payment Count The number of payments made for the order.
price_discount NUMERIC Price Discount The total item price discounts applied to the order.
price_subtotal NUMERIC Price Subtotal The cumulative cost of all units of all line items before discounts, delivery and tax.
refund_count NUMERIC Refund Count The number of refunds issued for the order.
sales_record_reference TEXT Sales Record Reference The Selling Manager sales record number of the order.
seller_id TEXT Seller ID The eBay user ID of the seller who sold the order.
total_due_seller NUMERIC Total Due Seller The total the seller receives for the order after all costs.
total_fee_basis_amount NUMERIC Total Fee Basis Amount The cumulative base amount used to calculate the final value fees of the order.
total_marketplace_fee NUMERIC Total Marketplace Fee The cumulative fees accrued for the order and deducted from the seller payout.

eBay Traffic fields

The Traffic report of the eBay connector includes 12 fields.

ID Type Name Description
click_through_rate PERCENT Click Through Rate Listing views from the search results page divided by listing impressions on the search results page.
listing_impression_search_results_page NUMERIC Listing Impressions Search Results Page The number of times the seller's listings were displayed on the search results page.
listing_impression_store NUMERIC Listing Impressions Store The number of times the seller's listings were displayed in the seller's store.
listing_impression_total NUMERIC Listing Impressions Total The number of times the seller's listings were displayed on the search results page or in the seller's store.
listing_views_source_direct NUMERIC Listing Views Direct The number of listing views that came from a direct link.
listing_views_source_off_ebay NUMERIC Listing Views From Off eBay The number of listing views that came from outside eBay.
listing_views_source_other_ebay NUMERIC Listing Views From Other eBay Pages The number of listing views that came from other eBay pages.
listing_views_source_search_results_page NUMERIC Listing Views From Search Results Page The number of listing views that came from the search results page.
listing_views_source_store NUMERIC Listing Views From Store The number of listing views that came from the seller's store.
listing_views_total NUMERIC Listing Views Total The number of times buyers viewed the seller's listings.
sales_conversion_rate PERCENT Sales Conversion Rate Transactions divided by total listing views.
transactions NUMERIC Transactions The number of completed transactions.

eBay other fields

The eBay connector has 21 fields that do not belong to a named report, or belong to a report with only one or two fields.

ID Type Name Description Report
account_id TEXT Account ID The immutable eBay user ID of the seller account.
account_name TEXT Account Name The eBay username of the seller account.
data_fetched_at TIMESTAMP Data fetched at UTC timestamp (second precision) of when the connector request that pulled the row started. Freshly pulled rows show this request's start time; cache hits keep the start time of the request that filled the cache. Selecting this field disables aggregation, so rows are returned individually (each keeping its own fetch time) instead of being summed.
datasource TEXT Data Source The name of the Windsor connector returning the row
date DATE Date Date of the record: order creation, traffic day, campaign start or report day.
day_of_month TEXT Day of month Day of the month
month TEXT Month Number of the month
now TIMESTAMP Now Current timestamp
source TEXT Source The name of the Windsor connector returning the row
today DATE Today Today's date
week TEXT Week Week (Sun-Sat).
week_day TEXT Day of week and day number Weekday number and name combined (Sun-Sat).Numbered from 0 Sunday to 6 Saturday.
week_day_iso TEXT Day of week and day number, ISO Weekday number and name combined, ISO format (Mon-Sun).Numbered from 1 Monday to 7
week_iso TEXT Week ISO Week, ISO format (Mon-Sun).
year TEXT Year Year
year_month TEXT Yearmonth Year and month, e.g. 2024|3
year_month_name TEXT Year month name Year and month with the month name written out, e.g. "Jan 2025".
year_of_week TEXT Year of week The year that contains first day of the week (Sun-Sat).
year_of_week_iso TEXT Year of week, ISO The year that contains first day of the ISO week (Mon-Sun).
year_week TEXT Year week Year and week for US weeks (Sun-Sat), e.g. 2024|15
year_week_iso TEXT Year week ISO Year and week for ISO weeks (Mon-Sun), e.g. 2024|20