NAME
eBay::API::XML::Call::GetItemTransactions::GetItemTransactionsRequestType
DESCRIPTION
Retrieves transaction information for a specified itemID. Depending on whether the listing sells one or multiple items and on whether anything has been sold in that listing, this returns zero, one or multiple transactions. Often, it is more efficient to use GetSellerTransactions instead.
SYNOPSIS
INHERITANCE
eBay::API::XML::Call::GetItemTransactions::GetItemTransactionsRequestType inherits from the eBay::API::XML::RequestDataType class
Subroutines:
setIncludeContainingOrder()
Whether to retrieve the order information. Default is false. Will not return the ContainingOrder information for an Express transaction that was part of an Express order.
RequiredInput: No
# Argument: 'xs:boolean'isIncludeContainingOrder()
# Returns: 'xs:boolean'
setIncludeFinalValueFee()
Indicates whether to include final value fees in the response. For most listing types, the fee is returned in Transaction.FinalValueFee. For Dutch auctions that end with bids (not Buy It Now purchases), the fee is returned in Item.SellingStatus.FinalValueFee. The Final Value Fee for FixedPriceItem, StoresFixedPrice, and Buy It Now Dutch listing types is returned on a transaction by transaction basis. For all other listing types, including Chinese and Dutch (no Buy It Now purchases), the Final Value Fee is returned when the listing status is Completed.
RequiredInput: No
# Argument: 'xs:boolean'isIncludeFinalValueFee()
# Returns: 'xs:boolean'
setItemID()
Unique item ID for the item for which to retrieve transactions.
MaxLength: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits)
RequiredInput: Yes
# Argument: 'ns:ItemIDType'getItemID()
# Returns: 'ns:ItemIDType'
setModTimeFrom()
Also see NumberOfDays which, if used, takes precedence over ModTimeFrom and ModTimeTo. If you prefer to use ModTimeFrom and ModTimeTo, you specify the time range within which retrieved transactions' statuses were modified. ModTimeFrom is the earlier (older) date and ModTimeTo is the later (more recent) date. If you specify this value, and do not specify the other end of the range, then the time range is 30 days. The time range between ModTimeFrom to ModTimeTo cannot be greater than 30 days.
RequiredInput: No
# Argument: 'xs:dateTime'getModTimeFrom()
# Returns: 'xs:dateTime'
setModTimeTo()
Also see NumberOfDays which, if used, takes precedence over ModTimeFrom and ModTimeTo. If you prefer to use ModTimeFrom and ModTimeTo, you specify the time range within which retrieved transactions' statuses were modified. ModTimeFrom is the earlier (older) date and ModTimeTo is the later (more recent) date. If you specify this value, and do not specify the other end of the range, then the time range is 30 days. The time range between ModTimeFrom to ModTimeTo cannot be greater than 30 days.
RequiredInput: No
# Argument: 'xs:dateTime'getModTimeTo()
# Returns: 'xs:dateTime'
setNumberOfDays()
NumberOfDays enables you to specify the number of days' worth of new and modified transactions that you want to retrieve. The call response contains the transactions 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.
Max: 30
RequiredInput: No
# Argument: 'xs:int'getNumberOfDays()
# Returns: 'xs:int'
setPagination()
Child elements control pagination of the output. Use its EntriesPerPage property to control the number of transactions to return per call and its PageNumber property to specify the page of data to return.
RequiredInput: No
# Argument: 'ns:PaginationType'getPagination()
# Returns: 'ns:PaginationType'
setPlatform()
Name of the eBay co-branded site upon which the transaction was made. This will serve as a filter for the transactions to get emitted in the response.
RequiredInput: No
# Argument: 'ns:TransactionPlatformCodeType'getPlatform()
# Returns: 'ns:TransactionPlatformCodeType'
setTransactionID()
Identifies one transaction for a listing. For Chinese auctions listings (single-item listings for which there can be only one transaction), TransactionID is always 0, and for multi-quantity listings (for which there can be multiple transactions), TransactionID has a non-0 value. To determine the valid transaction IDs for a listing, you typically need to have previously executed GetItemTransactionsCall or GetSellerTransactionsCall and stored all the listing's transactions.
MaxLength: 19 (Note: The eBay database specifies 38. Currently, transaction IDs are usually 9 to 12 digits.)
RequiredInput: No
# Argument: 'xs:string'getTransactionID()
# Returns: 'xs:string'