|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ebay.sdk.ApiCall
com.ebay.sdk.call.SetUserNotesCall
public class SetUserNotesCall
Wrapper class of the SetUserNotes call of eBay SOAP API.
Title: SOAP API wrapper library.
Description: Contains wrapper classes for eBay SOAP APIs.
Copyright: Copyright (c) 2009
Company: eBay Inc.
ItemID
- 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.
Action
- 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.
NoteText
- 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.
TransactionID
- 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.
VariationSpecifics
- 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.
SKU
- 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.
OrderLineItemID
- 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.
Field Summary |
---|
Fields inherited from class com.ebay.sdk.ApiCall |
---|
apiException, sendReqListeners |
Constructor Summary | |
---|---|
SetUserNotesCall()
Constructor. |
|
SetUserNotesCall(ApiContext apiContext)
Constructor. |
Method Summary | |
---|---|
SetUserNotesActionCodeType |
getAction()
Gets the SetUserNotesRequestType.action. |
java.lang.String |
getItemID()
Gets the SetUserNotesRequestType.itemID. |
java.lang.String |
getNoteText()
Gets the SetUserNotesRequestType.noteText. |
java.lang.String |
getOrderLineItemID()
Gets the SetUserNotesRequestType.orderLineItemID. |
java.lang.String |
getSKU()
Gets the SetUserNotesRequestType.sKU. |
java.lang.String |
getTransactionID()
Gets the SetUserNotesRequestType.transactionID. |
NameValueListArrayType |
getVariationSpecifics()
Gets the SetUserNotesRequestType.variationSpecifics. |
void |
setAction(SetUserNotesActionCodeType action)
Sets the SetUserNotesRequestType.action. |
void |
setItemID(java.lang.String itemID)
Sets the SetUserNotesRequestType.itemID. |
void |
setNoteText(java.lang.String noteText)
Sets the SetUserNotesRequestType.noteText. |
void |
setOrderLineItemID(java.lang.String orderLineItemID)
Sets the SetUserNotesRequestType.orderLineItemID. |
void |
setSKU(java.lang.String sKU)
Sets the SetUserNotesRequestType.sKU. |
void |
setTransactionID(java.lang.String transactionID)
Sets the SetUserNotesRequestType.transactionID. |
void |
setUserNotes()
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. |
void |
setVariationSpecifics(NameValueListArrayType variationSpecifics)
Sets the SetUserNotesRequestType.variationSpecifics. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SetUserNotesCall()
public SetUserNotesCall(ApiContext apiContext)
apiContext
- The ApiContext object to be used to make the call.Method Detail |
---|
public void setUserNotes() throws ApiException, SdkException, java.lang.Exception
ApiException
SdkException
java.lang.Exception
public SetUserNotesActionCodeType getAction()
public void setAction(SetUserNotesActionCodeType action)
action
- SetUserNotesActionCodeTypepublic java.lang.String getItemID()
public void setItemID(java.lang.String itemID)
itemID
- Stringpublic java.lang.String getNoteText()
public void setNoteText(java.lang.String noteText)
noteText
- Stringpublic java.lang.String getOrderLineItemID()
public void setOrderLineItemID(java.lang.String orderLineItemID)
orderLineItemID
- Stringpublic java.lang.String getSKU()
public void setSKU(java.lang.String sKU)
sKU
- Stringpublic java.lang.String getTransactionID()
public void setTransactionID(java.lang.String transactionID)
transactionID
- Stringpublic NameValueListArrayType getVariationSpecifics()
public void setVariationSpecifics(NameValueListArrayType variationSpecifics)
variationSpecifics
- NameValueListArrayType
|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The information contained in this document is proprietary and confidential.
Use of this information and the eBay API requires a Non-Disclosure Agreement (NDA) between the user and eBay Inc.
For information regarding a qualifying NDA, contact Developer Relations:
developer-relations@ebay.com
© 2004-2009 eBay Inc. All rights reserved.