eBay Trading APIVersion 1125

GetOrdersRequestType ( AbstractRequestType )

Retrieves the orders for which the authenticated user is a participant, either as the buyer or the seller. The call returns all the orders that meet the request criteria. Orders older than 90 days old will not be returned.

Call that uses GetOrdersRequestType:

Fields



CreateTimeFrom ( dateTime ) [0..1]
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.

Note: Unless one or more OrderID values are used, one of the three available date range filters must be used.
See the Field Index to learn which calls use CreateTimeFrom.

CreateTimeTo ( dateTime ) [0..1]
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.

Note: If a GetOrders call is made within a few seconds after the creation of a multiple line item order, the caller runs the risk of retrieving orders that are in an inconsistent state, since the order consolidation involved in a multiple line item order may not have been completed. For this reason, it is recommended that sellers include the CreateTimeTo field in the call, and set its value to: Current Time - 2 minutes.
Note: Unless one or more OrderID values are used, one of the three available date range filters must be used.
See the Field Index to learn which calls use CreateTimeTo.

IncludeFinalValueFee ( boolean ) [0..1]
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.
See the Field Index to learn which calls use IncludeFinalValueFee.

ListingType ( ListingTypeCodeType ) [0..1]
Not used by any call.

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.
See the Field Index to learn which calls use ListingType.

ModTimeFrom ( dateTime ) [0..1]
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.

Note: Unless one or more OrderID values are used, one of the three available date range filters must be used.
See the Field Index to learn which calls use ModTimeFrom.

ModTimeTo ( dateTime ) [0..1]
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.

Note: Unless one or more OrderID values are used, one of the three available date range filters must be used.
See the Field Index to learn which calls use ModTimeTo.

NumberOfDays ( int ) [0..1]
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.

Note: This date filter only allows you to retrieve orders created/modified within the last 30 days. So, if you wish to retrieve orders created and/or modified more than 30 days in the past, the CreateTimeFrom/CreateTimeTo or ModTimeFrom/ModTimeTo date filters should be used instead.
Note: Unless one or more OrderID values are used, one of the three available date range filters must be used.
See the Field Index to learn which calls use NumberOfDays.

OrderIDArray ( OrderIDArrayType ) [0..1]
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.

Note: As of June 2019, eBay has changed the format of order identifier values. The new format is a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. Unlike in the past, instead of just being known and exposed to the seller, these unique order identifiers will also be known and used/referenced by the buyer and eBay customer support.

For developers and sellers who are already integrated with the Trading API's order management calls, this change shouldn't impact your integration unless you parse the existing order identifiers (e.g., OrderID or OrderLineItemID), or otherwise infer meaning from the format (e.g., differentiating between a single line item order versus a multiple line item order). Because we realize that some integrations may have logic that is dependent upon the old identifier format, eBay is rolling out this Trading API change with version control to support a transition period of approximately 9 months before applications must switch to the new format completely.

During the transition period, for developers/sellers using a Trading WSDL older than Version 1113, they can use the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header in API calls to control whether the new or old OrderID format is returned in call response payloads. To get the new OrderID format, the value of the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header must be set to 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.

Note: For sellers integrated with the new order ID format, please note that the identifier for an order will change as it goes from unpaid to paid status. Sellers can check to see if an order has been paid by looking for a value of 'Complete' in the CheckoutStatus.Status field in the response of GetOrders or GetOrderTransactions call, or in the Status.CompleteStatus field in the response of GetItemTransactions or GetSellerTransactions call. Sellers should not fulfill orders until buyer has made payment. When using a GetOrders or GetOrderTransactions call to retrieve specific order(s), either of these order IDs (paid or unpaid status) can be used to retrieve an order.
See the Field Index to learn which calls use OrderIDArray.

OrderRole ( TradingRoleCodeType ) [0..1]
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.
See the Field Index to learn which calls use OrderRole.

OrderStatus ( OrderStatusCodeType ) [0..1]
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.

If one or more OrderID values are specified through the OrderIDArray container, the OrderStatus field should not be used, and it is ignored if it is used. If an OrderStatus value is not used and no OrderID values are specified, orders in all states are returned.
See the Field Index to learn which calls use OrderStatus.

Pagination ( PaginationType ) [0..1]
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.
See the Field Index to learn which calls use Pagination.

SortingOrder ( SortOrderCodeType ) [0..1]
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.
See the Field Index to learn which calls use SortingOrder.