Saltar al contenido

Update a BEO

Módulo Hospitality

PATCH/beos/{id}beos.update

A banquet event order. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

  • Requiere la capacidad hospitality.beo.write.
  • Alcances de OAuth: hospitality.
  • Envía If-Match con el ETag que leíste. Una etiqueta desactualizada devuelve 412; si falta, devuelve 428.
  • Estados de error: 400, 401, 404, 412, 422, 428, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

beos.update: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the beo.

Cuerpo de la solicitud: BeoUpdate

beos.update: BeoUpdate
CampoTipoObligatorioDescripción
fulfillment_idstring (uuid) | nullNoIdentifier of the catering fulfillment.
event_atstring (date-time)NoService time.
guest_countinteger | nullNoGuaranteed count.Restricciones: range 0 to any
{
  "fulfillment_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "event_at": "2026-10-08T14:30:00Z",
  "guest_count": 140
}

Respuesta 200: Beo

beos.update: Beo
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the beo.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
project_idstring (uuid)SíIdentifier of the project.
fulfillment_idstring (uuid) | nullSíIdentifier of the catering fulfillment.
event_atstring (date-time)SíService time.
guest_countinteger | nullSíGuaranteed count.Restricciones: range 0 to any
beo_numberintegerSíNumber within the project; the display key is {project_key}-{beo_number}.Restricciones: range 1 to any
approved_atstring (date-time) | nullSíWhen the BEO was approved.
approved_bystring (uuid) | nullSíIdentifier of the person who approved the BEO; never its author.
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "fulfillment_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "event_at": "2026-10-08T14:30:00Z",
  "guest_count": 140,
  "beo_number": 4,
  "approved_at": "2026-10-08T14:30:00Z",
  "approved_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Ejemplos de código

curl -X PATCH "$XOS_BASE_URL/beos/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"fulfillment_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","event_at":"2026-10-08T14:30:00Z","guest_count":140}'
const { data, etag } = await xos.beos.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "fulfillment_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "event_at": "2026-10-08T14:30:00Z",
    "guest_count": 140
  }, { ifMatch: etag });
response = xos.beos.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"fulfillment_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "event_at": "2026-10-08T14:30:00Z", "guest_count": 140}, if_match=etag)
xos beos update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"fulfillment_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","event_at":"2026-10-08T14:30:00Z","guest_count":140}' --if-match auto