Inherits from Trading_AbstractRequestType : NSObject
Declared in Trading_GetOrdersRequestType.h
Trading_GetOrdersRequestType.m

Overview

Retrieves the orders for which the authenticated user is a participant, either as the buyer
or the seller. Also for Half.com. The call returns all the
orders that meet the request specifications.

@ingroup EBayAPIInterface

Tasks

  •   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.



    Not applicable to Half.com.

         property
  •   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.


    Applicable to Half.com.

         property
  •   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.



    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 retrieiving orders that are in an
    inconsistent state, since the order consolidation involved in a multi-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.



    Applicable to Half.com.

         property
  •   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.


    Applicable to eBay.com and Half.com.

         property
  •   orderStatus

    Filters the returned orders by order status. For eBay orders, only the Active and
    Completed values are applicable. The Shipping value can be used for Half.com
    orders. If this field is used with a date filter, returned orders
    must satisfy both the date range and the OrderStatus value.



    To retrieve orders with a status of Inactive or Cancelled, you must specify
    the order IDs (OrderIDArray.OrderID). When you specify order IDs, no
    other filters may be 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.

         property
  •   listingType

    Specify Half to retrieve Half.com orders.



    Note:
    Do not use this field if you are retrieving eBay orders.



    This field cannnot be used as a listing type filter on eBay.com. If not
    provided, or if you specify any value other than Half, 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.

         property
  •   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.

         property
  •   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.



    Applicable to Half.com.

         property
  •   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.



    Applicable to Half.com.

         property
  •   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.



    Applicable to Half.com.

         property
  •   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.

         property

Properties

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.


Applicable to Half.com.

@property (nonatomic, retain) NSDate *createTimeFrom

Discussion

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.


Applicable to Half.com.

type : NSDate, wrapper for primitive date

Declared In

Trading_GetOrdersRequestType.h

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.



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 retrieiving orders that are in an
inconsistent state, since the order consolidation involved in a multi-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.



Applicable to Half.com.

@property (nonatomic, retain) NSDate *createTimeTo

Discussion

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.



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 retrieiving orders that are in an
inconsistent state, since the order consolidation involved in a multi-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.



Applicable to Half.com.

type : NSDate, wrapper for primitive date

Declared In

Trading_GetOrdersRequestType.h

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.

@property (nonatomic, retain) NSNumber *includeFinalValueFee

Discussion

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.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_GetOrdersRequestType.h

listingType

Specify Half to retrieve Half.com orders.



Note:
Do not use this field if you are retrieving eBay orders.



This field cannnot be used as a listing type filter on eBay.com. If not
provided, or if you specify any value other than Half, 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.

@property (nonatomic, retain) NSString *listingType

Discussion

Specify Half to retrieve Half.com orders.



Note:
Do not use this field if you are retrieving eBay orders.



This field cannnot be used as a listing type filter on eBay.com. If not
provided, or if you specify any value other than Half, 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.

type: string constant in Trading_ListingTypeCodeType.h

Declared In

Trading_GetOrdersRequestType.h

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.



Applicable to Half.com.

@property (nonatomic, retain) NSDate *modTimeFrom

Discussion

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.



Applicable to Half.com.

type : NSDate, wrapper for primitive date

Declared In

Trading_GetOrdersRequestType.h

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.



Applicable to Half.com.

@property (nonatomic, retain) NSDate *modTimeTo

Discussion

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.



Applicable to Half.com.

type : NSDate, wrapper for primitive date

Declared In

Trading_GetOrdersRequestType.h

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.



Applicable to Half.com.

@property (nonatomic, retain) NSNumber *numberOfDays

Discussion

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.



Applicable to Half.com.

type : NSNumber, wrapper for primitive int

Declared In

Trading_GetOrdersRequestType.h

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.



Not applicable to Half.com.

@property (nonatomic, retain) Trading_OrderIDArrayType *orderIDArray

Discussion

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.



Not applicable to Half.com.

type : class Trading_OrderIDArrayType

Declared In

Trading_GetOrdersRequestType.h

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.


Applicable to eBay.com and Half.com.

@property (nonatomic, retain) NSString *orderRole

Discussion

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.


Applicable to eBay.com and Half.com.

type: string constant in Trading_TradingRoleCodeType.h

Declared In

Trading_GetOrdersRequestType.h

orderStatus

Filters the returned orders by order status. For eBay orders, only the Active and
Completed values are applicable. The Shipping value can be used for Half.com
orders. If this field is used with a date filter, returned orders
must satisfy both the date range and the OrderStatus value.



To retrieve orders with a status of Inactive or Cancelled, you must specify
the order IDs (OrderIDArray.OrderID). When you specify order IDs, no
other filters may be 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.

@property (nonatomic, retain) NSString *orderStatus

Discussion

Filters the returned orders by order status. For eBay orders, only the Active and
Completed values are applicable. The Shipping value can be used for Half.com
orders. If this field is used with a date filter, returned orders
must satisfy both the date range and the OrderStatus value.



To retrieve orders with a status of Inactive or Cancelled, you must specify
the order IDs (OrderIDArray.OrderID). When you specify order IDs, no
other filters may be 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.

type: string constant in Trading_OrderStatusCodeType.h

Declared In

Trading_GetOrdersRequestType.h

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.

@property (nonatomic, retain) Trading_PaginationType *pagination

Discussion

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.

type : class Trading_PaginationType

Declared In

Trading_GetOrdersRequestType.h