Get an eSIM destination
Returns one destination with its plans, in the item shape that search returns.
Returns one destination with its plans, in the item shape that search returns.
An unknown ID, or a destination that search does not list, gives 404 / 10004. After a purchase, the order item's
purchasedProduct.details.destination.id gives the coverage of the destination the eSIM was bought for.
PartnerApiKeyX-Partner-Key<token>Partner API Key (X-Partner-Key)
id*stringThe destination id from search, the destination list or the catalog.
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.
OK
- response
One destination as search, the one-destination route and the catalog return it. id is the
destination's opaque ID; an order names one of its offers by public ID. Prices are indicative;
quote recalculates them.
id*stringname*stringcountryCode?|ISO 3166-1 alpha-2 code of a local destination; null for regional and global ones.
category*string"local""regional""global"logoUrl?string|nulldescription?string|nulloffers*array<>details*Destination facts outside the item keys every partner service shares.
curl -X GET 'https://api.sandbox.openroam.com/v1/esims/destinations/destn_k3m7q2t5w4y6b2d4f6h3j5n7pq?currency=USD'{ "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" ] } ] }}List compatible devices GET
Lists the devices known to support eSIM. Returns an array of `{ brand, model, os, deviceType, name, notes }`, without paging.
List eSIM destinations GET
Lists every destination with an orderable plan, as summaries without plans. Returns the complete list `{ items }`, ordered by name, without paging or prices. Read a destination's plans with `destinations/{id}`.