eSIM catalog
Returns every destination with its plans, page by page, for partner inventory.
Returns every destination with its plans, page by page, for partner inventory.
Returns { items, nextCursor }, in a fixed order, with the search filters except iccid.
Continue with nextCursor as cursor, the same filters and the same currency until it is
null. A cursor reused with other filters or another currency gives 400 / 10001. Quote confirms the final price
and availability.
PartnerApiKeyX-Partner-Key<token>Partner API Key (X-Partner-Key)
countryCode?stringOptional ISO 3166-1 alpha-2 country, in either case: keeps the destinations whose coverage includes it, regional and global ones too. A blank value is rejected.
category?stringKeep local, regional or global destinations.
"local""regional""global"region?stringKeep the destinations of this region, in display or slug form, for example North America or north-america.
validityDays?integerKeep the plans valid for exactly this many days; at least 1.
int32isUnlimited?booleanKeep the unlimited (true) or the limited (false) plans.
currency?stringPrice currency, three letters in either case; the API key's currency when omitted. An unsupported code gives 400 / 10001 at currency, reason NOT_SUPPORTED.
cursor?stringThe nextCursor of the previous page; omit it for the first page. Reuse it only with the same filters and currency.
limit?integerPage size, 1 to 100; default 100.
int32OK
- response
A page of the partner catalog walk, in a fixed order. Continue with nextCursor, the same filters and
the same currency until it is null.
items*array<>nextCursor?string|nullcurl -X GET 'https://api.sandbox.openroam.com/v1/esims/catalog?countryCode=FR&category=regional®ion=Europe&validityDays=7&isUnlimited=false¤cy=USD&limit=10'{ "items": [ { "id": "string", "name": "string", "countryCode": "string", "category": "local", "logoUrl": "string", "description": "string", "offers": [ { "publicId": "string", "name": "string", "description": "string", "price": { "amount": 0, "currency": "string" }, "requiredInputs": [ { "name": "string", "type": "text", "required": true, "description": "string", "fields": [ {} ] } ], "details": { "validityDays": 0, "data": { "amount": 0, "unit": "string", "isUnlimited": true, "label": "string" }, "voice": { "amount": 0, "unit": "string", "isUnlimited": true, "label": "string", "type": "string" }, "sms": { "amount": 0, "unit": "string", "isUnlimited": true, "label": "string", "type": "string" }, "apn": { "apn": "string", "apnUsername": "string", "apnPassword": "string" }, "properties": { "withKyc": true, "withTopUp": true, "withHotspot": true, "withDataRoaming": true, "withSubscription": true, "withDestinationInstall": true, "withUsageCheck": true, "technology": "string", "activation": "string", "charge": "string" }, "restrictions": { "throttle": true, "throttleSpeed": 0, "throttleUnit": "string", "throttleThreshold": 0, "throttleThresholdUnit": "string", "expireInDays": 0 }, "notes": [ "string" ], "plan": "string" } } ], "details": { "destinationCode": "string", "region": "string", "coverage": [ { "countryCode": "string", "name": "string", "networks": [ "string" ], "carriers": [ "string" ] } ] } } ], "nextCursor": "string"}Order eSIMs POST
Places an order for new eSIMs or a top-up and returns the accepted order. Takes the same body as quote and needs the `manage` order permission (403 / 10003 without it). An `Idempotency-Key` header with a new UUID is required for every purchase: a retry with the same key and body returns the order already accepted, 409 / 12002 with `Retry-After` while it is still being accepted, and a changed body gives 409 / 12001. A top-up is an offer from `search?iccid=` ordered with `inputs.iccid` and quantity 1; without `inputs.iccid` the same offer is bought as a new eSIM. A new eSIM is instant unless `inputs.isInstant` is false, which delivers an entitlement to provision later. Every price is recalculated: a current price above `inputs.maxPrice` gives 409 / 11002 before anything is charged. A wallet charge that fails creates no order and gives 402 / 16000, with `details[0]` naming `wallet` and `INSUFFICIENT_BALANCE` or `WALLET_BLOCKED`; send the same request with the same key after a top-up. An unknown or foreign `inputs.iccid` gives 404 / 10004 and charges nothing.
List compatible devices GET
Lists the devices known to support eSIM. Returns an array of `{ brand, model, os, deviceType, name, notes }`, without paging.