Skip to main content

Referencia de API

Bienvenido a la referencia de la API de ZenFlow. Esta documentación cubre todos los endpoints disponibles para gestionar pedidos, productos, stock y webhooks.

URL Base

https://api.zenflow.com.ar/api/v1

Autenticación

Todas las solicitudes a la API requieren autenticación mediante API Key:
curl -X GET "https://api.zenflow.com.ar/api/v1/orders" \
  -H "X-API-Key: zenflow_live_your_key_here"
Consulta Autenticación para más detalles.

Formato de Respuesta

Todas las respuestas siguen una estructura JSON consistente:

Respuesta Exitosa

{
  "success": true,
  "data": {
    // Payload de respuesta
  }
}

Respuesta Paginada

{
  "success": true,
  "data": {
    "items": [...],
    "pagination": {
      "total": 100,
      "page": 1,
      "limit": 50,
      "total_pages": 2
    }
  }
}

Respuesta de Error

{
  "success": false,
  "error": {
    "code": "codigo_error",
    "message": "Mensaje de error descriptivo"
  }
}

Endpoints Disponibles

Pedidos

MétodoEndpointDescripciónScope
GET/ordersListar pedidosread:orders
GET/orders/:idObtener detalles del pedidoread:orders
POST/ordersCrear pedido(s)write:orders
PUT/orders/:idActualizar pedidowrite:orders
POST/orders/:id/cancelCancelar pedidowrite:orders
GET/orders/:id/statusObtener estado del pedidoread:orders

Productos

MétodoEndpointDescripciónScope
GET/productsListar productosread:products
GET/products/:idObtener producto por IDread:products
GET/products/sku/:skuObtener producto por SKUread:products
GET/products/barcode/:barcodeObtener producto por código de barrasread:products
POST/productsCrear productowrite:products
PUT/products/:idActualizar productowrite:products
POST/products/bulkUpsert masivo de productoswrite:products
DELETE/products/:idEliminar productowrite:products

Stock

MétodoEndpointDescripciónScope
GET/stockObtener niveles de stockread:stock
GET/stock/product/:idObtener stock del productoread:stock
GET/stock/sku/:skuObtener stock por SKUread:stock
PUT/stock/product/:idActualizar stock del productowrite:stock
POST/stock/bulkActualización masiva de stockwrite:stock
GET/stock/movementsObtener movimientos de stockread:stock
POST/stock/adjustmentCrear ajustewrite:stock

Webhooks

MétodoEndpointDescripciónScope
GET/webhooks/eventsListar eventos disponiblesread:webhooks
GET/webhooksListar webhooksread:webhooks
GET/webhooks/:idObtener detalles del webhookread:webhooks
POST/webhooksCrear webhookwrite:webhooks
PUT/webhooks/:idActualizar webhookwrite:webhooks
DELETE/webhooks/:idEliminar webhookwrite:webhooks
POST/webhooks/:id/rotate-secretRotar secretwrite:webhooks
POST/webhooks/:id/toggleHabilitar/deshabilitarwrite:webhooks
GET/webhooks/:id/deliveriesObtener historial de entregasread:webhooks
GET/webhooks/:id/statsObtener estadísticasread:webhooks
POST/webhooks/:id/testEnviar evento de pruebawrite:webhooks

Parámetros Comunes

Paginación

La mayoría de los endpoints de listado soportan paginación:
ParámetroTipoPor DefectoDescripción
pageinteger1Número de página
limitinteger50Items por página (máx 100)

Filtrado

Muchos endpoints soportan filtrado mediante parámetros de consulta. Consulta la documentación de cada endpoint para los filtros disponibles.

Formatos de Fecha

Todas las fechas usan formato ISO 8601:
  • 2024-01-15 (solo fecha)
  • 2024-01-15T10:30:00Z (con hora)

Códigos de Estado HTTP

CódigoDescripción
200Éxito
201Creado
400Solicitud Incorrecta
401No Autorizado
403Prohibido
404No Encontrado
409Conflicto
429Límite de Tasa
500Error Interno

Límites de Tasa

Consulta Límites de Tasa para más detalles.