com.ebay.sdk.call.GetSellerTransactionsCall Maven / Gradle / Ivy
/*
Copyright (c) 2013 eBay, Inc.
This program is licensed under the terms of the eBay Common Development and
Distribution License (CDDL) Version 1.0 (the "License") and any subsequent version
thereof released by eBay. The then-current version of the License can be found
at http://www.opensource.org/licenses/cddl1.php and in the eBaySDKLicense file that
is under the eBay SDK ../docs directory.
*/
package com.ebay.sdk.call;
import java.util.List;
import java.util.ArrayList;
import java.lang.Boolean;
import java.lang.Integer;
import java.util.Calendar;
import com.ebay.sdk.*;
import com.ebay.soap.eBLBaseComponents.*;
/**
* 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.
*
Input property: 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.
*
* If you don't specify a ModTimeFrom/ModTimeTo filter, the NumberOfDays time filter is used and it defaults to 30 (days).
* TimeTo sets GetSellerTransactionsRequestType.ModTimeTo:
* The ModTimeFrom and ModTimeTo fields specify a date range for retrieving
* order line items associated with the seller. The ModTimeTo
* field is the ending 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.
*
* If the ModTimeFrom field is
* used and the ModTimeTo field is omitted, the ModTimeTo value defaults to
* the present time or to 30 days past the ModTimeFrom value (if
* ModTimeFrom value is more than 30 days in the past). This field is not
* applicable if the NumberOfDays date filter is used.
*
* If you don't specify a ModTimeFrom/ModTimeTo filter, the NumberOfDays
* time filter is used and it defaults to 30 (days).
*
Input property: 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.
*
Input property: 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.
*
*
Input property: 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.
*
Input property: 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).
You can combine SKUArray with InventoryTrackingMethod. For example, if you also pass in InventoryTrackingMethod=SKU, the response only includes order line items for listings that include InventoryTrackingMethod=SKU and one of the requested SKUs.
*
Input property: 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.
*
Input property: 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
*
* The call response contains the order line items whose status was modified within the specified number of days since the API call was made. NumberOfDays is often preferable to using the ModTimeFrom and ModTimeTo filters because you only need to specify one value. If you use NumberOfDays, then ModTimeFrom and ModTimeTo are ignored.
*
* For this field, one day is defined as 24 hours.
*
Input property: InventoryTrackingMethod - Filters the response to only include order line items for listings
* that match this InventoryTrackingMethod setting.
*
* For example,
*
*
* - If you set this to SKU, the call returns order line items for your listings that are tracked by SKU.
* - If you set this to ItemID, the call omits order line items for your listings that are tracked by SKU.
* - If you don't pass this in, the call returns all order line items, regardless of whether they are tracked by SKU, or ItemID.
*
*
* Note:
* To specify the InventoryTrackingMethod when you create a listing, use AddFixedPriceItem or RelistFixedPriceItem.
* AddFixedPriceItem and RelistFixedPriceItem are defined in
* the Merchant Data API (part of Large Merchant Services).
*
*
* You can combine SKUArray with InventoryTrackingMethod.
* For example, if you set this to SKU and you also pass in
* SKUArray, the response only includes order line items for listings
* that include InventoryTrackingMethod = SKU and one of the
* requested SKUs.
*
Input property: 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
* Codice Fiscale is only applicable to buyers on the Italy and Spain sites. It is required that buyers on the Italy site provide their Codice Fiscale ID before buying an item, and sellers on the Spain site have the option of requiring buyers on the Spain site to provide their taxpayer ID.
*
Output property: 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.
*
Output property: 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.
*
Output property: 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.
Note: Due to the fact that item data on the eBay platform has a shorter retention period than order data, it is possible that some retrieved pages will contain no data. For pages that contain no data, the ReturnedTransactionCountActual value will be '0'. It is also possible that pages 2, 3, and 4 have no data, but pages 1 and 5 do have data. Therefore, we recommend that you scroll through each page of data (making subsequent GetSellerTransactions calls and incrementing the Pagination.PageNumber value by '1' each time) until you reach the last page, indicated by HasMoreTransactions=false.
*
Output property: 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.
*
Output property: 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.
Note: Due to the fact that item data on the eBay platform has a shorter retention period than order data, it is possible that some retrieved pages will contain no data. For pages that contain no order line item data, the ReturnedTransactionCountActual value will be '0'. It is also possible that pages 2, 3, and 4 have no data, but pages 1 and 5 do have data. Therefore, we recommend that you scroll through each page of data (making subsequent GetSellerTransactions calls and incrementing the Pagination.PageNumber value by '1' each time) until you reach the last page, indicated by HasMoreTransactions=false.
*
Output property: 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.
*
Output property: 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.
*
Output property: 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.
*
* @author Ron Murphy
* @version 1.0
*/
public class GetSellerTransactionsCall extends com.ebay.sdk.ApiCall
{
private TimeFilter modifiedTimeFilter = null;
private PaginationType pagination = null;
private Boolean includeFinalValueFee = null;
private Boolean includeContainingOrder = null;
private SKUArrayType sKUArray = null;
private TransactionPlatformCodeType platform = null;
private Integer numberOfDays = null;
private InventoryTrackingMethodCodeType inventoryTrackingMethod = null;
private Boolean includeCodiceFiscale = null;
private PaginationResultType paginationResult=null;
private boolean hasMoreTransactions=false;
private Integer returnedTransactionsPerPage=null;
private Integer returnedPageNumber=null;
private int returnedTransactionCountActual=0;
private UserType seller=null;
private TransactionType[] returnedTransactions=null;
private boolean payPalPreferred=false;
/**
* Constructor.
*/
public GetSellerTransactionsCall() {
}
/**
* Constructor.
* @param apiContext The ApiContext object to be used to make the call.
*/
public GetSellerTransactionsCall(ApiContext apiContext) {
super(apiContext);
}
/**
* 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. (To retrieve
* transactions for another seller's listing, use GetItemTransactions.)
*
*
* @throws ApiException
* @return The TransactionType[] object.
*/
public TransactionType[] getSellerTransactions()
throws com.ebay.sdk.ApiException, com.ebay.sdk.SdkException, java.lang.Exception
{
GetSellerTransactionsRequestType req;
req = new GetSellerTransactionsRequestType();
if( this.modifiedTimeFilter == null )
throw new SdkException("ModifiedTimeFilter property is not set.");
req.setDetailLevel(this.getDetailLevel());
if (this.modifiedTimeFilter != null)
{
req.setModTimeFrom(this.modifiedTimeFilter.getTimeFrom());
req.setModTimeTo(this.modifiedTimeFilter.getTimeTo());
}
if (this.pagination != null)
req.setPagination(this.pagination);
if (this.includeFinalValueFee != null)
req.setIncludeFinalValueFee(this.includeFinalValueFee);
if (this.includeContainingOrder != null)
req.setIncludeContainingOrder(this.includeContainingOrder);
if (this.sKUArray != null)
req.setSKUArray(this.sKUArray);
if (this.platform != null)
req.setPlatform(this.platform);
if (this.inventoryTrackingMethod != null)
req.setInventoryTrackingMethod(this.inventoryTrackingMethod);
if(this.includeCodiceFiscale !=null)
req.setIncludeCodiceFiscale(this.includeCodiceFiscale);
GetSellerTransactionsResponseType resp = (GetSellerTransactionsResponseType) execute(req);
this.paginationResult = resp.getPaginationResult();
this.hasMoreTransactions = (resp.isHasMoreTransactions() == null? false: resp.isHasMoreTransactions().booleanValue());
this.returnedTransactionsPerPage = resp.getTransactionsPerPage();
this.returnedPageNumber = resp.getPageNumber();
this.returnedTransactionCountActual = (resp.getReturnedTransactionCountActual() == null? 0: resp.getReturnedTransactionCountActual().intValue());
this.seller = resp.getSeller();
this.returnedTransactions = (resp.getTransactionArray() == null? null: resp.getTransactionArray().getTransaction());
this.payPalPreferred = (resp.isPayPalPreferred() == null? false: resp.isPayPalPreferred().booleanValue());
return this.getReturnedTransactions();
}
/**
* Gets the GetSellerTransactionsRequestType.includeCodiceFiscale.
* @return Boolean
*/
public Boolean getIncludeCodiceFiscale()
{
return this.includeCodiceFiscale;
}
/**
* Sets the GetSellerTransactionsRequestType.includeCodiceFiscale.
* @param includeCodiceFiscale Boolean
*/
public void setIncludeCodiceFiscale(Boolean includeCodiceFiscale)
{
this.includeCodiceFiscale = includeCodiceFiscale;
}
/**
* Gets the GetSellerTransactionsRequestType.includeContainingOrder.
* @return Boolean
*/
public Boolean getIncludeContainingOrder()
{
return this.includeContainingOrder;
}
/**
* Sets the GetSellerTransactionsRequestType.includeContainingOrder.
* @param includeContainingOrder Boolean
*/
public void setIncludeContainingOrder(Boolean includeContainingOrder)
{
this.includeContainingOrder = includeContainingOrder;
}
/**
* Gets the GetSellerTransactionsRequestType.includeFinalValueFee.
* @return Boolean
*/
public Boolean getIncludeFinalValueFee()
{
return this.includeFinalValueFee;
}
/**
* Sets the GetSellerTransactionsRequestType.includeFinalValueFee.
* @param includeFinalValueFee Boolean
*/
public void setIncludeFinalValueFee(Boolean includeFinalValueFee)
{
this.includeFinalValueFee = includeFinalValueFee;
}
/**
* Gets the GetSellerTransactionsRequestType.inventoryTrackingMethod.
* @return InventoryTrackingMethodCodeType
*/
public InventoryTrackingMethodCodeType getInventoryTrackingMethod()
{
return this.inventoryTrackingMethod;
}
/**
* Sets the GetSellerTransactionsRequestType.inventoryTrackingMethod.
* @param inventoryTrackingMethod InventoryTrackingMethodCodeType
*/
public void setInventoryTrackingMethod(InventoryTrackingMethodCodeType inventoryTrackingMethod)
{
this.inventoryTrackingMethod = inventoryTrackingMethod;
}
/**
* Gets the GetSellerTransactionsRequestType.modifiedTimeFilter.
* @return TimeFilter
*/
public TimeFilter getModifiedTimeFilter()
{
return this.modifiedTimeFilter;
}
/**
* Sets the GetSellerTransactionsRequestType.modifiedTimeFilter.
* @param modifiedTimeFilter TimeFilter
*/
public void setModifiedTimeFilter(TimeFilter modifiedTimeFilter)
{
this.modifiedTimeFilter = modifiedTimeFilter;
}
/**
* Gets the GetSellerTransactionsRequestType.numberOfDays.
* @return Integer
*/
public Integer getNumberOfDays()
{
return this.numberOfDays;
}
/**
* Sets the GetSellerTransactionsRequestType.numberOfDays.
* @param numberOfDays Integer
*/
public void setNumberOfDays(Integer numberOfDays)
{
this.numberOfDays = numberOfDays;
}
/**
* Gets the GetSellerTransactionsRequestType.pagination.
* @return PaginationType
*/
public PaginationType getPagination()
{
return this.pagination;
}
/**
* Sets the GetSellerTransactionsRequestType.pagination.
* @param pagination PaginationType
*/
public void setPagination(PaginationType pagination)
{
this.pagination = pagination;
}
/**
* Gets the GetSellerTransactionsRequestType.platform.
* @return TransactionPlatformCodeType
*/
public TransactionPlatformCodeType getPlatform()
{
return this.platform;
}
/**
* Sets the GetSellerTransactionsRequestType.platform.
* @param platform TransactionPlatformCodeType
*/
public void setPlatform(TransactionPlatformCodeType platform)
{
this.platform = platform;
}
/**
* Gets the GetSellerTransactionsRequestType.sKUArray.
* @return SKUArrayType
*/
public SKUArrayType getSKUArray()
{
return this.sKUArray;
}
/**
* Sets the GetSellerTransactionsRequestType.sKUArray.
* @param sKUArray SKUArrayType
*/
public void setSKUArray(SKUArrayType sKUArray)
{
this.sKUArray = sKUArray;
}
/**
* Get all seller transactions in specified date range.
* It handles pagination internally and ignores the Pagination property.
* GetSellerTransactionsCall.TimeFilter will be ignored.
* @throws ApiException
* @throws SdkException
* @throws Exception
* @return TransactionType[]
*/
public TransactionType[] getEntireSellerTransactions()
throws com.ebay.sdk.ApiException, com.ebay.sdk.SdkException, java.lang.Exception
{
if( this.modifiedTimeFilter == null )
throw new SdkException("TimeFilter is not set.");
return getEntireSellerTransactions(this.modifiedTimeFilter);
}
/**
* Get all seller transactions in specified date range.
* It handles pagination internally and ignores the Pagination property.
*
* @param modifiedTimeFilter TimeFilter
* @throws ApiException
* @throws SdkException
* @throws Exception
* @return TransactionType[]
*/
public TransactionType[] getEntireSellerTransactions(TimeFilter modifiedTimeFilter)
throws com.ebay.sdk.ApiException, com.ebay.sdk.SdkException, java.lang.Exception
{
GetSellerTransactionsRequestType req = new GetSellerTransactionsRequestType();
// Modified time filter is mandatory.
req.setModTimeFrom(modifiedTimeFilter.getTimeFrom());
req.setModTimeTo(modifiedTimeFilter.getTimeTo());
int pageNum = 1;
PaginationType pgn = new PaginationType();
pgn.setEntriesPerPage(new Integer(100));
pgn.setPageNumber(new Integer(pageNum++));
req.setPagination(pgn);
if (this.includeFinalValueFee != null)
req.setIncludeFinalValueFee(this.includeFinalValueFee);
if (this.includeContainingOrder != null)
req.setIncludeContainingOrder(this.includeContainingOrder);
if (this.sKUArray != null)
req.setSKUArray(this.sKUArray);
if (this.platform != null)
req.setPlatform(this.platform);
if (this.inventoryTrackingMethod != null)
req.setInventoryTrackingMethod(this.inventoryTrackingMethod);
if(this.includeCodiceFiscale !=null)
req.setIncludeCodiceFiscale(this.includeCodiceFiscale);
ArrayList transList = new ArrayList();
while(true)
{
GetSellerTransactionsResponseType resp = (GetSellerTransactionsResponseType)this.execute(req);
TransactionArrayType tarray = resp.getTransactionArray();
TransactionType[] tm = (tarray == null) ? null : tarray.getTransaction();
if( tm != null )
{
for (int i = 0; i < tm.length; i++)
transList.add(tm[i]);
}
if( resp.getReturnedTransactionCountActual() != null )
this.returnedTransactionCountActual = resp.getReturnedTransactionCountActual().intValue();
if( !resp.isHasMoreTransactions().booleanValue() )
break;
pgn.setPageNumber(new Integer(pageNum++));
}
// Build results.
this.returnedTransactions = new TransactionType[transList.size()];
for(int i = 0; i < this.returnedTransactions.length; i ++)
{
this.returnedTransactions[i] = (TransactionType)transList.get(i);
}
return this.returnedTransactions;
}
/**
* Executes the API. GetSellerTransactionsCall.TimeFilter will be ignored.
* @param modifiedTimeFilter TimeFilter
* @throws ApiException
* @throws SdkException
* @throws Exception
* @return TransactionType[]
*/
public TransactionType[] getSellerTransactions(TimeFilter modifiedTimeFilter)
throws com.ebay.sdk.ApiException, com.ebay.sdk.SdkException, java.lang.Exception
{
this.modifiedTimeFilter = modifiedTimeFilter;
return getSellerTransactions();
}
/**
*
* @return TimeFilter
*/
public TimeFilter getTimeFilter() {
return this.modifiedTimeFilter;
}
/**
* Sets time filter for transactions to be returned.
* @param timeFilter TimeFilter
*/
public void setTimeFilter(TimeFilter timeFilter) {
this.modifiedTimeFilter = timeFilter;
}
/**
* Valid after executing the API.
* Gets the returned GetSellerTransactionsResponseType.hasMoreTransactions.
*
* @return boolean
*/
public boolean getHasMoreTransactions()
{
return this.hasMoreTransactions;
}
/**
* Valid after executing the API.
* Gets the returned GetSellerTransactionsResponseType.paginationResult.
*
* @return PaginationResultType
*/
public PaginationResultType getPaginationResult()
{
return this.paginationResult;
}
/**
* Valid after executing the API.
* Gets the returned GetSellerTransactionsResponseType.payPalPreferred.
*
* @return boolean
*/
public boolean getPayPalPreferred()
{
return this.payPalPreferred;
}
/**
* Valid after executing the API.
* Gets the returned GetSellerTransactionsResponseType.returnedPageNumber.
*
* @return Integer
*/
public Integer getReturnedPageNumber()
{
return this.returnedPageNumber;
}
/**
* Valid after executing the API.
* Gets the returned GetSellerTransactionsResponseType.returnedTransactionCountActual.
*
* @return int
*/
public int getReturnedTransactionCountActual()
{
return this.returnedTransactionCountActual;
}
/**
* Valid after executing the API.
* Gets the returned GetSellerTransactionsResponseType.returnedTransactions.
*
* @return TransactionType[]
*/
public TransactionType[] getReturnedTransactions()
{
return this.returnedTransactions;
}
/**
* Valid after executing the API.
* Gets the returned GetSellerTransactionsResponseType.returnedTransactionsPerPage.
*
* @return Integer
*/
public Integer getReturnedTransactionsPerPage()
{
return this.returnedTransactionsPerPage;
}
/**
* Valid after executing the API.
* Gets the returned GetSellerTransactionsResponseType.seller.
*
* @return UserType
*/
public UserType getSeller()
{
return this.seller;
}
}