GET /returns
Summary: List Returns
Operation ID: get-returns
Auth: unknown
Operation ID: get-returns
Auth: unknown
Description
Retrieves summary return activity during the queried timespan. Although return knowledge can be learned from `GET /orders/{id}` it can take an unknown amount of time for an order that is refused or undeliverable to return to an FDC facility. Instead we recommend regularly querying this API.
Parameters (4)
fromDate
(string, query, required)
Date-time in ISO 8601 format for selecting orders after, or at, the specified time
limit
(integer, query, optional, default: 80)
The numbers of items to return
Constraints: {'minimum': 1, 'maximum': 200}
page
(integer, query, optional, default: 1)
A multiplier of the number of items (limit parameter) to skip before returning results
Constraints: {'minimum': 1}
toDate
(string, query, required)
Date-time in ISO 8601 format for selecting orders before, or at, the specified time
No probe data for this endpoint yet.