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 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 sales 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 order associated with the Selling Manager email log.

If an OrderID is used in the request, the OrderLineItemID and ItemID/TransactionID pair are not required.

Note: As of June 2019, eBay has changed the format of order identifier values. The new format is a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. Unlike in the past, instead of just being known and exposed to the seller, these unique order identifiers will also be known and used/referenced by the buyer and eBay customer support.

For developers and sellers who are already integrated with the Trading API's order management calls, this change shouldn't impact your integration unless you parse the existing order identifiers (e.g., OrderID or OrderLineItemID), or otherwise infer meaning from the format (e.g., differentiating between a single line item order versus a multiple line item order). Because we realize that some integrations may have logic that is dependent upon the old identifier format, eBay is rolling out this Trading API change with version control to support a transition period of approximately 9 months before applications must switch to the new format completely.

During the transition period, for developers/sellers using a Trading WSDL older than Version 1113, they can use the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header in API calls to control whether the new or old OrderID format is returned in call response payloads. To get the new OrderID format, the value of the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header must be set to 1113. During the transition period and even after, the new and old OrderID formats will still be supported/accepted in all Trading API call request payloads. After the transition period (which will be announced), only the new OrderID format will be returned in all Trading API call response payloads, regardless of the Trading WSDL version used or specified compatibility level.

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 (bidder wins the auction, buyer clicks buy button, or buyer purchases item through PlaceOffer call).

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 field 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.
 java.lang.String getItemID()
          Gets the GetSellingManagerEmailLogRequestType.itemID.
 java.lang.String getOrderID()
          Gets the GetSellingManagerEmailLogRequestType.orderID.
 java.lang.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.
 java.lang.Long getTransactionID()
          Gets the GetSellingManagerEmailLogRequestType.transactionID.
 void setEmailDateRange(TimeRangeType emailDateRange)
          Sets the GetSellingManagerEmailLogRequestType.emailDateRange.
 void setItemID(java.lang.String itemID)
          Sets the GetSellingManagerEmailLogRequestType.itemID.
 void setOrderID(java.lang.String orderID)
          Sets the GetSellingManagerEmailLogRequestType.orderID.
 void setOrderLineItemID(java.lang.String orderLineItemID)
          Sets the GetSellingManagerEmailLogRequestType.orderLineItemID.
 void setTransactionID(java.lang.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, isEnableoAuthTokenHTTPHeader, removeSendRequestListener, setApiContext, setBotBlock, setCallRetry, setDetailLevel, setEnableCompression, setEnableoAuthTokenHTTPHeader, 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,
                                                              java.lang.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
java.lang.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 java.lang.String getItemID()
Gets the GetSellingManagerEmailLogRequestType.itemID.

Returns:
String

setItemID

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

Parameters:
itemID - String

getOrderID

public java.lang.String getOrderID()
Gets the GetSellingManagerEmailLogRequestType.orderID.

Returns:
String

setOrderID

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

Parameters:
orderID - String

getOrderLineItemID

public java.lang.String getOrderLineItemID()
Gets the GetSellingManagerEmailLogRequestType.orderLineItemID.

Returns:
String

setOrderLineItemID

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

Parameters:
orderLineItemID - String

getTransactionID

public java.lang.Long getTransactionID()
Gets the GetSellingManagerEmailLogRequestType.transactionID.

Returns:
Long

setTransactionID

public void setTransactionID(java.lang.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.