Skip to main content
GET
List orders
Returns the orders attributed to affiliate channels, newest first. Requires scope network:orders:read.

Authorizations

x-api-key
string
header
required

Brand key created in the dashboard.

Query Parameters

page
integer
default:1

Page number.

Required range: x >= 1
limit
integer
default:20

Items per page. Values above 100 return 400.

Required range: 1 <= x <= 100
from
string<date-time>

Start of the period (ISO 8601). Default: 30 days ago.

to
string<date-time>

End of the period (ISO 8601). Default: now. At most 90 days after from.

status
enum<string>

Filter by order status.

Available options:
pending,
approved,
canceled,
reproved
commissionStatus
string

Filter by commission status, for example pending.

channelId
string<uuid>

Only orders attributed to this affiliate channel.

Response

Paginated orders

data
object[]
required
meta
object
required