|
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 are used to 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 created (or 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. This field is not applicable if the NumberOfDays date filter is used.
Pagination
- If many order line items are available to retrieve, you may need to call GetSellerTransactions multiple times to retrieve all the data. Each result set is returned as a page of order line items. Use the Pagination filters to control the maximum number of order line items to retrieve per page (i.e., per call), and the page number to retrieve.
IncludeFinalValueFee
- This field is included and set to true
if the user wants to view the Final Value Fee (FVF) for all order line items in the response. The Final Value Fee is returned in the Transaction.FinalValueFee field. The Final Value Fee is assessed right after the creation of an order line item.
IncludeContainingOrder
- This field is included and set to true
if the user wants to view order-level details, including the unique identifier of the order and the status of the order. The order-level details will be shown in the ContainingOrder container in the response.
SKUArray
- This container is used to search for order line items generated from one or more product SKU values. The response will only include order line items for the seller's product(s) that are represented by the specified SKU value(s).
SKU
. The InventoryTrackingMethod value can be set when the seller lists the item through an AddFixedPriceItem call, or it can be set by including the InventoryTrackingMethod field in a GetSellerTransactions call and setting its value to SKU
.
Platform
- Note: This field should no longer be used since its sole purpose was to allow the seller to filter between eBay orders and Half.com orders, and the Half.com site no longer exists.
NumberOfDays
- This field is used to specify how many days (24-hour periods) back in the past you wish to retrieve order line items. All order line items created (or last modified) within this period are retrieved. This value can be set between 1 (day) and 30 (days), and defaults to 30 (days) if omitted from the call.
InventoryTrackingMethod
- This filter is used if the seller wishes to set/change the inventory tracking method. When creating a listing with the AddFixedPriceItem call (or relisting with RelistFixedPriceItem call), sellers can decide whether to track their inventory by Item ID (generated by eBay at listing time) or by seller-defined SKU value.
SKU
) if the seller wishes to retrieve order line items based on specified SKU values (specified through SKUArray container) and the current inventory tracking method is set to Item ID.
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 container.
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.