Create a fulfillment line
Hospitality module
POST/fulfillment-linesfulfillmentLines.create
A line of a fulfillment. Creates a fulfillment line. 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: FulfillmentLineCreate
| Field | Type | Required | Description |
|---|---|---|---|
| fulfillment_id | string (uuid) | Yes | Identifier of the fulfillment. |
| description | string | Yes | Line description.Constraints: length 1 to 300 |
| quantity | number | No | Quantity. |
| unit_price_minor | integer (int64) | null | No | Unit price. Integer minor units of the resource currency; null means unpriced, never zero. |
| currency_code | string | null | No | ISO 4217 currency of the price; required when the line is priced.Constraints: pattern ^[A-Z]{3}$ |
| person_id | string (uuid) | null | No | Identifier of the guest the line is for, such as a room night. |
{
"fulfillment_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"description": "King room, 3 nights",
"quantity": 4,
"unit_price_minor": 32900,
"currency_code": "USD",
"person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Response 201: FulfillmentLine
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the fulfillment line. |
| 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. |
| fulfillment_id | string (uuid) | Yes | Identifier of the fulfillment. |
| description | string | Yes | Line description.Constraints: length 1 to 300 |
| quantity | number | Yes | Quantity. |
| unit_price_minor | integer (int64) | null | Yes | Unit price. Integer minor units of the resource currency; null means unpriced, never zero. |
| currency_code | string | null | Yes | ISO 4217 currency of the price; required when the line is priced.Constraints: pattern ^[A-Z]{3}$ |
| person_id | string (uuid) | null | Yes | Identifier of the guest the line is for, such as a room night. |
{
"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",
"fulfillment_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"description": "King room, 3 nights",
"quantity": 4,
"unit_price_minor": 32900,
"currency_code": "USD",
"person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Code samples
curl -X POST "$XOS_BASE_URL/fulfillment-lines" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"fulfillment_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","description":"King room, 3 nights","quantity":4,"unit_price_minor":32900,"currency_code":"USD","person_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'const { data } = await xos.fulfillmentLines.create({
"fulfillment_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"description": "King room, 3 nights",
"quantity": 4,
"unit_price_minor": 32900,
"currency_code": "USD",
"person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
});response = xos.fulfillment_lines.create({"fulfillment_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "description": "King room, 3 nights", "quantity": 4, "unit_price_minor": 32900, "currency_code": "USD", "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"})xos fulfillment-lines create --data '{"fulfillment_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","description":"King room, 3 nights","quantity":4,"unit_price_minor":32900,"currency_code":"USD","person_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'