Calcular un envío

En esta página explicaremos cómo calcular un envío con Rocketfy y todas sus transportadoras

Calcular envío

POST https://api.rocketfy.co/api/public/calculateShipping

Este método te permitirá calcular un envío desde una ciudad de origen hasta una ciudad destino, teniendo en cuenta sus dimensiones, peso y valor a recaudar.

Headers

Name	Type	Description
Authorization	string	Token que recibes del método de autenticación inicial en Primeros pasos y debe enviarse en el siguiente formato: Bearer MI_TOKEN_DE_ACCESO

Request Body

Name	Type	Description
total	number	Valor total del pedido, este valor se utiliza para determinar el valor del paquete a transportar y si se debe recaudar efectivo, será el valor que la transportadora cobrará al comprador de la tienda. Ejemplo: 150000
lines	object	Objeto que contiene el origen y destino del envío, contiene los datos básicos para calcularlo. Nota: Las propiedades city y departament se relacionan directamente con la función que retorna las ciudades y departamentos, donde es igual al nombre de la ciudad y el nombre de el departamento seleccionado. Ejemplo: { "from": { "city": "Medellin", "departament": "Antioquia", "address": "Carrera 77b # 48b -131, 201" }, "to": { "city": "Cali", "departament": "Valle", "address": "Calle 14 oeste # 4 46" } }
weight	number	Peso del paquete en Kilogramos Ejemplo: 3
large	number	Largo del paquete en Centímetros Ejemplo: 30
height	number	Alto del paquete en Centímetros. Ejemplo: 10
width	number	Ancho del paquete en Centímetros. Ejemplo: 50
cod	boolean	El parámetro COD se refiere a (Cash On Delivery) por sus siglas, esta propiedad contempla si el servicio retornará los departamentos y ciudades a los cuales hay servicio de recaudo de efectivo o no. Ejemplo: Destinos con recaudo de efectivo: {"cod": true} Destinos sin recaudo de efectivo: {"cod": false}

200 Respuesta del método de calculo del envío. Nota: La propiedad courriers es un arreglo de todas las transportadoras para el trayecto consultado, y dentro de cada objeto estará el parámetro shipping_value que indica el valor del envío con ese transportador. También a tener en cuenta, la propiedad disabled representa una transportadora que no está disponible en el momento.

{
    "message": "Calculo del envío",
    "data": {
        "from": {
            "city": "Medellin",
            "state": "Antioquia",
            "address": "Carrera 77b # 00 - 00",
            "location": null
        },
        "to": {
            "city": "Cali",
            "state": "Valle",
            "address": "Calle 14 oeste # 00 - 00",
            "location": null
        },
        "courriers": [
            {
                "name": "Servientrega",
                "key": "servientrega",
                "disabled": false,
                "blocked_from_admin": true,
                "cod": true,
                "pickup": true,
                "postal_code": "76001000",
                "journey_ids": {
                    "origin": 20,
                    "dest": 20
                },
                "default": true,
                "img": "https://fs.rocketfy.co/icons/courriers/servientrega.svg",
                "pyme": false,
                "shipping_value": 13600, //Valor del envío
                "shipping_time": "2",
                "id": null,
                "response": {
                    "ok": true
                }
            },
            {
                "name": "TCC",
                "key": "tcc",
                "disabled": false,
                "blocked_from_admin": true,
                "cod": false,
                "pickup": true,
                "postal_code": "76001000",
                "journey_ids": {
                    "origin": "",
                    "dest": ""
                },
                "default": false,
                "img": "https://fs.rocketfy.co/icons/courriers/tcc.svg",
                "pyme": false,
                "shipping_value": 11675, //Valor del envío
                "shipping_time": "2",
                "shipping_without_handle": 7763,
                "shipping_handle": 360,
                "base_cod": 2000,
                "id": "926868902",
                "response": {
                    "ok": true
                }
            }
        ],
        "dimensions": {
            "width": 10,
            "height": 10,
            "large": 10,
            "weight": 1,
            "volume": 0.4
        }
    }
}

404 Error al momento de calcular el envío

{
  "message": {
    "success": false,
    "message": "No se especifica ciudad de destino"
  },
  "err": "Business Logic"
}