GET
List return orders

Authorizations

x-api-key
string
header
required

Query Parameters

page
integer
default:0

Page number, starting at 0. Must be a non-negative integer.

per_page
integer
default:10

Number of return orders per page. Must be a non-negative integer. No maximum is enforced; keep it reasonable (e.g. up to 100).

buyer_return_order_state_code
enum<integer>[]

Only return orders in these states. JSON array of state codes, e.g. [1,7]. See BuyerReturnOrderState for the codes.

Available options:
1,
2,
3,
4,
5,
6,
7,
8
external_order_number
string[]

Only return orders whose external_order_number is one of these values (exact match). JSON array of strings, e.g. ["EXT-1","EXT-2"].

external_order_id
string

Only return orders with this external_order_id (exact match).

Response

A page of return orders.

data
object[]

Return orders on this page.

meta
object

Pagination of this response.