Ir al contenido
Documentación de Connecto
connecto.lat
Guía de usuarioConfiguración general e IA

Referencia de las APIs

Esta página se genera automáticamente desde el catálogo de APIs de Connecto (Core\Api\Catalogo): lo que ves aquí es exactamente lo que ofrece la aplicación. No la edites a mano; para cambiarla modifica el catálogo y vuelve a generarla.

Todas las APIs usan la misma dirección base, https://tu-dominio/api/v1, y la misma autenticación (Authorization: Bearer cnx_TU_LLAVE). Las credenciales, los permisos y los límites se explican en APIs y webhooks. Todas las APIs vienen habilitadas; el acceso a cada una lo da la credencial: en Configuración → APIs y Webhooks se marcan (y se pueden editar cuando quieras) sus permisos de lectura y de escritura.

Resumen#

APITipoPermisosEndpoints
Consulta de contactosLecturacontactos:consultar3
Correos (enviar a un contacto)Escritura y Lecturacorreos:enviar, correos:leer2
Listas de distribución (ver y suscribir)Lectura y Escrituralistas:leer, listas:suscribir2
Cupones de descuento (validar y canjear)Lectura y Escrituracupones:validar, cupones:canjear5
Contactos (listar, crear y editar)Lectura y Escrituracontactos:leer, contactos:escribir4
Conversaciones y mensajesLecturaconversaciones:leer3
OportunidadesLectura y Escrituraoportunidades:leer, oportunidades:escribir5
PedidosLectura y Escriturapedidos:leer, pedidos:escribir4

Permisos especiales que cubren también las APIs que se construyan después: *:lectura (todas las de lectura) y *:escritura (todas las que modifican datos).

Consulta de contactos#

Busca contactos por uno o varios campos (por ejemplo la cédula, el correo o un campo que tú creaste) y devuelve todos sus datos y las redes o canales asociados.

PermisoTipoQué permite
contactos:consultarLecturaConsultar contactos y sus redes

POST /api/v1/contactos/consultar#

Devuelve los contactos que cumplen TODOS los filtros enviados (o alguno, con «coincidencia»: «alguno»). Permiso: contactos:consultar.

Dato del cuerpo (JSON)Qué es
filtrosobjeto {campo: valor}. El valor puede ser un texto, un número, una lista de valores (basta con que coincida uno) o {"operador": "...", "valor": "..."}.
coincidencia«todos» (por defecto: se cumplen todos los filtros) o «alguno».
paginanúmero de página (1 por defecto)
limiteresultados por página, de 1 a 100 (25 por defecto)
JSON
{
    "filtros": {
        "numero_documento": "1020304050",
        "estado": "ACTIVO"
    },
    "coincidencia": "todos"
}

GET /api/v1/contactos/consultar#

Lo mismo que el POST, con los filtros en la dirección: ?filtro[campo]=valor&filtro[otro_campo]=valor. Para varios valores de un campo: ?filtro[estado][]=ACTIVO&filtro[estado][]=INACTIVO. Permiso: contactos:consultar.

ParámetroQué es
filtro[campo]un filtro por cada campo a consultar
coincidenciatodos
paginanúmero de página
limitede 1 a 100

GET /api/v1/contactos/campos#

Lista los campos por los que se puede consultar (incluidos los que se crearon a mano), su tipo, los operadores que admiten y sus valores válidos. Permiso: contactos:consultar.

Qué devuelve: Cada contacto trae sus datos básicos, el tipo de contacto, el propietario, los campos opcionales activos (documento, nacionalidad, departamento, ciudad…), los campos personalizados y «redes»: una entrada por canal (WhatsApp, Messenger, Instagram, Telegram…) con las cuentas del contacto y los canales conectados por los que ha conversado.

Detalle completo de los campos, operadores y respuesta: API: Consulta de contactos.

Correos (enviar a un contacto)#

Un sistema externo envía un correo a un contacto a través del CRM: queda registrado en la actividad del contacto y lleva un píxel que cuenta cuántas veces lo abrió. Envía mensajes reales, por eso nace apagada y su permiso se da de forma explícita.

PermisoTipoQué permite
correos:enviarEscrituraEnviar correos a contactos
correos:leerLecturaConsultar cuántas veces se abrió un correo enviado por la API

POST /api/v1/correos/enviar#

Envía un correo al contacto. El correo sale por la conexión SMTP de notificaciones del sistema, lleva el píxel de lectura y queda en la actividad del contacto (asunto, contenido y lecturas). El HTML se limpia (sin scripts, iframes ni manejadores de eventos). Devuelve un «id» para consultar después cuántas veces se abrió. Permiso: correos:enviar.

Dato del cuerpo (JSON)Qué es
destinatarioobligatorio: el correo del destinatario (o {"email": "…", "nombre": "…"}). Debe ser el correo de un contacto del CRM.
asuntoobligatorio, hasta 300 caracteres
cuerpo_htmlobligatorio: el contenido del correo en HTML (hasta 500 KB)
contacto_idopcional: id del contacto, si ya lo conoces (el correo debe ser uno de los suyos)
crear_contactoopcional: true para crear el contacto si no existe uno con ese correo (si no, responde 404 contacto_no_encontrado)
JSON
{
    "destinatario": "[email protected]",
    "asunto": "Tu pedido fue recibido",
    "cuerpo_html": "<h2>¡Gracias por tu compra!</h2><p>Recibimos tu pedido <b>PED-000123</b>.</p>"
}

GET /api/v1/correos/consultar#

Cuántas veces se abrió un correo enviado por la API: cantidad de lecturas, primera y última y el detalle de las más recientes. Solo ve correos enviados por la API. Permiso: correos:leer.

ParámetroQué es
idel «id» que devolvió /correos/enviar

Qué devuelve: enviar: {"datos": {"enviado": true, "id": 57, "contacto_id": 12, "contacto_creado": false, "destinatario": "…", "con_pixel": true}}. consultar: {"datos": {"id", "destinatario", "asunto", "enviado_at", "aperturas": 2, "primera_apertura_at", "ultima_apertura_at", "lecturas": [{"at"}]}}. Errores: 404 contacto_no_encontrado, 422 dato_invalido / correo_no_pertenece, 502 envio_fallido (no hay SMTP configurado o el servidor lo rechazó), 503 api_deshabilitada.

Listas de distribución (ver y suscribir)#

Un sistema externo ve el listado de listas de distribución de correo y suscribe a un contacto a una o varias. Al suscribir se deja su autorización para recibir correos, por eso nace apagada y suscribir es un permiso explícito.

PermisoTipoQué permite
listas:leerLecturaVer las listas de distribución
listas:suscribirEscrituraSuscribir contactos a listas de distribución

GET /api/v1/listas#

Lista las listas de distribución de correo activas: id, nombre, descripción y cuántos contactos tienen. Con «q» filtra por nombre; paginado. Permiso: listas:leer.

ParámetroQué es
qtexto que debe contener el nombre de la lista
paginanúmero de página (1 por defecto)
limiteresultados por página, de 1 a 100 (25 por defecto)

POST /api/v1/listas/suscribir#

Suscribe un contacto a una o varias listas de distribución y deja su autorización para recibir correos como «otorgada» (quien integra responde de haberla obtenido). El contacto se busca por su correo (o contacto_id). Una baja no se revierte sola: si el contacto se dio de baja de los correos, no se suscribe (responde baja_previa) salvo que se envíe «reactivar_baja»: true porque la persona volvió a pedirlo. Permiso: listas:suscribir.

Dato del cuerpo (JSON)Qué es
emailel correo del contacto (obligatorio si no envías contacto_id)
listasobligatorio: lista de ids de las listas (GET /listas), hasta 50
contacto_idopcional: id del contacto; el correo debe ser uno de los suyos
crear_contactoopcional: true para crear el contacto si no existe uno con ese correo
nombreopcional: nombre para el contacto nuevo
reactivar_bajaopcional: true solo si la persona se dio de baja y volvió a pedir suscribirse
JSON
{
    "email": "[email protected]",
    "listas": [
        1172,
        917
    ],
    "crear_contacto": true,
    "nombre": "Ana Pérez"
}

Qué devuelve: listar: {"datos": [{"id", "nombre", "descripcion", "contactos", "creada_at"}], "total", "pagina", "limite", "hay_mas"}. suscribir: {"datos": {"contacto_id", "contacto_creado", "se_dio_de_baja", "autorizacion_correo", "listas": [{"lista_id", "nombre", "estado": "suscrito" | "ya_estaba" | "baja_previa" | "no_existe"}]}}. Errores: 404 contacto_no_encontrado, 422 dato_invalido / correo_no_pertenece / contacto_sin_correo, 503 api_deshabilitada.

Cupones de descuento (validar y canjear)#

Para tiendas y carritos externos: comprueba un código de cupón contra el carrito y devuelve el descuento, lo canjea cuando se paga el pedido (sin pasarse del límite de usos) y lo libera si el pedido se cancela.

PermisoTipoQué permite
cupones:validarLecturaValidar cupones y calcular su descuento (no los gasta)
cupones:canjearEscrituraCanjear y liberar cupones

GET /api/v1/cupones/consultar#

Solo CARGA el cupón por su código: devuelve cómo está configurado (tipo y valor, tope, vigencia, usos, límites, mínimos, combinable, productos incluidos y excluidos y su estado). No lo valida contra un carrito, no calcula descuentos y no gasta usos. Responde 404 si el código no existe. Permiso: cupones:validar.

ParámetroQué es
codigoel código del cupón (no distingue mayúsculas)

POST /api/v1/cupones/consultar#

Lo mismo que el GET, con el código en el cuerpo (JSON). Permiso: cupones:validar.

Dato del cuerpo (JSON)Qué es
codigoel código del cupón
JSON
{
    "codigo": "BIENVENIDA10"
}

POST /api/v1/cupones/validar#

Comprueba si el código se puede usar con este comprador y este carrito y calcula el descuento. NO gasta el cupón: llámalo cada vez que el cliente cambie el carrito. Un cupón que no se puede usar responde 200 con valido=false y un «motivo» (no_existe, inactivo, no_iniciado, vencido, agotado, limite_contacto, contacto_no_elegible, contacto_requerido, no_es_primera_compra, no_combinable, sin_productos_elegibles, monto_minimo, cantidad_minima…) y un «mensaje» listo para mostrar. Permiso: cupones:validar.

Dato del cuerpo (JSON)Qué es
codigoel código del cupón (no distingue mayúsculas)
contactoquién compra: {"id": 123} o {"email": "..."} o {"telefono": "..."} o {"numero_documento": "..."} (necesario si el cupón tiene límite por contacto, es para contactos concretos o es de primera compra)
itemsel carrito: lista de {"producto_id", "precio_id" (la referencia), "referencia", "cantidad", "precio"?}. Basta producto_id, precio_id o referencia; el precio sale del catálogo salvo que lo envíes. Necesario para cupones de porcentaje.
codigos_aplicadosotros cupones que el carrito ya tiene (solo se pueden sumar los marcados como combinables)
JSON
{
    "codigo": "BIENVENIDA10",
    "contacto": {
        "email": "[email protected]"
    },
    "items": [
        {
            "producto_id": 12,
            "precio_id": 30,
            "cantidad": 2
        }
    ]
}

POST /api/v1/cupones/canjear#

Gasta un uso del cupón cuando el pedido se confirma o se paga. Vuelve a validar todas las reglas y es seguro con compras simultáneas (nunca supera el límite de usos). Es idempotente: repetir la llamada con la misma «referencia_externa» devuelve el mismo canje sin gastar otro uso. Permiso: cupones:canjear.

Dato del cuerpo (JSON)Qué es
codigoel código del cupón
referencia_externaobligatoria: el número de pedido de tu tienda
contactoigual que en validar
itemsigual que en validar
codigos_aplicadosigual que en validar
pedido_idopcional: id del pedido en Connecto, si lo creaste por la API de pedidos
JSON
{
    "referencia_externa": "WEB-1001",
    "codigo": "BIENVENIDA10",
    "contacto": {
        "email": "[email protected]"
    },
    "items": [
        {
            "producto_id": 12,
            "precio_id": 30,
            "cantidad": 2
        }
    ]
}

POST /api/v1/cupones/liberar#

Devuelve el uso del cupón (pedido cancelado, pago fallido). Idempotente. Permiso: cupones:canjear.

Dato del cuerpo (JSON)Qué es
codigoel código del cupón
referencia_externala misma referencia con la que se canjeó
JSON
{
    "codigo": "BIENVENIDA10",
    "referencia_externa": "WEB-1001"
}

Qué devuelve: validar: {"datos": {"valido": true, "codigo", "tipo": "pct|envio", "valor", "descuento" (USD), "envio_gratis", "subtotal_elegible", "lineas": [{"indice", "elegible", "descuento"}], "combinable", "vence_at", "usos_restantes"}} o {"valido": false, "motivo", "mensaje"}. canjear: {"datos": {"canjeado": true, "uso_id", "descuento", "envio_gratis", "repetido"}}. Si el módulo de cupones está apagado: error 503 «modulo_apagado».

Contactos (listar, crear y editar)#

Lista y consulta contactos con un conjunto básico de datos, crea contactos nuevos y edita nombre, teléfono, correo y tipo.

PermisoTipoQué permite
contactos:leerLecturaListar y ver contactos
contactos:escribirEscrituraCrear y editar contactos

GET /api/v1/contactos#

Lista contactos. Filtros: q (texto libre), email, telefono, actualizado_desde, limite, pagina. Permiso: contactos:leer.

ParámetroQué es
qtexto libre
emailcorreo exacto
telefonoteléfono
actualizado_desdefecha (2026-01-31)
limite1 a 100
paginapágina

GET /api/v1/contactos/{id}#

Un contacto por su id. Permiso: contactos:leer.

POST /api/v1/contactos#

Crea un contacto (exige nombre y, al menos, teléfono o correo). Opcionalmente guarda su documento y su ubicación (se validan contra los catálogos; lo que no se pueda aplicar se omite y se informa en «advertencias»). Si ya existe un contacto con ese teléfono, correo o número de documento responde 409 con su id. Permiso: contactos:escribir.

Dato del cuerpo (JSON)Qué es
nombreobligatorio
apellidosopcional
telefonoopcional
emailopcional
tipo_contacto_idopcional
whatsappopcional: true si el teléfono también tiene WhatsApp
numero_documentoopcional
tipo_documentoopcional: nombre («Cédula de ciudadanía») o id
paisopcional: código (CO) o nombre
departamentoopcional: nombre o id
ciudadopcional: nombre o id
direccionopcional
JSON
{
    "nombre": "Ana Pérez",
    "telefono": "+57 300 123 4567",
    "email": "[email protected]",
    "numero_documento": "1020304050",
    "tipo_documento": "Cédula de ciudadanía",
    "pais": "Colombia",
    "departamento": "Antioquia",
    "ciudad": "Medellín"
}

PATCH /api/v1/contactos/{id}#

Edita nombre, apellidos, teléfono, correo, tipo de contacto y la ubicación (país, departamento, ciudad y dirección). La ubicación se envía por nombre o por id/código y se valida contra los catálogos; lo que no se pueda aplicar (un nombre que no está en el catálogo o un campo desactivado en Configuración › Contactos) se omite y se informa en «advertencias» sin impedir el resto. Permiso: contactos:escribir.

Dato del cuerpo (JSON)Qué es
nombreopcional
apellidosopcional
telefonoopcional
emailopcional
tipo_contacto_idopcional
paisopcional: código (CO) o nombre
departamentoopcional: nombre o id
ciudadopcional: nombre o id
direccionopcional
numero_documentoopcional: solo se completa si el contacto no tiene uno
tipo_documentoopcional: solo se completa si el contacto no tiene uno
JSON
{
    "telefono": "+57 311 000 0000",
    "pais": "Colombia",
    "departamento": "Antioquia",
    "ciudad": "Medellín"
}

Conversaciones y mensajes#

Lee las conversaciones (con su canal, estado y asesor) y los mensajes de cada una.

PermisoTipoQué permite
conversaciones:leerLecturaLeer conversaciones y mensajes

GET /api/v1/conversaciones#

Lista conversaciones. Filtros: estado (open, pending, resolved), contacto_id, actualizada_desde, limite, pagina. Permiso: conversaciones:leer.

ParámetroQué es
estadoopen
contacto_idid del contacto
actualizada_desdefecha
limite1 a 100
paginapágina

GET /api/v1/conversaciones/{id}#

Una conversación. Permiso: conversaciones:leer.

GET /api/v1/conversaciones/{id}/mensajes#

Mensajes de una conversación (los más recientes primero). Permiso: conversaciones:leer.

ParámetroQué es
limite1 a 100
antes_de_idpara seguir con los más antiguos

Oportunidades#

Consulta las oportunidades (procesos de venta), agrega un contacto a un embudo definido y la mueve de etapa.

PermisoTipoQué permite
oportunidades:leerLecturaLeer oportunidades y embudos
oportunidades:escribirEscrituraCrear oportunidades y cambiarlas de etapa

GET /api/v1/oportunidades#

Lista oportunidades. Filtros: estado (abierto, ganado, perdido), contacto_id, limite, pagina. Permiso: oportunidades:leer.

ParámetroQué es
estadoabierto
contacto_idid del contacto
limite1 a 100
paginapágina

GET /api/v1/oportunidades/{id}#

Una oportunidad. Permiso: oportunidades:leer.

GET /api/v1/embudos#

Lista los embudos activos con sus etapas (id, nombre, tipo abierta/ganada/perdida): sirven para saber qué embudo_id y etapa_id usar. Permiso: oportunidades:leer.

POST /api/v1/oportunidades#

Agrega un contacto a un proceso de venta: crea su oportunidad en el embudo (y la etapa) que indiques. Un contacto solo puede tener UNA oportunidad abierta por embudo (si ya la tiene responde 409 con su id), salvo que envíes «varias»: true (p. ej. una oportunidad por cada pedido de la web). Se ejecutan las acciones automáticas de la etapa. Permiso: oportunidades:escribir.

Dato del cuerpo (JSON)Qué es
contacto_idid del contacto (o bien numero_documento, o bien email)
embudo_idid del embudo (o «embudo»: su nombre). Si no lo envías se usa el embudo por defecto
etapa_idopcional: id de una etapa abierta (o «etapa»: su nombre). Por defecto, la primera etapa del embudo
tituloopcional
valoropcional
monedaopcional
producto_idopcional
fecha_cierre_esperadaopcional, AAAA-MM-DD
propietario_idopcional: id del usuario responsable
variasopcional (true/false): permite que el contacto tenga varias oportunidades abiertas en el embudo (una por cada pedido); por defecto solo una
pedido_idopcional: id de un pedido ya creado del mismo contacto (o «pedido_numero»: su número); queda enlazado a la oportunidad
notaopcional: nota inicial
JSON
{
    "numero_documento": "1020304050",
    "embudo": "Ventas",
    "etapa": "Contactado",
    "titulo": "Matrícula Procuraduría",
    "valor": 325000
}

PATCH /api/v1/oportunidades/{id}#

Cambia la oportunidad de etapa (por etapa_id o por nombre, dentro de su embudo) y/o edita sus datos. Respeta las reglas del embudo y de la etapa: transiciones permitidas, datos requeridos y motivo al perder (422 si no se cumplen); si la etapa pide aprobación responde 202. DATOS DEL PEDIDO: si la etapa destino tiene acciones «Cambiar un dato» sobre el pedido (Configuración › Oportunidades › acciones de la etapa), el valor de cada dato se envía en el MISMO cuerpo, con el nombre del dato como nombre del campo (por ejemplo comprobante_url); al entrar a la etapa, la acción lo guarda en el pedido de la oportunidad. Si la etapa no tiene esa acción, el dato se ignora. También se aceptan en POST /oportunidades cuando nace directamente en una etapa con esa acción. Respuesta 422 si el valor no es válido (la URL debe ser http o https). Permiso: oportunidades:escribir.

Dato del cuerpo (JSON)Qué es
etapa_idid de la etapa destino (o «etapa»: su nombre)
motivo_perdida_idobligatorio si el embudo lo exige y la etapa es de pérdida
notaopcional
tituloopcional
valoropcional
monedaopcional
producto_idopcional
fecha_cierre_esperadaopcional
propietario_idopcional
comprobante_urldato del pedido: URL de la imagen del comprobante de pago. Se guarda en el pedido de la oportunidad SOLO si la etapa destino tiene la acción «Cambiar un dato → Comprobante de pago»; el nombre del campo es el nombre del dato
envio_guiadato del pedido (ver comprobante_url): guía de envío
envio_metododato del pedido: método de envío
envio_direcciondato del pedido: dirección de envío
notasdato del pedido: notas
JSON
{
    "etapa": "Pago confirmado",
    "comprobante_url": "https://w3.grupogeard.com/comprobantes/GG-261021-7C0451.jpg"
}

Pedidos#

Lee, crea y actualiza pedidos: el contacto asociado a sus productos, con precio y descuento de cada uno (o general), IVA, envío, estado del pedido, del pago y de la entrega.

PermisoTipoQué permite
pedidos:leerLecturaLeer pedidos
pedidos:escribirEscrituraCrear y actualizar pedidos (incluye pagos, reembolsos y entregas)

GET /api/v1/pedidos#

Lista pedidos (más recientes primero) con sus totales y estados, sin las líneas. Filtros opcionales. Permiso: pedidos:leer.

ParámetroQué es
estadoborrador
estado_pagosin_pagar
estado_entregasin_entregar
fuentemanual
contacto_idid del contacto
oportunidad_idid de la oportunidad
cotizacion_idid de la cotización
referencia_externaid del pedido en tu sistema
qtexto: número, cliente o referencia
desdeAAAA-MM-DD
hastaAAAA-MM-DD
limite1 a 100
paginapágina

GET /api/v1/pedidos/{id}#

Un pedido completo: líneas (producto, precio, descuento, IVA, total, entregado), descuento general, envío, totales, pagos y reembolsos. Permiso: pedidos:leer.

POST /api/v1/pedidos#

Crea un pedido para un contacto. Cada línea puede ser un producto del catálogo (producto_id; el precio sale del catálogo si no envías «precio», y con varios precios puedes elegir «precio_id») o una línea libre (solo «nombre» y «precio»). Los descuentos pueden ser por línea y/o generales, en porcentaje (pct) o valor fijo; se aplican ANTES del IVA. La fuente queda registrada (por defecto «api»). Si envías «referencia_externa» y ya existe un pedido con esa referencia y fuente, responde 409 con su id (así puedes reintentar sin duplicar). Con «estado»: «pendiente» puedes incluir «pagos». VARIABLE ADICIONAL complemento_correo: texto HTML (medio de pago y datos de la cuenta, por ejemplo) que el correo del pedido incrusta tal cual con la variable {{pedido:complemento_correo}}; se limpia (sin scripts ni formularios, solo estilos en línea), máximo 20.000 caracteres. Permiso: pedidos:escribir.

Dato del cuerpo (JSON)Qué es
contacto_idid del contacto (o bien numero_documento, o bien email)
itemslista de líneas: {producto_id
descuento_generalopcional: {tipo: pct
envioopcional: un monto, o {monto, impuesto_pct?, direccion?, metodo?, guia?}
monedaopcional, 3 letras (por defecto la configurada)
estadoopcional: borrador
pagosopcional (solo con estado pendiente): [{monto, metodo?: transferencia
fuenteopcional: api (por defecto)
fuente_detalleopcional: por ejemplo la web de origen
referencia_externaopcional: el id de este pedido en tu sistema (evita duplicados)
oportunidad_idopcional
cotizacion_idopcional
responsable_idopcional: id del usuario
notasopcional
terminosopcional
comprobante_urlopcional: URL (http o https) de la imagen del comprobante de pago
complemento_correoopcional: bloque HTML con el medio de pago y los datos de la cuenta, que el correo del pedido incrusta con la variable {{pedido:complemento_correo}} (máx. 20.000 caracteres; se limpia: sin scripts ni formularios, solo estilos en línea, imágenes y enlaces http/https)
JSON
{
    "numero_documento": "1020304050",
    "items": [
        {
            "producto_id": 12,
            "cantidad": 1,
            "descuento": {
                "tipo": "pct",
                "valor": 10
            }
        },
        {
            "nombre": "Material impreso",
            "cantidad": 2,
            "precio": 15000,
            "impuesto_pct": 0
        }
    ],
    "descuento_general": {
        "tipo": "valor",
        "valor": 5000
    },
    "envio": {
        "monto": 12000,
        "direccion": "Calle 1 # 2-3, Bogotá"
    },
    "estado": "pendiente",
    "referencia_externa": "WEB-10234"
}

PATCH /api/v1/pedidos/{id}#

Actualiza un pedido. Los productos, descuentos y el envío solo se cambian mientras el pedido es borrador (o pendiente sin pagos); las notas, los datos de envío y el responsable, siempre que no esté cancelado o reembolsado. Además: cambiar de «estado» (solo transiciones válidas), registrar un «pago» o «pagos» (no puede superar el saldo), un «reembolso» y la «entrega». Todo se aplica en una sola operación: si algo falla (422), no se guarda nada. Permiso: pedidos:escribir.

Dato del cuerpo (JSON)Qué es
itemsreemplaza todas las líneas (misma forma que al crear)
descuento_general{tipo: pct
enviomonto, o {monto, impuesto_pct, direccion, metodo, guia}
estadoborrador
motivoopcional: motivo de la cancelación
pago{monto, metodo?, referencia?, nota?}
pagoslista de pagos como el anterior
reembolso{monto, metodo?, referencia?, nota?}
entrega{estado: sin_entregar
responsable_idid del usuario
notastexto
terminostexto
comprobante_urlURL (http o https) de la imagen del comprobante de pago; con texto vacío se quita
complemento_correoopcional: bloque HTML con el medio de pago y los datos de la cuenta, que el correo del pedido incrusta con la variable {{pedido:complemento_correo}} (máx. 20.000 caracteres; se limpia: sin scripts ni formularios, solo estilos en línea, imágenes y enlaces http/https)
JSON
{
    "pago": {
        "monto": 150000,
        "metodo": "transferencia",
        "referencia": "TRX-9981"
    },
    "entrega": {
        "estado": "entregado"
    }
}
¿Te fue útil esta página?
Última actualización: 14/11/2026