com.ebay.sdk.call.GetItemTransactionsCall 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.lang.Boolean;
import java.lang.Integer;
import java.lang.String;
import java.util.Calendar;
import com.ebay.sdk.*;
import com.ebay.soap.eBLBaseComponents.*;
/**
* Wrapper class of the GetItemTransactions 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 an eBay listing. A listing can have multiple
* order line items, but only one ItemID. When you use
* ItemID alone, eBay returns all order line items that are associated with
* the ItemID. If you pair ItemID with a specific TransactionID,
* data on a specific order line item is returned. If OrderLineItemID is
* specified in the request, any ItemID/TransactionID pair specified in the
* same request will be ignored.
*
*
* Note:
* GetItemTransactions doesn't support SKU as an input because this
* call requires an identifier that is unique across your active
* and ended listings. Even when InventoryTrackingMethod is set to
* SKU in a listing, the SKU is only unique across your active
* listings (not your ended listings). To retrieve order line items
* by SKU, use GetSellerTransactions or GetOrderTransactions instead.
*
*
Input property: ModifiedTimeFilter - Helper wrapper to set GetItemTransactionsRequestType ModTimeFrom, ModTimeTo:
* TimeFrom sets GetItemTransactionsRequestType.ModTimeFrom:
* The ModTimeFrom and ModTimeTo fields specify a date range for retrieving order line items associated with the specified ItemID. The ModTimeFrom field is the starting date range. All of the listing'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. The maximum date range that may be specified is 30 days. This field is not applicable if a specific TransactionID or OrderLineItemID is included in the request or 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 GetItemTransactionsRequestType.ModTimeTo:
* The ModTimeFrom and ModTimeTo fields specify a date range for retrieving order line items associated with the specified ItemID. The ModTimeTo field is the ending date range. All eBay 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 a specific TransactionID or OrderLineItemID is included in the request or 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: TransactionID - Include a TransactionID field in the request if you want to retrieve the
* data for a specific order line item. If a TransactionID is
* provided, any specified time filter is ignored.
*
Input property: Pagination - Child elements control pagination of the output. Use the EntriesPerPage property to control the number of order line items to return per call and the PageNumber property to specify the specific page of data to return. If multiple pages of order line items are returned based on input criteria and Pagination properties, GetItemTransactions will need to be called multiple times (with the PageNumber value being increased by 1 each time) to scroll through all results.
*
Input property: IncludeFinalValueFee - Indicates whether to include 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.
*
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 that are part of the same order.
*
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 API support for Half.com listings is being deprecated, this field is no longer necessary to use since eBay orders will be the only orders that are retrieved.
*
* The default behavior of GetItemTransactions 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 only 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 - This time filter specifies the number of days (24-hour periods) in the
* past to search for order line items. All eBay order line items that were
* either created or modified within this period are returned in the
* response. If specified, NumberOfDays will override any date range
* specified with the ModTimeFrom/ModTimeTo time filters. This field is not
* applicable if a specific TransactionID or OrderLineItemID is included in
* the request.
*
Input property: IncludeVariations - If included in the request and set to True, all variations defined for
* the item are returned at the root level, including variations
* that have no sales. If not included in the request or set to false, the
* variations with sales are still returned in separate Transaction nodes. This information is intended to help sellers to reconcile their
* local inventory with eBay's records, while processing order line items
* (without requiring a separate call to GetItem).
*
Input property: OrderLineItemID - A unique identifier for an eBay order line item. 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. If you want to retrieve data on a
* specific order line item, you can use an OrderLineItemID value in the
* request instead of the ItemID/TransactionID pair. If an OrderLineItemID is
* provided, any specified time filter is ignored.
*
Output property: PaginationResult - Contains the total number of pages (TotalNumberOfPages) and the total number
* of entries (TotalNumberOfEntries) that could be returned given repeated calls
* that use the same selection criteria as the call that returned this response.
*
Output property: HasMoreTransactions - Indicates whether there are additional order line items to retrieve.
* That is, indicates whether more pages of data are available to be
* returned, given the filters that were specified in the request.
* Returns false for the last page of data.
*
Output property: ReturnedTransactionsPerPage - Number of order line items returned per page (per call). May be a higher value
* than ReturnedTransactionCountActual if the page returned is the last page
* and more than one page of data exists.
*
Output property: ReturnedPageNumber - Page number for the page of order line items the response returned.
*
Output property: ReturnedTransactionCountActual - Number of order line items retrieved in the current page of results just returned.
* May be a lower value than TransactionsPerPage if the page returned is the last
* page and more than one page of data exists.
*
Output property: Item - Item object that spawned the order line item. It is a purchase from this item's listing
* that the order line item represents.
*
Output property: ReturnedTransactions - List of Transaction objects representing the order line items resulting
* from the listing. Each Transaction object contains the data for one purchase
* (of one or more items in the same listing). The Transaction.Item field is not
* returned because the Item object is returned at the root level of the response.
* See the reference guide for more information about the fields that are returned.
*
Output property: PayPalPreferred - Indicates whether the item's 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 GetItemTransactionsCall extends com.ebay.sdk.ApiCall
{
private String itemID = null;
private TimeFilter modifiedTimeFilter = null;
private String transactionID = null;
private PaginationType pagination = null;
private Boolean includeFinalValueFee = null;
private Boolean includeContainingOrder = null;
private TransactionPlatformCodeType platform = null;
private Integer numberOfDays = null;
private Boolean includeVariations = null;
private String orderLineItemID = null;
private PaginationResultType paginationResult=null;
private boolean hasMoreTransactions=false;
private Integer returnedTransactionsPerPage=null;
private Integer returnedPageNumber=null;
private int returnedTransactionCountActual=0;
private ItemType item=null;
private TransactionType[] returnedTransactions=null;
private boolean payPalPreferred=false;
/**
* Constructor.
*/
public GetItemTransactionsCall() {
}
/**
* Constructor.
* @param apiContext The ApiContext object to be used to make the call.
*/
public GetItemTransactionsCall(ApiContext apiContext) {
super(apiContext);
}
/**
* Retrieves order line item information for a specified ItemID. The call returns zero, one, or multiple order line items, depending on the number of items sold from the listing.
You can retrieve order line item data for a specific time range or number of days. If you don't specify a range or number of days, order line item data will be returned for the past 30 days. This call cannot retrieve sales older than 90 days old.
*
*
* @throws ApiException
* @throws SdkException
* @throws Exception
* @return The TransactionType[] object.
*/
public TransactionType[] getItemTransactions()
throws com.ebay.sdk.ApiException, com.ebay.sdk.SdkException, java.lang.Exception
{
GetItemTransactionsRequestType req;
req = new GetItemTransactionsRequestType();
if( this.itemID == null )
throw new SdkException("ItemID property is not set.");
req.setDetailLevel(this.getDetailLevel());
if (this.itemID != null)
req.setItemID(this.itemID);
if (this.modifiedTimeFilter != null)
{
req.setModTimeFrom(this.modifiedTimeFilter.getTimeFrom());
req.setModTimeTo(this.modifiedTimeFilter.getTimeTo());
}
if (this.transactionID != null)
req.setTransactionID(this.transactionID);
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.platform != null)
req.setPlatform(this.platform);
if (this.numberOfDays != null)
req.setNumberOfDays(this.numberOfDays);
if (this.includeVariations != null)
req.setIncludeVariations(this.includeVariations);
if (this.orderLineItemID != null)
req.setOrderLineItemID(this.orderLineItemID);
GetItemTransactionsResponseType resp = (GetItemTransactionsResponseType) 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.item = resp.getItem();
this.returnedTransactions = (resp.getTransactionArray() == null? null: resp.getTransactionArray().getTransaction());
this.payPalPreferred = (resp.isPayPalPreferred() == null? false: resp.isPayPalPreferred().booleanValue());
return this.getReturnedTransactions();
}
/**
* Gets the GetItemTransactionsRequestType.includeContainingOrder.
* @return Boolean
*/
public Boolean getIncludeContainingOrder()
{
return this.includeContainingOrder;
}
/**
* Sets the GetItemTransactionsRequestType.includeContainingOrder.
* @param includeContainingOrder Boolean
*/
public void setIncludeContainingOrder(Boolean includeContainingOrder)
{
this.includeContainingOrder = includeContainingOrder;
}
/**
* Gets the GetItemTransactionsRequestType.includeFinalValueFee.
* @return Boolean
*/
public Boolean getIncludeFinalValueFee()
{
return this.includeFinalValueFee;
}
/**
* Sets the GetItemTransactionsRequestType.includeFinalValueFee.
* @param includeFinalValueFee Boolean
*/
public void setIncludeFinalValueFee(Boolean includeFinalValueFee)
{
this.includeFinalValueFee = includeFinalValueFee;
}
/**
* Gets the GetItemTransactionsRequestType.includeVariations.
* @return Boolean
*/
public Boolean getIncludeVariations()
{
return this.includeVariations;
}
/**
* Sets the GetItemTransactionsRequestType.includeVariations.
* @param includeVariations Boolean
*/
public void setIncludeVariations(Boolean includeVariations)
{
this.includeVariations = includeVariations;
}
/**
* Gets the GetItemTransactionsRequestType.itemID.
* @return String
*/
public String getItemID()
{
return this.itemID;
}
/**
* Sets the GetItemTransactionsRequestType.itemID.
* @param itemID String
*/
public void setItemID(String itemID)
{
this.itemID = itemID;
}
/**
* Gets the GetItemTransactionsRequestType.modifiedTimeFilter.
* @return TimeFilter
*/
public TimeFilter getModifiedTimeFilter()
{
return this.modifiedTimeFilter;
}
/**
* Sets the GetItemTransactionsRequestType.modifiedTimeFilter.
* @param modifiedTimeFilter TimeFilter
*/
public void setModifiedTimeFilter(TimeFilter modifiedTimeFilter)
{
this.modifiedTimeFilter = modifiedTimeFilter;
}
/**
* Gets the GetItemTransactionsRequestType.numberOfDays.
* @return Integer
*/
public Integer getNumberOfDays()
{
return this.numberOfDays;
}
/**
* Sets the GetItemTransactionsRequestType.numberOfDays.
* @param numberOfDays Integer
*/
public void setNumberOfDays(Integer numberOfDays)
{
this.numberOfDays = numberOfDays;
}
/**
* Gets the GetItemTransactionsRequestType.orderLineItemID.
* @return String
*/
public String getOrderLineItemID()
{
return this.orderLineItemID;
}
/**
* Sets the GetItemTransactionsRequestType.orderLineItemID.
* @param orderLineItemID String
*/
public void setOrderLineItemID(String orderLineItemID)
{
this.orderLineItemID = orderLineItemID;
}
/**
* Gets the GetItemTransactionsRequestType.pagination.
* @return PaginationType
*/
public PaginationType getPagination()
{
return this.pagination;
}
/**
* Sets the GetItemTransactionsRequestType.pagination.
* @param pagination PaginationType
*/
public void setPagination(PaginationType pagination)
{
this.pagination = pagination;
}
/**
* Gets the GetItemTransactionsRequestType.platform.
* @return TransactionPlatformCodeType
*/
public TransactionPlatformCodeType getPlatform()
{
return this.platform;
}
/**
* Sets the GetItemTransactionsRequestType.platform.
* @param platform TransactionPlatformCodeType
*/
public void setPlatform(TransactionPlatformCodeType platform)
{
this.platform = platform;
}
/**
* Gets the GetItemTransactionsRequestType.transactionID.
* @return String
*/
public String getTransactionID()
{
return this.transactionID;
}
/**
* Sets the GetItemTransactionsRequestType.transactionID.
* @param transactionID String
*/
public void setTransactionID(String transactionID)
{
this.transactionID = transactionID;
}
/**
* Get all item transactions in specified date range.
* It handles pagination internally and ignores the Pagination property.
* GetItemTransactionsCall.ItemID and
* GetItemTransactionsCall.ModifiedTimeFilter will be ignored.
* @param modifiedTimeFilter TimeFilter
* @throws ApiException
* @throws SdkException
* @throws Exception
* @return TransactionType[]
*/
public TransactionType[] getEntireItemTransactions()
throws com.ebay.sdk.ApiException, com.ebay.sdk.SdkException, java.lang.Exception
{
if( this.itemID == null )
throw new SdkException("ItemID is not set.");
if( this.modifiedTimeFilter == null )
throw new SdkException("ModifiedTimeFilter is not set.");
return getEntireItemTransactions();
}
/**
* Execute the API call. GetItemTransactionsCall.ItemID and
* GetItemTransactionsCall.ModifiedTimeFilter will be ignored.
* @param itemID String Unique ID of item that you are retrieving transactions for.
* @param modifiedTimeFilter TimeFilter Range of transactions that you are retrieving.
* @throws ApiException
* @throws SdkException
* @throws Exception
* @return TransactionType[]
*/
public TransactionType[] getItemTransactions(String itemID, TimeFilter modifiedTimeFilter)
throws com.ebay.sdk.ApiException, com.ebay.sdk.SdkException, java.lang.Exception
{
GetItemTransactionsRequestType req = new GetItemTransactionsRequestType();
req.setItemID(itemID);
req.setModTimeFrom(modifiedTimeFilter.getTimeFrom());
req.setModTimeTo(modifiedTimeFilter.getTimeTo());
if (null != includeContainingOrder)
req.setIncludeContainingOrder(includeContainingOrder);
if (null != includeFinalValueFee)
req.setIncludeFinalValueFee(includeFinalValueFee);
if( this.pagination != null )
req.setPagination(this.pagination);
if( this.transactionID != null && this.transactionID.length() > 0 )
req.setTransactionID(this.transactionID);
// Call eBay
GetItemTransactionsResponseType resp = (GetItemTransactionsResponseType)this.execute(req);
this.returnedTransactions = resp.getTransactionArray() == null ? null :
resp.getTransactionArray().getTransaction();
this.paginationResult = resp.getPaginationResult();
this.item = resp.getItem();
if( resp.isHasMoreTransactions() != null )
this.hasMoreTransactions = resp.isHasMoreTransactions().booleanValue();
if( resp.isPayPalPreferred() != null )
this.payPalPreferred = resp.isPayPalPreferred().booleanValue();
if( resp.getReturnedTransactionCountActual() != null )
this.returnedTransactionCountActual = resp.getReturnedTransactionCountActual().intValue();
// Save EntriesPerPage and PageNumber back to the input PaginationType.
if( this.pagination == null )
this.pagination = new PaginationType();
if( resp.getTransactionsPerPage() != null )
this.pagination.setEntriesPerPage(resp.getTransactionsPerPage());
if( resp.getPageNumber() != null )
this.pagination.setPageNumber(resp.getPageNumber());
return this.returnedTransactions;
}
/**
* Backward compatible function - do not use
*/
public void setIncludeFinalValueFe(Boolean includeFinalValueFee) {
this.includeFinalValueFee = includeFinalValueFee;
}
/**
* Valid after executing the API.
* Gets the returned GetItemTransactionsResponseType.hasMoreTransactions.
*
* @return boolean
*/
public boolean getHasMoreTransactions()
{
return this.hasMoreTransactions;
}
/**
* Valid after executing the API.
* Gets the returned GetItemTransactionsResponseType.item.
*
* @return ItemType
*/
public ItemType getItem()
{
return this.item;
}
/**
* Valid after executing the API.
* Gets the returned GetItemTransactionsResponseType.paginationResult.
*
* @return PaginationResultType
*/
public PaginationResultType getPaginationResult()
{
return this.paginationResult;
}
/**
* Valid after executing the API.
* Gets the returned GetItemTransactionsResponseType.payPalPreferred.
*
* @return boolean
*/
public boolean getPayPalPreferred()
{
return this.payPalPreferred;
}
/**
* Valid after executing the API.
* Gets the returned GetItemTransactionsResponseType.returnedPageNumber.
*
* @return Integer
*/
public Integer getReturnedPageNumber()
{
return this.returnedPageNumber;
}
/**
* Valid after executing the API.
* Gets the returned GetItemTransactionsResponseType.returnedTransactionCountActual.
*
* @return int
*/
public int getReturnedTransactionCountActual()
{
return this.returnedTransactionCountActual;
}
/**
* Valid after executing the API.
* Gets the returned GetItemTransactionsResponseType.returnedTransactions.
*
* @return TransactionType[]
*/
public TransactionType[] getReturnedTransactions()
{
return this.returnedTransactions;
}
/**
* Valid after executing the API.
* Gets the returned GetItemTransactionsResponseType.returnedTransactionsPerPage.
*
* @return Integer
*/
public Integer getReturnedTransactionsPerPage()
{
return this.returnedTransactionsPerPage;
}
}