Crear ítem en el carrito en Melhor Envio, con una API

Agrega 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.

Identificador
melhor_envio_create_cart_item

La llamada

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

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

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
serviceintegerSíId of the service chosen in Calculate shipping, such as 1 for PAC.
fromobjectSíSender. A person sends document (CPF); a company sends company_document (CNPJ) and state_register.
toobjectSíRecipient. A person sends document (CPF); a company sends company_document (CNPJ) and state_register.
productsarraySíEvery product in the shipment, complete: it goes into the content declaration sent to SEFAZ.
volumesarraySíPackages of the shipment, with the dimensions and weight of the packages of the chosen service in Calculate shipping.
optionsobjectNoInsurance, additional services and documents of the shipment.

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_create_cart_item. 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.