Saltar al contenido
API v1 · https://bentho.org/api
GET/api/mod/facturacion/{espacio}/orders/{orden}

Una orden

La orden con su estado, sus líneas, su total, las cuentas donde pagar y qué datos de despacho faltan.

  • PERMISOlee (vale cualquier clave)
  • 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 Facturación.
ordenstringSÍEl id de la orden: el que devolvió crearla (32 caracteres hexadecimales).

RESPUESTA 200

CAMPOTIPOQUÉ ES
id · estadostringEl id de la orden y su estado: ver estados.
session_ref · lead_refstring | nullTus referencias de la conversación y del cliente, las que mandaste al crearla.
lineas[]{ variant_id, sku, nombre, cantidad, precio_unitario, total_linea, adjustments }Cada línea con el precio que dio Productos al crearla. No cambia aunque el precio cambie después.
lineas[].adjustments[{ promotion_id, regla, target, monto }]Las promociones de Productos que rebajaron la línea. monto va en negativo. Vacío si ninguna.
subtotal · descuento_totalstringLa suma de las líneas antes de promociones, y todos los descuentos: los de Productos más el descuento que mandaste.
enviostringEl envío que mandaste al crearla. 0 si no mandaste.
totalstringLo que el cliente paga: el total de productos de Productos, menos tu descuento, más el envío.
monedastringPor defecto COP.
catalog_version · tarifa_versionstring | nullLa versión de precios de Productos con la que se cotizó, y la de la tarifa de Comercial que mandaste.
reservation_refsstring[]Las reservas de stock en Productos. Vacío si reservar_stock está apagado.
despachoobject | nullLos datos de despacho guardados (campo → valor). Datos personales.
creado_at · actualizado_atnumberSegundos desde 1970, con decimales.
expira_atnumber | nullHasta cuándo puede pagarse, en segundos desde 1970.
cuentas[]{ metodo, etiqueta, numero, titular }Las cuentas activas del espacio, para decirle al cliente dónde pagar. Salen de la configuración.
despacho_status{ activo, completo, faltantes, campos }Qué datos de despacho faltan. Con el despacho apagado: activo: false y completo: true.

ESTADOS DE UNA ORDEN

CAMPOTIPOQUÉ ES
pending_paymentesperando pagoCreada, con su total. Espera el pago hasta expira_at.
under_reviewesperando revisiónLlegó un comprobante: espera que alguien lo apruebe o lo rechace.
rejectedesperando pagoSe rechazó el comprobante. Admite otro; el stock sigue reservado.
paidpagadaPago aprobado y venta confirmada en Productos. Lista para despachar.
fulfilledterminadaDespachada.
expiredterminadaVenció sin pago (al llamar a vencer órdenes). Su stock se liberó.
cancelledterminadaCancelada. Su stock se liberó.

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

STATUSCUÁNDODETAIL LITERAL
403El espacio no tiene el módulo Facturaciónmódulo no habilitado para este espacio.
404No hay una orden con ese id en el espacioorden no encontrada.

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

  • Quién movió la orden a cada estado, y por qué, en su historia.
  • Son datos personales del cliente: guárdalos solo donde los necesites y no los copies a registros ni a herramientas de terceros.