Cancelar etiqueta en Melhor Envio, con una API
Cancela una etiqueta. Una etiqueta generada solo puede cancelarse antes de ser postada y antes de que se avise a la transportista de una recolección; el reembolso de una etiqueta generada llega 12 horas después de la aprobación.
- Identificador
- melhor_envio_cancel_label
La llamada
POST https://connect.reportei.com/api/tools/melhor_envio_cancel_label/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"order": {}
}
}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ámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| order | object | Sí | The label to cancel and the reason. |
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_cancel_label. Se convierte en la definición de tool de tu agente sin conversión.
Otras tools de Melhor Envio
- Calcular envíoPOSTCotiza 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.
- Crear ítem en el carritoPOSTAgrega una etiqueta al carrito de la cuenta y la devuelve. Su id es el id de la etiqueta en las demás herramientas. No se paga nada hasta Comprar etiquetas. Correios, J&T y Loggi aceptan un volumen por llamada: para más paquetes, agrega un ítem por paquete.
- Listar ítems del carritoGETLista las etiquetas del carrito que aún no se pagaron, con id, servicio, precio, remitente, destinatario y volúmenes. Las etiquetas permanecen 20 días en el carrito. 10 por página: pasa page para las siguientes, hasta last_page.
- Eliminar ítem del carritoDELETEQuita del carrito una etiqueta que aún no se pagó.
- Comprar etiquetasPOSTPaga etiquetas del carrito con el saldo de la billetera de Melhor Envio y devuelve la compra, con el total y las etiquetas, ya liberadas. La billetera necesita saldo suficiente: compruébalo con Obtener saldo. Las etiquetas pagadas aún necesitan Generar etiquetas.
- Generar etiquetasPOSTGenera etiquetas pagadas, lo que es necesario antes de Imprimir etiquetas, y devuelve el resultado de cada id. Una etiqueta generada debe postarse en un plazo de 20 días, o 7 días con Correios.
- Imprimir etiquetasPOSTDevuelve un enlace para imprimir etiquetas generadas. Un enlace privado se abre solo para quien inició sesión en la cuenta de Melhor Envio; un enlace público se abre para cualquiera que lo tenga.
- Listar etiquetasGETLista las etiquetas de la cuenta con id, protocolo, estado, servicio, precio, código de seguimiento y las fechas de pago, generación, postaje y entrega. 10 por página: pasa page para las siguientes, hasta last_page.
Mira Connect aplicado a tu producto.
Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.
