AddMemberMessagesAAQToBidder

Sellers use this call to send messages to bidders, and to users who have made offers via Best Offer, regarding an active listing. Messages sent to users appear in their My eBay Inbox. Sellers can use AddMemberMessagesAAQToBidder to send up to ten messages per call. The following restrictions apply:

• The item specified by ItemID must be currently active
• The message sender must be the seller of the item
• The recipients must be bidders on that item, or they must have made offers on that item via Best Offer

Usage Details

AddMemberMessagesAAQToBidder accepts up to ten messages per request.

The call returns success for each message that was successfully sent. For messages that were not successfully sent, the application needs to parse the error response to determine whether or not it is possible to recover from the error.

If required fields are missing from the message, they can be added and the message can be resent. However, if the basic requirements between the seller and the bidder are not met (for example, if the item is no longer active), the message will not be able to be resent and the seller must use an alternate means to contact the user (such as contacting the former bidder via the eBay.com Web site). To contact users by phone, you must use GetUserContactDetails to obtain the additional contact information.

AddMemberMessagesAAQToBidder returns Success or Failure (an error) for the entire call, as well as each for each message container in the response. The call may succeed as a whole, even though individual messages in the request might have failed. The following figure illustrates a call that succeeded, although some messages failed:

Figure 1: AddMemberMessagesAAQToBidder response containers

Note that if a warning occurs, the result set will contain both normal data and an error construct. See Error Handling for details.

Testing AddMemberMessagesAAQToBidder

You can test AddMemberMessagesAAQToBidder in the Sandbox.

To test the call, you must have a "bidding" relationship between two users. The caller must have listed the specified item, and the target users must have bid, or placed an offer, on the item. In addition, the item must be currently active.

1. Create a seller in the sandbox and have them list an item. You must allow Best Offers on your item if you want to test sending messages to users who have made Best Offers.
2. Create a buyer in the sandbox and have them place a bid (or an offer) on the item. You can use the Sandbox UI for this task.
3. Call AddMemberMessagesAAQToBidder with the test seller's authentication token. Specify the test buyer in the RecipientID field and the item you created in ItemID field.
4. After sending the message, check the buyer's My Messages in the Sandbox UI to see if the message successfully reached their Inbox.

Further testing information can be obtained through Developer Technical Support.

Related Information

See also the reference documentation for these calls:

• AddMemberMessageAAQToPartner - Enables a buyer and seller in an order relationship to send messages to each other's My Messages Inboxes.
• AddMemberMessageRTQ - Enables a seller to reply to a question about an active item listing.

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"?>
<AddMemberMessagesAAQToBidderRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <AddMemberMessagesAAQToBidderRequestContainer> AddMemberMessagesAAQToBidderRequestContainerType
    <CorrelationID> string </CorrelationID>
    <ItemID> string </ItemID>
    <MemberMessage> MemberMessageType
      <Body> string </Body>
      <EmailCopyToSender> boolean </EmailCopyToSender>
      <RecipientID> string </RecipientID>
      <!-- ... more RecipientID values allowed here ... -->
    </MemberMessage>
  </AddMemberMessagesAAQToBidderRequestContainer>
  <!-- ... more AddMemberMessagesAAQToBidderRequestContainer nodes allowed here ... -->
  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</AddMemberMessagesAAQToBidderRequest>

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"?>
<AddMemberMessagesAAQToBidderResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <AddMemberMessagesAAQToBidderResponseContainer> AddMemberMessagesAAQToBidderResponseContainerType
    <Ack> AckCodeType </Ack>
    <CorrelationID> string </CorrelationID>
  </AddMemberMessagesAAQToBidderResponseContainer>
  <!-- ... more AddMemberMessagesAAQToBidderResponseContainer nodes allowed here ... -->
  <!-- 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>
</AddMemberMessagesAAQToBidderResponse>

Detail Controls

DetailLevel

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

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.

Sends messages to two users who have made Best Offers on an item.

Description

Seller m***************r listed an item with a Best Offer option. She received two offers on the book, and she can use AddMemberMessagesAAQToBidder to send messages each bidder with the results of their offers.

Input

This request contains two AddMemberMessagesAAQToBidderRequestContainer nodes, one for each message being sent. Note that the ItemId is the same for each message, although you can use one call to send messages regarding more than a single item. Use CorrelationID values to make it easier to interpret the results.

XML format.

<?xml version="1.0" encoding="utf-8"?>
<AddMemberMessagesAAQToBidderRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>A*******3</eBayAuthToken>
  </RequesterCredentials>
  <AddMemberMessagesAAQToBidderRequestContainer>
    <!-- This is a seller-defined value, and is used to match up each member message in the response -->
    <CorrelationID>1</CorrelationID>
    <!-- The user making this call must be the seller of the listing ID posted below -->
    <ItemID>1**********2</ItemID>
    <MemberMessage>
      <Body>
        Greetings! Thank you for your offer. In fact, you made the Best Offer,
        so I am happy to inform you that you won the book.
      </Body>
      !-- The user ID of the buyer being sent the message -->
      <RecipientID>b************r</RecipientID>
    </MemberMessage>
  </AddMemberMessagesAAQToBidderRequestContainer>
  <AddMemberMessagesAAQToBidderRequestContainer>
    <CorrelationID>2</CorrelationID>
    <!-- This Item ID value should be the same for each buyer message being sent -->
    <ItemID>1**********2</ItemID>
    <MemberMessage>
      <Body>
        Greetings! Thank you for your offer. I am sorry to inform you that another
        bidder also made an offer, and I have decided to go with their offer.
        Good luck with your future bidding.
      </Body>
      <RecipientID>m*******r</RecipientID>
    </MemberMessage>
  </AddMemberMessagesAAQToBidderRequestContainer>
</AddMemberMessagesAAQToBidderRequest>

Output

The results from this call show that the overall call succeeded, as well as each message within the call.

XML format.
<?xml version="1.0" encoding="utf-8"?>
<AddMemberMessagesAAQToBidderResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2018-10-29T18:36:52.001Z</Timestamp>
  <Ack>Success</Ack>
  <Version>1081</Version>
  <Build>e1081_core_Bundled_2854399_R1</Build>
   <AddMemberMessagesAAQToBidderResponseContainer>
    <CorrelationID>*1</CorrelationID>
    <Ack>Success</Ack>
  </AddMemberMessagesAAQToBidderResponseContainer>
  <AddMemberMessagesAAQToBidderResponseContainer>
    <CorrelationID>*2</CorrelationID>
    <Ack>Success</Ack>
  </AddMemberMessagesAAQToBidderResponseContainer>
</AddMemberMessagesAAQToBidderResponse>

Change History