Skip to content
API

Nuvlyx API v1

Integra tu tienda con tu sistema externo: bots de WhatsApp, ERP, scripts de inventario.

Qué es esta API

La Nuvlyx API es un conjunto de endpoints REST que le permiten al dueño de una tienda Nuvlyx integrar su sistema externo (bot de WhatsApp, ERP, panel propio, scripts de inventario) con la tienda. Es de tipo server-to-server, autenticada con un Personal Access Token (PAT) que usted mismo genera desde el panel.

Todos los endpoints están bajo el prefijo:

https://api.nuvlyx.com/api/v1/external/

Inicio rápido

1. Cree un token desde el panel

Entre a su panel de la tienda y vaya a Configuración → API Tokens → Crear token. Asigne los permisos (scopes) que su integración va a necesitar y guarde el token mostrado una sola vez.

2. Haga su primer request

curl https://api.nuvlyx.com/api/v1/external/products \
  -H "Authorization: Bearer nvl_live_TU_TOKEN"

3. Lea la respuesta

[
  {
    "id": "0f1c…",
    "name": "Suscripción 1 mes",
    "slug": "suscripcion-1-mes",
    "kind": "DIGITAL",
    "status": "ACTIVE",
    "variations": [
      { "id": "abc…", "sku": "SUB-1M", "price": "10000.00", "stockQuantity": 42 }
    ]
  }
]

Convenciones

  • Formato: todas las respuestas y cuerpos son JSON (UTF-8).
  • Fechas: ISO 8601 en UTC. Ejemplo: 2026-05-18T14:30:00.000Z.
  • Montos: cadenas decimales con 2 decimales en la moneda base de la tienda. Ejemplo: "10000.00".
  • IDs: UUID v4.
  • Teléfonos: formato E.164 estricto. Ejemplo: +573001234567.
  • Errores: HTTP estándar (401, 403, 404, 422, 500). Cuerpo: { "statusCode": ..., "message": "...", "error": "..." }.

Endpoints disponibles

MétodoRutaPermiso
GET/external/productsproducts:read
GET/external/products/:idproducts:read
GET/external/products/:id/priceproducts:read
GET/external/ordersorders:read
GET/external/orders/:idorders:read
POST/external/ordersorders:write
GET/external/customers/:idcustomers:read
GET/external/customers/by-phone/:phonecustomers:read
GET/external/customers/:id/walletwallet:read
GET/external/customers/by-phone/:phone/walletwallet:read
POST/external/customers/:id/wallet/rechargewallet:write
POST/external/customers/by-phone/:phone/wallet/rechargewallet:write
POST/external/productsproducts:write
GET/external/inventory/stockinventory:read
POST/external/inventory/licensesinventory:write
GET/external/webhookswebhooks:manage
POST/external/webhookswebhooks:manage
DELETE/external/webhooks/:idwebhooks:manage
GET/external/webhooks/:id/deliverieswebhooks:manage

Lea también: errores, rate limits, idempotencia, paginación y webhooks.

WhatsApp · powered by Mosend

Nuvlyx no envía WhatsApp directamente: delega la entrega a la organización Mosend del OWNER. Cada tienda conecta su propia cuenta de Mosend desde Configuración → WhatsApp (Mosend) en el admin. Mosend factura al OWNER directo; nosotros solo ruteamos el evento al template correcto.

Si quieres mandar WhatsApp programáticamente desde tu integración, usa la API key de Mosend del OWNER contra https://api.mosend.dev — los endpoints públicos de Nuvlyx no exponen un proxy de envío.

Docs de Mosend: developer.mosend.dev.

¿Necesita ayuda?

Escríbanos a hola@nuvlyx.com o únase a la comunidad en Telegram donde compartimos integraciones de otros revendedores y resolvemos dudas.