Skip to content

Update a fulfillment line

Hospitality module

PATCH/fulfillment-lines/{id}fulfillmentLines.update

A line of a fulfillment. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

  • Requires the capability hospitality.fulfillment.write.
  • OAuth scopes: hospitality.
  • Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
  • Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.

Path and query parameters

fulfillmentLines.update: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the fulfillment line.

Request body: FulfillmentLineUpdate

fulfillmentLines.update: FulfillmentLineUpdate
FieldTypeRequiredDescription
descriptionstringNoLine description.Constraints: length 1 to 300
quantitynumberNoQuantity.
unit_price_minorinteger (int64) | nullNoUnit price. Integer minor units of the resource currency; null means unpriced, never zero.
currency_codestring | nullNoISO 4217 currency of the price; required when the line is priced.Constraints: pattern ^[A-Z]{3}$
person_idstring (uuid) | nullNoIdentifier of the guest the line is for, such as a room night.
{
  "description": "King room, 3 nights",
  "quantity": 4,
  "unit_price_minor": 32900,
  "currency_code": "USD",
  "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Response 200: FulfillmentLine

fulfillmentLines.update: FulfillmentLine
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the fulfillment line.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
fulfillment_idstring (uuid)YesIdentifier of the fulfillment.
descriptionstringYesLine description.Constraints: length 1 to 300
quantitynumberYesQuantity.
unit_price_minorinteger (int64) | nullYesUnit price. Integer minor units of the resource currency; null means unpriced, never zero.
currency_codestring | nullYesISO 4217 currency of the price; required when the line is priced.Constraints: pattern ^[A-Z]{3}$
person_idstring (uuid) | nullYesIdentifier 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 PATCH "$XOS_BASE_URL/fulfillment-lines/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"description":"King room, 3 nights","quantity":4,"unit_price_minor":32900,"currency_code":"USD","person_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'
const { data, etag } = await xos.fulfillmentLines.update("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"
  }, { ifMatch: etag });
response = xos.fulfillment_lines.update("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"}, if_match=etag)
xos fulfillment-lines update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"description":"King room, 3 nights","quantity":4,"unit_price_minor":32900,"currency_code":"USD","person_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}' --if-match auto