List partner amendments
Lists amendments across the authenticated partner's orders.
Lists amendments across the authenticated partner's orders.
Requires the read order permission. Includes manual and automatic amendments in all
statuses. Optional repeated statuses, productType, amendmentMode, orderId, orderItemId and inclusive
UTC from/to timestamps filter the result. Use flat page (default 1) and limit (default 10,
maximum 100) query parameters. Nested paging keys return 400 with code 10001.
Amounts retain their original currency; a quote does not imply settlement.
Example response:
{"items":[{"id":"b7428a30-f760-46e8-b504-a670bf9bed19","orderId":"a46ee792-287e-44ef-a641-48de1a0f72fd","orderItemId":"cf4a49ac-b785-43d4-912a-4be3443e48bd","productType":"hotel","amendmentMode":"manual","status":"quoted","createdAt":"2026-11-03T09:00:00Z","amountToPay":{"amount":25,"currency":"USD"},"amountToRefund":{"amount":0,"currency":"USD"}}],"pagination":{"currentCount":1,"totalCount":1,"skip":0,"limit":10,"hasMore":false,"page":1,"totalPages":1}}
PartnerApiKeyX-Partner-Key<token>Partner API Key (X-Partner-Key)
page?integerOne-based page number. Default 1.
int32limit?integerPage size, 1 to 100. Default 10.
int32statuses?array<>Repeat to match any of the requested statuses.
productType?string"esim""hotel""flight""carRental""train""lounge""ticket""tour""activity""cruise""remittance""vpn""transportation""insurance""billPayment""giftCard""loyaltyProgram""voip""airtime""utility"amendmentMode?string"automatic""manual"orderId?stringuuidorderItemId?stringuuidfrom?stringInclusive creation timestamp with UTC offset. ISO 8601 date-time. A value with Z or an offset is converted to UTC; a value without a zone is read as UTC, and a date alone means 00:00 UTC on that day.
date-timeto?stringInclusive creation timestamp with UTC offset. Send the end of a UTC day to include that whole day. ISO 8601 date-time. A value with Z or an offset is converted to UTC; a value without a zone is read as UTC, and a date alone means 00:00 UTC on that day.
date-timeOK
- response
items*array<>pagination*Paging of a list response.
curl -X GET 'https://api.sandbox.openroam.com/v1/amendments?page=1&limit=10&orderId=01a1432e-7121-7b0e-a0a0-c35454d3b883&from=2026-10-01T00%3A00%3A00Z&to=2026-10-31T23%3A59%3A59Z'{ "items": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5", "orderItemId": "33207bce-c741-4896-a76b-8afcf6e4179a", "productType": "esim", "amendmentMode": "automatic", "status": "pending", "createdAt": "2019-08-24T14:15:22Z", "amountToPay": { "amount": 0, "currency": "string" }, "amountToRefund": { "amount": 0, "currency": "string" } } ], "pagination": { "currentCount": 0, "totalCount": 0, "skip": 0, "limit": 0, "hasMore": true, "page": 0, "totalPages": 0 }}Preview an item cancellation GET
Previews the cancellation penalty and expected refund for an order item. Requires the `read` order permission. Returns `penaltyAmount`, the `cancellationFee` kept in addition to it (`null` when none applies) and the expected `refundAmount`, all in the order currency, `isRefundable`, the cancellation band in effect, priced at the penalty (`appliedPenalties`: at most one `{ from, penaltyAmount }`), `effectiveCancellationDate` and `checkInDate`, calculated with the same rules as the partner portal. The fee comes out of what the penalty leaves, so the refund is never negative. `isRefundable: false` means the penalty alone keeps the whole price, so the item cannot be cancelled; it is not an error. A fee that takes what the penalty leaves does not make it false: the item can still be cancelled, with a refund of 0. The preview does not cancel the item or change its state, and it does not lock the penalty: the cancel call recalculates it, so a later cancellation band may apply. The preview refuses what the cancel refuses. A delivered item of a kind that cannot take back a delivery (airtime, utility, gift cards, eSIMs) can never be cancelled and returns `422` with code `18000` (`CANCELLATION_NOT_SUPPORTED`). Otherwise, when the item's `actions.cancellation` is not `available`, it returns `409` with code `18001` (`CANCELLATION_NOT_AVAILABLE`), and `details[0].reason` repeats `actions.cancellation.availability`. A refund started by OpenRoam support returns the same `409` with `MANUAL_REVIEW`. A delivered item is priced with its product's cancellation rules. An item that was not delivered has no cancellation to price: a rejected item whose automatic refund has not started previews a full refund of what was paid (after a failed refund, the amounts that refund is retried with), with a `penaltyAmount` of 0 and no `cancellationFee` or `appliedPenalties`. A cancellation the product refuses, for example after check-out, returns `400` with code `10001`. An item of another partner, or an unknown id, returns `404` with code `10004`.
Quote an amendment POST
Quotes a change to a delivered order item. Available only when the item's `actions.amendment` is `available`: the item must be fulfilled, not refunded, and its product must support automatic changes. Items whose changes need manual review show `manualReview` and use the manual amendment routes instead. A kind of item that can never be amended returns `422` with code `18002` (`AMENDMENT_NOT_SUPPORTED`); otherwise an amendment that is not allowed now returns `409` with code `18003` (`AMENDMENT_NOT_AVAILABLE`), and `details[0].reason` repeats `actions.amendment.availability` (`MANUAL_REVIEW` or `NOT_AVAILABLE`). An item of another partner, or an unknown id, returns `404` with code `10004`. Send the requested change in `attributes`, in the shape the item's product defines; top-level names that start with `_` are reserved for OpenRoam and ignored. The response has an `amendmentRequestId`, the time the quote was made (`processedAt`), the time it expires (`expiresAt`) and one or more `options`, each with an `id`, an `amountToPay` and an `amountToRefund` in the API key's currency, and an `amendmentFee`: a fee for the change, already included in those amounts, or `null` when none applies. Nothing changes and nothing is charged until you confirm the quote with `POST /order-items/{id}/amendments/confirm`, before `expiresAt`. Requires an `Idempotency-Key` header (a UUID). Repeating a completed request with the same key returns `409` with code `12000` (`IDEMPOTENCY_KEY_ALREADY_USED`): a quote is not kept, so request a new one with a new key. One still running returns `409` with code `12002` (`IDEMPOTENCY_KEY_IN_PROGRESS`) and a `Retry-After` header, and a different body with the same key `409` with code `12001`. A request that ended in an error can be sent again with the same key and body.