Skip to Content
OpenRoam Docs
Order items

Quote an amendment

Quotes a change to a delivered order item.

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

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.

Authorization

PartnerApiKey
headerX-Partner-Key<token>

Partner API Key (X-Partner-Key)

Path Parameters

id*string

Order item id (items[].id from the order response).

Formatuuid

Header Parameters

Idempotency-Key*string

UUID idempotency key for safe retries of this operation.

Formatuuid

Request Body

The requested change.

  1. body

The change requested for a delivered order item.

attributes?unknown

Required. A JSON object describing the change, in the shape the item's product defines for amendments.

Response Body

OK

  1. response

A priced amendment quote. Confirm it before expiresAt.

amendmentRequestId*string

The quote id to send when confirming.

Formatuuid
processedAt*string

When the quote was made (UTC).

Formatdate-time
expiresAt*string

When the quote expires (UTC); confirm it before then.

Formatdate-time
options*array<>

The priced options; confirm one by its id.

Example Request
curl -X POST 'https://api.sandbox.openroam.com/v1/order-items/01a1432e-7121-7b0e-a0a0-c35454d3b883/amendments/quote' \  -H 'Idempotency-Key: 0b8f7f3e-6b7a-4a52-9a5e-3d2f1a9c7e10' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "amendmentRequestId": "f62d9c3e-1bd6-4c13-9f52-d1b5092380b3",  "processedAt": "2019-08-24T14:15:22Z",  "expiresAt": "2019-08-24T14:15:22Z",  "options": [    {      "id": "string",      "amountToPay": {        "amount": 0,        "currency": "string"      },      "amountToRefund": {        "amount": 0,        "currency": "string"      },      "amendmentFee": {        "amount": 0,        "currency": "string"      }    }  ]}

List partner amendments GET

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}}```

Update an item POST

Updates a delivered order item, without a charge. Changes what the item's kind lets a partner change after the purchase, in one call. An update never charges or refunds anything: a change with a price, such as a hotel or flight change, is an amendment (`POST /order-items/{id}/amendments/quote`). At launch only gift cards can be updated: `inputs` takes a new `recipientEmail` and `giftMessage`, and the gift email is sent again, to the new address with the new message. A card bought without a recipient needs `recipientEmail`. Every other kind of item returns `422` with code `18004` (`UPDATE_NOT_SUPPORTED`). Available when the item's `actions.update` is `available`; otherwise the update returns `409` with code `18005` (`UPDATE_NOT_AVAILABLE`), and `details[0].reason` repeats `actions.update.availability` (`IN_PROGRESS` or `NOT_AVAILABLE`). The same `409` is returned when the item stops being available during the call, for example after a cancel. A member of `inputs` left out or sent as `null` keeps its current value, and at least one member must be present. An invalid member returns `400` with code `10001` at `inputs.<member>`, with the same reasons as the order's `inputs`, and a member the item's kind does not define returns `400` with code `10001` and reason `UNSUPPORTED_FIELD`. An item of another partner, or an unknown id, returns `404` with code `10004`. A malformed body (not valid JSON, `inputs` missing, `null` or not an object, or a top-level member other than `inputs`) returns `400` with code `10001` before the item is read. The checks on the item then run in this order: `404`, `422`, `409`, then `400` for the members of `inputs`. Returns the item exactly as `GET /order-items/{id}` returns it. No webhook is sent for an update. Requires an `Idempotency-Key` header (a UUID). Repeating a completed request with the same key and body returns `200` with the item as `GET /order-items/{id}` returns it now, and changes nothing again (no gift email is sent again). 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. Updating the same item again needs a new key.