List account services
Lists every service OpenRoam sells through the Partner API, with whether the account may sell it.
Lists every service OpenRoam sells through the Partner API, with whether the account may sell it.
Returns { services }, one entry per service, ordered by productType, without paging. Each entry is
{ productType, enabled, requestable }. enabled is true when the account may search, quote
and order the service now; any other request that sells it returns 403 with code 10003.
requestable is true when the account can ask OpenRoam to enable the service; an enabled service is
never requestable. A service OpenRoam does not offer at the moment is not listed. The endpoint takes no query
parameters; an unknown parameter returns 400 with code 10001.
PartnerApiKeyX-Partner-Key<token>Partner API Key (X-Partner-Key)
OK
- response
Every service OpenRoam sells through the Partner API, ordered by product type, with the account's access.
services*array<>curl -X GET 'https://api.sandbox.openroam.com/v1/account/services'{ "services": [ { "productType": "esim", "enabled": true, "requestable": true } ]}API reference
Every Partner API operation and webhook event, generated from the OpenAPI specification.
Create an order POST
Places one order of one to five items, of one or several product types, and pays it from the wallet. Each item names its `productType`, the `publicId` of the offer from search or quote, a `quantity` and, where the product needs them, product-specific `inputs` (required for hotels and flights). An order has at most five items and a total quantity of at most five; an item with quantity `n` becomes `n` separate order items, each with its own `items[].id`. Every item is validated before anything is charged; a rejected item is reported at `items[i]` in `details`, for example `11004` (`OFFER_EXPIRED_OR_INVALID`) for an unknown, expired or other-product `publicId`, `11003` (`OFFER_UNAVAILABLE`) or `11002` (`OFFER_PRICE_CHANGED`). The optional `maxTotal` `{ amount, currency }` caps the whole order: the sum of every item's price times its quantity, in the order currency. Its currency must be the order currency (otherwise `400`, `10001`, `CURRENCY_MISMATCH` at `maxTotal.currency`). A higher total returns `409` with code `11002` (`OFFER_PRICE_CHANGED`) at `maxTotal`, after every item is priced and before anything is charged; a total equal to it is accepted. The order total is charged to the partner's selected wallet. On success the order is `processing` and its items start as `pending`; delivery continues after the response, so follow it with `GET orders/{id}`, `GET orders/{orderId}/fulfillment/status` or the `order.fulfillment.updated` webhook. If the charge fails, no order is created and the call returns `402` with code `16000` (`PAYMENT_FAILED`); when the reason is known, `details[0]` names `wallet` with reason `INSUFFICIENT_BALANCE` or `WALLET_BLOCKED`. Top up or unblock the wallet and send the same request again with the same `Idempotency-Key`. Requires an `Idempotency-Key` header (a UUID) per purchase. Repeating the same request with the same key never charges twice: once the order is accepted it returns `200` with that order's current state; while the first request is still running it returns `409` with code `12002` (`IDEMPOTENCY_KEY_IN_PROGRESS`) and a `Retry-After` header, after which you send the same request again; a different body with the same key returns `409` with code `12001` (`IDEMPOTENCY_KEY_REQUEST_MISMATCH`). After a timeout or `5xx`, retry with the same key and body rather than a new key. A `referenceId` already used by another order of the partner returns `409` with code `10005` (`CONFLICT`). An eSIM top-up whose `inputs.iccid` is not one of your eSIMs returns `404` with code `10004` (`NOT_FOUND`) and charges nothing.