Saltar al contenido principal

Como crear y manejar un despacho

Acá se va a detallar como se crea un despacho, se asigna un merch y una óden, se rutea para que se pueda trabajar con este y finalmente se lo da como completado.

  • Endpoints Requeridos:
    • GET | /merch/
    • GET | /merch/request
    • POST | /dispatch/
    • PATCH | /dispatch/:id/add-requests
    • PATCH | /dispatch/:id/remove-requests
    • PATCH | /dispatch/:id/cancel
    • PATCH | /dispatch/:id/route ⚠️
Estados del Despacho
  • Pendiente
    • El despacho está siendo configurado antes de ser asignado a un empleado.
  • Ruteado
    • El despacho ya fue configurado correctamente y está listo para comenzar a trabajar.
  • Completado
    • Se completaron/anularon todas las órdenes del despacho y este se marcó como completado.
  • Anulado
    • El despacho fue anulado por un usuario.

Obtener el listado de los merchs disponibles​

  • Previo a la creación del despacho se debe seleccionar un merch para asignarlo al despacho, esto lo hacemos con el listado de merchs tal como se indica en su guia.

Crear el despacho​

  • Una vez seleccionado el merch a asignar se puede proceder a crear un despacho vacío mediante su respectivo endpoint como se indica en su guia, este va a recibir 3 campos los cuales 2 de ellos son obligatorios (assignedMerchId y targetDate) los cuales definen a que merch se va a asignar el despacho y cual es la fecha en la que se debe completar el despacho.

Asignar órdenes al despacho​

  • Antes de rutear un despacho se le deben asignar ódenes las cuales se obtienen mediante el endpoint merch requests, una vez tengamos las ódenes las vamos asignar a un despacho, esto se hace mediante el endpoint add requests.

Eliminar órdenes de un despacho​

  • En caso de que se haya asignado una órden incorrecta a un despacho esta se puede eliminar del despacho mediante el endpoint remove requests.

Rutear un despacho​

aviso

Una vez que se rutea un despacho este no puede ser cancelado.
En caso de querer cancelar un despacho de debe utilizar el endpoint cancel.

  • Una que se terminó de configurar el despacho este debe ser ruteado para que se comience a trabajar con el, esto lo hacemos con el endpoint de ruteado.

Como se completa un despacho?​

  • Los despachos se marcan como completados automáticamente una vez que todas las órdenes que este tenga asignadas sean completadas o anuladas.