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

Cancela una orden

Cancela una orden que aún no se ha pagado y libera su stock en Productos. No se puede deshacer.

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

CUERPO · JSON

CAMPOTIPOREQUERIDOQUÉ ES
motivostringnoPor qué. Queda en la historia.
actorstringnoQuién la cancela. Sin él, la historia dice "operador".

RESPUESTA 200

La orden, en cancelled, con los campos de GET orders/{orden}.

CAMPOTIPOQUÉ ES
estado"cancelled"Cancelada.

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

STATUSCUÁNDODETAIL LITERAL
403El espacio no tiene el módulo Facturaciónmódulo no habilitado para este espacio.
403La clave es de solo lecturaTu cuenta es de solo lectura en este espacio.
404No hay una orden con ese id en el espacioorden no encontrada.
409La orden ya está pagada, despachada o vencidatransición ilegal: <de> → cancelled
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

  • El cuerpo es obligatorio aunque sus campos no: manda al menos {}.
  • Cancelar una orden ya cancelada no da error: la devuelve igual.