Skip to Content
OpenRoam Docs
Hotel manual amendments

Request a manual amendment

Requests a manual change to a confirmed hotel booking.

POST
/v1/order-items/{id}/manual-amendments

Requests a manual change to a confirmed hotel booking.

Requires an Idempotency-Key header (a UUID) and an API key with order-manage permission. Send the requested change as attributes: new checkInDate and checkOutDate, holder or roomGuests (one entry per booked room, roomIndex 1-based); anything omitted keeps its booked value. Returns { amendmentId }; the request starts as Pending and nothing is charged until you approve a quote.

The order item must be fulfilled, not refunded, use the manual amendment flow and have no open request (Pending, InProgress, Quoted or PartnerApproved). Errors: 400 / 21100 invalid request, 21101 booking not amendable, 21102 a request is already open, 21104 manual amendments not available, 21113 or 21114 invalid or unsupported room and guest changes; 404 / 10004 when the order item is not found.

The same key after the request finished gives 409 / 12000: read the request it created with GET /order-items/{id}/amendments. While it is still running the key gives 409 / 12002 with Retry-After, and with a different body 409 / 12001.

Authorization

PartnerApiKey
headerX-Partner-Key<token>

Partner API Key (X-Partner-Key)

Path Parameters

id*string

The hotel order item's id, from items[].id of the order.

Formatuuid

Header Parameters

Idempotency-Key*string

UUID idempotency key for safe retries of this operation.

Formatuuid

Request Body

The requested change.

  1. body

A manual amendment request for a hotel booking.

attributes?unknown

The requested change, as a JSON object; anything omitted keeps its booked value. Fields: checkInDate and checkOutDate (yyyy-MM-dd); holder (title, firstName, lastName, email, phone); roomGuests, one entry per booked room with a 1-based roomIndex and its guests (title, firstName, lastName, middleName, isAdult defaulting to true, and age for a child). Occupancy follows the guest list. Order reads return the holder's email and phone masked: send one back as returned, or empty, to keep the booked one; any other masked value is refused with 400 / 10001. Their guests carry no isAdult: send false for a guest aged 0–17.

Response Body

OK

  1. response
amendmentId*string

ID of the amendment request.

Formatuuid
Example Request
curl -X POST 'https://api.sandbox.openroam.com/v1/order-items/01a1432e-7121-7b0e-a0a0-c35454d3b883/manual-amendments' \  -H 'Idempotency-Key: 0b8f7f3e-6b7a-4a52-9a5e-3d2f1a9c7e10' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "amendmentId": "f50ac643-fd02-46d5-9e8a-eb5968ac5fa0"}