Changes since
the last release

com.ebay.sdk.call
Class SetUserNotesCall

java.lang.Object
  extended by com.ebay.sdk.ApiCall
      extended by com.ebay.sdk.call.SetUserNotesCall

public class SetUserNotesCall
extends ApiCall

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.


Input property: ItemID - ID of the item to which the My eBay note will be attached. Notes can only be added to items that are currently being tracked in My eBay.
Input property: 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 a an existing user note.
Input property: NoteText - Text of the note. Maximum 250 characters. Required only if the Action is AddOrUpdate. This note text will completely replace any existing My eBay note for the specified item.
Input property: TransactionID - Unique identifier for the order line item (transaction) 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.
Input property: VariationSpecifics - Container consisting of name-value pairs that identify (match) one variation within a fixed-price, multi-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.
Input property: 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, multi- 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.
Input property: 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, 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.

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.

Version:
1.0
Author:
Ron Murphy

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.
 String getItemID()
          Gets the SetUserNotesRequestType.itemID.
 String getNoteText()
          Gets the SetUserNotesRequestType.noteText.
 String getOrderLineItemID()
          Gets the SetUserNotesRequestType.orderLineItemID.
 String getSKU()
          Gets the SetUserNotesRequestType.sKU.
 String getTransactionID()
          Gets the SetUserNotesRequestType.transactionID.
 NameValueListArrayType getVariationSpecifics()
          Gets the SetUserNotesRequestType.variationSpecifics.
 void setAction(SetUserNotesActionCodeType action)
          Sets the SetUserNotesRequestType.action.
 void setItemID(String itemID)
          Sets the SetUserNotesRequestType.itemID.
 void setNoteText(String noteText)
          Sets the SetUserNotesRequestType.noteText.
 void setOrderLineItemID(String orderLineItemID)
          Sets the SetUserNotesRequestType.orderLineItemID.
 void setSKU(String sKU)
          Sets the SetUserNotesRequestType.sKU.
 void setTransactionID(String transactionID)
          Sets the SetUserNotesRequestType.transactionID.
 void setUserNotes()
          Enables users to add, replace, and delete My eBay notes for items that are being tracked in the My eBay All Selling and All Buying areas.
 void setVariationSpecifics(NameValueListArrayType variationSpecifics)
          Sets the SetUserNotesRequestType.variationSpecifics.
 
Methods inherited from class com.ebay.sdk.ApiCall
addDetailLevel, addSendRequestListener, execute, executeByApiName, getApiContext, getApiException, getBotBlock, getCallRetry, getDetailLevel, getEnableCompression, getEndUserIP, getErrorHandling, getInvocationID, getMessageID, getOutputSelector, getRequestXml, getResponseObject, getResponseXml, getSite, getWarningLevel, hasError, hasWarning, removeSendRequestListener, setApiContext, setBotBlock, setCallRetry, setDetailLevel, setEnableCompression, setEndUserIP, setErrorHandling, setInvocationID, setMessageID, setOutputSelector, setSite, setWarningLevel
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SetUserNotesCall

public SetUserNotesCall()
Constructor.


SetUserNotesCall

public SetUserNotesCall(ApiContext apiContext)
Constructor.

Parameters:
apiContext - The ApiContext object to be used to make the call.
Method Detail

setUserNotes

public void setUserNotes()
                  throws ApiException,
                         SdkException,
                         Exception
Enables users to add, replace, and delete My eBay notes for items that are being tracked in the My eBay All Selling and All Buying areas.

Throws:
ApiException
SdkException
Exception

getAction

public SetUserNotesActionCodeType getAction()
Gets the SetUserNotesRequestType.action.

Returns:
SetUserNotesActionCodeType

setAction

public void setAction(SetUserNotesActionCodeType action)
Sets the SetUserNotesRequestType.action.

Parameters:
action - SetUserNotesActionCodeType

getItemID

public String getItemID()
Gets the SetUserNotesRequestType.itemID.

Returns:
String

setItemID

public void setItemID(String itemID)
Sets the SetUserNotesRequestType.itemID.

Parameters:
itemID - String

getNoteText

public String getNoteText()
Gets the SetUserNotesRequestType.noteText.

Returns:
String

setNoteText

public void setNoteText(String noteText)
Sets the SetUserNotesRequestType.noteText.

Parameters:
noteText - String

getOrderLineItemID

public String getOrderLineItemID()
Gets the SetUserNotesRequestType.orderLineItemID.

Returns:
String

setOrderLineItemID

public void setOrderLineItemID(String orderLineItemID)
Sets the SetUserNotesRequestType.orderLineItemID.

Parameters:
orderLineItemID - String

getSKU

public String getSKU()
Gets the SetUserNotesRequestType.sKU.

Returns:
String

setSKU

public void setSKU(String sKU)
Sets the SetUserNotesRequestType.sKU.

Parameters:
sKU - String

getTransactionID

public String getTransactionID()
Gets the SetUserNotesRequestType.transactionID.

Returns:
String

setTransactionID

public void setTransactionID(String transactionID)
Sets the SetUserNotesRequestType.transactionID.

Parameters:
transactionID - String

getVariationSpecifics

public NameValueListArrayType getVariationSpecifics()
Gets the SetUserNotesRequestType.variationSpecifics.

Returns:
NameValueListArrayType

setVariationSpecifics

public void setVariationSpecifics(NameValueListArrayType variationSpecifics)
Sets the SetUserNotesRequestType.variationSpecifics.

Parameters:
variationSpecifics - NameValueListArrayType

Changes since
the last release

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.