Request a manual amendment
Requests a manual change to a confirmed hotel booking.
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.
PartnerApiKeyX-Partner-Key<token>Partner API Key (X-Partner-Key)
id*stringThe hotel order item's id, from items[].id of the order.
uuidIdempotency-Key*stringUUID idempotency key for safe retries of this operation.
uuidThe requested change.
- body
A manual amendment request for a hotel booking.
attributes?unknownThe 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.
OK
- response
amendmentId*stringID of the amendment request.
uuidcurl -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 '{}'{ "amendmentId": "f50ac643-fd02-46d5-9e8a-eb5968ac5fa0"}Cancel a manual amendment POST
Cancels a manual amendment request that has not been worked on yet. Only a `Pending` request can be cancelled; once it is `Quoted`, decline it instead. No body. Returns `{ amendmentId }` and moves the request to `Cancelled`. Errors: 400 / 21103 in any other status, 400 / 21104 when the booking does not use manual amendments, 404 / 10004 when not found.
Decline a manual amendment POST
Declines the quoted price of a manual amendment. Only a `Quoted` request can be declined. No body and no money moves. Returns `{ amendmentId }` and moves the request to `Cancelled`; the booking is unchanged. Errors: 400 / 21103 in any other status, 404 / 10004 when not found.