Skip to main content
GET
cURL

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>

Incluír pedidos desde alguna fecha. Si no se incluye se toman todos los pedidos

toDate
string<date-time>

Incluír pedidos hasta que fecha. Si no se incluye se toman todos los pedidos

orderStatuses
string[]

Un arreglo, opcional. Muestra los pedidos que tengan estos estados (pending, waiting, preparing, delivering, done, cancelled, scheduled)

useDeliverAt
boolean

Verdadero o falso. Si es que se deja verdadero se van a ordenar y filtrar los pedidos por fecha de entrega, sino por fecha de creación

includeNotPaid
boolean

Verdadero o falso. Si es verdadero se incluyen los pedidos con pago no completado (paymentStatus no done).

page
integer

Página de los resultados

Response

success

status
string

Resultado de la operación

Example:

"ok"

data
object[]