eBay Trading APIVersion 1391
 

AddMemberMessageAAQToPartner

This call enables a buyer and seller in an order relationship to send messages to each other through My eBay. Buyer and seller order partners can send messages to each other up to 90 days after the creation of the order line item.

Short-duration call rate limit: To protect eBay's infrastructure and servers from being overloaded and/or destabilized, the AddMemberMessageAAQToPartner call has a short-duration call rate limit that restricts bursts of very high traffic.

Per (seller) user ID, no more than 75 AddMemberMessageAAQToPartner calls can be executed within any 60-second interval. If this call rate limit is exceeded at any time, the application making the called is blocked. Each time an application is blocked, the user/application must wait until the block is reset after 100 seconds. This short-duration call rate limit applies to all seller accounts, and sellers/developers cannot appeal or request for a higher limit.

Note: Testing this call in the Sandbox environment is not supported.

See Communication Between Members for conceptual information about the messaging system.

See also the reference documentation for these calls:



Input Output Detail Controls Samples Change History

Input

See also Samples.

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.

The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls). 

<?xml version="1.0" encoding="utf-8"?>
<AddMemberMessageAAQToPartnerRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <ItemID> ItemIDType (string) </ItemID>
  <MemberMessage> MemberMessageType
    <Body> string </Body>
    <EmailCopyToSender> boolean </EmailCopyToSender>
    <MessageMedia> MessageMediaType
      <MediaName> string </MediaName>
      <MediaURL> anyURI </MediaURL>
    </MessageMedia>
    <!-- ... more MessageMedia nodes allowed here ... -->
    <QuestionType> QuestionTypeCodeType </QuestionType>
    <RecipientID> string </RecipientID>
    <!-- ... more RecipientID values allowed here ... -->
    <Subject> string </Subject>
  </MemberMessage>
  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</AddMemberMessageAAQToPartnerRequest>
Argument Type Occurrence Meaning
Call-specific Input Fields [Jump to standard fields]
ItemID ItemIDType (string) Required Unique identifier for the listing that is being discussed between the two order partners.
MemberMessage MemberMessageType Required This container holds the message, and includes the subject, message body, and other details related to the message.
MemberMessage.Body string Required Content of the message is input into this string field. HTML formatting is not allowed in the body of the message. If plain HTML is used, an error occurs and the message will not go through. If encoded HTML is used, the message may go through but the formatting will not be successful, and the recipient of the message will just see the HTML formatting tags.
Max length: 2000.
MemberMessage
  .EmailCopyToSender 		boolean Optional Indicates if a copy of the messages is to be emailed to the sender. If omitted, this defaults to whatever the user set in preferences.
Default: omitted.
MemberMessage.MessageMedia MessageMediaType Optional,
repeatable: [0..*]		 Media details attached to the message.
MemberMessage.MessageMedia
  .MediaName 		string Conditional The name of the image. This will be displayed on the flimstrip.
Max length: 100.
MemberMessage.MessageMedia
  .MediaURL 		anyURI Conditional URL of an image to be included in a message. The image must be uploaded to EPS (eBay Picture Services) using a separate API call or the web flow. This URL will be validated and if it doesn't exist, the request will fail.
Max length: 200.
MemberMessage.QuestionType QuestionTypeCodeType Required Context of the question (e.g. Shipping, General).

Applicable values: See QuestionType.
MemberMessage.RecipientID string Required,
repeatable: [1..*]		 Recipient's eBay user ID. For AddMemberMessagesAAQToBidder, it must be the seller of an item, that item's bidder, or a user who has made an offer on that item using Best Offer. Note: maxOccurs is a shared schema element and needs to be unbounded for AddMemberMessagesAAQToBidder. For AddMemberMessageRTQ, this field is mandatory if ItemID is not in the request. For all other uses, there can only be one RecipientID.
MemberMessage.Subject string Required Subject of this email message.
Standard Input Fields  
ErrorLanguage string Optional Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Below are some examples from different countries.

ID Country
en_AU Australia
de_AT Austria
nl_BE Belgium (Dutch)
fr_BE Belgium (French)
en_CA Canada
fr_CA Canada (French)
zh_CN China
fr_FR France
de_DE Germany
zh_HK Hong Kong
en_IN India
en_IE Ireland
it_IT Italy
nl_NL Netherlands
en_SG Singapore
es_ES Spain
de_CH Switzerland
en_GB United Kingdom
en_US United States
MessageID string Optional Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned.

Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Version string Conditional The version number of the API code that you are programming against (e.g., 1149). The version you specify for a call has these basic effects:
  • It indicates the version of the code lists and other data that eBay should use to process your request.
  • It indicates the schema version you are using.
You need to use a version that is greater than or equal to the lowest supported version.
For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using.

For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.)

See:
    HTTP headers
    eBay Schema Versioning Strategy
    Lowest Supported Version

WarningLevel WarningLevelCodeType Optional Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request.

An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment.

WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors.

We recommend that you only use this during development and debugging. Do not use this in requests performed in the Production environment.

Applicable values:

High
(in) The WarningLevel value is set to High if the user wishes to receive warnings when the application passes unrecognized or deprecated elements in an API call request. Setting the WarningLevel value to High is not recommended in a production environment. Instead, it should only be used during the development/debugging stage.
Low
(in) The WarningLevel value is set to Low if the user does not wish to receive warnings when the application passes unrecognized or deprecated elements in an API call request. This is the default value if WarningLevel is not specified in the call request.

See Warning Level.



Input Output Detail Controls Samples Change History

Output

See also Samples.

The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).

<?xml version="1.0" encoding="utf-8"?>
<AddMemberMessageAAQToPartnerResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- (No call-specific Output fields) -->

  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <Errors> ErrorType
    <ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
    <ErrorCode> token </ErrorCode>
    <ErrorParameters ParamID="string"> ErrorParameterType
      <Value> string </Value>
    </ErrorParameters>
    <!-- ... more ErrorParameters nodes allowed here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes allowed here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
</AddMemberMessageAAQToPartnerResponse>
Return Value Type Occurrence Meaning
(No call-specific fields)
Standard Output Fields  
Ack AckCodeType Always A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for the Ack field.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
Failure
(out) This value indicates that the call request processing failed.
Success
(out) This value indicates that the call request was processed successfully without any issues.
Warning
(out) This value indicates that the call request was successful, but processing was not without any issues. These issues can be checked in the Errors container, that will also be returned when one or more known issues occur with the call request.

(Not all values in AckCodeType apply to this field.)

Code so that your app gracefully handles any future changes to this list.
Build string Always This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues.
CorrelationID string Conditionally Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned.

Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Errors ErrorType Conditionally,
repeatable: [0..*]		 A list of application-level errors (if any) that occurred when eBay processed the request.
Errors.ErrorClassification ErrorClassificationCodeType Conditionally API errors are divided between two classes: system errors and request errors.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
RequestError
(out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data.
SystemError
(out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.

Code so that your app gracefully handles any future changes to this list.
Errors.ErrorCode token Conditionally A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.

See Errors By Number.
Errors.ErrorParameters ErrorParameterType Conditionally,
repeatable: [0..*]		 This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters
  [ attribute ParamID ]		 string Conditionally This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters.Value string Conditionally This is the value of the request parameter noted in the ParamID attribute. So, if the ParamID value was ItemID, the value in this field would be the actual value of that ItemID.
Errors.LongMessage string Conditionally A more detailed description of the condition that raised the error.
Errors.SeverityCode SeverityCodeType Conditionally Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
Error
(out) The request that triggered the error was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data.

If the source of the problem is within the application (such as a missing required element), change the application before you retry the request.
  • If the problem is due to end-user input data, please alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, you can attempt to re-send the request to eBay.
  • If the source of the problem is on eBay's side, An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.


See the Error handling section of the Making a Trading API call guide for more information.
Warning
(out) The request was processed successfully, but something occurred that may affect your application or the user. For example, eBay may have changed a value the user sent in. In this case, eBay returns a normal, successful response and also returns the warning.

When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future.

Code so that your app gracefully handles any future changes to this list.
Errors.ShortMessage string Conditionally A brief description of the condition that raised the error.
HardExpirationWarning string Conditionally Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token.
Timestamp dateTime Always This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See the Time Values section in the eBay Features Guide for information about this time format and converting to and from the GMT time zone.

Note: GetCategories and other Trading API calls are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed.
Version string Always The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See the Standard Data for All Calls section in the eBay Features Guide for information on using the response version when troubleshooting CustomCode values that appear in the response.



Input Output Detail Controls Samples Change History

Detail Controls


DetailLevel

This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.



Input Output Detail Controls Samples Change History

Samples

New to making API calls? Please see Making a Call.

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Available samples:

Sample: Basic Call

Sends a message from the seller to the buyer.

Description

The seller wants to encourage good customer relations with their buyers, so after the sale of a book, she sends a message thanking the buyer for the business.

Input

XML format.

<?xml version="1.0" encoding="utf-8"?>
<AddMemberMessageAAQToPartnerRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>A*******3</eBayAuthToken>
  </RequesterCredentials>
  <!-- The user making this call must be the buyer or seller of the listing ID posted below -->
  <ItemID>9********7</ItemID>
  <MemberMessage>
    <Subject>Thank You for your purchase</Subject>
    <Body>We appreciate your business and hope you enjoy your book.</Body>
    <!-- The Question Type pass in the field below should be one of the enum values defined in QuestionTypeCodeType of Trading API, including 'General', 'Payment', or 'Shipping'  -->
    <QuestionType>General</QuestionType>
    <!-- The recipient must be the order partner of the user making the call -->
    <RecipientID>b************r</RecipientID>
  </MemberMessage>
</AddMemberMessageAAQToPartnerRequest>

Output

XML format.
<?xml version="1.0" encoding="utf-8"?>
<AddMemberMessageAAQToPartnerResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2018-10-29T18:36:52.001Z</Timestamp>
  <Ack>Success</Ack>
  <Version>1081</Version>
  <Build>e1081_core_Bundled_3048229_R1</Build>
</AddMemberMessageAAQToPartnerResponse>

Back to list of samples

Sample: Ask the Seller a Question About Shipping

Sends a question about shipping from the buyer to the seller.

Description

The buyer wants to confirm the book she has won will be shipped safely.

Input

In the request, the QuestionType is set to Shipping to indicate the nature of the question. The RecipientID is set to the seller's user ID. The Body contains the question.

XML format.

<?xml version="1.0" encoding="UTF-8"?>
<AddMemberMessageAAQToPartnerRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>A*******3</eBayAuthToken>
  </RequesterCredentials>
  <!-- The user making this call must be the buyer or seller of the listing ID posted below -->
  <ItemID>1**********8</ItemID>
  <MemberMessage>
    <Subject>Question about shipping</Subject>
    <Body>I would like to have the item shipped in a box, and not in a padded
    envelope. Is there any additional charge for that?</Body>
    <!-- The Question Type pass in the field below should be one of the enum values defined in QuestionTypeCodeType of Trading API, including 'General', 'Payment', or 'Shipping'  -->
    <QuestionType>Shipping</QuestionType>
    <!-- The recipient must be the order partner of the user making the call --> 
    <RecipientID>T************************r</RecipientID>
  </MemberMessage>
</AddMemberMessageAAQToPartnerRequest>

Output

The Ack field in the response indicates the call was successful.

XML format.
<?xml version="1.0" encoding="UTF-8"?>
<AddMemberMessageAAQToPartnerResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2018-10-29T18:36:52.001Z</Timestamp>
  <Ack>Success</Ack>
  <Version>1081</Version>
  <Build>E1081_CORE_BUNDLED_11934711_R1</Build>
</AddMemberMessageAAQToPartnerResponse>

Back to list of samples



Input Output Detail Controls Samples Change History

Change History

Change Date Description
833
2013-07-25
  • MessageMediaType.MediaName (added): The new MessageMediaType lets sellers share photos in messages through the API. The MediaURL field is the URL of an image to be included in a message. For more information about the see MessageMediaType.
  • MessageMediaType.MediaURL (added): The new MessageMediaType lets sellers share photos in messages through the API. The MediaURL field is the URL of an image to be included in a message. For more information about the see MessageMediaType.
657
2010-02-17
  • MemberMessage.Body (modified): The content of the input field has increased to 4000 characters in size. If the API version is less than 653, the limit remains at 1000.
573
2008-07-09
  • MemberMessage.HideSendersEmailAddress (deprecated): Currently Deprecated for the sandbox environment. It would be deprecated in production starting in September 2008.
523
2007-07-25
  • Subject (doc change): Documentation correction; the Subject field has been added as required input.
465
2006-06-14
  • (doc change) New call.