getPromotionReports

The URI of the current page of results from the result set.

Occurrence: Always

The number of items returned on a single page from the result set. This value can be set in the request with the limit query parameter.

Occurrence: Always

The URI for the following page of results. This value is returned only if there is an additional page of results to display from the result set.

Max length: 2048

Occurrence: Conditional

The number of results skipped in the result set before listing the first returned result. This value can be set in the request with the offset query parameter.

Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of 0.

Occurrence: Always

The URI for the preceding page of results. This value is returned only if there is a previous page of results to display from the result set.

Max length: 2048

Occurrence: Conditional

A list of promotionReports contained in the paginated result set.

Occurrence: Always

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

Occurrence: Always

The base currency applied to the value field to establish a monetary amount.

The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD

Occurrence: Conditional

The monetary amount in the specified currency.

Required in the amount type.

Occurrence: Conditional

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

Occurrence: Always

The base currency applied to the value field to establish a monetary amount.

The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD

Occurrence: Conditional

The monetary amount in the specified currency.

Required in the amount type.

Occurrence: Conditional

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

Occurrence: Always

The base currency applied to the value field to establish a monetary amount.

The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD

Occurrence: Conditional

The monetary amount in the specified currency.

Required in the amount type.

Occurrence: Conditional

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

Occurrence: Always

The base currency applied to the value field to establish a monetary amount.

The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD

Occurrence: Conditional

The monetary amount in the specified currency.

Required in the amount type.

Occurrence: Conditional

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

Occurrence: Always

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.

Occurrence: Always

The base currency applied to the value field to establish a monetary amount.

The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD

Occurrence: Conditional

The monetary amount in the specified currency.

Required in the amount type.

Occurrence: Conditional

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.

Occurrence: Always

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.

Occurrence: Always

The percentage sales lift is the total dollar amount gained due to discounts. This value is calculated as follows:

promotionSale / totalSale = percentageSalesLift

Occurrence: Conditional

The URI of the discount report.

Occurrence: Always

A unique eBay-assigned ID for the discount that's generated when the discount is created.

Occurrence: Always

The unique eBay-assigned ID of the discount report that is generated when the report is created.

Occurrence: Conditional

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.

Occurrence: Always

The base currency applied to the value field to establish a monetary amount.

The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD

Occurrence: Conditional

The monetary amount in the specified currency.

Required in the amount type.

Occurrence: Conditional

Indicates the type of the discount, either CODED_COUPON, MARKDOWN_SALE, ORDER_DISCOUNT, or VOLUME_DISCOUNT.

Occurrence: Always

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.

Occurrence: Always

The base currency applied to the value field to establish a monetary amount.

The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD

Occurrence: Conditional

The monetary amount in the specified currency.

Required in the amount type.

Occurrence: Conditional

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

Occurrence: Always

The base currency applied to the value field to establish a monetary amount.

The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD

Occurrence: Conditional

The monetary amount in the specified currency.

Required in the amount type.

Occurrence: Conditional

The total number of items retrieved in the result set.

If no items are found, this field is returned with a value of 0.

Occurrence: Always