📄️ Introducción
Cargamos es una empresa que provee servicios de entrega de última milla gracias a su red de centros de distribución de última milla. Cualquier empresa física o moral que quiera hacer uso de estos servicios, puede registrarse e integrar sus órdenes haciendo uso de nuestro mecanismos de integración. Los beneficios de realizar la última milla con Cargamos incluye realizar entregas en el mismo día o día después, incluyendo la gestión de reintentos y trazabilidad en tiempo real. Además, utiliza tipos de vehículos optimizados al tipo de paquete. Todo esto genera ahorros y una mejor experiencia para sus clientes.
📄️ Shipper
El shipper es quien solicita el servicio de shipment., o entrega de paquetes. Puede ser una persona física o moral. Para poder realizar una integración es necesario registrarse, proceso descrito en la sección Guía de uso API Cargamos/Paso 1: Registro. Dependiendo del método de integración, por ejemplo si se usa la API, se deberá de realizar un proceso de autenticación y autorización al momento de integrar los shipments.
📄️ Shipment
Un shipment es cómo se denomina en Cargamos al servicio de entrega de paquetes. Los shipments son solicitados por los shippers por medio de la “integración” de una órden. Al solicitar un shipment, es necesario proveer la siguiente información:
📄️ La integracion
Las “órdenes de entrega” son las solicitudes realizadas a Cargamos para efectuar un servicio de entrega. Dichas órdenes deben ser validadas teniendo en cuenta que el shipper esté autorizado para ser servido, la información suministrada sea suficiente para efectuar el servicio, que exista cobertura para la ubicación solicitada; y que el nivel de servicio solicitado (por medio de las fechas shipperDropoffDate y expectedDeliveryDate) pueda ser honrado bajo los tiempos, ubicaciones y condiciones del contrato firmado con Cargamos. Una vez esta orden de entrega es validada, se convierte en un shipment. Todo este proceso, desde que se provee la orden hasta que se valida y se genera el shipment en el sistema, sucede durante el denominado proceso de integración.
📄️ Recipient Location
Representa la dirección del destinatario final del paquete/shipment, o en otras palabras, el dropoff. Se representa por medio de diversos campos que deben de ser proporcionados por separado. Esto último es necesario para facilitar que los servicios de geocoding puedan, de forma automatizada, proporcionar ayuda adicional para determinar la localización exacta, en caso de que sea necesario; de igual forma, facilitan la visualización de la información por parte del repartidor.
📄️ Recipient Information
Representa información básica del destinatario final. Esta información es utilizada para contactar al destinatario en caso de que existan problemas para localizar al mismo durante la entrega. Esta información no es persistida en el sistema, y se elimina una vez se finaliza el ciclo de vida del shipment.
📄️ Package
Corresponde a la información física del paquete consolidado único que será integrado y por consecuencia entregado. Incluye información de su contenido, dimensiones, peso, valor, etc. Es posible especificar los items que componen el paquete con información compatible para Carta Porte como es utilizada en México.
📄️ Nivel de servicio y parámetros para gestionar el shipment
Cada integración tiene parámetros adicionales asociados al nivel de servicio, así como utilizados para la gestión del shipment por parte del shipper.
📄️ Webhooks
Un webhook consiste en una URL por medio de la cual el servidor\*, Cargamos en este caso, puede iniciar la comunicación con el cliente, y suministrar información en la medida que esta se haga disponible y sin requerir que el cliente la solicite bajo demanda. Nótese que las comunicaciones habitualmente son iniciadas por el cliente. En este caso, es el servidor el que inicia la misma.
📄️ Autenticación
Cargamos hace uso de un flujo de OAuth para realizar la autorización de los llamados de la API. Se realiza la secuencia que se observa en la figura.