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

Guarda los datos de despacho

Añade a la orden los datos para enviarla (nombre, cédula, dirección…), a medida que los tengas. Solo si el espacio activó el despacho.

  • 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
datos{ campo: valor }SÍLos datos que tengas, por su campo de la configuración. Se suman a los que ya había; "" borra un campo.

RESPUESTA 200

La orden, con despacho y despacho_status al día.

CAMPOTIPOQUÉ ES
despacho{ campo: valor }Todos los datos guardados.
despacho_status.completobooleantrue cuando están todos los requeridos.
despacho_status.faltantesstring[]Los requeridos que faltan.
despacho_status.campos[]{ campo, etiqueta, requerido }Los campos activos, para saber qué pedir.

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.
409El espacio no tiene el despacho activo (se comprueba antes que la orden){"mensaje": "…", "code": "despacho_inactivo"}
404No hay una orden con ese id en el espacioorden no encontrada.
409La orden ya está despachada, vencida o cancelada{"mensaje": "…", "code": "despacho_cerrado", "estado": "<estado>"}
422Un campo que no está activo en la configuración. No se guarda nada{"mensaje": "…", "code": "campos_desconocidos", "campos": [ … ]}
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

  • Aquí detail es un objeto: decide por su code, no por el texto de mensaje.
  • Son datos personales. Se guardan solo en la orden; el registro de cambios apunta qué campos tocaste, nunca sus valores.