# Docs - [Guides](/docs/llms-full.txt): Concepts, quickstart and product guides - [Introduction](/docs.md): One API to sell eSIMs, airtime, bill payments, gift cards, hotels and flights. - [Quickstart](/docs/quickstart.md): Search, quote and order an eSIM in Sandbox, then follow its delivery. - [Authentication](/docs/authentication.md): Authenticate every request with a partner API key in the X-Partner-Key header. - [Environments](/docs/environments.md): The Partner API hosts, and how Sandbox differs from Production. - **Core concepts** - [Orders](/docs/orders.md): Mixed orders, order and payment status, and what you can do with an order item after purchase. - [Idempotency](/docs/idempotency.md): Retry purchases and other changes safely with the Idempotency-Key header. - [Errors](/docs/errors.md): The error body, the shared error codes and how to handle each one. - [Webhooks](/docs/webhooks.md): Receive signed events when orders are delivered, refunded or amended, and when eSIMs change. - **Products** - [eSIMs](/docs/products/esims.md): Sell data eSIM plans for a country, a region or the world, deliver the install details, and manage the eSIM after purchase. - [Airtime](/docs/products/airtime.md): Top up mobile numbers in many countries with fixed or range-priced airtime offers, from number lookup to delivered value. - [Utility bill payments](/docs/products/utility.md): Pay electricity, water, gas, internet and other bills, or buy prepaid tokens and PINs, for billers in many countries. - [Gift cards](/docs/products/gift-cards.md): Search the gift card catalog, quote a card at a fixed or custom value, order it, and read the issued codes. - [Hotels](/docs/products/hotels.md): Search hotel stays, quote a rate, book it for named guests, and manage cancellations and amendments. - [Flights](/docs/products/flights.md): Search itineraries and fares, quote with seats and bags, book for named passengers, and manage the booking after purchase. - **Tools** - [SDKs](/docs/sdks.md): Official OpenRoam client libraries for eight languages, generated from the API specification. - [MCP server](/docs/mcp.md): Connect AI assistants and agents to the Partner API with the OpenRoam MCP server. - **Updates** - [Changelog](/docs/changelog.md): Changes to the Partner API and its documentation. - [API reference](/docs/api-reference/llms-full.txt): Every Partner API operation and webhook event - [API reference](/docs/api-reference.md): Every Partner API operation and webhook event, generated from the OpenAPI specification. - **Shared** - Account - [List account services](/docs/api-reference/account/get-services.md): Lists every service OpenRoam sells through the Partner API, with whether the account may sell it. - Orders - [Create an order](/docs/api-reference/orders/create-order.md): Places one order of one to five items, of one or several product types, and pays it from the wallet. - [List orders](/docs/api-reference/orders/get-all.md): Lists the partner's orders, newest first, with optional filters. - [Get an order](/docs/api-reference/orders/get-by-id.md): Gets the current state of one order. - [Preview an order cancellation](/docs/api-reference/orders/get-cancellation-preview.md): Previews cancelling every item of an order now, with the totals. - [Get fulfillment status](/docs/api-reference/orders/get-fulfillment-status.md): Gets the current fulfillment state of every item in an order. - [Quote an order](/docs/api-reference/orders/quote-order.md): Prices a mixed order body with current prices, without placing an order. - [Resend a traveller email](/docs/api-reference/orders/resend-email.md): Sends an email of a hosted-site order to its traveller again. - Order items - [Cancel an item](/docs/api-reference/order-items/cancel.md): Cancels an order item and refunds what was paid for it, less any cancellation penalty. - [Confirm an amendment](/docs/api-reference/order-items/confirm-amendment.md): Confirms a quoted amendment, paying any surcharge or receiving any refund. - [Get an amendment](/docs/api-reference/order-items/get-amendment-by-id.md): Gets one amendment of an order item. - [List item amendments](/docs/api-reference/order-items/get-amendments.md): Lists every amendment of an order item. - [Get an order item](/docs/api-reference/order-items/get-by-id.md): Gets an order item: what was bought, its delivery, its refund and what you can do next. - [Preview an item cancellation](/docs/api-reference/order-items/get-cancellation-preview.md): Previews the cancellation penalty and expected refund for an order item. - [List partner amendments](/docs/api-reference/order-items/list-partner-amendments.md): Lists amendments across the authenticated partner's orders. - [Quote an amendment](/docs/api-reference/order-items/quote-amendment.md): Quotes a change to a delivered order item. - [Update an item](/docs/api-reference/order-items/update.md): Updates a delivered order item, without a charge. - Wallets - [Create a wallet](/docs/api-reference/wallets/create.md): Creates an empty wallet in a currency the partner has no wallet in yet. - [List wallets](/docs/api-reference/wallets/get-all.md): Lists all of the partner's wallets. - [Get a wallet](/docs/api-reference/wallets/get-by-id.md): Gets one wallet with its totals. - [List wallet transactions](/docs/api-reference/wallets/get-transactions.md): Lists a wallet's transactions, newest first, with optional filters. - [Select a wallet](/docs/api-reference/wallets/select.md): Makes a wallet the partner's selected wallet, which pays for new orders. - [Transfer between wallets](/docs/api-reference/wallets/transfer.md): Moves funds from one of the partner's wallets to another, converting between their currencies. - [Update a wallet](/docs/api-reference/wallets/update.md): Renames a wallet or changes its low-balance threshold. - Currencies - [List currencies](/docs/api-reference/currencies/get-all.md): Lists every supported currency with its current rate to USD. - Reference data - [List countries](/docs/api-reference/common/get-countries.md): Lists every country and territory with its codes, English name, calling code and flag. - [List mobile networks](/docs/api-reference/common/get-mobile-networks.md): Lists mobile network codes (MCC/MNC) with their operator, country and calling code. - **Products** - eSIMs - [Order eSIMs](/docs/api-reference/esims/create-order.md): Places an order for new eSIMs or a top-up and returns the accepted order. - [eSIM catalog](/docs/api-reference/esims/get-catalog.md): Returns every destination with its plans, page by page, for partner inventory. - [List compatible devices](/docs/api-reference/esims/get-compatible-devices.md): Lists the devices known to support eSIM. - [Get an eSIM destination](/docs/api-reference/esims/get-destination.md): Returns one destination with its plans, in the item shape that search returns. - [List eSIM destinations](/docs/api-reference/esims/get-destinations.md): Lists every destination with an orderable plan, as summaries without plans. - [Get an eSIM](/docs/api-reference/esims/get-esim.md): Returns one of your eSIMs by its ICCID, with its installation details, plan and top-ups. - [List eSIM location events](/docs/api-reference/esims/get-location-events.md): Lists the networks and locations where an eSIM registered, newest first. - [List eSIM status events](/docs/api-reference/esims/get-status-events.md): Lists the status changes of an eSIM, newest first. - [Get eSIM usage by day](/docs/api-reference/esims/get-usage-details.md): Returns the current usage of an eSIM with a per-day breakdown. - [List eSIM usage history](/docs/api-reference/esims/get-usage-history.md): Lists the recorded usage readings of an eSIM, newest first. - [Get eSIM usage](/docs/api-reference/esims/get-usage.md): Returns the current data, SMS and voice usage of an eSIM. - [Provision a deferred eSIM](/docs/api-reference/esims/provision.md): Provisions a deferred eSIM bought with `inputs.isInstant: false` and returns it. - [Quote eSIMs](/docs/api-reference/esims/quote.md): Prices the order body with current prices, without placing an order. - [Search eSIM plans](/docs/api-reference/esims/search.md): Searches eSIM destinations and returns them with their plans, one page at a time. - [Send an SMS to an eSIM](/docs/api-reference/esims/send-sms.md): Sends a text message to one of your eSIMs. - Airtime - [Airtime catalog](/docs/api-reference/airtime/catalog.md): Returns the operator directory, page by page, for partner inventory. - [Order airtime](/docs/api-reference/airtime/create-order.md): Places an airtime top-up order and returns the accepted order. - [Get an airtime operator](/docs/api-reference/airtime/get-operator.md): Returns one operator with its offers for a phone number of its country (manual flow, step 2). - [List airtime operators](/docs/api-reference/airtime/get-operators.md): Lists the operators of a country that the customer can choose manually (manual flow, step 1). - [Look up a phone number](/docs/api-reference/airtime/lookup-number.md): Describes a phone number and returns its carrier from a carrier lookup when the number is valid. - [Quote airtime](/docs/api-reference/airtime/quote.md): Prices the order body with current prices, without placing an order. - [Search airtime by phone number](/docs/api-reference/airtime/search.md): Searches for a phone number's operator by carrier lookup and returns it with its offers (detected flow). - Utility - [Pay utility bills](/docs/api-reference/utility/create-order.md): Places a utility bill payment order and returns the accepted order. - [Get a biller](/docs/api-reference/utility/get-biller.md): Returns one biller with its offers, in the item shape that search returns. - [Utility catalog](/docs/api-reference/utility/get-catalog.md): Returns every biller with its offers, page by page, for partner inventory. - [Quote utility payments](/docs/api-reference/utility/quote.md): Prices the order body with current prices, without placing an order. - [Search billers](/docs/api-reference/utility/search.md): Searches the billers of a country and returns them with their offers, one page at a time. - Gift cards - [Order gift cards](/docs/api-reference/gift-cards/create-order.md): Places a gift card order and returns the accepted order. - [Get a gift card](/docs/api-reference/gift-cards/get-card.md): Returns one gift card with its offers, in the item shape that search returns. - [Gift card catalog](/docs/api-reference/gift-cards/get-catalog.md): Returns every gift card with its offers, page by page, for partner inventory. - [List gift card categories](/docs/api-reference/gift-cards/get-categories.md): Lists the gift card categories with their display names. - [Quote gift cards](/docs/api-reference/gift-cards/quote.md): Prices the order body with current prices, without placing an order. - [Search gift cards](/docs/api-reference/gift-cards/search.md): Searches gift cards and returns them with their offers, one page at a time. - Hotels - [Book hotels](/docs/api-reference/hotels/create-order.md): Places and pays for hotel bookings of up to 5 searched or quoted rates. - [List hotel amenities](/docs/api-reference/hotels/get-amenity-catalog.md): Returns the amenity catalog: every amenity code and group with its display label. - [Get hotel catalog files](/docs/api-reference/hotels/get-catalog-files.md): Returns download links for the current hotel catalog files. - [Search hotel destinations](/docs/api-reference/hotels/get-destinations.md): Finds the places to search hotels in by name: a country, a region, a city or a district. - [Get a hotel](/docs/api-reference/hotels/get-property.md): Returns one hotel's content: the item that search returns, without `offers`. - [Quote hotel rates](/docs/api-reference/hotels/quote.md): Prices up to 5 searched or quoted rates again with the hotel system and issues a new offer for each. - [Search hotels](/docs/api-reference/hotels/search.md): Searches hotels by location or hotel IDs and returns their bookable rates for the stay. - Hotel manual amendments - [Approve a manual amendment](/docs/api-reference/hotel-manual-amendments/approve-manual-amendment.md): Approves the quoted price of a manual amendment and settles it from your wallet. - [Cancel a manual amendment](/docs/api-reference/hotel-manual-amendments/cancel-manual-amendment.md): Cancels a manual amendment request that has not been worked on yet. - [Request a manual amendment](/docs/api-reference/hotel-manual-amendments/create-manual-amendment.md): Requests a manual change to a confirmed hotel booking. - [Decline a manual amendment](/docs/api-reference/hotel-manual-amendments/decline-manual-amendment.md): Declines the quoted price of a manual amendment. - Flights - [Order flights](/docs/api-reference/flights/create-order.md): Places and pays for flight bookings, one fare per item. - [Get a flight seat map](/docs/api-reference/flights/get-seat-map.md): Returns the seat map of a flight offer, with the seats each passenger can take and their prices. - [Quote flights](/docs/api-reference/flights/quote.md): Prices flight fares again with the airline, without placing an order. - [Search flights](/docs/api-reference/flights/search.md): Searches flight itineraries and the fares bookable on them. - **Events** - Webhook events - [The profile status of an eSIM changed.](/docs/api-reference/webhooks/esim-profile-status-updated.md): Delivered at least once to your webhook URL. - [The data or expiry usage of an eSIM reached a new band.](/docs/api-reference/webhooks/esim-usage-updated.md): Delivered at least once to your webhook URL. - [The delivery of an order's items changed: delivered, rejected, or a delivered result was revised.](/docs/api-reference/webhooks/order-fulfillment-updated.md): Delivered at least once to your webhook URL. - [A manual amendment request progressed, or needs your action.](/docs/api-reference/webhooks/order-item-manual-amendment-status.md): Delivered at least once to your webhook URL. - [A refund of an order item progressed or finished.](/docs/api-reference/webhooks/order-item-refunded.md): Delivered at least once to your webhook URL. - [A wallet balance fell to a lower low-balance threshold band.](/docs/api-reference/webhooks/partner-balance-low.md): Delivered at least once to your webhook URL.