eBay: Most-used fields#
The table below gives information about most-used fields that you can import from eBay. Other fields might also be available in Adverity.
The fields that you can fetch in Adverity are updated regularly to reflect updates to data source APIs.
API name |
Adverity UI name |
Description |
Use in Adverity |
|---|---|---|---|
Date |
Date |
The date of the record, standardized by the data integration platform from various eBay API date fields like order creation date or transaction date. |
dimension |
endDate |
endDate |
The end date for the period covered by a report, in ISO 8601 UTC format. |
dimension |
lastUpdatedDate |
lastUpdatedDate |
The date and time when the data in the report was last updated, in ISO 8601 UTC format. |
dimension |
orders.buyer.buyerRegistrationAddress.contactAddress.addressLine1 |
orders.buyer.buyerRegistrationAddress.contactAddress.addressLine1 |
The first line of the buyer’s contact address as registered on eBay. |
dimension |
orders.buyer.buyerRegistrationAddress.contactAddress.city |
orders.buyer.buyerRegistrationAddress.contactAddress.city |
The city of the buyer’s contact address as registered on eBay. |
dimension |
orders.buyer.buyerRegistrationAddress.contactAddress.countryCode |
orders.buyer.buyerRegistrationAddress.contactAddress.countryCode |
The country code of the buyer’s contact address as registered on eBay. |
dimension |
orders.buyer.buyerRegistrationAddress.contactAddress.postalCode |
orders.buyer.buyerRegistrationAddress.contactAddress.postalCode |
The postal code of the buyer’s contact address as registered on eBay. |
dimension |
orders.buyer.buyerRegistrationAddress.contactAddress.stateOrProvince |
orders.buyer.buyerRegistrationAddress.contactAddress.stateOrProvince |
The state or province of the buyer’s contact address as registered on eBay. |
dimension |
orders.buyer.buyerRegistrationAddress.email |
orders.buyer.buyerRegistrationAddress.email |
The email address of the buyer as registered on eBay. |
dimension |
orders.buyer.buyerRegistrationAddress.fullName |
orders.buyer.buyerRegistrationAddress.fullName |
The full name of the buyer as registered on eBay. |
dimension |
orders.buyer.buyerRegistrationAddress.primaryPhone.phoneNumber |
orders.buyer.buyerRegistrationAddress.primaryPhone.phoneNumber |
The primary phone number of the buyer as registered on eBay. |
metric |
orders.buyer.taxAddress.city |
orders.buyer.taxAddress.city |
The city of the buyer’s tax address. |
dimension |
orders.buyer.taxAddress.countryCode |
orders.buyer.taxAddress.countryCode |
The country code of the buyer’s tax address. |
dimension |
orders.buyer.taxAddress.postalCode |
orders.buyer.taxAddress.postalCode |
The postal code of the buyer’s tax address. |
metric |
orders.buyer.username |
orders.buyer.username |
The unique eBay username of the buyer for the order. |
dimension |
orders.cancelStatus.cancelRequests |
orders.cancelStatus.cancelRequests |
An array containing details of any cancellation requests associated with the order. |
dimension |
orders.cancelStatus.cancelState |
orders.cancelStatus.cancelState |
The current state of the cancellation process for the order. |
dimension |
orders.creationDate |
orders.creationDate |
The date and time when the order was created, in ISO 8601 UTC format. |
dimension |
orders.fulfillmentHrefs |
orders.fulfillmentHrefs |
An array of URLs that reference shipping fulfillments associated with the order. |
dimension |
orders.fulfillmentStartInstructions |
orders.fulfillmentStartInstructions |
A set of specifications and recommendations for sellers on how to fulfill an order, including details about shipping, service, addressing, and estimated delivery timelines. |
dimension |
orders.lastModifiedDate |
orders.lastModifiedDate |
The date and time when the order was last modified, in ISO 8601 UTC format. |
dimension |
orders.legacyOrderId |
orders.legacyOrderId |
The unique identifier for the order in the legacy eBay system. |
dimension |
orders.orderFulfillmentStatus |
orders.orderFulfillmentStatus |
The current fulfillment status of the order, indicating whether it is not started, in progress, or fulfilled. |
dimension |
orders.orderId |
orders.orderId |
The unique identifier for the eBay order. |
dimension |
orders.orderPaymentStatus |
orders.orderPaymentStatus |
The current payment status of the order, or the status of a refund request. |
dimension |
orders.paymentSummary.payments |
orders.paymentSummary.payments |
A summary of the payments made for the order. |
dimension |
orders.paymentSummary.refunds |
orders.paymentSummary.refunds |
A summary of any refunds issued for the order. |
dimension |
orders.paymentSummary.totalDueSeller.currency |
orders.paymentSummary.totalDueSeller.currency |
The currency of the total amount due to the seller for the order. |
dimension |
orders.paymentSummary.totalDueSeller.value |
orders.paymentSummary.totalDueSeller.value |
The monetary value of the total amount due to the seller for the order. |
metric |
orders.pricingSummary.deliveryCost.currency |
orders.pricingSummary.deliveryCost.currency |
The currency of the delivery cost for the order. |
dimension |
orders.pricingSummary.deliveryCost.value |
orders.pricingSummary.deliveryCost.value |
The monetary value of the delivery cost for the order. |
metric |
orders.pricingSummary.priceSubtotal.currency |
orders.pricingSummary.priceSubtotal.currency |
The currency of the subtotal price of the items in the order before taxes, delivery, and discounts. |
dimension |
orders.pricingSummary.priceSubtotal.value |
orders.pricingSummary.priceSubtotal.value |
The monetary value of the subtotal price of the items in the order before taxes, delivery, and discounts. |
metric |
orders.pricingSummary.total.currency |
orders.pricingSummary.total.currency |
The currency of the total cost of the order, including items, delivery, and taxes, minus any discounts. |
dimension |
orders.pricingSummary.total.value |
orders.pricingSummary.total.value |
The monetary value of the total cost of the order, including items, delivery, and taxes, minus any discounts. |
metric |
orders.salesRecordReference |
orders.salesRecordReference |
An eBay-generated identifier used for managing orders in Selling Manager and Seller Hub. |
metric |
orders.sellerId |
orders.sellerId |
The unique eBay user ID of the seller who sold the order. |
dimension |
orders.totalFeeBasisAmount.currency |
orders.totalFeeBasisAmount.currency |
The currency of the cumulative base amount used to calculate final value fees for the order. |
dimension |
orders.totalFeeBasisAmount.value |
orders.totalFeeBasisAmount.value |
The monetary value of the cumulative base amount used to calculate final value fees for the order. |
metric |
orders.totalMarketplaceFee.currency |
orders.totalMarketplaceFee.currency |
The currency of the total cumulative marketplace fees accrued for the order. |
dimension |
orders.totalMarketplaceFee.value |
orders.totalMarketplaceFee.value |
The monetary value of the total cumulative marketplace fees accrued for the order. |
metric |
record.click_through_rate.applicable |
record.click_through_rate.applicable |
A boolean indicating if the click-through rate value is applicable and valid for the record. |
dimension |
record.click_through_rate.value |
record.click_through_rate.value |
The computed value of the click-through rate for a listing. |
metric |
record.day.applicable |
record.day.applicable |
A boolean indicating if the day dimension is applicable and valid for the record. |
dimension |
record.day.value |
record.day.value |
The specific day for which the traffic report data is aggregated. |
metric |
record.listing_impression_search_results_page.applicable |
record.listing_impression_search_results_page.applicable |
A boolean indicating if the listing impression value from search results page is applicable and valid. |
dimension |
record.listing_impression_search_results_page.value |
record.listing_impression_search_results_page.value |
The total number of times the listing appeared on eBay search results pages. |
metric |
record.listing_impression_store.applicable |
record.listing_impression_store.applicable |
A boolean indicating if the listing impression value from the store is applicable and valid. |
dimension |
record.listing_impression_store.value |
record.listing_impression_store.value |
The total number of times the listing appeared within the seller’s eBay store. |
metric |
record.listing_impression_total.applicable |
record.listing_impression_total.applicable |
A boolean indicating if the total listing impression value is applicable and valid. |
dimension |
record.listing_impression_total.value |
record.listing_impression_total.value |
The total number of times the listing appeared in search results or within the seller’s store. |
metric |
record.listing_views_source_direct.applicable |
record.listing_views_source_direct.applicable |
A boolean indicating if the direct listing views value is applicable and valid. |
dimension |
record.listing_views_source_direct.value |
record.listing_views_source_direct.value |
The number of times the listing was viewed directly (e.g., via a direct link). |
metric |
record.listing_views_source_off_ebay.applicable |
record.listing_views_source_off_ebay.applicable |
A boolean indicating if the off-eBay listing views value is applicable and valid. |
dimension |
record.listing_views_source_off_ebay.value |
record.listing_views_source_off_ebay.value |
The number of times the listing was viewed from sources outside of eBay. |
metric |
record.listing_views_source_other_ebay.applicable |
record.listing_views_source_other_ebay.applicable |
A boolean indicating if the other eBay listing views value is applicable and valid. |
dimension |
record.listing_views_source_other_ebay.value |
record.listing_views_source_other_ebay.value |
The number of times the listing was viewed from other eBay sources (not search results or store). |
metric |
record.listing_views_source_search_results_page.applicable |
record.listing_views_source_search_results_page.applicable |
A boolean indicating if the listing views value from search results page is applicable and valid. |
dimension |
record.listing_views_source_search_results_page.value |
record.listing_views_source_search_results_page.value |
The number of times the listing was viewed directly from search results pages. |
metric |
record.listing_views_source_store.applicable |
record.listing_views_source_store.applicable |
A boolean indicating if the listing views value from the store is applicable and valid. |
dimension |
record.listing_views_source_store.value |
record.listing_views_source_store.value |
The number of times the listing was viewed from the seller’s eBay store. |
metric |
record.listing_views_total.applicable |
record.listing_views_total.applicable |
A boolean indicating if the total listing views value is applicable and valid. |
dimension |
record.listing_views_total.value |
record.listing_views_total.value |
The total number of times the listing was viewed from all sources. |
metric |
record.sales_conversion_rate.applicable |
record.sales_conversion_rate.applicable |
A boolean indicating if the sales conversion rate value is applicable and valid. |
dimension |
record.sales_conversion_rate.value |
record.sales_conversion_rate.value |
The rate at which listing views convert into sales. |
metric |
record.transaction.applicable |
record.transaction.applicable |
A boolean indicating if the transaction count value is applicable and valid. |
dimension |
record.transaction.value |
record.transaction.value |
The number of transactions recorded for the listing. |
metric |
startDate |
startDate |
The start date for the period covered by a report, in ISO 8601 UTC format. |
dimension |
transactions.amount.currency |
transactions.amount.currency |
The currency of the monetary amount for the transaction. |
dimension |
transactions.amount.value |
transactions.amount.value |
The monetary value of the transaction. |
metric |
transactions.buyer.username |
transactions.buyer.username |
The unique eBay username of the buyer involved in the transaction. |
dimension |
transactions.feeType |
transactions.feeType |
The type of fee deducted from the seller payout, such as final value fees, international fees, or payment processing fees. |
dimension |
transactions.orderId |
transactions.orderId |
The unique identifier of the eBay order associated with the monetary transaction. |
dimension |
transactions.orderLineItems.feeBasisAmount.currency |
transactions.orderLineItems.feeBasisAmount.currency |
The currency of the base amount used to calculate fees for the individual line item within a transaction. |
dimension |
transactions.orderLineItems.feeBasisAmount.value |
transactions.orderLineItems.feeBasisAmount.value |
The monetary value of the base amount used to calculate fees for the individual line item within a transaction. |
metric |
transactions.orderLineItems.lineItemId |
transactions.orderLineItems.lineItemId |
The unique identifier of the line item within the transaction. |
metric |
transactions.orderLineItems.marketplaceFees |
transactions.orderLineItems.marketplaceFees |
Details of marketplace fees applied to or credited for a specific line item within a transaction. |
dimension |
transactions.references |
transactions.references |
This field provides contextual reference information for a transaction, especially for non-sale charges. |
dimension |
transactions.salesRecordReference |
transactions.salesRecordReference |
An eBay-generated identifier used for managing the sales record associated with the transaction. |
metric |
transactions.totalFeeAmount.currency |
transactions.totalFeeAmount.currency |
The currency of the total fee amount deducted for the transaction. |
dimension |
transactions.totalFeeAmount.value |
transactions.totalFeeAmount.value |
The monetary value of the total fee amount deducted for the transaction. |
metric |
transactions.totalFeeBasisAmount.currency |
transactions.totalFeeBasisAmount.currency |
The currency of the cumulative base amount used to calculate fees for the entire transaction. |
dimension |
transactions.totalFeeBasisAmount.value |
transactions.totalFeeBasisAmount.value |
The monetary value of the cumulative base amount used to calculate fees for the entire transaction. |
metric |
transactions.transactionDate |
transactions.transactionDate |
The date and time when the monetary transaction occurred, in ISO 8601 UTC format. |
dimension |
transactions.transactionId |
transactions.transactionId |
The unique identifier for the monetary transaction. |
dimension |
transactions.transactionStatus |
transactions.transactionStatus |
The current status of the monetary transaction (e.g., Payout, Funds Processing, Completed). |
dimension |
transactions.transactionType |
transactions.transactionType |
The type of monetary transaction (e.g., SALE, REFUND, CREDIT). |
dimension |