List Returns
GET {{baseUrl}}/v1/order_returns?limit=<string>&ending_before=<string>&starting_after=<string>&tokens=<string>,<string>
Retrieve a list of all order returns.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
limit | string | The maximum number of returns to list. Range - 1-100. Default is 10. | |
ending_before | string | The ID of the order created after the last order you want to retrieve a return from. | |
starting_after | string | The ID of the order created before the first order you want to retrieve a return from. | |
tokens | string | Filters the list for orders related to the specified order. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"status":{"error_code":"\u003cstring\u003e","message":"\u003cstring\u003e","operation_id":"\u003cstring\u003e","response_code":"\u003cstring\u003e","status":"\u003cstring\u003e"},"data":[{"id":"\u003cstring\u003e","amount":"\u003cnumber\u003e","created":"\u003cinteger\u003e","currency":"CZK","items":[{"amount":"\u003cnumber\u003e","currency":"HRK","description":"\u003cstring\u003e","parent":"\u003cnumber\u003e","quantity":"\u003cnumber\u003e","type":"\u003cstring\u003e"},{"amount":"\u003cnumber\u003e","currency":"MAD","description":"\u003cstring\u003e","parent":"\u003cnumber\u003e","quantity":"\u003cnumber\u003e","type":"\u003cstring\u003e"}],"order":"\u003cstring\u003e","refund":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","amount":"\u003cnumber\u003e","created":"\u003cinteger\u003e","currency":"PYG","items":[{"amount":"\u003cnumber\u003e","currency":"MRO","description":"\u003cstring\u003e","parent":"\u003cnumber\u003e","quantity":"\u003cnumber\u003e","type":"\u003cstring\u003e"},{"amount":"\u003cnumber\u003e","currency":"MXN","description":"\u003cstring\u003e","parent":"\u003cnumber\u003e","quantity":"\u003cnumber\u003e","type":"\u003cstring\u003e"}],"order":"\u003cstring\u003e","refund":"\u003cstring\u003e"}]}