GetOrdersRequestType
Retrieves all of the orders for which the user is a participant (as either buyer or seller) that meet the criteria specified in the request.

An order is a combination of two or more transactions.

There are two mutually exclusive sets of filtering input arguments that you can use to query for orders. The first set is based on specific order IDs (one or more order IDs are passed in the call). The second set is a combination of date range, order role, and order status. If you use one set of filtering arguments, the arguments for the other filtering mechanism should not be specified in the same call. If a given call to GetOrders includes both criteria sets, the query based on order IDs is used, and the criteria for date range/order status/order role is ignored.

Applicable to Half.com (used to retrieve unshipped Half.com orders, such as orders that the seller has received but has not yet processed).
Fields
CreateTimeFrom ( dateTime )
CreateTimeTo ( dateTime )
ListingType ( ListingTypeCodeType )
OrderIDArray ( OrderIDArrayType )
OrderRole ( TradingRoleCodeType )
OrderStatus ( OrderStatusCodeType )
Pagination ( PaginationType )

CreateTimeFrom ( dateTime ) [0..1]
The starting date of the date range for the orders to retrieve.

Applicable to Half.com.
See the Field Index to learn which calls use CreateTimeFrom.

CreateTimeTo ( dateTime ) [0..1]
The ending date of the date range for the orders to retrieve.

Applicable to Half.com.
See the Field Index to learn which calls use CreateTimeTo.

ListingType ( see ListingTypeCodeType for possible values ) [0..1]
To retrieve Half.com orders, specify Half--Do not specify this field if you are retrieving eBay orders.

This field cannot be used as a listing type filter on eBay.com. If not provided, or if any value other than Half is specified, this field has no useful effect and the call retrieves eBay orders of all types. Also, you can't retrieve both eBay and Half.com orders in the same response.
See the Field Index to learn which calls use ListingType.

OrderIDArray ( OrderIDArrayType ) [0..1]
A set of orders to retrieve.

Not applicable to Half.com.
See the Field Index to learn which calls use OrderIDArray.

OrderRole ( see TradingRoleCodeType for possible values ) [0..1]
Filters orders based on the role of the user making the GetOrders request.

Not applicable to Half.com.
See the Field Index to learn which calls use OrderRole.

OrderStatus ( see OrderStatusCodeType for possible values ) [0..1]
Filters the returned orders by order status (Active or Completed). To retrieve orders with a status of Inactive or Cancelled, you must specify the order IDs (OrderIDArray.OrderID). When you specify OrderIDArray.OrderID, no other filters are used.

For Half.com, you can get some, but not all orders. Orders on Half.com have different order status values from eBay orders. When you set ListingType to Half, set OrderStatus to Shipped. Otherwise, GetOrders may return incomplete information or have indeterminate results.
See the Field Index to learn which calls use OrderStatus.

Pagination ( PaginationType ) [0..1]
Not applicable to eBay.com. Applicable to Half.com. If many orders are available, you may need to call GetOrders multiple times to retrieve all the data. Each result set is returned as a page of entries. Use this Pagination information to indicate the maximum number of entries to retrieve per page (i.e., per call), the page number to retrieve, and other data.
See the Field Index to learn which calls use Pagination.

This document was generated with a customized version of the apireferencedocs tool.

© 2005–2009 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.