|
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.GetOrdersCall
public class GetOrdersCall
Wrapper class of the GetOrders 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.
OrderIDArray
- This container is used if the user wants to retrieve one or more specific orders in which they are involved as either the seller or buyer. If one or more order IDs are specified in this container, any order role, order status, or date range filters are ignored if specified in the request.
1113
. During the transition period and even after, the new and old OrderID formats will still be supported/accepted in all Trading API call request payloads. After the transition period (which will be announced), only the new OrderID format will be returned in all Trading API call response payloads, regardless of the Trading WSDL version used or specified compatibility level.
CreateTimeFrom
- The CreateTimeFrom and CreateTimeTo fields specify a date range for retrieving orders that were created during this time period. The CreateTimeFrom field is the starting date range. All eBay orders that were created within this date range are returned in the output. The maximum date range that may be specified with the CreateTimeFrom and CreateTimeTo fields is 90 days. CreateTimeFrom/CreateTimeTo date filters are ignored if the NumberOfDays date filter is used in the request, or if one or more order IDs are passed in the request. This value cannot be set back more than 90 days in the past, as this call cannot retrieve sales older than 90 days old.
CreateTimeTo
- The CreateTimeFrom and CreateTimeTo fields specify a date range for retrieving orders that were created during this time period. The CreateTimeTo field is the ending date range. All eBay orders that were created within this date range are returned in the output. The maximum date range that may be specified with the CreateTimeFrom and CreateTimeTo fields is 90 days. If the CreateTimeFrom field is used and the CreateTimeTo field is omitted, the "TimeTo" value defaults to the present time or to 90 days past the CreateTimeFrom value (if CreateTimeFrom value is more than 90 days in the past). CreateTimeFrom/CreateTimeTo date filters are ignored if the NumberOfDays date filter is used in the request, or if one or more order IDs are passed in the request.
OrderRole
- This filter is used to toggle between retrieving orders based on the role of the user (seller or buyer). The order role defaults to Seller
if this field is not used. If this field is used with a date filter, returned orders must satisfy both the date range and the OrderRole value.
OrderStatus
- The field is used to retrieve eBay orders that are in a specific state. If this field is used with a date filter, only orders that satisfy both the date range and the OrderStatus value are retrieved. ListingType
- Note: This field's purpose was to allow the seller to retrieve only Half.com listings. Since the Half.com site has been shut down, this field is no longer applicable.
Pagination
- If many orders are available to retrieve, you may need to call GetOrders multiple times to retrieve all the data. Each result set is returned as a page of orders. Use the Pagination filters to control the maximum number of orders to retrieve per page (i.e., per call), and the page number to retrieve.
ModTimeFrom
- The ModTimeFrom and ModTimeTo fields specify a date range for retrieving existing orders that have been modified within this time period (for example, Incomplete
status to Pending
status or Pending
status to Complete
status). The ModTimeFrom field is the starting date range. All eBay orders that were last modified within this date range are returned in the output. Unlike the CreateTimeFrom/CreateTimeTo filters, which may cover a maximum period of 90 days, the maximum date range that may be specified with the ModTimeFrom and ModTimeTo fields is only 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. ModTimeFrom/ModTimeTo date filters are ignored if the CreateTimeFrom/CreateTimeTo or NumberOfDays date filters are used in the request, or if one or more order IDs are passed in the request.
ModTimeTo
- The ModTimeFrom and ModTimeTo fields specify a date range for retrieving existing orders that have been modified within this time window (for example, Incomplete
status to Pending
status or Pending
status to Complete
status). The ModTimeTo field is the ending date range. All eBay orders that were last modified within this date range are returned in the output. Unlike the CreateTimeFrom/CreateTimeTo filters, which may cover a maximum period of 90 days, the maximum date range that may be specified with the ModTimeFrom and ModTimeTo fields is 30 days. If the ModTimeFrom field is used and the ModTimeTo field is omitted, the 'TimeTo' value defaults to the present time (if ModTimeFrom value is less than 30 days in the past) or to 30 days past the ModTimeFrom value. ModTimeFrom/ModTimeTo date filters are ignored if the CreateTimeFrom/CreateTimeTo or NumberOfDays date filters are used in the request, or if one or more order IDs are passed in the request.
NumberOfDays
- This filter specifies the number of days (24-hour periods) in the past to search for orders. All eBay orders that were either created or modified within this period are returned in the output. This field cannot be used in conjunction with the CreateTimeFrom/CreateTimeTo or ModTimeFrom/ModTimeTo date filters.
IncludeFinalValueFee
- This field is included and set to true
if the user wants to view the Final Value Fee (FVF) for all orders 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.
SortingOrder
- This filter controls whether orders are retrieved in ascending order (oldest to newest according to modification date) or descending order (newest to oldest according to modification date). The default is Ascending
, so the user will need to include this field and set it to Descending
if the user wishes to view the most recent orders first in the retrieved output.
ReturnedPaginationResult
- Contains information regarding the pagination of data, including the total number of pages and the total number of orders.
ReturnedHasMoreOrders
- A true value indicates that there are more orders to be retrieved. Additional GetOrders calls with higher page numbers or more entries per page must be made to retrieve these orders. If false, no more orders are available or no orders match the request (based on the input filters).
ReturnedOrderArray
- The set of orders that match the order IDs or filter criteria specified.
ReturnedOrdersPerPage
- Indicates the number of orders that can be returned per page of data (i.e., per call). This is the same value specified in the Pagination.EntriesPerPage input (or the default value, if EntriesPerPage was not specified). This is not necessarily the actual number of orders returned per page (see ReturnedOrderCountActual).
ReturnedPageNumber
- Indicates the page number of data returned in the response. This is the same value specified in the Pagination.PageNumber input. If orders are returned, the first page is 1.
ReturnedReturnedOrderCountActual
- Indicates the total number of orders returned.
Field Summary |
---|
Fields inherited from class com.ebay.sdk.ApiCall |
---|
apiException, sendReqListeners |
Constructor Summary | |
---|---|
GetOrdersCall()
Constructor. |
|
GetOrdersCall(ApiContext apiContext)
Constructor. |
Method Summary | |
---|---|
java.util.Calendar |
getCreateTimeFrom()
Gets the GetOrdersRequestType.createTimeFrom. |
java.util.Calendar |
getCreateTimeTo()
Gets the GetOrdersRequestType.createTimeTo. |
java.lang.Boolean |
getIncludeFinalValueFee()
Gets the GetOrdersRequestType.includeFinalValueFee. |
ListingTypeCodeType |
getListingType()
Gets the GetOrdersRequestType.listingType. |
java.util.Calendar |
getModTimeFrom()
Gets the GetOrdersRequestType.modTimeFrom. |
java.util.Calendar |
getModTimeTo()
Gets the GetOrdersRequestType.modTimeTo. |
java.lang.Integer |
getNumberOfDays()
Gets the GetOrdersRequestType.numberOfDays. |
OrderIDArrayType |
getOrderIDArray()
Gets the GetOrdersRequestType.orderIDArray. |
TradingRoleCodeType |
getOrderRole()
Gets the GetOrdersRequestType.orderRole. |
OrderType[] |
getOrders()
Retrieves the orders for which the authenticated user is a participant, either as the buyer or the seller. |
OrderStatusCodeType |
getOrderStatus()
Gets the GetOrdersRequestType.orderStatus. |
PaginationType |
getPagination()
Gets the GetOrdersRequestType.pagination. |
java.lang.Boolean |
getReturnedHasMoreOrders()
Valid after executing the API. |
OrderType[] |
getReturnedOrderArray()
Valid after executing the API. |
java.lang.Integer |
getReturnedOrdersPerPage()
Valid after executing the API. |
java.lang.Integer |
getReturnedPageNumber()
Valid after executing the API. |
PaginationResultType |
getReturnedPaginationResult()
Valid after executing the API. |
java.lang.Integer |
getReturnedReturnedOrderCountActual()
Valid after executing the API. |
SortOrderCodeType |
getSortingOrder()
Gets the GetOrdersRequestType.sortingOrder. |
void |
setCreateTimeFrom(java.util.Calendar createTimeFrom)
Sets the GetOrdersRequestType.createTimeFrom. |
void |
setCreateTimeTo(java.util.Calendar createTimeTo)
Sets the GetOrdersRequestType.createTimeTo. |
void |
setIncludeFinalValueFee(java.lang.Boolean includeFinalValueFee)
Sets the GetOrdersRequestType.includeFinalValueFee. |
void |
setListingType(ListingTypeCodeType listingType)
Sets the GetOrdersRequestType.listingType. |
void |
setModTimeFrom(java.util.Calendar modTimeFrom)
Sets the GetOrdersRequestType.modTimeFrom. |
void |
setModTimeTo(java.util.Calendar modTimeTo)
Sets the GetOrdersRequestType.modTimeTo. |
void |
setNumberOfDays(java.lang.Integer numberOfDays)
Sets the GetOrdersRequestType.numberOfDays. |
void |
setOrderIDArray(OrderIDArrayType orderIDArray)
Sets the GetOrdersRequestType.orderIDArray. |
void |
setOrderRole(TradingRoleCodeType orderRole)
Sets the GetOrdersRequestType.orderRole. |
void |
setOrderStatus(OrderStatusCodeType orderStatus)
Sets the GetOrdersRequestType.orderStatus. |
void |
setPagination(PaginationType pagination)
Sets the GetOrdersRequestType.pagination. |
void |
setSortingOrder(SortOrderCodeType sortingOrder)
Sets the GetOrdersRequestType.sortingOrder. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public GetOrdersCall()
public GetOrdersCall(ApiContext apiContext)
apiContext
- The ApiContext object to be used to make the call.Method Detail |
---|
public OrderType[] getOrders() throws ApiException, SdkException, java.lang.Exception
ApiException
SdkException
java.lang.Exception
public java.util.Calendar getCreateTimeFrom()
public void setCreateTimeFrom(java.util.Calendar createTimeFrom)
createTimeFrom
- Calendarpublic java.util.Calendar getCreateTimeTo()
public void setCreateTimeTo(java.util.Calendar createTimeTo)
createTimeTo
- Calendarpublic java.lang.Boolean getIncludeFinalValueFee()
public void setIncludeFinalValueFee(java.lang.Boolean includeFinalValueFee)
includeFinalValueFee
- Booleanpublic ListingTypeCodeType getListingType()
public void setListingType(ListingTypeCodeType listingType)
listingType
- ListingTypeCodeTypepublic java.util.Calendar getModTimeFrom()
public void setModTimeFrom(java.util.Calendar modTimeFrom)
modTimeFrom
- Calendarpublic java.util.Calendar getModTimeTo()
public void setModTimeTo(java.util.Calendar modTimeTo)
modTimeTo
- Calendarpublic java.lang.Integer getNumberOfDays()
public void setNumberOfDays(java.lang.Integer numberOfDays)
numberOfDays
- Integerpublic OrderIDArrayType getOrderIDArray()
public void setOrderIDArray(OrderIDArrayType orderIDArray)
orderIDArray
- OrderIDArrayTypepublic TradingRoleCodeType getOrderRole()
public void setOrderRole(TradingRoleCodeType orderRole)
orderRole
- TradingRoleCodeTypepublic OrderStatusCodeType getOrderStatus()
public void setOrderStatus(OrderStatusCodeType orderStatus)
orderStatus
- OrderStatusCodeTypepublic PaginationType getPagination()
public void setPagination(PaginationType pagination)
pagination
- PaginationTypepublic SortOrderCodeType getSortingOrder()
public void setSortingOrder(SortOrderCodeType sortingOrder)
sortingOrder
- SortOrderCodeTypepublic java.lang.Boolean getReturnedHasMoreOrders()
public OrderType[] getReturnedOrderArray()
public java.lang.Integer getReturnedOrdersPerPage()
public java.lang.Integer getReturnedPageNumber()
public PaginationResultType getReturnedPaginationResult()
public java.lang.Integer getReturnedReturnedOrderCountActual()
|
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.