Saltar al contenido

Create a BEO

Módulo Hospitality

POST/beosbeos.create

A banquet event order. Creates a BEO. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

  • Requiere la capacidad hospitality.beo.write.
  • Alcances de OAuth: hospitality.
  • Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
  • Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: BeoCreate

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

Respuesta 201: Beo

beos.create: 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 POST "$XOS_BASE_URL/beos" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","fulfillment_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","event_at":"2026-10-08T14:30:00Z","guest_count":140}'
const { data } = await xos.beos.create({
    "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "fulfillment_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "event_at": "2026-10-08T14:30:00Z",
    "guest_count": 140
  });
response = xos.beos.create({"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "fulfillment_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "event_at": "2026-10-08T14:30:00Z", "guest_count": 140})
xos beos create --data '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","fulfillment_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","event_at":"2026-10-08T14:30:00Z","guest_count":140}'