GET | /

Función que Realiza

• Lista todas las ordenes mediante la id del usuario y su rol + algunos filtros.

---

Funcionamiento

• URL Completa: {domain}/api/v1/orders/
• Acción: GET
• Requiere Api-Key?: Si
• Requiere una Sesión?: Si
• Recibe datos mediante: Query
  • Cantidad de datos: 5
• Responde con contenido?: Si
• Responde únicamente con código de estado?: No
  • Código: 200 | OK
• Códigos de error: Vea la sección Errores

---

Contenido que se recibe por Query

nota

• Si se deja el campo en blanco o no se ingresa un parámetro se devolverán todos los despachos sin filtrar, de lo contrario si se ingresa el parámetro se devolverán los despachos completados o sin completar dependiendo de la elección.
• Los campos fromDate y toDate son opcionales.
• Si solo se recibe el campo fromDate se va a devolver un listado desde la fecha ingresada en adelante.
• Si solo se recibe el campo toDate se va a devolver un listado desde todos los elementos previos a la fecha ingresada.

status?      =   Enum('PENDIENTE', 'ANULADO', 'COMPLETADO', 'ASIGNADO')
fromDate?    =   Date(YYYY-MM-DD)
toDate?      =   Date(YYYY-MM-DD)
page         =   Int
pageSize     =   Int

---

Contenido que devuelve

{
  "meta": {
    "page": Int,
    "pageSize": Int,
    "count": Int,
  },
  "orders": [
    {
      "id": "String",
      "dispatchId": Int | null,
      "comments": "String" | null,
      "cancelReason": "String" | null,
      "creationDate": "Date",
      "completedDate": "Date" | null,
      "assignamentDate": "Date" | null,
      "routerUserId": "String" | null,
      "status": "String",
      "user": {
        "id": "String",
        "firstName": "String",
        "lastName": "String"
      },
      "client": {
        "id": Int,
        "socialReason": "String",
        "address": "String",
        "groupingChannel": "String",
        "status": "String",
        "frequency": "String",
        "gec": "String",
        "coords": {
          "latitude": "String",
          "longitude": "String"
        }
      },
      "merch": {
        "id": "String",
        "firstName": "String",
        "lastName": "String"
      } | null,
      "tasks": [
        {
          "id": Int,
          "name": "String",
          "status": "Enum('PENDIENTE', 'INCOMPLETO', 'COMPLETADO')",
          "incompleteReason": "String" | null
        }
      ],
      "materials": [
        {
          "id": Int,
          "description": "String"
        }
      ]
    }
  ]
}

---

Códigos de Error

HTTP Code	Custom Code	Message
500	UNEXPECTED_ERROR	No se encontró el usuario que debería estar inyectado en la solicitud.