Cotizar envíos

Descripción General

Esta API permite obtener estimaciones de tarifas para envíos a través de Ridery, basado en la ubicación de origen y destino. Antes de poder crear un envío es necesario crear una cotización

Endpoint

URL: baseURL/V2/corporate-api-partner/get-fare-estimates-shipments

Método: POST

Solicitud

Cuerpo de la Solicitud (sin location_id)

{
    "sourceLocation": [
        10.4346014,
        -66.862743
    ],
    "destinationLocation": [
        10.4970614,
        -66.8879179
    ],
    "source_address": "Este es el inicio de la ruta",
    "destination_address": "Esta es la direccion final de la ruta"
}

Cuerpo de la Solicitud (con location_id)

{
    "location_id": "x1",
    "destinationLocation": [
        10.4970614,
        -66.8879179
    ],
    "destination_address": "Esta es la direccion final de la ruta"
}

Descripción de los Campos

Campo	Descripción	Tipo	Requerido/ Opcional
sourceLocation	Coordenadas de la ubicación de origen [latitud, longitud]	Array (float)	Requerido si no se usa location_id
destinationLocation	Coordenadas de la ubicación de destino [latitud, longitud]	Array (float)	Requerido
source_address	Dirección de inicio de la ruta	Cadena de texto	Opcional si se usa location_id, Requerido si no se usa location_id
destination_address	Dirección final de la ruta	Cadena de texto	Requerido
location_id	ID único de locación previamente configurada por administrador	Cadena de texto	Opcional

Respuesta

Ejemplo de Respuesta Exitosa

{
    "success": true,
    "code": "00",
    "msg": "ok",
    "data": {
        "fares": {
            "corporate_wallet_amount": 11819.47,
            "time": 14.84,
            "distance": 12.5905,
            "city_types": [
                {
                    "city_type_id": "62bf1af16b60baf9ac4c27e3",
                    "typename": "Envíos Moto",
                    "fare": 5,
                    "max_package_depth": 20,
                    "max_package_height": 15,
                    "max_package_weight": 5,
                    "max_package_width": 10
                },
                {
                    "city_type_id": "6304eed60bb78f6407c7c904",
                    "typename": "Envíos Económico",
                    "fare": 9.56,
                    "max_package_depth": 20,
                    "max_package_height": 32,
                    "max_package_weight": 25,
                    "max_package_width": 32
                }
            ],
            "fare_id": "667c5c3b8d79d5cbb016e073"
        }
    }
}

Descripción de los Campos de la Respuesta

Campo	Descripción	Tipo
success	Indica si la solicitud fue exitosa	Boolean
code	Código de estado de la respuesta	String
msg	Mensaje de la respuesta	String
data	Datos de la respuesta	Object
fares	Información de tarifas	Object
corporate_wallet_amount	Sobregiro disponible restante en la cuenta corporativa	Number
time	Tiempo estimado de viaje en minutos	Number
distance	Distancia estimada del viaje en kilómetros	Number
city_types	Lista de tipos de ciudad con sus tarifas y restricciones	Array (Object)
city_type_id	ID del servicio	String
typename	Nombre del servicio	String
fare	Tarifa del servicio	Number
max_package_depth	Profundidad máxima del paquete en cm	Number
max_package_height	Altura máxima del paquete en cm	Number
max_package_weight	Peso máximo del paquete en kg	Number
max_package_width	Ancho máximo del paquete en cm	Number
fare_id	ID de la tarifa generada. Este ID se utiliza para crear un viaje	String

TIP

Esta cotización tiene una expiración de 7 días calendario a partir de una respuesta exitosa del servidor.

TIP

Esta puede ser reutilizada si no se ubica conductor en el primer request