Transition the fulfillment state

Módulo Hospitality

POST/fulfillments/{id}/transitionsfulfillments.transition

Moves the fulfillment lifecycle to another state through its transition RPC, which writes the transition ledger. Uses compare-and-set on `expected_state`; a disallowed transition returns a 422 refusal. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

Requiere la capacidad hospitality.fulfillment.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, 404, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

fulfillments.transition: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the fulfillment.

Cuerpo de la solicitud: FulfillmentTransitionRequest

fulfillments.transition: FulfillmentTransitionRequest
Campo	Tipo	Obligatorio	Descripción
expected_state	string	Sí	The state the caller believes the row is in (compare-and-set).Restricciones: pattern ^[A-Z][A-Za-z]( [A-Z][A-Za-z])*$
to_state	string	Sí	Target state.Restricciones: pattern ^[A-Z][A-Za-z]( [A-Z][A-Za-z])*$
reason	string	No	Reason, required by some transitions.Restricciones: length 1 to any

{
  "expected_state": "Proposed",
  "to_state": "Active",
  "reason": "Client approved the revised scope."
}

Respuesta 200: Fulfillment

fulfillments.transition: Fulfillment
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the fulfillment.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
project_id	string (uuid)	Sí	Identifier of the project.
fulfillment_kind	FulfillmentKind	Sí	Hospitality fulfillment kind.Restricciones: one of "Lodging", "Catering", "Travel", "Amenity"
title	string	Sí	Fulfillment title.Restricciones: length 1 to 300
fulfillment_state	"Proposed" \| "Active" \| "Blocked" \| "Complete" \| "Canceled"	Sí	Fulfillment state.
starts_at	string (date-time) \| null	Sí	Service start.
ends_at	string (date-time) \| null	Sí	Service end.
counterparty_id	string (uuid) \| null	Sí	Identifier of the supplier, such as the hotel or caterer.
fulfillment_number	integer	Sí	Number within the project; the display key is {project_key}-{fulfillment_number}.Restricciones: range 1 to any

{
  "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_kind": "Lodging",
  "title": "Headliner Hotel Block",
  "fulfillment_state": "Proposed",
  "starts_at": "2026-10-08T14:30:00Z",
  "ends_at": "2026-10-08T14:30:00Z",
  "counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "fulfillment_number": 3
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/fulfillments/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/transitions" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"expected_state":"Proposed","to_state":"Active","reason":"Client approved the revised scope."}'

const { data } = await xos.fulfillments.transition("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "expected_state": "Proposed",
    "to_state": "Active",
    "reason": "Client approved the revised scope."
  });

response = xos.fulfillments.transition("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"expected_state": "Proposed", "to_state": "Active", "reason": "Client approved the revised scope."})

xos fulfillments transition 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"expected_state":"Proposed","to_state":"Active","reason":"Client approved the revised scope."}'