GET | /

Función que Realiza

• Lista todos los despachos con o sin filtro de despachos completados.

---

Funcionamiento

• URL Completa: {domain}/api/v1/dispatch/
• Acción: GET
• Requiere Api-Key?: Si
• Requiere una Sesión?: Si
• Recibe datos mediante: Query
  • Cantidad de datos: 1
• 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 pero se requiere al menos 1 de ellos.
• 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', 'RUTEADO', 'COMPLETADO', 'ANULADO')
orderStatus? =   Enum('PENDIENTE', 'ASIGNADO', 'COMPLETADO', 'ANULADO')
fromDate?    =   Date(YYYY-MM-DD)
toDate?      =   Date(YYYY-MM-DD)
page         =   Int
pageSize     =   Int

---

Contenido que devuelve

{
  "meta": {
    "page": Int,
    "pageSize": Int,
    "count": Int,
  },
  "dispatchs": [
    {
      "id": Int,
      "userId": "String",
      "user": {
        "id": "String",
        "firstName": "String",
        "lastName": "String"
      },
      "merch": {
        "id": "String",
        "firstName": "String",
        "lastName": "String"
      },
      "details": "String" | null,
      "status": "enum('PENDIENTE', 'RUTEADO', 'COMPLETADO', 'ANULADO')",
      "creationDate": Date,
      "targetDate": Date,
    }
  ]
}

---

Códigos de Error

HTTP Code	Custom Code	Message
422	INVALID_DATE_RANGE	Se requiere al menos un inicio o final de fecha para buscar.