This doc page has moved! You should be automatically redirected to the resources page for the eBay Fulfillment API. If you are not redirected automatically, follow this link to the Fulfillment API.

eBay Fulfillment APIVersion 1.2.0

OrderSearchPagedCollection

This type contains the specifications for the collection of orders that match the search or filter criteria of a getOrders call. The collection is grouped into result sets (pages) of manageable size, and each execution of the call returns one result set. The OrderSearchPagedCollection fields provide the information necessary to navigate through all of these result sets, as well as the contents of the currently specified result set.

Call that uses OrderSearchPagedCollection:

Fields

orders ( array of Order )
warnings ( array of ErrorDetailV3 )


href ( string ) [0..?]
The URI of the getOrders call request that produced this result set.
See the Field Index to learn which calls use href.

limit ( integer ) [0..?]
The maximum number of orders returned in the current result set.

Note: If this is the last or only result set in the collection, it may contain fewer orders. To determine the number of result sets in the collection, divide this into the value of total and round up to the next integer.Default: 50
See the Field Index to learn which calls use limit.

next ( string ) [0..?]
The getOrders call URI for the next result set. For example, the following URI returns records 41 thru 50 from the collection of orders:

path/order?limit=10&offset=40
See the Field Index to learn which calls use next.

offset ( integer ) [0..?]
The distance (number of records) from the first order in the collection to the first order in this result set. In the request, you can use the offset parameter in conjunction with the limit parameter to control the pagination of the output. For example, if offset is set to 30 and limit is set to 10, the call retrieves orders 31 thru 40 from the resulting collection of orders.

Note: This feature employs a zero-based list, where the first item in the list has an offset of 0.Default: 0 (zero)
See the Field Index to learn which calls use offset.

orders ( array of Order ) [0..?]
Contains the array of orders in the current result set. The details of each order include information about the buyer, order history, shipping fulfillments, line items, costs, payments, and order fulfillment status.

The orders are sorted by orders.orderId.
See the Field Index to learn which calls use orders.

prev ( string ) [0..?]
The getOrders call URI for the previous result set. For example, the following URI returns orders 21 thru 30 from the collection of orders:

path/order?limit=10&offset=20

Note: This feature employs a zero-based list, where the first order in the list has an offset of 0.
See the Field Index to learn which calls use prev.

total ( integer ) [0..?]
The total number of orders in the collection.

Note: If no orders are found, this field is returned with a value of 0.
See the Field Index to learn which calls use total.

warnings ( array of ErrorDetailV3 ) [0..?]
Contains warnings related to this call request. This is usually empty.
See the Field Index to learn which calls use warnings.