Create a fulfillment

Módulo Hospitality

POST/fulfillmentsfulfillments.create

A lodging, catering, travel or amenity fulfillment. Creates a fulfillment. 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.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, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: FulfillmentCreate

fulfillments.create: FulfillmentCreate
Campo	Tipo	Obligatorio	Descripción
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
starts_at	string (date-time) \| null	No	Service start.
ends_at	string (date-time) \| null	No	Service end.
counterparty_id	string (uuid) \| null	No	Identifier of the supplier, such as the hotel or caterer.

{
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "fulfillment_kind": "Lodging",
  "title": "Headliner Hotel Block",
  "starts_at": "2026-10-08T14:30:00Z",
  "ends_at": "2026-10-08T14:30:00Z",
  "counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Respuesta 201: Fulfillment

fulfillments.create: 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" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","fulfillment_kind":"Lodging","title":"Headliner Hotel Block","starts_at":"2026-10-08T14:30:00Z","ends_at":"2026-10-08T14:30:00Z","counterparty_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'

const { data } = await xos.fulfillments.create({
    "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "fulfillment_kind": "Lodging",
    "title": "Headliner Hotel Block",
    "starts_at": "2026-10-08T14:30:00Z",
    "ends_at": "2026-10-08T14:30:00Z",
    "counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
  });

response = xos.fulfillments.create({"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "fulfillment_kind": "Lodging", "title": "Headliner Hotel Block", "starts_at": "2026-10-08T14:30:00Z", "ends_at": "2026-10-08T14:30:00Z", "counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"})

xos fulfillments create --data '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","fulfillment_kind":"Lodging","title":"Headliner Hotel Block","starts_at":"2026-10-08T14:30:00Z","ends_at":"2026-10-08T14:30:00Z","counterparty_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'