Referencia de la API

Los 34 endpoints de la API pública de Posdata, generados del contrato OpenAPI 1.0.0.

API REST servidor a servidor para cuentas con plan Pro. Autenticación con API key (Bearer). Montos en pesos colombianos enteros; fechas ISO 8601 en UTC.

Cada endpoint tiene su página con parámetros, cuerpo, respuestas, errores y ejemplos. Los objetos que devuelve y recibe la API están, campo por campo, en Objetos. El contrato completo en OpenAPI 3.1 está en api.posdata.so/public/v1/openapi.json.

URLs base

https://api.posdata.so/public/v1: Producción (keys pdk_live_).
https://apidev.posdata.so/public/v1: Pruebas (keys pdk_test_, datos de prueba, puede reiniciarse).

Todas las peticiones llevan Authorization: Bearer <tu API key>. MiraAutenticación.

Cuenta

Endpoint	Qué hace	Permiso
GET/me	Cuenta, API key y frescura de los datos	cualquier key

Productos

Endpoint	Qué hace	Permiso
GET/products	Listar productos	`products:read`
POST/products	Crear producto	`products:write`
GET/products/{id}	Obtener un producto	`products:read`
PATCH/products/{id}	Editar producto	`products:write`
GET/categories	Listar categorías	`products:read`
POST/categories	Crear categoría	`products:write`
GET/categories/{id}	Obtener una categoría	`products:read`
PATCH/categories/{id}	Editar categoría	`products:write`
PATCH/products/{id}/variants/{variantId}	Editar variante	`products:write`

Clientes

Endpoint	Qué hace	Permiso
GET/customers	Listar clientes	`customers:read`
POST/customers	Crear cliente	`customers:write`
GET/customers/{id}	Obtener un cliente	`customers:read`
PATCH/customers/{id}	Editar cliente	`customers:write`

Inventario

Endpoint	Qué hace	Permiso
GET/warehouses	Listar bodegas	`inventory:read`
GET/warehouses/{id}	Obtener una bodega	`inventory:read`
GET/inventory/movements	Listar movimientos de inventario	`inventory:read`
POST/inventory/movements	Registrar movimiento de stock	`inventory:write`
GET/inventory/levels	Listar el stock por bodega	`inventory:read`
GET/inventory/movements/{id}	Obtener un movimiento de inventario	`inventory:read`
POST/inventory/counts	Registrar un conteo de inventario	`inventory:write`
GET/inventory/kardex	Kardex de un producto	`inventory:read`
GET/inventory/valuation	Valor del inventario	`inventory:costs`

Ventas

Endpoint	Qué hace	Permiso
GET/sales	Listar ventas	`sales:read`
GET/sales/{id}	Obtener una venta	`sales:read`

Facturación

Endpoint	Qué hace	Permiso
GET/invoices	Listar documentos	`invoices:read`
GET/invoices/{id}	Obtener un documento	`invoices:read`

Cotizaciones

Endpoint	Qué hace	Permiso
GET/quotes	Listar cotizaciones	`quotes:read`
GET/quotes/{id}	Obtener una cotización	`quotes:read`

Caja

Endpoint	Qué hace	Permiso
GET/cash-sessions	Listar turnos de caja	`cash:read`
GET/cash-sessions/{id}	Obtener un turno de caja	`cash:read`

Reportes

Endpoint	Qué hace	Permiso
GET/reports/daily-sales	Ventas por día	`reports:read`

Eventos

Endpoint	Qué hace	Permiso
GET/events	Listar eventos	`events:read`
GET/events/{id}	Obtener un evento	`events:read`