Listar pedidos

Descripción

Lista todos los pedidos de la marca. Ordenados por el valor del atributo useDeliverAt(Ver parámetros más abajo)

• Método: orders
• Parámetros:
  • filter: Un texto que se usa para filtrar por código de pedido o nombre del comprador
  • storesIds: Un arreglo con el ID o ID externo de los locales
  • fromDate: Incluír pedidos desde alguna fecha. Si no se incluye se toman todos los pedidos
  • toDate: Incluír pedidos hasta que fecha. Si no se incluye se toman todos los pedidos
  • orderStatuses: Un arreglo, opcional. Muestra los pedidos que tengan estos estados (pending, waiting, preparing, delivering, done, cancelled, scheduled)
  • useDeliverAt: 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 Verdadero o falso. Si es verdadero se incluyen los pedidos con pago no completado (paymentStatus no done).
  • page: Página de los resultados
• Respuesta:
  • [PaginatedResult]: Los pedidos pendientes. PaginatedResult de Order

Ejemplo

Llamada

POST /api/v1/orders

Content-Type: application/json

{
  "storesIds": ["Li4eEa3W2hiuGGCFa"],
  "page": 1
}

Respuesta

{
  "totalCount": 36,
  "totalPages": 2,
  "hasNextPage": false,
  "hasPreviousPage": true,
  "items": [
    <Order>,
    <Order>,
    ...
  ]
}