Calcular envío en Melhor Envio, con una API

Cotiza el envío de productos entre dos CEPs y devuelve una entrada por servicio, con id, transportista, precio, plazo de entrega, los paquetes y un error cuando el servicio no cubre la ruta. custom_price y custom_delivery_time incluyen las tarifas y descuentos de la cuenta. Solo se cotizan los servicios habilitados para la integración en el panel de Melhor Envio.

Identificador
melhor_envio_calculate_shipping

La llamada

POST https://connect.reportei.com/api/tools/melhor_envio_calculate_shipping/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "from": {},
    "to": {},
    "products": []
  }
}

Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.

Parámetros

Las descripciones de los parámetros siguen la documentación oficial de la app, en inglés.

ParámetroTipoObligatorioDescripción
fromobjectSíOrigin of the shipment.
toobjectSíDestination of the shipment.
productsarraySíProducts in the shipment, with unit dimensions, weight and value. Melhor Envio packs them and multiplies the value by the quantity.
optionsobjectNoAdditional services, which raise the price.

Conexiones posibles

Tu cliente conecta su cuenta de Melhor Envio una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.

OAuth con la app de tu producto

Registras la app OAuth de tu producto una sola vez, con POST /api/merchants/credentials/melhor_envio, y tu cliente autoriza la cuenta en una pantalla de consentimiento. Connect renueva el token cuando está por vencer.

La respuesta

Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.

Lista para agentes de IA

El input de esta tool es un JSON Schema, disponible en GET /api/tools/melhor_envio_calculate_shipping. Se convierte en la definición de tool de tu agente sin conversión.

Otras tools de Melhor Envio

Ver las 12 tools

Toolkits de la misma categoría

Ver los 100 toolkits

Mira Connect aplicado a tu producto.

Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.