Consulta tarifas de mercado con la API
Qué devuelve la API de Tarifas de Mercado, cómo obtener una clave y qué saber sobre lotes, caché y datos de prueba antes de construir.
La API de Tarifas de Mercado lleva el mismo rango Bajo, Medio y Alto que ves en la plataforma a tu propio TMS, herramienta de precios o pantalla de cotización. Envías una ruta y recibes una serie semanal de tarifas, una entrada por semana con su propia etiqueta de confianza. Cada entrada se construye con las 12 semanas de ofertas hasta esa semana, y la más reciente es la que muestra la plataforma. La referencia completa está en docs.cargado.com.
Paso 1: Obtén una clave
Las claves las crea el equipo de Cargado. Escribe a success@cargado.com, di cómo se llama la integración y pide el permiso de tarifas de mercado. En Obtén una clave de API para tu integración explicamos cómo funcionan las claves y cómo protegerlas. Envía la clave en el encabezado api-key en cada solicitud a https://api.cargado.com.
Paso 2: Envía una consulta
Llama a POST /rates/history con una lista requests de 1 a 16 rutas. Cada ruta necesita:
- Paradas: una recolección al inicio y una entrega al final. Cada lugar puede ser una ciudad estructurada, un código postal, una dirección o una dirección en texto libre.
- Remolque: exactamente un tipo de remolque.
- Cruce (opcional, solo en rutas de México): agrega una parada de cruce fronterizo, o déjala fuera y Cargado usa su cruce recomendado y te dice cuál fue.
- Millas de la ruta (opcional): tu propia distancia, si quieres que sustituya la de Cargado.
Agrega currency (USD, MXN o CAD) a la solicitud. Por defecto es USD.
Paso 3: Lee los resultados
Los resultados llegan en el mismo orden que tus solicitudes. Cada uno tiene éxito o falla por su cuenta, marcado como DATA o ERROR, así que una ruta con error no afecta el resto del lote. Un resultado DATA incluye:
- La ruta consultada: el origen y el destino (y si alguno de los dos es un mercado extendido), la categoría de remolque y el cruce.
suggestedRates,allInRatesyperMileRates: una entrada por semana, de la más antigua a la más reciente. Cada una trae p25, p50 y p75 en centavos de dólar o de peso, más el margen de error y la confianza. Por ejemplo, 330000 es $3,300.latestSuggestedRate: la cifra que la plataforma muestra como Bajo, Medio y Alto.- Las millas de la ruta, con y sin el movimiento vacío hasta los centros de los mercados.
Las semanas sin datos suficientes no se incluyen. Si una ruta no tiene ninguna, recibes un resultado ERROR con el código RATE_HISTORY_NOT_FOUND.
Paso 4: Prueba antes de salir a producción
Pide al equipo de Cargado acceso al sandbox en https://api.sandbox.cargado.com. El sandbox devuelve tarifas simuladas, así que úsalo para probar tu integración, nunca para cotizar.
Caché y uso
Cada llamada a POST /rates/history se registra como una consulta y cuenta para el mismo límite mensual que las consultas en la plataforma y en Excel. Si envías exactamente la misma solicitud otra vez en la misma semana, Cargado devuelve el resultado anterior en lugar de crear una consulta nueva. También puedes recuperar una consulta guardada por su id con GET /rates/history/{id}. Consulta Límites del plan y qué significan los correos de aviso de uso.
Importante: si docs.cargado.com y este artículo no coinciden, sigue este artículo: una solicitud admite hasta 16 rutas y las tarifas semanales llegan de la más antigua a la más reciente.
Still stuck?
Email us and a person on our team will answer. Send the posting link or a screenshot if you have one.