Saltar al contenido
API v1 · https://bentho.org/api
POST/api/mod/productos/{espacio}/inventory/reservations

Reserva stock

Aparta unidades de una variante por un tiempo, mientras tu cliente paga. Lo reservado no se puede vender a otro; si vence el plazo, vuelve solo.

  • PERMISOescribe
  • CRÉDITOSno gasta
  • AUTENTICACIÓNBearer bth_…

PARÁMETROS

CAMPOTIPOREQUERIDOQUÉ ES
espaciostringSÍEl id del espacio (sale en GET /api/companies). Tiene que tener el módulo Productos.

CUERPO · JSON

CAMPOTIPOREQUERIDOQUÉ ES
variant_idstringSÍLa variante.
cantidadnumber | stringnoCuántas. Por defecto 1.
ttl_sintegernoCuántos segundos dura. Por defecto 900 (15 minutos).
bodegastringnoPor defecto, la única.
session_id · sale_refstringnoTus referencias: el carrito y el pedido.

RESPUESTA 201

La reserva, activa.

CAMPOTIPOQUÉ ES
id · variant_id · bodegastringLa reserva y qué retiene.
cantidadstringLo retenido.
estadostringVer estados.
session_id · sale_refstring | nullLos que diste.
expires_at · created_atnumberCuándo vence y cuándo se creó, en segundos desde 1970.
released_atnumber | nullCuándo dejó de retener. null mientras está activa.

ESTADOS DE UNA RESERVA

CAMPOTIPOQUÉ ES
activaretieneDescuenta de lo disponible hasta expires_at.
liberadaterminadaLa liberaste: el stock vuelve.
consumidaterminadaSe convirtió en venta (venta con su reservation_id).
expiradaterminadaVenció su plazo: el stock vuelve solo.

ERRORES DE ESTA RUTA · SIEMPRE {"detail": …}

STATUSCUÁNDODETAIL LITERAL
403El espacio no tiene el módulo Productosmódulo no habilitado para este espacio.
403La clave es de solo lecturaTu cuenta es de solo lectura en este espacio.
409No alcanza lo disponible, la variante no tiene stock cargado o la cantidad no es mayor que 0sin disponibilidad suficiente para reservar.
422Falta un campo obligatorio o uno no es de su tipo (detail es una lista)—

Y los de cualquier ruta —clave inválida, cuenta no al día, IP, límites—, en Errores, límites y créditos.

CONVIENE SABER

  • Al confirmar la venta, pasa el id como reservation_id de la línea en Confirma una venta: la reserva se consume y no se descuenta dos veces.
  • Si tu cliente abandona, libérala sin esperar al plazo.