Title: SOAP API wrapper library.
Description: Contains wrapper classes for eBay SOAP APIs.
Copyright: Copyright (c) 2009
Company: eBay Inc.
OrderIDArray - A container for eBay order IDs. If one or more order IDs are specified in this container, no other call-specific input fields are applicable. CreateTimeFrom - The CreateTimeFrom and CreateTimeTo fields specify a date range for retrieving orders. 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. CreateTimeTo - The CreateTimeFrom and CreateTimeTo fields specify a date range for retrieving orders. 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 - Filters the returned orders based on the role of the user. The user's role is either buyer or seller. 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 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 - Specify Half to retrieve Half.com orders. 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 entries. Use the Pagination filters to control the maximum number of entries to retrieve per page (i.e., per call), the page number to retrieve, and other data. ModTimeFrom - 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 ModTimeFrom field is the starting date range. All eBay orders that were last modified within this date range are returned in the output. The maximum date range that may be specified with the ModTimeFrom and ModTimeTo fields is 30 days. 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. 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. This date filter is ignored if one or more order IDs are passed in the request. IncludeFinalValueFee - Indicates whether to include the Final Value Fee (FVF) for all Transaction objects in the response. The Final Value Fee is returned in Transaction.FinalValueFee. The Final Value Fee is assessed right after the creation of an eBay order line item. SortingOrder - Specifies how orders returned by this call should be sorted (using LastModifiedTime as the sort key). A value of Ascending returns the earliest modified orders first, and a value of Descending returns the latest modified orders first. Ascending 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. Also applicable to Half.com (only returns orders that have not been marked as shipped). 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.
@author Ron Murphy
@version 1.0
| |
| |
| |
| |
| |
| |