complexType "ns:MyMessagesMessageType"

Overview

Namespace

WSDL

Schema

Component

Index

PREV C-TYPE NEXT C-TYPE

FRAMES NO FRAMES NS-Bindings

SUMMARY: XML REP | DERIVED | USE

DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD

eBay Trading API

complexType "ns:MyMessagesMessageType"

Namespace:	urn:ebay:apis:eBLBaseComponents
Content:	complex, 26 elements, elem. wildcard
Defined:	globally in Schema in ebaySvc.wsdl; see XML source
Includes:	definitions of 26 elements, elem. wildcard
Used:	at 1 location

Component Diagram

XML Representation Summary

<...>

Content:

</...>

All Direct / Indirect Based Elements (1):

ns:Message (in ns:Messages)

Known Usage Locations

As direct type of elements (1):

ns:Message (in ns:Messages)

Annotation

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.

XML Source (w/o annotations (27); see within schema source)

<xs:complexType name="MyMessagesMessageType">

<xs:sequence>

<xs:element minOccurs="0" name="Sender" type="xs:string"/>

<xs:element minOccurs="0" name="RecipientUserID" type="xs:string"/>

<xs:element minOccurs="0" name="SendToName" type="xs:string"/>

<xs:element minOccurs="0" name="Subject" type="xs:string"/>

<xs:element minOccurs="0" name="MessageID" type="ns:MyMessagesMessageIDType"/>

<xs:element minOccurs="0" name="ExternalMessageID" type="xs:string"/>

<xs:element minOccurs="0" name="ContentType" type="xs:string"/>

<xs:element minOccurs="0" name="Text" type="xs:string"/>

<xs:element minOccurs="0" name="Flagged" type="xs:boolean"/>

<xs:element minOccurs="0" name="Read" type="xs:boolean"/>

<xs:element minOccurs="0" name="CreationDate" type="xs:dateTime"/>

<xs:element minOccurs="0" name="ReceiveDate" type="xs:dateTime"/>

<xs:element minOccurs="0" name="ExpirationDate" type="xs:dateTime"/>

<xs:element minOccurs="0" name="ItemID" type="ns:ItemIDType"/>

<xs:element minOccurs="0" name="ResponseDetails" type="ns:MyMessagesResponseDetailsType"/>

<xs:element minOccurs="0" name="ForwardDetails" type="ns:MyMessagesForwardDetailsType"/>

<xs:element minOccurs="0" name="Folder" type="ns:MyMessagesFolderType"/>

<xs:element minOccurs="0" name="Content" type="xs:string"/>

<xs:element minOccurs="0" name="MessageType" type="ns:MessageTypeCodeType"/>

<xs:element minOccurs="0" name="ListingStatus" type="ns:ListingStatusCodeType"/>

<xs:element minOccurs="0" name="QuestionType" type="ns:QuestionTypeCodeType"/>

<xs:element minOccurs="0" name="Replied" type="xs:boolean"/>

<xs:element minOccurs="0" name="HighPriority" type="xs:boolean"/>

<xs:element minOccurs="0" name="ItemEndTime" type="xs:dateTime"/>

<xs:element minOccurs="0" name="ItemTitle" type="xs:string"/>

<xs:element maxOccurs="unbounded" minOccurs="0" name="MessageMedia" type="ns:MessageMediaType"/>

<xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>

</xs:sequence>

</xs:complexType>

Content Element Detail (all declarations defined in this component; 27/27)

ns:Content

Type:

xs:string, predefined, simple content

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.

XML Representation Summary

<ns:Content>

Content:

{ xs:string }

</ns:Content>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="Content" type="xs:string"/>

ns:ContentType

Type:

xs:string, predefined, simple content

Content type of the body text. The three acceptable values are "TEXT", "HTML", and "XML" (Note: This is case sensitive).

XML Representation Summary

<ns:ContentType>

Content:

{ xs:string }

</ns:ContentType>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="ContentType" type="xs:string"/>

ns:CreationDate

Type:

xs:dateTime, predefined, simple content

Date and time that a message was created by the sender.

XML Representation Summary

<ns:CreationDate>

Content:

{ xs:dateTime }

</ns:CreationDate>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="CreationDate" type="xs:dateTime"/>

ns:ExpirationDate

Type:

xs:dateTime, predefined, simple content

Date and time at which a message expires.

XML Representation Summary

<ns:ExpirationDate>

Content:

{ xs:dateTime }

</ns:ExpirationDate>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="ExpirationDate" type="xs:dateTime"/>

ns:ExternalMessageID

Type:

xs:string, predefined, simple content

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.

XML Representation Summary

<ns:ExternalMessageID>

Content:

{ xs:string }

</ns:ExternalMessageID>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="ExternalMessageID" type="xs:string"/>

ns:Flagged

Type:

xs:boolean, predefined, simple content

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).

XML Representation Summary

<ns:Flagged>

Content:

{ xs:boolean }

</ns:Flagged>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="Flagged" type="xs:boolean"/>

ns:Folder

Type:

ns:MyMessagesFolderType, complex content

Details relating to a My Messages folder.

Component Diagram

XML Representation Summary

<ns:Folder>

Content:

ns:FolderID?, ns:FolderName?, {any}*

</ns:Folder>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="Folder" type="ns:MyMessagesFolderType"/>

ns:ForwardDetails

Type:

ns:MyMessagesForwardDetailsType, complex content

Details relating to the forwarding of a message. Only returned if the message is forwarded.

Component Diagram

XML Representation Summary

<ns:ForwardDetails>

Content:

ns:UserForwardDate?, ns:ForwardMessageEncoding?, {any}*

</ns:ForwardDetails>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="ForwardDetails" type="ns:MyMessagesForwardDetailsType"/>

ns:HighPriority

Type:

xs:boolean, predefined, simple content

Indicates if this message is marked as a high-priority message.

XML Representation Summary

<ns:HighPriority>

Content:

{ xs:boolean }

</ns:HighPriority>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="HighPriority" type="xs:boolean"/>

ns:ItemEndTime

Type:

xs:dateTime, predefined, simple content

Date and time for the ended item.

XML Representation Summary

<ns:ItemEndTime>

Content:

{ xs:dateTime }

</ns:ItemEndTime>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="ItemEndTime" type="xs:dateTime"/>

ns:ItemID

Type:

ns:ItemIDType, simple content

Unique identifier of an eBay listing. This field is returned if the corresponding message is associated with a specific listing.

XML Representation Summary

<ns:ItemID>

Content:

{ xs:string }

</ns:ItemID>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="ItemID" type="ns:ItemIDType"/>

ns:ItemTitle

Type:

xs:string, predefined, simple content

Title of the item listing.

XML Representation Summary

<ns:ItemTitle>

Content:

{ xs:string }

</ns:ItemTitle>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="ItemTitle" type="xs:string"/>

ns:ListingStatus

Type:

ns:ListingStatusCodeType, simple content

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.

XML Representation Summary

<ns:ListingStatus>

Content:

{ enumeration of xs:token }

</ns:ListingStatus>

Simple Content

Enumeration:

"Active"	-	The listing is still active or the listing has ended with a sale but eBay has not completed processing the sale details (e.g., total price and high bidder). A multi-item listing is considered active until all items have winning bids or purchases or the listing ends with at least one winning bid or purchase. If the listing has ended with a sale but this Active status is returned, please allow several minutes for eBay to finish processing the listing.
"Ended"	-	The listing has ended. If the listing ended with a sale, eBay has completed processing of the sale. All sale information returned from eBay (e.g., total price and high bidder) should be considered accurate and complete. However, the final value fee is not yet available.
"Completed"	-	The listing has closed and eBay has completed processing the sale. All sale information returned from eBay (e.g., total price and high bidder) should be considered accurate and complete. Although the Final Value Fee (FVF) for FixedPriceItem and StoresFixedPrice items is returned by GetSellerTransactions and GetItemTransactions, all other listing types (excluding Buy It Now purchases) require the listing status to be Completed before the Final Value Fee is returned.
"CustomCode"	-	Reserved for internal or future use.
"Custom"	-	Reserved for internal or future use.

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="ListingStatus" type="ns:ListingStatusCodeType"/>

ns:MessageID

Type:

ns:MyMessagesMessageIDType, simple content

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.

XML Representation Summary

<ns:MessageID>

Content:

{ xs:string }

</ns:MessageID>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="MessageID" type="ns:MyMessagesMessageIDType"/>

ns:MessageMedia

Type:

ns:MessageMediaType, complex content

Media details stored as part of the message.

Component Diagram

XML Representation Summary

<ns:MessageMedia>

Content:

ns:MediaURL?, ns:MediaName?, {any}*

</ns:MessageMedia>

XML Source (w/o annotations (1); see within schema source)

<xs:element maxOccurs="unbounded" minOccurs="0" name="MessageMedia" type="ns:MessageMediaType"/>

ns:MessageType

Type:

ns:MessageTypeCodeType, simple content

Type of message being retrieved through GetMyMessages. This is available only on the US site.

XML Representation Summary

<ns:MessageType>

Content:

{ enumeration of xs:token }

</ns:MessageType>

Simple Content

Enumeration:

see details at ns:MessageTypeCodeType

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="MessageType" type="ns:MessageTypeCodeType"/>

ns:QuestionType

Type:

ns:QuestionTypeCodeType, simple content

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.

XML Representation Summary

<ns:QuestionType>

Content:

{ enumeration of xs:token }

</ns:QuestionType>

Simple Content

Enumeration:

"General"	-	This enumeration value indicates that a general question was asked about the order line item.
"Shipping"	-	This enumeration value indicates that a question about shipping the order line item was asked.
"Payment"	-	This enumeration value indicates that a payment question was asked about the order line item.
"MultipleItemShipping"	-	This enumeration value indicates that a question was asked about a shipment that involves multiple packages.
"CustomizedSubject"	-	This enumeration value indicates that question was asked about a customized subject.
"None"	-	This enumeration value indicates that question does not have a subject.
"CustomCode"	-	Reserved for future or internal use.

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="QuestionType" type="ns:QuestionTypeCodeType"/>

ns:Read

Type:

xs:boolean, predefined, simple content

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.

XML Representation Summary

<ns:Read>

Content:

{ xs:boolean }

</ns:Read>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="Read" type="xs:boolean"/>

ns:ReceiveDate

Type:

xs:dateTime, predefined, simple content

Date and time that a message was received by My Messages and stored in a database for the recipient.

XML Representation Summary

<ns:ReceiveDate>

Content:

{ xs:dateTime }

</ns:ReceiveDate>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="ReceiveDate" type="xs:dateTime"/>

ns:RecipientUserID

Type:

xs:string, predefined, simple content

Displayable user ID of the recipient.

XML Representation Summary

<ns:RecipientUserID>

Content:

{ xs:string }

</ns:RecipientUserID>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="RecipientUserID" type="xs:string"/>

ns:Replied

Type:

xs:boolean, predefined, simple content

Indicates if there has been a reply to the message.

XML Representation Summary

<ns:Replied>

Content:

{ xs:boolean }

</ns:Replied>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="Replied" type="xs:boolean"/>

ns:ResponseDetails

Type:

ns:MyMessagesResponseDetailsType, complex content

Details relating to the response to a message.

Component Diagram

XML Representation Summary

<ns:ResponseDetails>

Content:

ns:ResponseEnabled?, ns:ResponseURL?, ns:UserResponseDate?, {any}*

</ns:ResponseDetails>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="ResponseDetails" type="ns:MyMessagesResponseDetailsType"/>

ns:Sender

Type:

xs:string, predefined, simple content

Display name of the eBay user that sent the message.

XML Representation Summary

<ns:Sender>

Content:

{ xs:string }

</ns:Sender>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="Sender" type="xs:string"/>

ns:SendToName

Type:

xs:string, predefined, simple content

Displayable name of the user or eBay application to which the message is sent. Only returned for M2M, and if a value exists.

XML Representation Summary

<ns:SendToName>

Content:

{ xs:string }

</ns:SendToName>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="SendToName" type="xs:string"/>

ns:Subject

Type:

xs:string, predefined, simple content

Subject of the message.

XML Representation Summary

<ns:Subject>

Content:

{ xs:string }

</ns:Subject>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="Subject" type="xs:string"/>

ns:Text

Type:

xs:string, predefined, simple content

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.

XML Representation Summary

<ns:Text>

Content:

{ xs:string }

</ns:Text>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="Text" type="xs:string"/>

{any element from any namespace}

XML Source (see within schema source)

<xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>

Overview

Namespace

WSDL

Schema

Component

Index

PREV C-TYPE NEXT C-TYPE

FRAMES NO FRAMES NS-Bindings

SUMMARY: XML REP | DERIVED | USE

DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD

eBay Trading API

WSDL documentation generated with FlexDoc/XML 1.13 using FlexDoc/XML WSDLDoc 1.2.5 template set. All XSD diagrams generated by FlexDoc/XML DiagramKit.