SetUserNotes
Add, replace, and delete My eBay notes for items that are being tracked in the My eBay Selling and Buying areas.
Note: This procedure makes use of indexed parameters. These input parameters are denoted with a '#' character at the end of their names.
Indexed parameters facilitate providing multiple instances a single parameter as inputs for the procedure.
Suppose there is an input parameter named Param#. Input multiple instances of an indexed parameter like this:
EXEC ProcedureName Param#1 = "value1", Param#2 = "value2", Param#3 = "value3"
Input
Name | Type | Required | Description |
Action | String | True | The seller must include this field and set it to 'AddOrUpdate' to add a new user note or update an existing user note, or set it to 'Delete' to delete an existing user note. |
ItemId | String | False | Unique identifier of the listing to which the My eBay note will be attached. Notes can only be added to items that are currently being tracked in My eBay. |
NoteText | String | False | This field is needed if the Action is AddOrUpdate. The text supplied in this field will completely replace any existing My eBay note for the specified item. |
OrderLineItemId | String | False | A unique identifier for an eBay order line item. This field is created as soon as there is a commitment to buy from the seller, and its value is based upon the concatenation of ItemID and TransactionID, with a hyphen in between these two IDs. OrderLineItemID can be used in the input instead of an ItemID/TransactionID pair to identify an order line item. |
SKU | String | False | SKU value of the item variation to which the My eBay note will be attached. Notes can only be added to items that are currently being tracked in My eBay. A SKU (stock keeping unit) value is defined by and used by the seller to identify a variation within a fixed-price, multiple- variation listing. The SKU value is assigned to a variation of an item through the Variations.Variation.SKU element. |
TransactionId | String | False | Unique identifier for the order line item to which the My eBay note will be attached. Notes can only be added to order line items that are currently being tracked in My eBay. Buyers can view user notes made on order line items in the PrivateNotes field of the WonList container in GetMyeBayBuying, and sellers can view user notes made on order line items in the PrivateNotes field of the SoldList and DeletedFromSoldList containers in GetMyeBaySellinging. |
VariationSpecificName# | String | False | Depending on the call and context, this value is either a name of an Item/Category/Variation Specific, or a Parts Compatibility name. |
VariationSpecificValue# | String | False | Depending on the call and context, this value is either the value of an Item/Category/Variation Specific, a Parts Compatibility value, or a product identifier. |
Result Set Columns
Name | Type | Description |
Success | String | This value shows a boolean indication of whether the operation was successful or not. |