eBay Trading APIVersion 1349
 

EndOfAuctionEmailPreferencesType

Contains the seller's preferences for the email that can be sent to the winner of an auction listing.

Types that use EndOfAuctionEmailPreferencesType:

Calls that use EndOfAuctionEmailPreferencesType:

Fields



CopyEmail ( boolean ) [0..1]
Not used by any call.

This field is deprecated.
See the Field Index to learn which calls use CopyEmail.

EmailCustomized ( boolean ) [0..1]
This field is used in a SetUserPreferences call to set/change the setting of whether a customized email will be sent to the winning bidder or not.

This field is always returned to indicate whether or not a customized email will be sent to the winning bidder.
See the Field Index to learn which calls use EmailCustomized.

LogoCustomized ( boolean ) [0..1]
This field is used in a SetUserPreferences call to set/change the setting of whether a customized logo will be used or not in the customized email that is sent to the winning bidder. The URI to a customized logo is provided through the TemplateText field. If the seller would like to use a customized logo, the LogoType field must also be included, and its value will be set to Customized.

This field is always returned to indicate whether or not a customized logo is used in a customized email that is sent to the winning bidder.
See the Field Index to learn which calls use LogoCustomized.

This field is needed in the SetUserPreferences call if the seller would like to use a customized or eBay Store logo. If the seller would like to use a customized logo, this field's value will be set to Customized. If the seller would like to use their eBay Store logo (if it exists), this field's value will be set to Store.

This field is always returned, and its value will be None if no logo is used in the customized email.
See the Field Index to learn which calls use LogoType.

LogoURL ( anyURI ) [0..1]
The seller can include a customized logo in the email that is sent to the winner of an auction listing. The full URI to this logo image should be applied in this field. If the seller is going to include a customized logo in the email through this field, the seller must also include the LogoCustomized field and set its value to true, and include the LogoType field and set its value to Customized.

This field is only returned if a customized logo is being used for the customized email.
See the Field Index to learn which calls use LogoURL.

TemplateText ( string ) [0..1]
The seller can customize the text of the email that is sent to the winner of an auction listing. The text of the email is provided in this field. If the seller is going to customize the text of the email through this field, the seller must also include the TextCustomized field and set its value to true.The text of the custom message for the email.

This field is only returned if set for the account.
See the Field Index to learn which calls use TemplateText.

TextCustomized ( boolean ) [0..1]
This field is used in a SetUserPreferences call to set/change the setting of whether customized text will be used or not in the customized email that is sent to the winning bidder. Customized text is provided through the LogoURL field.

This field is always returned to indicate whether or not customized text is used in a customized email that is sent to the winning bidder.
See the Field Index to learn which calls use TextCustomized.