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.

IDTypeNameDescription
ad_group_idTEXTAd Group IDThe unique identifier of the ad group; only cost per click campaigns have ad groups.
ad_group_nameTEXTAd Group NameThe name of the ad group; only cost per click campaigns have ad groups.
NUMERICPromoted Listings Ad FeesThe Promoted Listings fees charged for the campaign, in the listing site currency.
NUMERICPromoted Listings Average Cost Per SaleAd fees divided by attributed sales.
NUMERICPromoted Listings ClicksThe number of clicks on Promoted Listings of the campaign.
PERCENTPromoted Listings CTRAd clicks divided by ad impressions.
TEXTPromoted Listings CurrencyThe ISO 4217 currency of the ad fees and the sale amount.
NUMERICPromoted Listings ImpressionsThe number of times a Promoted Listing of the campaign was displayed.
NUMERICPromoted Listings ROASAttributed sale amount divided by ad fees.
NUMERICPromoted Listings Sale AmountThe total amount of the sales attributed to the campaign, in the listing site currency.
NUMERICPromoted Listings SalesThe 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.

IDTypeNameDescription
bid_percentageNUMERICBid PercentageThe ad rate of a cost per sale campaign, as a percentage of the sale amount.
campaign_budget_statusTEXTCampaign Budget StatusThe status of the daily budget, e.g. ACTIVE or EXHAUSTED.
campaign_channelTEXTCampaign ChannelThe advertising channel of the campaign: ON_SITE or OFF_SITE.
campaign_daily_budgetNUMERICCampaign Daily BudgetThe daily budget of a cost per click campaign.
campaign_daily_budget_currencyTEXTCampaign Daily Budget CurrencyThe ISO 4217 currency of the daily budget.
campaign_end_timeTIMESTAMPCampaign End TimeThe date and time the campaign ends (UTC), empty for campaigns without an end date.
campaign_idTEXTCampaign IDThe unique identifier of the Promoted Listings campaign.
campaign_nameTEXTCampaign NameThe seller-defined name of the campaign.
campaign_start_timeTIMESTAMPCampaign Start TimeThe date and time the campaign starts (UTC).
campaign_statusTEXTCampaign StatusThe status of the campaign, e.g. RUNNING, PAUSED or ENDED.
campaign_targeting_typeTEXTCampaign Targeting TypeWhether the campaign uses MANUAL or SMART targeting.
funding_modelTEXTFunding ModelHow eBay charges the campaign: COST_PER_SALE or COST_PER_CLICK.
marketplace_idTEXTMarketplace IDThe 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.

IDTypeNameDescription
discounted_line_item_costNUMERICDiscounted Line Item CostThe cost of the line item after discounts.
item_location_countryCOUNTRYItem Location CountryThe country of the physical location of the item.
item_titleTEXTItem TitleThe title of the listing.
legacy_item_idTEXTLegacy Item IDThe legacy listing item ID of the line item.
legacy_variation_idTEXTLegacy Variation IDThe variation ID within a multiple-variation listing.
line_item_costNUMERICLine Item CostThe selling price of the line item before discounts.
line_item_currencyTEXTLine Item Currency CodeThe ISO 4217 currency of the line item amounts.
line_item_fulfillment_statusTEXTLine Item Fulfillment StatusThe fulfillment status of the line item: NOT_STARTED, IN_PROGRESS or FULFILLED.
line_item_idTEXTLine Item IDThe unique identifier of the order line item.
line_item_quantityNUMERICLine Item Quantity OrderedThe number of units of the line item in the order.
line_item_refund_amountNUMERICLine Item Refund AmountThe sum of all refunds issued for the line item.
line_item_shipping_costNUMERICLine Item Shipping CostThe total cost of shipping all units of the line item.
line_item_tax_amountNUMERICLine Item Tax AmountThe sum of all taxes applied to the line item.
line_item_totalNUMERICLine Item TotalThe total the buyer pays for the line item after all costs.
listing_marketplace_idTEXTListing Marketplace IDThe eBay marketplace where the line item was listed.
purchase_marketplace_idTEXTPurchase Marketplace IDThe eBay marketplace where the line item was purchased.
skuTEXTSKUThe seller-defined stock keeping unit of the line item.
sold_formatTEXTSold FormatThe listing type of the line item: AUCTION, FIXED_PRICE, OTHER or SECOND_CHANCE_OFFER.
sold_via_ad_campaignBOOLEANSold Via Ad CampaignWhether the line item was sold through a Promoted Listings campaign.

eBay Orders fields

The Orders report of the eBay connector includes 27 fields.

IDTypeNameDescription
buyer_countryCOUNTRYBuyer CountryThe country of the buyer's registration address.
buyer_usernameTEXTBuyer UsernameThe eBay user ID of the buyer.
cancel_stateTEXTCancel StateThe cancellation state of the order: NONE_REQUESTED, IN_PROGRESS or CANCELED.
currencyTEXTCurrencyThe ISO 4217 currency of the order amounts.
delivery_costNUMERICDelivery CostThe total cost of delivering the order before discounts.
delivery_discountNUMERICDelivery DiscountThe total delivery discounts applied to the order.
ebay_collect_and_remit_taxBOOLEANeBay Collect And Remit TaxWhether eBay collects and remits the tax for the order.
legacy_order_idTEXTLegacy Order IDThe legacy (Trading API) identifier of the order.
line_item_countNUMERICLine Item CountThe number of line items in the order.
order_adjustmentNUMERICOrder AdjustmentThe total adjustments applied to the cost of the order.
order_creation_timeTIMESTAMPOrder Creation TimeThe date and time the order was created (UTC).
order_feeNUMERICOrder FeeThe total special fees applied to the order, such as a tire recycling fee.
order_financial_statusTEXTOrder Payment StatusThe payment status of the order: PAID, PENDING, FAILED, PARTIALLY_REFUNDED or FULLY_REFUNDED.
order_fulfillment_statusTEXTOrder Fulfillment StatusHow far the order is fulfilled: NOT_STARTED, IN_PROGRESS or FULFILLED.
order_idTEXTOrder IDThe unique identifier of the order.
order_last_modified_timeTIMESTAMPOrder Last Modified TimeThe date and time the order was last modified (UTC).
order_taxNUMERICOrder TaxThe total tax of the order.
order_totalNUMERICOrder TotalThe total cost of the order after line items, delivery, tax and adjustments.
payment_countNUMERICPayment CountThe number of payments made for the order.
price_discountNUMERICPrice DiscountThe total item price discounts applied to the order.
price_subtotalNUMERICPrice SubtotalThe cumulative cost of all units of all line items before discounts, delivery and tax.
refund_countNUMERICRefund CountThe number of refunds issued for the order.
sales_record_referenceTEXTSales Record ReferenceThe Selling Manager sales record number of the order.
seller_idTEXTSeller IDThe eBay user ID of the seller who sold the order.
total_due_sellerNUMERICTotal Due SellerThe total the seller receives for the order after all costs.
total_fee_basis_amountNUMERICTotal Fee Basis AmountThe cumulative base amount used to calculate the final value fees of the order.
total_marketplace_feeNUMERICTotal Marketplace FeeThe 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.

IDTypeNameDescription
click_through_ratePERCENTClick Through RateListing views from the search results page divided by listing impressions on the search results page.
listing_impression_search_results_pageNUMERICListing Impressions Search Results PageThe number of times the seller's listings were displayed on the search results page.
listing_impression_storeNUMERICListing Impressions StoreThe number of times the seller's listings were displayed in the seller's store.
listing_impression_totalNUMERICListing Impressions TotalThe number of times the seller's listings were displayed on the search results page or in the seller's store.
listing_views_source_directNUMERICListing Views DirectThe number of listing views that came from a direct link.
listing_views_source_off_ebayNUMERICListing Views From Off eBayThe number of listing views that came from outside eBay.
listing_views_source_other_ebayNUMERICListing Views From Other eBay PagesThe number of listing views that came from other eBay pages.
listing_views_source_search_results_pageNUMERICListing Views From Search Results PageThe number of listing views that came from the search results page.
listing_views_source_storeNUMERICListing Views From StoreThe number of listing views that came from the seller's store.
listing_views_totalNUMERICListing Views TotalThe number of times buyers viewed the seller's listings.
sales_conversion_ratePERCENTSales Conversion RateTransactions divided by total listing views.
transactionsNUMERICTransactionsThe 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.

IDTypeNameDescriptionReport
account_idTEXTAccount IDThe immutable eBay user ID of the seller account.
account_nameTEXTAccount NameThe eBay username of the seller account.
data_fetched_atTIMESTAMPData fetched atUTC 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.
datasourceTEXTData SourceThe name of the Windsor connector returning the row
dateDATEDateDate of the record: order creation, traffic day, campaign start or report day.
day_of_monthTEXTDay of monthDay of the month
monthTEXTMonthNumber of the month
nowTIMESTAMPNowCurrent timestamp
sourceTEXTSourceThe name of the Windsor connector returning the row
todayDATETodayToday's date
weekTEXTWeekWeek (Sun-Sat).
week_dayTEXTDay of week and day numberWeekday number and name combined (Sun-Sat).Numbered from 0 Sunday to 6 Saturday.
week_day_isoTEXTDay of week and day number, ISOWeekday number and name combined, ISO format (Mon-Sun).Numbered from 1 Monday to 7
week_isoTEXTWeek ISOWeek, ISO format (Mon-Sun).
yearTEXTYearYear
year_monthTEXTYearmonthYear and month, e.g. 2024|3
year_month_nameTEXTYear month nameYear and month with the month name written out, e.g. "Jan 2025".
year_of_weekTEXTYear of weekThe year that contains first day of the week (Sun-Sat).
year_of_week_isoTEXTYear of week, ISOThe year that contains first day of the ISO week (Mon-Sun).
year_weekTEXTYear weekYear and week for US weeks (Sun-Sat), e.g. 2024|15
year_week_isoTEXTYear week ISOYear and week for ISO weeks (Mon-Sun), e.g. 2024|20