feed APIv1.1.0

OrderTaskCollection

The type that defines the fields for a paginated result set of orders. The response consists of 0 or more sequenced pages where each page has 0 or more items.

Types that use OrderTaskCollection

Not used by any types

Call that uses OrderTaskCollection

Fields

Field
Type
Description
href
The path to the call URI that produced the current page of results.
limit
The value of the limit parameter submitted in the request, which is the maximum number of tasks to return per page, from the result set. A result set is the complete set of tasks returned by the method.

Note:Though this parameter is not required to be submitted in the request, the parameter defaults to 10 if omitted.

next
The path to the call URI for the next page of results. This value is returned if there is an additional page of results to return from the result set.
offset
The number of results skipped in the result set before listing the first returned result. This value can be set in the request with the offset query parameter.

Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of 0.

prev
The path to the call URI for the previous page of results. This is returned if there is a previous page of results from the result set.
tasks
array of OrderTask
An array of the order tasks on this page. The tasks are sorted by creation date. An empty array is returned if the filter criteria excludes all tasks.
total
The total number of order tasks that match the input criteria.