Overview 
Namespace 
WSDL 
Schema 
 Component 
Index 
PREV C-TYPE   NEXT C-TYPE
FRAMES   NO FRAMES NS-Bindings
SUMMARY: XML REP | DERIVED | USE
DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD
eBay Trading API
complexType "ns:SetUserNotesRequestType"
Namespace:
urn:ebay:apis:eBLBaseComponents
Content:
complex, 17 elements, elem. wildcard
Defined:
globally in Schema in ebaySvc.wsdl; see XML source
Includes:
definitions of 7 elements
Used:
at 1 location
Component Diagram
XML Representation Summary
<...>
   
Content: 
ns:DetailLevel*, ns:ErrorLanguage?, ns:MessageID?, ns:Version?, ns:EndUserIP?, ns:ErrorHandling?, ns:InvocationID?, ns:OutputSelector*, ns:WarningLevel?, ns:BotBlock?, {any}*, ns:ItemID?, ns:Action?, ns:NoteText?, ns:TransactionID?, ns:VariationSpecifics?, ns:SKU?, ns:OrderLineItemID?
</...>
All Direct / Indirect Based Elements (1):
ns:SetUserNotesRequest
Known Usage Locations
Annotation
Enables users to add, modify, or delete a pinned note for any item that is being tracked in the My eBay All Selling and All Buying areas.
Type Definition Detail
Type Derivation Tree
ns:AbstractRequestType (extension)
  ns:SetUserNotesRequestType
XML Source (w/o annotations (8); see within schema source)
<xs:complexType name="SetUserNotesRequestType">
<xs:complexContent>
<xs:extension base="ns:AbstractRequestType">
<xs:sequence>
<xs:element minOccurs="0" name="ItemID" type="ns:ItemIDType"/>
<xs:element minOccurs="0" name="Action" type="ns:SetUserNotesActionCodeType"/>
<xs:element minOccurs="0" name="NoteText" type="xs:string"/>
<xs:element minOccurs="0" name="TransactionID" type="xs:string"/>
<xs:element minOccurs="0" name="VariationSpecifics" type="ns:NameValueListArrayType"/>
<xs:element minOccurs="0" name="SKU" type="ns:SKUType"/>
<xs:element minOccurs="0" name="OrderLineItemID" type="xs:string"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
Content Element Detail (all declarations defined in this component; 7/18)
ns:Action
Type:
ns:SetUserNotesActionCodeType, simple content
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.
XML Representation Summary
<ns:Action>
   
Content: 
{ enumeration of xs:token }
</ns:Action>
Simple Content
Enumeration:
"AddOrUpdate"
 - 
Creates or replaces an item's My eBay notes. Note that if the specified item already has notes in My eBay, the new notes will completely replace the existing notes. They will not be appended.
"Delete"
 - 
Deletes any existing My eBay notes for the specified item. Specifying Delete when no notes exist does nothing, but does not return an error.
"CustomCode"
 - 
Reserved for internal or future use.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="Action" type="ns:SetUserNotesActionCodeType"/>
ns:ItemID
Type:
ns:ItemIDType, simple content
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.
XML Representation Summary
<ns:ItemID>
   
Content: 
{ xs:string }
</ns:ItemID>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ItemID" type="ns:ItemIDType"/>
ns:NoteText
Type:
xs:string, predefined, simple content
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.
XML Representation Summary
<ns:NoteText>
   
Content: 
{ xs:string }
</ns:NoteText>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="NoteText" type="xs:string"/>
ns:OrderLineItemID
Type:
xs:string, predefined, simple content
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. OrderLineItemID can be used in the input instead of an ItemID/TransactionID pair to identify an order line item.

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.
XML Representation Summary
<ns:OrderLineItemID>
   
Content: 
{ xs:string }
</ns:OrderLineItemID>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="OrderLineItemID" type="xs:string"/>
ns:SKU
Type:
ns:SKUType, simple content
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.

This field can only be used if the Item.InventoryTrackingMethod field (set with the AddFixedPriceItem or RelistFixedPriceItem calls) is set to SKU.

If a specific order line item is targeted in the request with an ItemID/TransactionID pair or an OrderLineItemID value, any specified SKU is ignored by the call.
XML Representation Summary
<ns:SKU>
   
Content: 
{ xs:string }
</ns:SKU>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="SKU" type="ns:SKUType"/>
ns:TransactionID
Type:
xs:string, predefined, simple content
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.

The TransactionID value for auction listings is always 0 since there can be only one winning bidder/one sale for an auction listing.
XML Representation Summary
<ns:TransactionID>
   
Content: 
{ xs:string }
</ns:TransactionID>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="TransactionID" type="xs:string"/>
ns:VariationSpecifics
Type:
ns:NameValueListArrayType, complex content
Container consisting of name-value pairs that identify (match) one variation within a fixed-price, multiple-variation listing. The specified name-value pair(s) must exist in the listing specified by either the ItemID or SKU values specified in the request. If a specific order line item is targeted in the request with an ItemID/TransactionID pair or an OrderLineItemID value, any specified VariationSpecifics container is ignored by the call.
Component Diagram
XML Representation Summary
<ns:VariationSpecifics>
   
Content: 
ns:NameValueList*
</ns:VariationSpecifics>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="VariationSpecifics" type="ns:NameValueListArrayType"/>
Overview 
Namespace 
WSDL 
Schema 
 Component 
Index 
PREV C-TYPE   NEXT C-TYPE
FRAMES   NO FRAMES NS-Bindings
SUMMARY: XML REP | DERIVED | USE
DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD
eBay Trading API
WSDL documentation generated with FlexDoc/XML 1.13 using FlexDoc/XML WSDLDoc 1.2.5 template set. All XSD diagrams generated by FlexDoc/XML DiagramKit.