|
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.soap.eBLBaseComponents.AbstractRequestType
com.ebay.soap.eBLBaseComponents.GetItemTransactionsRequestType
public class GetItemTransactionsRequestType
This call retrieves details on one or more order line items for a specified eBay listing. Auctions and single-quantity, fixed-price listings can only have one order line item, but a multiple-quantity and/or multiple-variation, fixed-priced listing can have numerous order line items.
To find one or more order line items for an eBay listing, an ItemID value can be passed in. If a user wanted to retrieve a specific order line item, an ItemID value and a an TransactionID value can be passed in, or an OrderLineItemID value can be passed in instead of an ItemID/TransactionID pair.
The NumberOfDays or the ModTimeFrom and ModTimeTo date range filters can be used to retrieve order line items generated (or last modified) within a specific range of time. The maximum date range that can be set is 30 days, and the ModTimeFrom date value cannot be set any further back than 90 days in the past. If no date range filters are used, all order line items (associated with the specified listing) generated (or last modified) in the last 30 days are retrieved. Date ranges are generally only used for multiple-quantity or multiple-variation, fixed-price listings that can have multiple order line items.
There are also pagination filters available that allow the user to control how many and which order line items are returned on each page of a results set.
Java class for GetItemTransactionsRequestType complex type.
The following schema fragment specifies the expected content contained within this class.
<complexType name="GetItemTransactionsRequestType"> <complexContent> <extension base="{urn:ebay:apis:eBLBaseComponents}AbstractRequestType"> <sequence> <element name="ItemID" type="{urn:ebay:apis:eBLBaseComponents}ItemIDType" minOccurs="0"/> <element name="ModTimeFrom" type="{http://www.w3.org/2001/XMLSchema}dateTime" minOccurs="0"/> <element name="ModTimeTo" type="{http://www.w3.org/2001/XMLSchema}dateTime" minOccurs="0"/> <element name="TransactionID" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/> <element name="Pagination" type="{urn:ebay:apis:eBLBaseComponents}PaginationType" minOccurs="0"/> <element name="IncludeFinalValueFee" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/> <element name="IncludeContainingOrder" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/> <element name="Platform" type="{urn:ebay:apis:eBLBaseComponents}TransactionPlatformCodeType" minOccurs="0"/> <element name="NumberOfDays" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/> <element name="IncludeVariations" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/> <element name="OrderLineItemID" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/> </sequence> </extension> </complexContent> </complexType>
Field Summary | |
---|---|
protected java.lang.Boolean |
includeContainingOrder
|
protected java.lang.Boolean |
includeFinalValueFee
|
protected java.lang.Boolean |
includeVariations
|
protected java.lang.String |
itemID
|
protected java.util.Calendar |
modTimeFrom
|
protected java.util.Calendar |
modTimeTo
|
protected java.lang.Integer |
numberOfDays
|
protected java.lang.String |
orderLineItemID
|
protected PaginationType |
pagination
|
protected TransactionPlatformCodeType |
platform
|
protected java.lang.String |
transactionID
|
Fields inherited from class com.ebay.soap.eBLBaseComponents.AbstractRequestType |
---|
any, botBlock, detailLevel, endUserIP, errorHandling, errorLanguage, invocationID, messageID, outputSelector, version, warningLevel |
Constructor Summary | |
---|---|
GetItemTransactionsRequestType()
|
Method Summary | |
---|---|
java.lang.String |
getItemID()
Gets the value of the itemID property. |
java.util.Calendar |
getModTimeFrom()
Gets the value of the modTimeFrom property. |
java.util.Calendar |
getModTimeTo()
Gets the value of the modTimeTo property. |
java.lang.Integer |
getNumberOfDays()
Gets the value of the numberOfDays property. |
java.lang.String |
getOrderLineItemID()
Gets the value of the orderLineItemID property. |
PaginationType |
getPagination()
Gets the value of the pagination property. |
TransactionPlatformCodeType |
getPlatform()
Gets the value of the platform property. |
java.lang.String |
getTransactionID()
Gets the value of the transactionID property. |
java.lang.Boolean |
isIncludeContainingOrder()
Gets the value of the includeContainingOrder property. |
java.lang.Boolean |
isIncludeFinalValueFee()
Gets the value of the includeFinalValueFee property. |
java.lang.Boolean |
isIncludeVariations()
Gets the value of the includeVariations property. |
void |
setIncludeContainingOrder(java.lang.Boolean value)
Sets the value of the includeContainingOrder property. |
void |
setIncludeFinalValueFee(java.lang.Boolean value)
Sets the value of the includeFinalValueFee property. |
void |
setIncludeVariations(java.lang.Boolean value)
Sets the value of the includeVariations property. |
void |
setItemID(java.lang.String value)
Sets the value of the itemID property. |
void |
setModTimeFrom(java.util.Calendar value)
Sets the value of the modTimeFrom property. |
void |
setModTimeTo(java.util.Calendar value)
Sets the value of the modTimeTo property. |
void |
setNumberOfDays(java.lang.Integer value)
Sets the value of the numberOfDays property. |
void |
setOrderLineItemID(java.lang.String value)
Sets the value of the orderLineItemID property. |
void |
setPagination(PaginationType value)
Sets the value of the pagination property. |
void |
setPlatform(TransactionPlatformCodeType value)
Sets the value of the platform property. |
void |
setTransactionID(java.lang.String value)
Sets the value of the transactionID property. |
Methods inherited from class com.ebay.soap.eBLBaseComponents.AbstractRequestType |
---|
_getAny, _getDetailLevel, _getOutputSelector, getAny, getAny, getAnyLength, getBotBlock, getDetailLevel, getDetailLevel, getDetailLevelLength, getEndUserIP, getErrorHandling, getErrorLanguage, getInvocationID, getMessageID, getOutputSelector, getOutputSelector, getOutputSelectorLength, getVersion, getWarningLevel, setAny, setAny, setBotBlock, setDetailLevel, setDetailLevel, setEndUserIP, setErrorHandling, setErrorLanguage, setInvocationID, setMessageID, setOutputSelector, setOutputSelector, setVersion, setWarningLevel |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected java.lang.String itemID
protected java.util.Calendar modTimeFrom
protected java.util.Calendar modTimeTo
protected java.lang.String transactionID
protected PaginationType pagination
protected java.lang.Boolean includeFinalValueFee
protected java.lang.Boolean includeContainingOrder
protected TransactionPlatformCodeType platform
protected java.lang.Integer numberOfDays
protected java.lang.Boolean includeVariations
protected java.lang.String orderLineItemID
Constructor Detail |
---|
public GetItemTransactionsRequestType()
Method Detail |
---|
public java.lang.String getItemID()
String
public void setItemID(java.lang.String value)
value
- allowed object is
String
public java.util.Calendar getModTimeFrom()
String
public void setModTimeFrom(java.util.Calendar value)
value
- allowed object is
String
public java.util.Calendar getModTimeTo()
String
public void setModTimeTo(java.util.Calendar value)
value
- allowed object is
String
public java.lang.String getTransactionID()
String
public void setTransactionID(java.lang.String value)
value
- allowed object is
String
public PaginationType getPagination()
PaginationType
public void setPagination(PaginationType value)
value
- allowed object is
PaginationType
public java.lang.Boolean isIncludeFinalValueFee()
Boolean
public void setIncludeFinalValueFee(java.lang.Boolean value)
value
- allowed object is
Boolean
public java.lang.Boolean isIncludeContainingOrder()
Boolean
public void setIncludeContainingOrder(java.lang.Boolean value)
value
- allowed object is
Boolean
public TransactionPlatformCodeType getPlatform()
TransactionPlatformCodeType
public void setPlatform(TransactionPlatformCodeType value)
value
- allowed object is
TransactionPlatformCodeType
public java.lang.Integer getNumberOfDays()
Integer
public void setNumberOfDays(java.lang.Integer value)
value
- allowed object is
Integer
public java.lang.Boolean isIncludeVariations()
Boolean
public void setIncludeVariations(java.lang.Boolean value)
value
- allowed object is
Boolean
public java.lang.String getOrderLineItemID()
String
public void setOrderLineItemID(java.lang.String value)
value
- allowed object is
String
|
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.