Qodex.ai

Moovin Retail Enterprise micro-servicio

Number of APIs: 25

Introducción

Moovin más que ser una solución de logística busca convertirse en un aliado estratégico para las empresas en el crecimiento digital, para ello cuenta con una amplia gama de servicios que ha decidido poner del cliente.

El API que se expone a continuación permite hacer uso de la solución llamada Moovin Retail. Esta
solución está especialmente diseñada para empresas que tengan múltiples puntos de venta o centros de distribución y tengan que realizar gestiones de cobro con o sin retorno al punto de origen.

Conocimientos

Técnicos:

  • Consultas a endpoints por HTTPS/SSL.
  • Manejo del formato JSON.

Códigos de error

  • 200 status: SUCCESS.
  • 404 token inválido.
  • 500 Internal Error.

Servidores

Definiciones:

  • CEDI: centro de distribución
  • Moover: se determina a los motociclistas que trabajan como mensajeros en Moovin.
  • PDV: punto de venta es cada uno de los negocios desde donde se envían las órdenes.
  • Orden: grupo de paquetes o paquete que se debe entregar a un cliente específico.
  • Paquete: elemento unitario utilizado para un envío. Una Orden puede estar compuesta por varios paquetes.
  • Cliente: se refiere al cliente final, el receptor del paquete.
  • Usuario: persona que se registra en la plataforma de Moovin. Cada usuario puede tener varios perfiles diferentes.
  • Perfil: un usuario pueden tener tantos perfiles como necesite, en estos se registran las condiciones de negocio (tarifas, afiliado al cual se depositarán los cobros realizados en tarjeta, etc.). Típicamente, en Moovin Retail se creará un perfil para cada punto de venta de tal forma que se puedan tener diferentes reglas de negocio y que se puedan diferencias los servicios enviados por cada PDV o CEDI.
  • Tarea: son acciones que debe ejecutar el Moover sl momento de realziar la entrega. Por ejemplo:
    • Tomar una fotografía.
    • Recolectar un documento.
    • Realziar la entrega del producto.

Estados de una orden o paquete

  • PENDING: cuando una orden es creada si estado inicial es pendinete ya que se requiere que se prepare para su entrega.
  • PREPARED: si una orden se encuentra lista para ser enviada al cliente. Es importante destacar que para poder solicitar el servicio de entrega la orden debe estar en estado de preparada sino el sistema no permite solicitar el permiso
  • INSERVICE: cuando una orden se encuentra asignada a un servicio.
  • CANCEL: en caso de que la orden se desee cancelar para no ser entregada al cliente.
  • DELIVERED: cuando la orden ha sido entrega al cliente final del comercio.
  • CONSOLIDATOR: cuando una orden es creada y está compuesta por 1 o más paquetes por lo que para realizar su entrega se requiere consolidar paquetes de diferentes sedes del cliente.
  • PICKUP: cuando el mensajero ha recolectado el paquete para ser entregado al cliente.
  • INPROCESS: es un estado opcional que se puede utilizar para indicar que un empleado está preparado el paquete por control y no se preparé 2 veces una misma orden.
  • CANCELRETURN: Si se cancela una orden o paquete que ya se encontraba en posesión de un mensajero para su entrega por lo que se le indicará al mensajero que una vez finalice la entrega de órdenes pendientes debe retornar a la sede para devolver el paquete.
  • QUEUEDSERVICE: es en caso de permitir que el mensajero pueda retirar dos servicios de forma simultánea se colocara el estado al paquete de que se encuentra en un servicio que aún no se procede a entregar.
  • QUEUEDSERVICESTART: cuando el mensajero inicia un servicio que se encontraba encolado.

  1. Obtener el token POST https://auth.moovin.me/auth/realms/morannon/protocol/openid-connect/token

  2. Crear un CEDI POST {{url}}/moovin-retail/api/v1/CEDILocation/insert

  3. Modificar CEDI POST {{url}}/moovin-retail/api/v1/CEDILocation/modify

  4. Crear una orden POST {{url}}/moovin-retail/api/v1/order/create

  5. Obtener información específica de una orden GET {{url}}/moovin-retail/api/v1/order/specificOrder?idOrder=20

  6. Obtener listado de órdenes GET {{url}}/moovin-retail/api/v1/order/list?records=25&page=0

  7. Cambiar el estado de una orden - paquete POST {{url}}/moovin-retail/api/v1/order/changeStatus

  8. Agregar una tarea a la orden POST {{url}}/moovin-retail/api/v1/order/addTask

  9. Eliminar una tarea de la orden POST {{url}}/moovin-retail/api/v1/order/deleteTask

  10. Agregar un cobro a una orden POST {{url}}/moovin-retail/api/v1/order/addPayment