Skip to Content
OpenRoam Docs
Hotel manual amendments

Approve a manual amendment

Approves the quoted price of a manual amendment and settles it from your wallet.

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

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.

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

Header Parameters

Idempotency-Key*string

UUID idempotency key for safe retries of this operation.

Formatuuid

Request Body

Optional settlement choice.

  1. body

Approval of a quoted manual amendment.

walletId?|

Optional ID of your wallet to settle the amendment from; the wallet proposed with the quote is used when omitted. It cannot be changed while an approval is in progress.

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/approve' \  -H 'Idempotency-Key: 0b8f7f3e-6b7a-4a52-9a5e-3d2f1a9c7e10' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "amendmentId": "f50ac643-fd02-46d5-9e8a-eb5968ac5fa0"}

Search hotels POST

Searches hotels by location or hotel IDs and returns their bookable rates for the stay. Send `searchCriteria.location` or `searchCriteria.hotelIds`; a non-empty `hotelIds` wins and `location` is then ignored. `checkIn`, `checkOut`, `rooms` and `guestNationality` are required: rates are priced for the occupancy, child ages and guest market sent here. A stay longer than 30 nights returns 400 / 10001 with reason `MAX_STAY_EXCEEDED` at `checkOut`. The body rejects an unknown member at every level, `filters`, `searchCriteria.location` and `rooms[]` included, and the route takes no query parameters: either gives 400 / 10001. Returns `{ items, pagination, nextCursor, details }`. Each item is a hotel: `id`, `name`, `countryCode`, `category` (always null), `logoUrl` (the main image), `description`, its `offers`, and `details` with the star rating, address, coordinates, images, amenity groups and contact. Each offer is one rate: an opaque `publicId`, a `name` such as "Deluxe King, Breakfast, Free cancellation", a `price` for the whole stay (all rooms and nights), and the rate terms in `details`, including `expiresAt`. Pass an offer's `publicId` to quote or order before it expires. The hotel's `id` is not an offer; send it in `searchCriteria.hotelIds` to search that hotel again. A hotel without an orderable offer is not listed. `details.availableFilters` holds the amenity filter values of a `cityCode` search. Location searches are paged: `limit` is 1–50 (default 20) and the next page is requested by sending the response's `nextCursor` back as `cursor` with the same body; a null `nextCursor` is the last page. A page can hold fewer hotels than `limit`, even none, while `nextCursor` is not null: keep paging until it is null. `pagination` is `{ currentCount, limit, hasMore }`: the walk states no page number and no total. To keep pages small, each hotel on a page has one offer, its cheapest rate, with empty `nightlyPrices` and `surcharges`, and no description and one image. A `hotelIds` search returns every rate of those hotels with the full detail, as one complete page; an empty `items` there means none of those hotels has an orderable offer. Errors: an ID that is not a hotel ID returns 400 / 21000; an unknown or expired hotel ID 400 / 11004; 503 / 21003 when offers are temporarily unavailable (retry the search); 502, 504 or 503 with 21007–21009 when the hotel system fails, times out or is unavailable.

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.