Response fields
Response field descriptions
Output container/field | Type | Description |
---|---|---|
promotionId | string | The unique eBay-assigned identifier of a discount. Occurrence: Always |
promotionStartDate | string | The date and time the discount starts in UTC format (yyyy-MM-ddThh:mm:ssZ). Occurrence: Always |
promotionEndDate | string | The date and time the discount ends in UTC format (yyyy-MM-ddThh:mm:ssZ). Occurrence: Always |
promotionType | PromotionTypeEnum | This enumeration value indicates the type of discount. See the PromotionTypeEnum type description for more information on each different discount type. Occurrence: Always |
promotionMessage | string | The text describing the discount. Occurrence: Conditional |
promotionTermsUrl | string | The URL for the terms and conditions page for the discount. Occurrence: Conditional |
ruleTemplateName | RuleTemplateNameEnum | This enumeration value indicates the conditions of the discount, such as 'Buy N items, and get Y off total'. See the RuleTemplateNameEnum type description for more information on what each value indicates. Occurrence: Always |
couponCode | string | A unique code that buyers can use during checkout to receive a discount. Occurrence: Conditional |
discountBenefit | DiscountBenefitEnum | This enumeration value indicates the discount benefit as either a monetary amount or percentage of the item/order price. See the DiscountBenefitEnum type description for more information on what each value indicates. Occurrence: Always |
amountOffItemValue | double | The monetary amount that is discounted off an item (or items) when the discount criteria is met. Occurrence: Conditional |
amountOffItemCurrency | CurrencyCodeEnum | The currency of the dollar value expressed in the amountOffItemValue field. Occurrence: Conditional |
amountOffOrderValue | double | Used for threshold discounts, this is the monetary amount that is discounted off an order when the discount criteria is met. Occurrence: Conditional |
amountOffOrderCurrency | CurrencyCodeEnum | The currency of the dollar value expressed in the amountoffOrderValue field. Occurrence: Conditional |
percentageOffItemValue | double | The percentage that is discounted off the sales price of the item (or items) when the discount criteria is met. Occurrence: Conditional |
percentageOffOrderValue | double | Used for threshold discounts, this is the percentage of the order price that is discounted off the order when the discount criteria is met. Occurrence: Conditional |
discountSpecification | DiscountSpecificationEnum | This enumeration value indicates the criteria for when the discount triggers. The discount is applied each time the specified criteria is met. See the DiscountSpecificationEnum type description for more information on what each value indicates. Occurrence: Always |
minAmountValue | double | Known as the threshold amount, this is the minimum dollar amount that needs to be spent on discounted items in order to qualify for the discount. Occurrence: Conditional |
minAmountCurrency | CurrencyCodeEnum | The base currency applied to the value field of minAmountValue to establish a monetary amount. Occurrence: Conditional |
forEachAmountValue | double | The monetary amount that must be spent on discounted items before the discount is applied, which applies for each multiple of this value on a repeating basis. Occurrence: Conditional |
forEachAmountCurrency | CurrencyCodeEnum | The base currency applied to the value field of forEachAmountValue to establish a monetary amount. Occurrence: Conditional |
minQuantity | int | The minimum quantity of discounted items that need to be bought in order to qualify for the discount. Occurrence: Conditional |
forEachQuantity | int | The number of items that must be purchased in order to qualify for the discount, which applies for each multiple of this quantity on a repeating basis. Occurrence: Conditional |
numberOfDiscountedItems | int | The number of items to be discounted when other criteria are met, such as forEachQuantity or minQuantity. Occurrence: Conditional |
maxDiscountAmountValue | double | The maximum monetary amount a buyer can save per discount. Occurrence: Conditional |
maxDiscountAmountCurrency | CurrencyCodeEnum | The base currency applied to the value field of maxDiscountAmountValue to establish a monetary amount. Occurrence: Conditional |
maxRedemptionPerUser | int | The maximum number of times a discount can be redeemed per buyer. Occurrence: Conditional |
itemIds | string | A semicolon delimited array of item IDs that are to be discounted. Occurrence: Always |