|
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.GetSellerTransactionsCall
public class GetSellerTransactionsCall
Wrapper class of the GetSellerTransactions 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.
ModifiedTimeFilter
- Helper wrapper to set GetSellerTransactionsRequestType ModTimeFrom, ModTimeTo:
TimeFrom sets GetSellerTransactionsRequestType.ModTimeFrom:
The ModTimeFrom and ModTimeTo fields specify a date range for retrieving order line items associated with the seller. The ModTimeFrom field is the starting date range. All of the seller's order line items that were last modified within this date range are returned in the output. The maximum date range that may be specified is 30 days. This value cannot be set back more than 90 days in the past, as this call cannot retrieve sales older than 90 days old. This field is not applicable if the NumberOfDays date filter is used.
Pagination
- Child elements control pagination of the output. Use EntriesPerPage property to
control the number of transactions to return per call and PageNumber property to
specify the page of data to return.
IncludeFinalValueFee
- Indicates whether to include Final Value Fee (FVF) in the response. For most listing types, the Final Value Fee is returned in Transaction.FinalValueFee. The Final Value Fee is returned for each order line item.
IncludeContainingOrder
- Include this field and set it to true
if you want the ContainingOrder container to be returned in the response under each Transaction node. For single line item orders, the ContainingOrder.OrderID value takes the value of the OrderLineItemID value for the order line item. For Combined Invoice orders, the ContainingOrder.OrderID value will be shared by at least two order line items (transactions) that are part of the same order.
SKUArray
- Container for a set of SKUs. Filters (reduces) the response to only include order line items for listings that include any of the specified SKUs. If multiple listings include the same SKU, order line items for all of them are returned (assuming they also match the other criteria in the GetSellerTransactions request).InventoryTrackingMethod=SKU
, the response only includes order line items for listings that include InventoryTrackingMethod=SKU
and one of the requested SKUs.
Platform
- Note: This field's purpose is to allow the seller to retrieve only eBay listings or only Half.com listings instead of both order types. Since the Half.com site has been shut down, this field is no longer necessary to use since eBay orders will be the only orders that are retrieved.
The default behavior of GetSellerTransactions is to retrieve all order line items originating from eBay.com and Half.com. If the user wants to retrieve only eBay.com order line items or Half.com order line items, this filter can be used to perform that function. Inserting 'eBay' into this field will restrict retrieved order line items to those originating on eBay.com, and inserting 'Half' into this field will restrict retrieved order line items to those originating on Half.com.
NumberOfDays
- Enables you to specify the number of days' worth of new and modified
order line items that you want to retrieve. The maximum value for this field is 30
InventoryTrackingMethod
- Filters the response to only include order line items for listings
that match this InventoryTrackingMethod setting. InventoryTrackingMethod
= SKU
and one of the
requested SKUs.
IncludeCodiceFiscale
- If this field is included in the call request and set to true
, taxpayer identification information for the buyer is returned under the BuyerTaxIdentifier PaginationResult
- Container consisting of the total number of order line items that match the input criteria and the total number of pages that must be scrolled through to view all order line items. To scroll through each page of order line item data, make subsequent GetSellerTransactions calls, incrementing the Pagination.PageNumber field by a value of '1' each time.
HasMoreTransactions
- This flag indicates whether there are additional pages of order line items to view. This field will be returned as true
if there are additional pages or order line items to view
, or false
if the current page of order line item data is the last page of data.
ReturnedTransactionsPerPage
- This value indicates the number of order line items returned per page (per call) and is controlled by the Pagination.EntriesPerPage value passed in the call request. Unless it is the last (or possibly only) page of data (HasMoreTransactions=false), the TransactionsPerPage value should equal the Pagination.EntriesPerPage value passed in the call request. ReturnedPageNumber
- This value indicates the page number of retrieved order line items that match the input criteria. This value is controlled by the Pagination.PageNumber value passed in the call request. To scroll through all pages of order line items that match the input criteria, you increment the Pagination.PageNumber value by 1
with each subsequent GetSellerTransactions call.
ReturnedTransactionCountActual
- This value indicates the total number of (non-empty) order line items retrieved in the current page of results. The ReturnedTransactionCountActual value will be lower than the TransactionsPerPage value if one or more empty order line items are retrieved on the page. Seller
- Contains information about the seller whose order line items are being returned.
See the reference guide for information about the Seller object fields
that are returned.
ReturnedTransactions
- List of Transaction objects representing the seller's recent sales.
Each Transaction object contains the data for one purchase
(of one or more items in the same listing).
See the reference guide for more information about the fields that are returned
for each order line item.
PayPalPreferred
- Indicates whether the seller has the preference enabled that shows that the seller
prefers PayPal as the method of payment for an item. This preference is indicated on
an item's View Item page and is intended to influence a buyer to use PayPal
to pay for the item.
Field Summary |
---|
Fields inherited from class com.ebay.sdk.ApiCall |
---|
apiException, sendReqListeners |
Constructor Summary | |
---|---|
GetSellerTransactionsCall()
Constructor. |
|
GetSellerTransactionsCall(ApiContext apiContext)
Constructor. |
Method Summary | |
---|---|
TransactionType[] |
getEntireSellerTransactions()
Get all seller transactions in specified date range. |
TransactionType[] |
getEntireSellerTransactions(TimeFilter modifiedTimeFilter)
Get all seller transactions in specified date range. |
boolean |
getHasMoreTransactions()
Valid after executing the API. |
java.lang.Boolean |
getIncludeCodiceFiscale()
Gets the GetSellerTransactionsRequestType.includeCodiceFiscale. |
java.lang.Boolean |
getIncludeContainingOrder()
Gets the GetSellerTransactionsRequestType.includeContainingOrder. |
java.lang.Boolean |
getIncludeFinalValueFee()
Gets the GetSellerTransactionsRequestType.includeFinalValueFee. |
InventoryTrackingMethodCodeType |
getInventoryTrackingMethod()
Gets the GetSellerTransactionsRequestType.inventoryTrackingMethod. |
TimeFilter |
getModifiedTimeFilter()
Gets the GetSellerTransactionsRequestType.modifiedTimeFilter. |
java.lang.Integer |
getNumberOfDays()
Gets the GetSellerTransactionsRequestType.numberOfDays. |
PaginationType |
getPagination()
Gets the GetSellerTransactionsRequestType.pagination. |
PaginationResultType |
getPaginationResult()
Valid after executing the API. |
boolean |
getPayPalPreferred()
Valid after executing the API. |
TransactionPlatformCodeType |
getPlatform()
Gets the GetSellerTransactionsRequestType.platform. |
java.lang.Integer |
getReturnedPageNumber()
Valid after executing the API. |
int |
getReturnedTransactionCountActual()
Valid after executing the API. |
TransactionType[] |
getReturnedTransactions()
Valid after executing the API. |
java.lang.Integer |
getReturnedTransactionsPerPage()
Valid after executing the API. |
UserType |
getSeller()
Valid after executing the API. |
TransactionType[] |
getSellerTransactions()
Retrieves transaction information for the user for which the call is made (and not for any other user), where a transaction is the information about the sale of one or more items by one buyer from a single listing. |
TransactionType[] |
getSellerTransactions(TimeFilter modifiedTimeFilter)
Executes the API. |
SKUArrayType |
getSKUArray()
Gets the GetSellerTransactionsRequestType.sKUArray. |
TimeFilter |
getTimeFilter()
|
void |
setIncludeCodiceFiscale(java.lang.Boolean includeCodiceFiscale)
Sets the GetSellerTransactionsRequestType.includeCodiceFiscale. |
void |
setIncludeContainingOrder(java.lang.Boolean includeContainingOrder)
Sets the GetSellerTransactionsRequestType.includeContainingOrder. |
void |
setIncludeFinalValueFee(java.lang.Boolean includeFinalValueFee)
Sets the GetSellerTransactionsRequestType.includeFinalValueFee. |
void |
setInventoryTrackingMethod(InventoryTrackingMethodCodeType inventoryTrackingMethod)
Sets the GetSellerTransactionsRequestType.inventoryTrackingMethod. |
void |
setModifiedTimeFilter(TimeFilter modifiedTimeFilter)
Sets the GetSellerTransactionsRequestType.modifiedTimeFilter. |
void |
setNumberOfDays(java.lang.Integer numberOfDays)
Sets the GetSellerTransactionsRequestType.numberOfDays. |
void |
setPagination(PaginationType pagination)
Sets the GetSellerTransactionsRequestType.pagination. |
void |
setPlatform(TransactionPlatformCodeType platform)
Sets the GetSellerTransactionsRequestType.platform. |
void |
setSKUArray(SKUArrayType sKUArray)
Sets the GetSellerTransactionsRequestType.sKUArray. |
void |
setTimeFilter(TimeFilter timeFilter)
Sets time filter for transactions to be returned. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public GetSellerTransactionsCall()
public GetSellerTransactionsCall(ApiContext apiContext)
apiContext
- The ApiContext object to be used to make the call.Method Detail |
---|
public TransactionType[] getSellerTransactions() throws ApiException, SdkException, java.lang.Exception
ApiException
SdkException
java.lang.Exception
public java.lang.Boolean getIncludeCodiceFiscale()
public void setIncludeCodiceFiscale(java.lang.Boolean includeCodiceFiscale)
includeCodiceFiscale
- Booleanpublic java.lang.Boolean getIncludeContainingOrder()
public void setIncludeContainingOrder(java.lang.Boolean includeContainingOrder)
includeContainingOrder
- Booleanpublic java.lang.Boolean getIncludeFinalValueFee()
public void setIncludeFinalValueFee(java.lang.Boolean includeFinalValueFee)
includeFinalValueFee
- Booleanpublic InventoryTrackingMethodCodeType getInventoryTrackingMethod()
public void setInventoryTrackingMethod(InventoryTrackingMethodCodeType inventoryTrackingMethod)
inventoryTrackingMethod
- InventoryTrackingMethodCodeTypepublic TimeFilter getModifiedTimeFilter()
public void setModifiedTimeFilter(TimeFilter modifiedTimeFilter)
modifiedTimeFilter
- TimeFilterpublic java.lang.Integer getNumberOfDays()
public void setNumberOfDays(java.lang.Integer numberOfDays)
numberOfDays
- Integerpublic PaginationType getPagination()
public void setPagination(PaginationType pagination)
pagination
- PaginationTypepublic TransactionPlatformCodeType getPlatform()
public void setPlatform(TransactionPlatformCodeType platform)
platform
- TransactionPlatformCodeTypepublic SKUArrayType getSKUArray()
public void setSKUArray(SKUArrayType sKUArray)
sKUArray
- SKUArrayTypepublic TransactionType[] getEntireSellerTransactions() throws ApiException, SdkException, java.lang.Exception
ApiException
SdkException
java.lang.Exception
public TransactionType[] getEntireSellerTransactions(TimeFilter modifiedTimeFilter) throws ApiException, SdkException, java.lang.Exception
modifiedTimeFilter
- TimeFilter
ApiException
SdkException
java.lang.Exception
public TransactionType[] getSellerTransactions(TimeFilter modifiedTimeFilter) throws ApiException, SdkException, java.lang.Exception
modifiedTimeFilter
- TimeFilter
ApiException
SdkException
java.lang.Exception
public TimeFilter getTimeFilter()
public void setTimeFilter(TimeFilter timeFilter)
timeFilter
- TimeFilterpublic boolean getHasMoreTransactions()
public PaginationResultType getPaginationResult()
public boolean getPayPalPreferred()
public java.lang.Integer getReturnedPageNumber()
public int getReturnedTransactionCountActual()
public TransactionType[] getReturnedTransactions()
public java.lang.Integer getReturnedTransactionsPerPage()
public UserType getSeller()
|
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.