The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

eBay::API::XML::Call::GetMemberMessages

DESCRIPTION

SYNOPSIS

INHERITANCE

eBay::API::XML::Call::GetMemberMessages inherits from the eBay::API::XML::BaseCall class

Subroutines:

setDisplayToPublic()

Specifies if the message should be displayed on the website with the item listing.

RequiredInput: No
#    Argument: 'xs:boolean'

setEndCreationTime()

Used as end of date range filter. If specified, filters the returned messages to only those with a creation date less than or equal to the specified date and time. <br><br> For CEM messages, StartCreationTime and EndCreationTime must be provided. <br><br> For ASQ messages, either the ItemID, or a date range (specified with StartCreationTime and EndCreationTime), or both must be included.

RequiredInput: Conditionally
#    Argument: 'xs:dateTime'

setItemID()

The ID of the item the message is about. <br><br> For ASQ messages, either the ItemID, or a date range (specified with StartCreationTime and EndCreationTime), or both must be included. ItemID is otherwise ignored.

MaxLength: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits)

RequiredInput: Conditionally
#    Argument: 'ns:ItemIDType'

setMailMessageType()

The type of message.

RequiredInput: Yes
#    Argument: 'ns:MessageTypeCodeType'

setMemberMessageID()

An ID that uniquely identifies the message for a given user to be retrieved. Used for the AskSellerQuestion notification only.

RequiredInput: No
#    Argument: 'xs:string'

setMessageStatus()

The status of the message.

RequiredInput: Conditionally
#    Argument: 'ns:MessageStatusTypeCodeType'

setPagination()

Standard pagination argument used to reduce response.

RequiredInput: Yes
#    Argument: 'ns:PaginationType'

setSenderID()

An eBay ID that uniquely identifies a user. For GetMemberMessages, this is the sender of the message. If included in the request, returns only messages from the specified sender.

RequiredInput: No
#    Argument: 'ns:UserIDType'

setStartCreationTime()

Used as beginning of date range filter. If specified, filters the returned messages to only those with a creation date greater than or equal to the specified date and time. <br><br> For CEM messages, StartCreationTime and EndCreationTime must be provided. <br><br> For ASQ messages, either the ItemID, or a date range (specified with StartCreationTime and EndCreationTime), or both must be included.

RequiredInput: Conditionally
#    Argument: 'xs:dateTime'

isHasMoreItems()

Specifies whether the response has more items.

Returned: Always
#    Returns: 'xs:boolean'

getMemberMessage()

The returned member messages. Returned if messages that meet the request criteria exist.

Returned: Conditionally
#    Returns: 'ns:MemberMessageExchangeArrayType'

getPaginationResult()

Shows the pagination of data returned by requests.

Returned: Always
#    Returns: 'ns:PaginationResultType'