Changes since
the last release

com.ebay.sdk.call
Class GetSellingManagerEmailLogCall

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

public class GetSellingManagerEmailLogCall
extends ApiCall

Wrapper class of the GetSellingManagerEmailLog 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 - Unique identifier for the eBay item listing associated with the Selling Manager email log. Unless the OrderID or OrderLineItemID value is specified in the request, the ItemID and TransactionID fields must be used to identify the Selling Manager email log to retrieve. You can use GetSellingManagerSoldListings to retrieve the ItemID, TransactionID or OrderLineItemID values that correspond to the Selling Manager sale record (SaleRecordID). All four of these fields are returned under the SellingManagerSoldTransaction container of the GetSellingManagerSoldListings request.
Input property: TransactionID - Unique identifier for the order line item (transaction) associated with the Selling Manager email log. Unless the OrderID or OrderLineItemID value is specified in the request, the ItemID and TransactionID fields must be used to identify the Selling Manager email log to retrieve. You can use GetSellingManagerSoldListings to retrieve the ItemID, TransactionID or OrderLineItemID values that correspond to the Selling Manager sale record (SaleRecordID). All four of these fields are returned under the SellingManagerSoldTransaction container of the GetSellingManagerSoldListings request.
Input property: OrderID - A unique identifier that identifies a single line item or multiple line item (Combined Payment) order associated with the Selling Manager email log.

For a single line item order, the OrderID value is identical to the OrderLineItemID value that is generated upon creation of the order line item. For a Combined Payment order, the OrderID value is created by eBay when the buyer or seller (sharing multiple, common order line items) combines multiple order line items into a Combined Payment order through the eBay site (or when the seller creates Combined Payment order through AddOrder). If an OrderID is used in the request, the OrderLineItemID and ItemID/TransactionID pair are not required.
Input property: EmailDateRange - Specifies the earliest (oldest) and latest (most recent) dates to use in a date range filter based on email sent date. Each of the time ranges can be up to 90 days.
Input property: OrderLineItemID - A unique identifier for an eBay order line item that is associated with the Selling Manager email log. 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. You can use GetSellingManagerSoldListings to retrieve the ItemID, TransactionID or OrderLineItemID values that correspond to the Selling Manager sale record (SaleRecordID). All four of these fields are returned under the SellingManagerSoldTransaction container of the GetSellingManagerSoldListings request. Unless an OrderID or an ItemID/TransactionID pair is specified in the GetSellingManagerSaleRecord request, the OrderLineItemID is required.

Output property: ReturnedEmailLog - Email logs associated with this order.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
GetSellingManagerEmailLogCall()
          Constructor.
GetSellingManagerEmailLogCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 TimeRangeType getEmailDateRange()
          Gets the GetSellingManagerEmailLogRequestType.emailDateRange.
 String getItemID()
          Gets the GetSellingManagerEmailLogRequestType.itemID.
 String getOrderID()
          Gets the GetSellingManagerEmailLogRequestType.orderID.
 String getOrderLineItemID()
          Gets the GetSellingManagerEmailLogRequestType.orderLineItemID.
 SellingManagerEmailLogType[] getReturnedEmailLog()
          Valid after executing the API.
 SellingManagerEmailLogType[] getSellingManagerEmailLog()
          Retrieves a log of emails sent, or scheduled to be sent, to buyers.
 Long getTransactionID()
          Gets the GetSellingManagerEmailLogRequestType.transactionID.
 void setEmailDateRange(TimeRangeType emailDateRange)
          Sets the GetSellingManagerEmailLogRequestType.emailDateRange.
 void setItemID(String itemID)
          Sets the GetSellingManagerEmailLogRequestType.itemID.
 void setOrderID(String orderID)
          Sets the GetSellingManagerEmailLogRequestType.orderID.
 void setOrderLineItemID(String orderLineItemID)
          Sets the GetSellingManagerEmailLogRequestType.orderLineItemID.
 void setTransactionID(Long transactionID)
          Sets the GetSellingManagerEmailLogRequestType.transactionID.
 
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

GetSellingManagerEmailLogCall

public GetSellingManagerEmailLogCall()
Constructor.


GetSellingManagerEmailLogCall

public GetSellingManagerEmailLogCall(ApiContext apiContext)
Constructor.

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

getSellingManagerEmailLog

public SellingManagerEmailLogType[] getSellingManagerEmailLog()
                                                       throws ApiException,
                                                              SdkException,
                                                              Exception
Retrieves a log of emails sent, or scheduled to be sent, to buyers.

The standard Trading API deprecation process is not applicable to this call.

Returns:
The SellingManagerEmailLogType[] object.
Throws:
ApiException
SdkException
Exception

getEmailDateRange

public TimeRangeType getEmailDateRange()
Gets the GetSellingManagerEmailLogRequestType.emailDateRange.

Returns:
TimeRangeType

setEmailDateRange

public void setEmailDateRange(TimeRangeType emailDateRange)
Sets the GetSellingManagerEmailLogRequestType.emailDateRange.

Parameters:
emailDateRange - TimeRangeType

getItemID

public String getItemID()
Gets the GetSellingManagerEmailLogRequestType.itemID.

Returns:
String

setItemID

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

Parameters:
itemID - String

getOrderID

public String getOrderID()
Gets the GetSellingManagerEmailLogRequestType.orderID.

Returns:
String

setOrderID

public void setOrderID(String orderID)
Sets the GetSellingManagerEmailLogRequestType.orderID.

Parameters:
orderID - String

getOrderLineItemID

public String getOrderLineItemID()
Gets the GetSellingManagerEmailLogRequestType.orderLineItemID.

Returns:
String

setOrderLineItemID

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

Parameters:
orderLineItemID - String

getTransactionID

public Long getTransactionID()
Gets the GetSellingManagerEmailLogRequestType.transactionID.

Returns:
Long

setTransactionID

public void setTransactionID(Long transactionID)
Sets the GetSellingManagerEmailLogRequestType.transactionID.

Parameters:
transactionID - Long

getReturnedEmailLog

public SellingManagerEmailLogType[] getReturnedEmailLog()
Valid after executing the API. Gets the returned GetSellingManagerEmailLogResponseType.returnedEmailLog.

Returns:
SellingManagerEmailLogType[]

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.