eBay Trading APIVersion 1111

DiscountProfileType

Details of a flat or calculated shipping discount rule. Shipping Discount Rules can be set up through the SetShippingDiscountProfiles call or through My eBay.

Types that use DiscountProfileType:

Calls that use DiscountProfileType:

Fields



DiscountProfileID ( string ) [0..1]
The unique eBay-created unique identifier for the shipping discount, assigned when the shipping discount rule is created.
In a SetShippingDiscountProfiles call,
  • If the value of ModifyActionCode is set to Add, this field is not applicable and is ignored
  • If provided.
  • If the value of Mod
  • IfyActionCode is set to Update, all fields of the modified rule must be provided, even if the values are not changing.
  • If the value of ModifyActionCode is set to Delete, either the DiscountProfileID value or is DiscountProfileName value is required, the MappingDiscountProfileID is optional, and all other fields of the DiscountProfile container are ignored.
See the Field Index to learn which calls use DiscountProfileID.

DiscountProfileName ( string ) [0..1]
The seller-provided title for the shipping discount rule.
In a SetShippingDiscountProfiles call,
  • If the value of ModifyActionCode is set to Add, this field is ignored (if provided) if this is the first shipping discount rule being created, but this field is required if there is more than one existing shipping discount rule of that type (flat rate or calculated)
  • If the value of ModifyActionCode is set to Update, all fields of the modified rule must be provided, even if the values are not changing
  • If the value of ModifyActionCode is set to Delete, the DiscountProfileID is required, the MappingDiscountProfileID is optional, and all other fields of the DiscountProfile container are ignored
  • If the value of ModifyActionCode is set to Delete, either the DiscountProfileID value or is DiscountProfileName value is required, the MappingDiscountProfileID is optional, and all other fields of the DiscountProfile container are ignored
See the Field Index to learn which calls use DiscountProfileName.

EachAdditionalAmount ( AmountType (double) ) [0..1]
The cost to ship each item beyond the first item (where the item with the highest shipping cost is selected by eBay as the first item). Let's say the buyer purchases three items, each set to ship for $8, and the seller set the EachAdditionalAmount to $6. The cost to ship three items would normally be $24, but since the seller specified $6, the total shipping cost would be $8 + $6 + $6, or $20. This field is only applicable for flat-rate shipping.
See the Field Index to learn which calls use EachAdditionalAmount.

EachAdditionalAmountOff ( AmountType (double) ) [0..1]
The amount by which to reduce the cost to ship each item beyond the first item (where the item with the highest shipping cost is selected by eBay as the first item). Let's say the buyer purchases three items, each set to ship for $8, and the seller set EachAdditionalAmountOff to $2. The cost to ship three items would normally be $24, but since the seller specified $2, the total shipping cost would be $24 - (two additional items x $2), or $20. This field is only applicable for flat-rate shipping.
See the Field Index to learn which calls use EachAdditionalAmountOff.

EachAdditionalPercentOff ( float ) [0..1]
The percentage by which to reduce the cost to ship each item beyond the first item (where the item with the highest shipping cost is selected by eBay as the first item). Let's say the buyer purchases three items, each set to ship for $8, and the seller set EachAdditionalPercentOff to 0.25. The cost to ship three items would normally be $24, but since the seller specified 0.25 ($2 out of $8), the total shipping cost would be $24 - (two additional items x $2), or $20. This field is only applicable for flat-rate shipping.
See the Field Index to learn which calls use EachAdditionalPercentOff.

MappedDiscountProfileID ( string ) [0..1]
For SetShippingDiscountProfiles, if MappedDiscountProfileID is omitted when ModifyActionCode is set to Delete, any listings currently using the profile identified by DiscountProfileID will have that profile removed.
See the Field Index to learn which calls use MappedDiscountProfileID.

WeightOff ( MeasureType (decimal) ) [0..1]
The amount of weight to subtract for each item beyond the first item before shipping costs are calculated. For example, there may be less packing material when the items are combined in one box than if they were shipped individually. Let's say the buyer purchases three items, each 10 oz. in weight, and the seller set WeightOff to 2 oz. The combined weight would be 30 oz., but since the seller specified 2 oz. off, the total weight for shipping cost calculation would be 30 oz. - (two additional items x 2 oz.), or 26 oz. This field is only applicable for calculated shipping.
See the Field Index to learn which calls use WeightOff.