SetUserNotes

Use this call to add, replace, and delete My eBay notes for items that are being tracked in the My eBay Selling and Buying areas.

You can use SetUserNotes to add notes to items that are being tracked in a user's My eBay page, including items the user is selling, items the user is bidding on, and items in the user's watch list. A note is a small piece of text that can be used however a user wants, although its intended use is to help a user attach additional reminders to an item, such as "This item would make a great gift for Mom."

If the call to SetUserNotes is successful, it returns the fields of the abstract response object (there are no call-specific return fields). This serves as confirmation that the authentication URL information was successfully submitted. If unsuccessful, it returns an error construct (see Error Handling).

You only need to make this call when you are adding, updating, or deleting the notes for a user. eBay does not place any restrictions on the number of times a note can be changed.

You can test this call in the Sandbox. To test SetUserNotes:

1. Find an item listed on the eBay Sandbox web site: http://sandbox.ebay.com
2. Sign-in as a test user and add the item to that user's watch list.
3. Get the item ID for the item, and use SetUserNotes to add a note to that item.
4. On the test user's My eBay page, look at the watch list and see that the note has been added for the item.

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"?>
<SetUserNotesRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <Action> SetUserNotesActionCodeType </Action>
  <ItemID> ItemIDType (string) </ItemID>
  <NoteText> string </NoteText>
  <OrderLineItemID> string </OrderLineItemID>
  <SKU> SKUType (string) </SKU>
  <TransactionID> string </TransactionID>
  <VariationSpecifics> NameValueListArrayType
    <NameValueList> NameValueListType
      <Name> string </Name>
      <Value> string </Value>
      <!-- ... more Value values allowed here ... -->
    </NameValueList>
    <!-- ... more NameValueList nodes allowed here ... -->
  </VariationSpecifics>
  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</SetUserNotesRequest>

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"?>
<SetUserNotesResponse 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>
</SetUserNotesResponse>

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.

Sets a note on an item of interest.

Description

A prospective buyer is looking for toaster ovens and she thinks she found one at a good price.

Input

XML format.

<?xml version="1.0" encoding="utf-8"?> 
<SetUserNotesRequest xmlns="urn:ebay:apis:eBLBaseComponents"> 
  <RequesterCredentials> 
    <eBayAuthToken>A*******3</eBayAuthToken> 
  </RequesterCredentials> 
  <ItemID>8**********0</ItemID> 
  <Action>AddOrUpdate</Action> 
  <NoteText>This could be the best buy.</NoteText> 
</SetUserNotesRequest>

Output

XML format.
<?xml version="1.0" encoding="utf-8"?> 
<SetUserNotesResponse xmlns="urn:ebay:apis:eBLBaseComponents"> 
  <Timestamp>2019-11-07T18:40:10.893Z</Timestamp> 
  <Ack>Success</Ack> 
  <Version>1125</Version>
  <Build>E1125_CORE_API_19070409_R1</Build> 
</SetUserNotesResponse>

Change History