Skip to main content
GET
Filter with status, customer_id and reference. data holds the orders and pagination has current_page, per_page, total and last_page. See Read orders.

Authorizations

X-Api-Key
string
header
required

Your API key (yativo_pk_...) from Developers → API Keys. Send together with X-Api-Secret.

X-Api-Secret
string
header
required

Your API secret (yativo_sk_...), shown once when the key is created.

Query Parameters

status
string

Filter by order status, for example paid.

customer_id
string

Only orders for this selling customer.

reference
string

Your order ID.

per_page
integer
default:20
Required range: 1 <= x <= 100

Response

Paginated orders

status
string
Example:

"success"

status_code
integer
Example:

200

message
string
Example:

"Request successful"

data
object