eBay: Most-used fields

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

dimensionMetadata

dimensionMetadata

Provides metadata about the dimensions used in a report, including their names, data types, and localized names.

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.

metric

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.buyerRegistrationAddress.secondaryPhone.phoneNumber

orders.buyer.buyerRegistrationAddress.secondaryPhone.phoneNumber

The secondary phone number of the buyer as registered on eBay.

metric

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.taxAddress.stateOrProvince

orders.buyer.taxAddress.stateOrProvince

The state or province of the buyer’s tax address.

dimension

orders.buyer.username

orders.buyer.username

The unique eBay username of the buyer for the order.

dimension

orders.buyerCheckoutNotes

orders.buyerCheckoutNotes

Any notes provided by the buyer during the checkout process 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.cancelStatus.cancelledDate

orders.cancelStatus.cancelledDate

The date and time when the order cancellation was processed.

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. These instructions are based on buyer and seller preferences, listing parameters, and buyer’s checkout choices.

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.lineItems.appliedPromotions

orders.lineItems.appliedPromotions

Details of any promotions that were applied to this specific line item.

dimension

orders.lineItems.deliveryCost.discountAmount.convertedFromCurrency

orders.lineItems.deliveryCost.discountAmount.convertedFromCurrency

The original currency from which the delivery cost discount amount was converted.

dimension

orders.lineItems.deliveryCost.discountAmount.convertedFromValue

orders.lineItems.deliveryCost.discountAmount.convertedFromValue

The original monetary value of the delivery cost discount before currency conversion.

metric

orders.lineItems.deliveryCost.discountAmount.currency

orders.lineItems.deliveryCost.discountAmount.currency

The currency of the discount amount applied to the delivery cost of the line item.

dimension

orders.lineItems.deliveryCost.discountAmount.value

orders.lineItems.deliveryCost.discountAmount.value

The monetary value of the discount amount applied to the delivery cost of the line item.

metric

orders.lineItems.deliveryCost.shippingCost.convertedFromCurrency

orders.lineItems.deliveryCost.shippingCost.convertedFromCurrency

The original currency from which the shipping cost was converted.

dimension

orders.lineItems.deliveryCost.shippingCost.convertedFromValue

orders.lineItems.deliveryCost.shippingCost.convertedFromValue

The original monetary value of the shipping cost before currency conversion.

metric

orders.lineItems.deliveryCost.shippingCost.currency

orders.lineItems.deliveryCost.shippingCost.currency

The currency of the shipping cost for the line item.

dimension

orders.lineItems.deliveryCost.shippingCost.value

orders.lineItems.deliveryCost.shippingCost.value

The monetary value of the shipping cost for the line item.

metric

orders.lineItems.itemLocation.countryCode

orders.lineItems.itemLocation.countryCode

The country code where the item for this line item is located.

dimension

orders.lineItems.itemLocation.location

orders.lineItems.itemLocation.location

The general geographical location (e.g., city, region) where the item for this line item is located.

dimension

orders.lineItems.itemLocation.postalCode

orders.lineItems.itemLocation.postalCode

The postal code where the item for this line item is located.

metric

orders.lineItems.legacyItemId

orders.lineItems.legacyItemId

The unique identifier for the item in the legacy eBay system associated with this line item.

metric

orders.lineItems.legacyVariationId

orders.lineItems.legacyVariationId

The unique identifier of a single variation within a multi-variation listing. This field is returned only if the purchased line item was from a multi-variation listing.

metric

orders.lineItems.lineItemCost.convertedFromCurrency

orders.lineItems.lineItemCost.convertedFromCurrency

The original currency from which the line item cost was converted.

dimension

orders.lineItems.lineItemCost.convertedFromValue

orders.lineItems.lineItemCost.convertedFromValue

The original monetary value of the line item cost before currency conversion.

metric

orders.lineItems.lineItemCost.currency

orders.lineItems.lineItemCost.currency

The currency of the cost for this specific line item.

dimension

orders.lineItems.lineItemCost.value

orders.lineItems.lineItemCost.value

The monetary value of the cost for this specific line item.

metric

orders.lineItems.lineItemFulfillmentInstructions.guaranteedDelivery

orders.lineItems.lineItemFulfillmentInstructions.guaranteedDelivery

A boolean indicating if guaranteed delivery is applicable for this line item.

dimension

orders.lineItems.lineItemFulfillmentInstructions.maxEstimatedDeliveryDate

orders.lineItems.lineItemFulfillmentInstructions.maxEstimatedDeliveryDate

The maximum estimated delivery date for this line item.

dimension

orders.lineItems.lineItemFulfillmentInstructions.minEstimatedDeliveryDate

orders.lineItems.lineItemFulfillmentInstructions.minEstimatedDeliveryDate

The minimum estimated delivery date for this line item.

dimension

orders.lineItems.lineItemFulfillmentInstructions.shipByDate

orders.lineItems.lineItemFulfillmentInstructions.shipByDate

The date by which the seller must ship this line item to meet delivery expectations.

dimension

orders.lineItems.lineItemFulfillmentStatus

orders.lineItems.lineItemFulfillmentStatus

The fulfillment status of the individual line item.

dimension

orders.lineItems.lineItemId

orders.lineItems.lineItemId

The unique identifier for this individual line item within the order.

metric

orders.lineItems.listingMarketplaceId

orders.lineItems.listingMarketplaceId

The identifier of the marketplace where the item for this line item was originally listed.

dimension

orders.lineItems.properties.buyerProtection

orders.lineItems.properties.buyerProtection

A flag indicating if buyer protection is applicable for this line item.

dimension

orders.lineItems.properties.soldViaAdCampaign

orders.lineItems.properties.soldViaAdCampaign

A flag indicating if this line item was sold as a result of an ad campaign.

dimension

orders.lineItems.purchaseMarketplaceId

orders.lineItems.purchaseMarketplaceId

The identifier of the marketplace where this line item was purchased.

dimension

orders.lineItems.quantity

orders.lineItems.quantity

The quantity of the item purchased in this line item.

metric

orders.lineItems.refunds

orders.lineItems.refunds

Details of any refunds specifically applied to this line item.

dimension

orders.lineItems.sku

orders.lineItems.sku

The stock keeping unit (SKU) for the item in this line item.

dimension

orders.lineItems.soldFormat

orders.lineItems.soldFormat

The eBay listing type or format of the line item at the time it was sold.

dimension

orders.lineItems.taxes

orders.lineItems.taxes

Details of taxes applied to this specific line item.

dimension

orders.lineItems.title

orders.lineItems.title

The title of the listing for the item in this line item.

dimension

orders.lineItems.total.convertedFromCurrency

orders.lineItems.total.convertedFromCurrency

The original currency from which the total line item cost was converted.

dimension

orders.lineItems.total.convertedFromValue

orders.lineItems.total.convertedFromValue

The original monetary value of the total line item cost before currency conversion.

metric

orders.lineItems.total.currency

orders.lineItems.total.currency

The currency of the total cost for this specific line item.

dimension

orders.lineItems.total.value

orders.lineItems.total.value

The monetary value of the total cost for this specific line item.

metric

orders.lineItems.variationAspects

orders.lineItems.variationAspects

An array of name-value pairs that describes the specific variation of a multi-variation listing. This array includes aspects like color or size and is returned only for orders from multi-variation listings.

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.convertedFromCurrency

orders.paymentSummary.totalDueSeller.convertedFromCurrency

The original currency from which the total amount due to the seller was converted.

dimension

orders.paymentSummary.totalDueSeller.convertedFromValue

orders.paymentSummary.totalDueSeller.convertedFromValue

The original monetary value of the total amount due to the seller before currency conversion.

metric

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.convertedFromCurrency

orders.pricingSummary.deliveryCost.convertedFromCurrency

The original currency from which the delivery cost was converted.

dimension

orders.pricingSummary.deliveryCost.convertedFromValue

orders.pricingSummary.deliveryCost.convertedFromValue

The original monetary value of the delivery cost before currency conversion.

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.deliveryDiscount.convertedFromCurrency

orders.pricingSummary.deliveryDiscount.convertedFromCurrency

The original currency from which the delivery discount amount was converted.

dimension

orders.pricingSummary.deliveryDiscount.convertedFromValue

orders.pricingSummary.deliveryDiscount.convertedFromValue

The monetary amount of the delivery discount before any currency conversion is applied. This field is returned if currency conversion is required.

metric

orders.pricingSummary.deliveryDiscount.currency

orders.pricingSummary.deliveryDiscount.currency

The three-letter ISO 4217 code indicating the currency of the delivery discount amount after any currency conversion. If no conversion is needed, it’s the default currency of the eBay marketplace.

dimension

orders.pricingSummary.deliveryDiscount.value

orders.pricingSummary.deliveryDiscount.value

The total amount of delivery discounts (including shipping discounts) applied to the order. This value should be a negative real number and is returned only if delivery discounts are applied.

metric

orders.pricingSummary.priceDiscount.currency

orders.pricingSummary.priceDiscount.currency

The currency of any price discounts applied to the order.

dimension

orders.pricingSummary.priceDiscount.value

orders.pricingSummary.priceDiscount.value

The monetary value of any price discounts applied to the order.

metric

orders.pricingSummary.priceSubtotal.convertedFromCurrency

orders.pricingSummary.priceSubtotal.convertedFromCurrency

The three-letter ISO 4217 code indicating the currency of the convertedFromValue field for the price subtotal, representing the currency before conversion. This is returned if currency conversion is required.

dimension

orders.pricingSummary.priceSubtotal.convertedFromValue

orders.pricingSummary.priceSubtotal.convertedFromValue

The monetary amount of the cumulative costs of all line items in the order before any currency conversion is performed. This value is returned if currency conversion is required.

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.convertedFromCurrency

orders.pricingSummary.total.convertedFromCurrency

The three-letter ISO 4217 code indicating the currency of the convertedFromValue field for the total order cost, representing the currency before conversion. This is returned if currency conversion is required.

dimension

orders.pricingSummary.total.convertedFromValue

orders.pricingSummary.total.convertedFromValue

The monetary amount of the total cost of the order before any currency conversion is performed. This value is returned if currency conversion is required.

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.convertedFromCurrency

orders.totalFeeBasisAmount.convertedFromCurrency

The three-letter ISO 4217 code that indicates the currency of the base amount used to calculate final value fees before any currency conversion. This value is returned if currency conversion is required.

dimension

orders.totalFeeBasisAmount.convertedFromValue

orders.totalFeeBasisAmount.convertedFromValue

The monetary amount, before any currency conversion, that serves as the basis for calculating final value fees for an order. This value is returned if currency conversion is required.

metric

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.convertedFromCurrency

orders.totalMarketplaceFee.convertedFromCurrency

The three-letter ISO 4217 code that indicates the currency of the cumulative marketplace fees before any currency conversion. This value is returned if currency conversion is required.

dimension

orders.totalMarketplaceFee.convertedFromValue

orders.totalMarketplaceFee.convertedFromValue

The monetary amount, before any currency conversion, of the cumulative fees accrued for the order and deducted from the seller payout. This value is returned if currency conversion is required.

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.payoutId

transactions.payoutId

The unique identifier of the seller payout associated with the monetary transaction.

metric

transactions.references

transactions.references

An array containing reference information for a transaction, which typically includes an identifier and its type, linking the transaction to specific entities like item IDs.

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

warnings

warnings

An array containing any warnings or errors generated during the processing of the API call.

dimension