Get order collection

GET

/rest/v1/order/order

Authorizations

bearerAuth

JWT access token obtained from /rest/auth/admin/login or /rest/auth/customer/login

Type

HTTP (bearer)

Parameters

Query Parameters

filter[id]

Filter by order IDs

Type

string

filter[orderSerial]

Filter by order serial (partial)

Type

string

filter[customerId]

Filter by customer ID

Type

string

filter[status]

Filter by status

Type

string

filter[payway]

Filter by payment method

Type

string

filter[isPaid]

Filter by paid status

Type

boolean

filter[paid]

Filter by paid flag

Type

boolean

filter[isVisible]

Filter by visibility

Type

boolean

filter[storeId]

Filter by store ID

Type

string

filter[provider]

Filter by provider

Type

string

sort

Sort order

Type

string

page

Page number

Type

integer

limit

Pagination limit

Type

integer

with

With relations (e.g., customer,basket)

Type

string

Responses

Successful operation

Content-Type

application/json

"string"

GET

/rest/v1/order/order

Playground

Authorization

bearerAuth

Variables

Key

Value

filter[id]

filter[orderSerial]

filter[customerId]

filter[status]

filter[payway]

filter[isPaid]

filter[paid]

filter[isVisible]

filter[storeId]

filter[provider]

sort

page

limit

with

Samples

Powered by VitePress OpenAPI