Skip to Content
OpenRoam Docs
Hotel manual amendments

Cancel a manual amendment

Cancels a manual amendment request that has not been worked on yet.

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

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.

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
amendmentId*string

The amendmentId returned when the request was created.

Formatuuid

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/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel'
Example Response
{  "amendmentId": "f50ac643-fd02-46d5-9e8a-eb5968ac5fa0"}

Approve a manual amendment POST

Approves the quoted price of a manual amendment and settles it from your wallet. Requires an `Idempotency-Key` header (a UUID). Only a `Quoted` request can be approved: show the quoted `amountToPay` or `amountToRefund` first. On approval `amountToPay` is debited and the request becomes `PartnerApproved`; `amountToRefund` is credited only after the change is confirmed. The body is optional; `walletId` picks the wallet to settle from. Returns `{ amendmentId }`. Errors: 400 / 21103 when the request is not `Quoted`; 400 / 21107 when the wallet balance is too low (the request stays `Quoted`; top up and approve again); 400 / 21106 when changing the wallet while an approval is in progress; 21105 or 21108–21112 for settlement and concurrency failures (reload the request and contact support before retrying a 21108). The same key and body after the approval finished returns `{ amendmentId }` again and approves and charges nothing again. While it is still running the key gives 409 / 12002 with `Retry-After`, and with a different body 409 / 12001.

Request a manual amendment POST

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.