Create a fulfillment
Hospitality module
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.
- Requires the capability hospitality.fulfillment.write.
- OAuth scopes: hospitality.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.
Request body: FulfillmentCreate
| Field | Type | Required | Description |
|---|---|---|---|
| project_id | string (uuid) | Yes | Identifier of the project. |
| fulfillment_kind | FulfillmentKind | Yes | Hospitality fulfillment kind.Constraints: one of "Lodging", "Catering", "Travel", "Amenity" |
| title | string | Yes | Fulfillment title.Constraints: 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"
}Response 201: Fulfillment
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the fulfillment. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| project_id | string (uuid) | Yes | Identifier of the project. |
| fulfillment_kind | FulfillmentKind | Yes | Hospitality fulfillment kind.Constraints: one of "Lodging", "Catering", "Travel", "Amenity" |
| title | string | Yes | Fulfillment title.Constraints: length 1 to 300 |
| fulfillment_state | "Proposed" | "Active" | "Blocked" | "Complete" | "Canceled" | Yes | Fulfillment state. |
| starts_at | string (date-time) | null | Yes | Service start. |
| ends_at | string (date-time) | null | Yes | Service end. |
| counterparty_id | string (uuid) | null | Yes | Identifier of the supplier, such as the hotel or caterer. |
| fulfillment_number | integer | Yes | Number within the project; the display key is {project_key}-{fulfillment_number}.Constraints: 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
}Code samples
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"}'