eBay Trading APIVersion 1119

MyMessagesMessageType

Container for the message information for each message specified in MessageIDs. The amount and type of information returned varies based on the requested detail level.

Type that uses MyMessagesMessageType:

Call that uses MyMessagesMessageType:

Fields



Content ( string ) [0..1]
Message body in plain text format. The message body is displayed in plain text even if the eBay user's Preferred Email Format preference on My eBay is set to HTML. Graphics and text formatting are dropped if the eBay user's preference is set to HTML.
See the Field Index to learn which calls use Content.

ContentType ( string ) [0..1]
Not used by any call.

Content type of the body text. The three acceptable values are "TEXT", "HTML", and "XML" (Note: This is case sensitive).
See the Field Index to learn which calls use ContentType.

CreationDate ( dateTime ) [0..1]
Not used by any call.

Date and time that a message was created by the sender.
See the Field Index to learn which calls use CreationDate.

ExpirationDate ( dateTime ) [0..1]
Date and time at which a message expires.
See the Field Index to learn which calls use ExpirationDate.

ExternalMessageID ( string ) [0..1]
ID used by an external application to uniquely identify a message. Returned only when specified by the external application on message creation.

This value is equivalent to the value used for MessageID in GetMemberMessages.
See the Field Index to learn which calls use ExternalMessageID.

Flagged ( boolean ) [0..1]
Indicates if the message is displayed with a flag in the seller's My Messages mailbox on eBay. It is strongly recommended that the seller act on the message by the specified date (or within 60 days, if not specified).
See the Field Index to learn which calls use Flagged.

Details relating to a My Messages folder.
See the Field Index to learn which calls use Folder.

ForwardDetails ( MyMessagesForwardDetailsType ) [0..1]
Not used by any call.

Details relating to the forwarding of a message. Only returned if the message is forwarded.
See the Field Index to learn which calls use ForwardDetails.

HighPriority ( boolean ) [0..1]
Indicates if this message is marked as a high-priority message.
See the Field Index to learn which calls use HighPriority.

ItemEndTime ( dateTime ) [0..1]
Date and time for the ended item.
See the Field Index to learn which calls use ItemEndTime.

ItemID ( ItemIDType (string) ) [0..1]
Unique identifier of an eBay listing. This field is returned if the corresponding message is associated with a specific listing.
See the Field Index to learn which calls use ItemID.

ItemTitle ( string ) [0..1]
Title of the item listing.
See the Field Index to learn which calls use ItemTitle.

ListingStatus ( ListingStatusCodeType ) [0..1]
Specifies an active or ended listing's status in eBay's processing workflow. If a listing ends with a sale (or sales), eBay needs to update the sale details (e.g., total price and buyer/high bidder) and the final value fee. This processing can take several minutes. If you retrieve a sold item and no details about the buyer/high bidder are returned or no final value fee is available, use this listing status information to determine whether eBay has finished processing the listing.

Note: For GetMyMessages, the listing status reflects the status of the listing at the time the question was created. The listing status for this call must not match the listing status returned by other calls (such as GetItemTransactions). This is returned only if Messages.Message.MessageType is AskSellerQuestion. This tag is no longer returned in the Sandbox environment.
See the Field Index to learn which calls use ListingStatus.

ID that uniquely identifies a message for a given user.

This value is not the same as the value used for the GetMemberMessages MessageID. Use the GetMemberMessages value (used as the GetMyMessages ExternalID) instead.
See the Field Index to learn which calls use MessageID.

MessageMedia ( MessageMediaType ) [0..*]
Media details stored as part of the message.
See the Field Index to learn which calls use MessageMedia.

MessageType ( MessageTypeCodeType ) [0..1]
Type of message being retrieved through GetMyMessages. This is available only on the US site.
See the Field Index to learn which calls use MessageType.

QuestionType ( QuestionTypeCodeType ) [0..1]
Currently available only on the US site. Context of the question (e.g. Shipping, General). Corresponds to the message subject. Applies if Messages.Message.MessageType is AskSellerQuestion.
See the Field Index to learn which calls use QuestionType.

Read ( boolean ) [0..1]
Indicates if a message has been viewed by a given user. Note that retrieving a message with the API does not mark it as read.
See the Field Index to learn which calls use Read.

ReceiveDate ( dateTime ) [0..1]
Date and time that a message was received by My Messages and stored in a database for the recipient.
See the Field Index to learn which calls use ReceiveDate.

RecipientUserID ( string ) [0..1]
Displayable user ID of the recipient.
See the Field Index to learn which calls use RecipientUserID.

Replied ( boolean ) [0..1]
Indicates if there has been a reply to the message.
See the Field Index to learn which calls use Replied.

Details relating to the response to a message.
See the Field Index to learn which calls use ResponseDetails.

Sender ( string ) [0..1]
Display name of the eBay user that sent the message.
See the Field Index to learn which calls use Sender.

SendToName ( string ) [0..1]
Displayable name of the user or eBay application to which the message is sent. Only returned for M2M, and if a value exists.
See the Field Index to learn which calls use SendToName.

Subject ( string ) [0..1]
Subject of the message.
See the Field Index to learn which calls use Subject.

Text ( string ) [0..1]
Contains the message content, and can contain a threaded message. This field can contain plain text or HTML, depending on the format of the original message. The API does not check the email-format preferences in My Messages on the eBay Web site.
See the Field Index to learn which calls use Text.