The VXM API lets external systems —ERPs, accounting platforms, marketplaces, logistics services, or your own automations— read and write data from your store. It is a REST API over HTTPS that exchanges JSON, authenticated with a per-store JWT Bearer token.

API

API REST de VXM

El API VXM permite que sistemas externos —ERPs, contabilidades, marketplaces, plataformas de logística o automatizaciones propias— lean y escriban datos de tu tienda. Es un API REST sobre HTTPS que recibe y devuelve JSON, autenticada con un token Bearer JWT por negocio.

Ilustración pixel art de un desarrollador integrando la API de VentasxMayor: dos monitores con código y el logo de la caja, servidor con luces, plantas y un gato dormido

Por dónde empezar

Tenés dos familias de endpoints: la API de Catálogo v1 (moderna, REST completa con GET/POST/PUT/DELETE para productos y categorías) es la recomendada para integraciones nuevas. La API de Sincronización ERP (legada) es la que usan los puentes de escritorio (Dragonfish, Contabilium, etc.).

API de Catálogo v1

La API moderna del negocio: productos, categorías, listas de precios, clientes, pedidos y carritos. REST completa, con el token Bearer del ERP. Es la recomendada para cualquier integración nueva.

29 endpoints · /api/v1

API de Storefront

Lo que ve y hace el comprador: catálogo público, búsqueda, carrito, checkout y su cuenta. Usa la sesión del comprador, no el token del ERP.

23 endpoints · /api/v1/storefront

Sincronización ERP (legada)

Los endpoints que usan los puentes de escritorio —Dragonfish, Contabilium y compañía— para bajar pedidos y subir stock. Sigue funcionando, pero una integración nueva conviene armarla sobre Catálogo v1.

7 endpoints · /api/erp-*

Inicio rápido

  1. Pegá tu token Bearer en el campo de arriba (generalo en Configuración → ERP → API Token).
  2. En la barra lateral elegí la familia (Catálogo v1 o ERP Legado) y hacé clic en el endpoint que querés probar.
  3. Completá los campos o el JSON de ejemplo, mirá el cURL que se genera en vivo y hacé clic en "Enviar solicitud". La respuesta aparece abajo.

URL base

https
https://tu-tienda.com

Todos los endpoints son relativos a la URL del panel de tu tienda.

Autenticación

Todas las llamadas requieren un token Bearer en el header Authorization. El token es un JWT que identifica tu negocio y, salvo que lo regeneres, no expira.

  1. Ingresá al panel de administración de tu tienda.
  2. Andá a Configuración → ERP y elegí API Token.
  3. Hacé clic en Generar Token. El token se mostrará una sola vez.
  4. Guardalo en un lugar seguro. Si se filtra, regeneralo desde la misma pantalla y actualizá tus integraciones.
http
Authorization: Bearer YOUR_TOKEN

Convenciones

  • La API de Catálogo v1 es REST sobre HTTPS: usá GET para leer, POST para crear, PUT para actualizar y DELETE para borrar. Los recursos viven bajo /api/v1/.
  • Las solicitudes con cuerpo deben enviar Content-Type: application/json.
  • Los listados se paginan con los parámetros offset y limit. El límite por defecto es 50 y el máximo 100.
  • Los productos se identifican por su "code" (por ejemplo, "REM-001") — pasalo en la URL para acceder a un producto. El resto de los recursos (categorías, listas de precios, clientes, pedidos, imágenes, opciones) se identifican por id numérico.
  • Las marcas de tiempo se intercambian como milisegundos desde epoch (lo que devuelve Date.now() en JavaScript).

Manejo de errores

Las respuestas con error usan códigos HTTP estándar y devuelven un cuerpo JSON con la clave error.

200 / 201 / 204Operación exitosa. 201 al crear un recurso, 204 cuando no hay contenido para devolver.
400Cuerpo inválido o falta un parámetro requerido.
401Token faltante o inválido.
404Recurso no encontrado o no pertenece a tu negocio.
409Conflicto: la operación no se puede completar en el estado actual (por ejemplo, borrar una categoría que tiene subcategorías).
422Error de validación: el cuerpo de la solicitud no cumple las reglas del recurso. El mensaje explica qué corregir.
json
{
  "error": {
    "code": "validation_error",
    "message": "Product 'name' is required"
  }
}