Trading_GetOrdersResponseType Class Reference
Inherits from | Trading_AbstractResponseType : NSObject |
Declared in | Trading_GetOrdersResponseType.h Trading_GetOrdersResponseType.m |
Overview
Returns the set of orders that match the order IDs or filter criteria specified.
@ingroup EBayAPIInterface
Tasks
-
paginationResult
Contains information regarding the pagination of
property
data, including the total number of pages and the total
number of orders. -
hasMoreOrders
A true value indicates that there are more orders to be
property
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). -
orderArray
The set of orders that match the order IDs or filter criteria specified.
property
Also applicable to Half.com (only returns orders that have not been marked as shipped). -
ordersPerPage
Indicates the number of orders that can be
property
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). -
pageNumber
Indicates the page number of data returned in the response.
property
This is the same value specified in the
Pagination.PageNumber input. If orders are returned, the first page is 1. -
returnedOrderCountActual
Indicates the total number of orders returned.
property
Properties
hasMoreOrders
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).
@property (nonatomic, retain) NSNumber *hasMoreOrders
Discussion
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).
type : NSNumber, wrapper for primitive bool
Declared In
Trading_GetOrdersResponseType.h
orderArray
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).
@property (nonatomic, retain) Trading_OrderArrayType *orderArray
Discussion
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).
type : class Trading_OrderArrayType
Declared In
Trading_GetOrdersResponseType.h
ordersPerPage
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).
@property (nonatomic, retain) NSNumber *ordersPerPage
Discussion
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).
type : NSNumber, wrapper for primitive int
Declared In
Trading_GetOrdersResponseType.h
pageNumber
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.
@property (nonatomic, retain) NSNumber *pageNumber
Discussion
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.
type : NSNumber, wrapper for primitive int
Declared In
Trading_GetOrdersResponseType.h
paginationResult
Contains information regarding the pagination of
data, including the total number of pages and the total
number of orders.
@property (nonatomic, retain) Trading_PaginationResultType *paginationResult
Discussion
Contains information regarding the pagination of
data, including the total number of pages and the total
number of orders.
type : class Trading_PaginationResultType
Declared In
Trading_GetOrdersResponseType.h