Changes since
the last release

com.ebay.sdk.call
Class GetSellingManagerSaleRecordCall

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

public class GetSellingManagerSaleRecordCall
extends ApiCall

Wrapper class of the GetSellingManagerSaleRecord 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 sale record. Unless the OrderID or OrderLineItemID value is specified in the request, the ItemID and TransactionID fields must be used to identify the Selling Manager sale record 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 associated with the Selling Manager sale record. Unless the OrderID or OrderLineItemID value is specified in the request, the ItemID and TransactionID fields must be used to identify the Selling Manager sale record 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 Invoice) order associated with the Selling Manager sale record(s).

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 Invoice order, the OrderIDvalue is created by eBay when the buyer or seller (sharing multiple, common order line items) combines multiple order line items into a Combined Invoice order through the eBay site (or when the seller creates Combined Invoice order through AddOrder). If an OrderID is used in the request, the OrderLineItemID and ItemID/TransactionID pair are not required.
Input property: OrderLineItemID - A unique identifier for an eBay order line item that is associated with the Selling Manager sale record. 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/Transaction pair is specified in the GetSellingManagerSaleRecord request, the OrderLineItemID is required.

Output property: ReturnedSellingManagerSoldOrder - Contains the data in a Selling Manager Sale Record.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
GetSellingManagerSaleRecordCall()
          Constructor.
GetSellingManagerSaleRecordCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 java.lang.String getItemID()
          Gets the GetSellingManagerSaleRecordRequestType.itemID.
 java.lang.String getOrderID()
          Gets the GetSellingManagerSaleRecordRequestType.orderID.
 java.lang.String getOrderLineItemID()
          Gets the GetSellingManagerSaleRecordRequestType.orderLineItemID.
 SellingManagerSoldOrderType getReturnedSellingManagerSoldOrder()
          Valid after executing the API.
 SellingManagerSoldOrderType getSellingManagerSaleRecord()
          Retrieves the data for one or more Selling Manager sale records.
 java.lang.String getTransactionID()
          Gets the GetSellingManagerSaleRecordRequestType.transactionID.
 void setItemID(java.lang.String itemID)
          Sets the GetSellingManagerSaleRecordRequestType.itemID.
 void setOrderID(java.lang.String orderID)
          Sets the GetSellingManagerSaleRecordRequestType.orderID.
 void setOrderLineItemID(java.lang.String orderLineItemID)
          Sets the GetSellingManagerSaleRecordRequestType.orderLineItemID.
 void setTransactionID(java.lang.String transactionID)
          Sets the GetSellingManagerSaleRecordRequestType.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

GetSellingManagerSaleRecordCall

public GetSellingManagerSaleRecordCall()
Constructor.


GetSellingManagerSaleRecordCall

public GetSellingManagerSaleRecordCall(ApiContext apiContext)
Constructor.

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

getSellingManagerSaleRecord

public SellingManagerSoldOrderType getSellingManagerSaleRecord()
                                                        throws ApiException,
                                                               SdkException,
                                                               java.lang.Exception
Retrieves the data for one or more Selling Manager sale records.

The standard Trading API deprecation process is not applicable to this call. The user must have a Selling Manager Pro subscription to use this call.

Returns:
The SellingManagerSoldOrderType object.
Throws:
ApiException
SdkException
java.lang.Exception

getItemID

public java.lang.String getItemID()
Gets the GetSellingManagerSaleRecordRequestType.itemID.

Returns:
String

setItemID

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

Parameters:
itemID - String

getOrderID

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

Returns:
String

setOrderID

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

Parameters:
orderID - String

getOrderLineItemID

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

Returns:
String

setOrderLineItemID

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

Parameters:
orderLineItemID - String

getTransactionID

public java.lang.String getTransactionID()
Gets the GetSellingManagerSaleRecordRequestType.transactionID.

Returns:
String

setTransactionID

public void setTransactionID(java.lang.String transactionID)
Sets the GetSellingManagerSaleRecordRequestType.transactionID.

Parameters:
transactionID - String

getReturnedSellingManagerSoldOrder

public SellingManagerSoldOrderType getReturnedSellingManagerSoldOrder()
Valid after executing the API. Gets the returned GetSellingManagerSaleRecordResponseType.returnedSellingManagerSoldOrder.

Returns:
SellingManagerSoldOrderType

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.