Hotel guides

Vouchers

Once a booking is confirmed, travellers need proof of it. Take the voucher as data to build your own, as a ready-made document, or have Roave email it to your client under your agency's name.

Voucher data

Request · cURL

curl "https://api.roaveagents.com/api/v1/bookings/66f1d2c4e4b0c1d2e3f4b010/voucher" \
  -H "X-API-Key: $ROAVE_API_KEY"

The response carries everything a hotel voucher needs: orderRef, stay (hotel, address, dates, rooms and guests), hotelConfirmationNumber, cancellationPolicy, excludedTaxes, policies, importantInformation and a priceSummary. Voucher data is available for hotel bookings; for other products, use the booking's line items and the supplier vouchers below.

Printable document

For a finished voucher, fetch the document. It's an HTML page (not wrapped in the JSON envelope) that prints cleanly or converts to PDF. Add ?prices=without to leave prices off — what you want when your client paid you a different price.

Request · cURL

curl "https://api.roaveagents.com/api/v1/bookings/66f1d2c4e4b0c1d2e3f4b010/voucher/document?prices=without" \
  -H "X-API-Key: $ROAVE_API_KEY" \
  -o voucher.html

Email the voucher to your client

Roave can send the voucher for you, branded with your agency's name, with the document attached as a PDF. It works for confirmed, cancelled and refunded bookings; any other state returns 400.

Request · cURL

curl -X POST "https://api.roaveagents.com/api/v1/bookings/66f1d2c4e4b0c1d2e3f4b010/email-client" \
  -H "X-API-Key: $ROAVE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "anna.smith@example.com",
    "agencyName": "Harbour Lane Travel",
    "note": "Have a wonderful trip — call us any time on +44 20 7946 0000.",
    "replyTo": "bookings@harbourlane.example",
    "withoutPrices": true
  }'

to defaults to the lead traveller's email. You can add cc addresses (at most 50 recipients in total, to included, once duplicates are removed), a note of up to 2,000 characters and a replyTo so replies reach you — without one, replies go to the reply-to address on your agency profile. The PDF is attached only when it renders, and the response's pdfAttached says whether it did. This endpoint is limited to 10 emails a minute per key.

Supplier vouchers for activities and transfers

For activities and transfers, the operator can issue its own voucher. When the operator issues one, it's in the line item's details.supplierVouchers. That voucher is the traveller's ticket: on the day, operators may not accept anything else. Always pass supplier vouchers to the traveller unchanged, alongside anything you produce yourself.

Transfers with a pickup-time notice have extra rules — see Transfers.