GetOrdersResponseType ( AbstractResponseType )

Returns the set of orders that match the order IDs or filter criteria specified.

Call that uses GetOrdersResponseType:

GetOrders

Fields

HasMoreOrders ( boolean )

OrderArray ( OrderArrayType )

OrdersPerPage ( int )

PageNumber ( int )

PaginationResult ( PaginationResultType )

ReturnedOrderCountActual ( int )

HasMoreOrders ( boolean ) [0..1]

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

See the Field Index to learn which calls use HasMoreOrders.

OrderArray ( OrderArrayType ) [0..1]

The set of orders that match the order IDs or filter criteria specified.

See the Field Index to learn which calls use OrderArray.

OrdersPerPage ( int ) [0..1]

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

See the Field Index to learn which calls use OrdersPerPage.

PageNumber ( int ) [0..1]

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.

See the Field Index to learn which calls use PageNumber.

PaginationResult ( PaginationResultType ) [0..1]

Contains information regarding the pagination of data, including the total number of pages and the total number of orders.

See the Field Index to learn which calls use PaginationResult.

ReturnedOrderCountActual ( int ) [0..1]

Indicates the total number of orders returned.

See the Field Index to learn which calls use ReturnedOrderCountActual.