Skip to main content
GET
List orders

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

filter
string

Un texto que se usa para filtrar por código de pedido o nombre del comprador.

storesIds
string[]

Un arreglo con el ID o ID externo de los locales.

fromDate
string<date-time>

Incluir pedidos desde alguna fecha.

toDate
string<date-time>

Incluir pedidos hasta alguna fecha.

orderStatuses
enum<string>[]

Muestra los pedidos que tengan estos estados.

Available options:
pending,
waiting,
preparing,
delivering,
done,
cancelled,
scheduled
useDeliverAt
boolean

Si es verdadero, ordena y filtra los pedidos por fecha de entrega. Si es falso, usa fecha de creación.

includeNotPaid
boolean

Si es verdadero, incluye pedidos con pago no completado (paymentStatus distinto de done).

page
number

Número de página.

Example:

1

limit
number

Número de items por página. Max 100. Por defecto: 10.

Example:

10

Response

The OpenAPI spec

success
boolean
Example:

true

data
object