Skip to main content

Note: As of July 8th 2024, promotions are now being referred to as discounts on Seller Hub and eBay help pages. Sell Marketing API documentation has been updated to reflect this product name change, but note that no API interface changes have been made.
This type defines the fields in a discount-level report.

Type that uses PromotionReportDetail

PromotionsReportPagedCollection

Call that uses PromotionReportDetail

Fields

Field
Type
Description
averageItemDiscount
The average item discount is the average discount that has been applied to each item being discounted. This value is calculated as follows:

totalDiscount / itemsSoldQuantity = averageItemDiscount
averageItemRevenue
The average item revenue is the average revenue that has been received for each item being discounted.. This value is calculated as follows:

totalSales / itemsSoldQuantity = averageItemRevenue
averageOrderDiscount
The average order discount is the average discount that has been applied to each order that has an active discount. This value is calculated as follows:

totalDiscount / numberOfOrdersSold = averageOrderDiscount
averageOrderRevenue
The average order revenue is the average revenue that has been received for each order that has an active discount. This value is calculated as follows:

totalSales / numberOfOrdersSold = averageOrderRevenue
averageOrderSize
The average order size is the average number of items that each order contained that have an active discount. This value is calculated as follows:

itemsSoldQuantity / numberOfOrdersSold = averageOrderSize
baseSale
This is the monetary amount of items purchased that have been discounted where the threshold wasn't met, so the discount was not applied.

For example, suppose you're running a "Buy 1, get 1 at 50%" discount on $5 socks. One buyer purchased only one pair of socks, so they pay the full price of $5. Here, your baseSale amount would be $5.
itemsSoldQuantity
This is the quantity of items purchased in a threshold discount where the threshold has been met and the discount was applied.

For example, suppose you're running a "Buy 1, get 1 at 50%" discount on $5 socks. One buyer purchases two pairs of socks, so they pay $7.50 for both pairs (rather than the full price of $10). Your number of items sold (itemsSoldQuantity) would be 2 and you number of orders sold (numberOfOrdersSold) would be 1.
numberOfOrdersSold
This is the number of orders sold in a threshold discount where the threshold has been met and the discount was applied.

For example, suppose you're running a "Buy 1, get 1 at 50%" discount on $5 socks. One buyer purchases two pairs of socks, so they pay $7.50 for both pairs (rather than the full price of $10). Your numberOfOrdersSold would be 1 and your itemsSoldQuantity would be 2.
percentageSalesLift
The percentage sales lift is the total dollar amount gained due to discounts. This value is calculated as follows:

promotionSale / totalSale = percentageSalesLift
promotionHref
The URI of the discount report.
promotionId
A unique eBay-assigned ID for the discount that's generated when the discount is created.
promotionReportId
The unique eBay-assigned ID of the discount report that is generated when the report is created.
promotionSale
This is the monetary amount of the items sold in a threshold discount where the threshold has been met and the discount was applied.

For example, suppose you're running a "Buy 1, get 1 at 50%" discount on $5 socks. One buyer purchases two pairs of socks, so they pay $7.50 for both pairs (rather than the full price of $10). Your promotionSale amount would be $7.50.
promotionType
Indicates the type of the discount, either CODED_COUPON, MARKDOWN_SALE, ORDER_DISCOUNT, or VOLUME_DISCOUNT.
totalDiscount
This is the monetary discount amount applied to the sale of items in a threshold discount where the threshold has been met and the discount was applied.

For example, suppose you're running a "Buy 1, get 1 at 50%" discount on $5 socks. One buyer purchases two pairs of socks, so they pay $7.50 for both pairs (rather than the full price of $10). Your totalDiscount amount would be $2.50.
totalSale
This is the total monetary sales amount of all items sold that were discounted.

For example, suppose you're running a "Buy 1, get 1 at 50%" discount on $5 socks. You make one sale where the buyer purchases only one pair of socks and they pay the full price of $5 (baseSale). You make a second sale where the buyer purchases two pairs of socks and they pay $7.50, for both pairs (promotionSale). Your totalSale would be $12.50. This value is calculated as follows:

baseSale + promotionSale = totalSale

Got thoughts? Click the feedback button – your insights help us improve!