eBay Bulk Data Exchange APIVersion 1.5.0

OrderReportFilter

Type defining the orderReportFilter container, which allows the user to set time, order status, or order type (eBay or Half.com) filters, and to specify whether or not to include Final Value Fees for each order line item in Merchant Data's OrderReport response.

The orderReportFilter container is only applicable if the downloadJobType value is set to 'OrderReport'.

Type that uses OrderReportFilter:

Call that uses OrderReportFilter:

Fields



createTimeFrom ( dateTime ) [0..1]
The createTimeFrom and createTimeTo fields specify a date range for retrieving orders. The createTimeFrom value is the start of the 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 is 30 days.

If the createTimeFrom field is set, the createTimeTo field must also be included or the call will fail.

If the order Creation Time or order Modification Time filters are not provided, the default behavior is to retrieve unacknowledged orders from the last 30 days.

Applicable to Half.com (if the listingType field is included and set to 'Half'.
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. The createTimeTo value is the end of the 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 is 30 days.

If the createTimeTo field is set, the createTimeFrom field must also be included or the call will fail.

If the order Creation Time or order Modification Time filters are not provided, the default behavior is to retrieve unacknowledged orders from the last 30 days.

Applicable to Half.com (if the listingType field is included and set to 'Half').
See the Field Index to learn which calls use createTimeTo.

includeFinalValueFee ( boolean ) [0..1]
This field should be included and set to 'true' if the user wishes to include the Final Value Fee for all order line items 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 eBay order line item.
See the Field Index to learn which calls use includeFinalValueFee.

listingType ( ListingType ) [0..1]
This field must be included and set to 'Half' if the user only wants to retrieve Half.com orders. This field should not be used if the user wishes to retrieve eBay.com orders.
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 orders. The modTimeFrom value is the start of the date range. All eBay orders that were modified within this date range are returned in the output. The maximum date range that may be specified is 30 days.

If the modTimeFrom field is set, the modTimeTo field must also be included or the call will fail. The modTimeFrom and modTimeTo filters are not applicable if the createTimeFrom and createTimeTo fields are set.

If the order Creation Time or order Modification Time filters are not provided, the default behavior is to retrieve unacknowledged orders from the last 30 days.

Applicable to Half.com (if the listingType field is included and set to 'Half').
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 orders. The modTimeTo value is the end of the date range. All eBay orders that were modified within this date range are returned in the output. The maximum date range that may be specified is 30 days.

If the modTimeFrom field is set, the modTimeTo field must also be included or the call will fail. The modTimeFrom and modTimeTo filters are not applicable if the createTimeFrom and createTimeTo fields are set.

If the order Creation Time or order Modification Time filters are not provided, the default behavior is to retrieve unacknowledged orders from the last 30 days.

Applicable to Half.com (if the listingType field is included and set to 'Half').
See the Field Index to learn which calls use modTimeTo.

orderStatus ( OrderStatusTypes ) [0..1]
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.

For eBay.com orders, this field's value can be set to 'Active', 'Completed', 'Cancelled' or 'Inactive' to retrieve orders in these states. The 'Shipped' value is only applicable for Half.com orders.
See the Field Index to learn which calls use orderStatus.

version ( int ) [1]
The value input into this field indicates the version number of the Trading API (specifically, GetOrders) that will be called when the orderReport is generated. This value must be a valid Trading API version number and it must be Version 841 or later. If an older version is used, orderReport will fail.

This field is required if the orderReportFilter container is used.
See the Field Index to learn which calls use version.