Skip to main content

The base response type of the getOrderEarnings method, which includes pagination output fields and a collection of orders that match the request criteria.

Types that use OrderEarnings

Not used by any types.

Call that uses OrderEarnings

GET
/order_earnings

Fields

Field
Type
Description
href
string
The URI for the current page of results.
limit
integer
The maximum number of order earnings records returned in a single page of results.
next
string
The URI for the next page of results. This field is only returned if there is a next page of results to retrieve.
offset
integer
The number of order earnings records skipped before returning the current page of results.
orders
array of OrderEarning
The list of order earnings records returned in the current page of results. This array will be returned as empty if no orders match the request criteria.
prev
string
The URI for the previous page of results. This field is only returned if there is a previous page of results to retrieve.
total
integer
The total number of order earnings records that match the request criteria.