Get an eSIM order by its own ID

GET

/api/v1/orders/esim/{orderId}

const url = 'https://api-omni.linra.net/api/v1/orders/esim/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api-omni.linra.net/api/v1/orders/esim/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Authorizations

partnerBearer

Parameters

Path Parameters

orderId

required

string format: uuid

Responses

200

The eSIM order.

application/json

object

state

required

string

payload

required

details

object

payload

required

object

orderId

string format: uuid

orderGlobalId

string

partnerId

string format: uuid

partnerGlobalId

string

geoScopeGlobalId

string

externalReference

string

status

string

statusDetail

Product-specific status detail carried on Topup/eSIM order responses.

object

productType

string

statusCode

string

description

string

nullable

productSku

string

email

string

dataAllowance

number format: decimal

validityDays

integer

amount

number format: decimal

currency

string

submittedAt

string format: date-time

completedAt

string format: date-time

nullable

esimIccid

Populated once provisioning succeeds.

string

nullable

esimQrCode

Populated once provisioning succeeds.

string

nullable

esimActivationCode

Populated once provisioning succeeds.

string

nullable

esimPlanDetails

Populated once provisioning succeeds.

string

nullable

errorMessage

string

nullable

displayCurrency

string

nullable

rate

number

nullable

amountDisplay

number

nullable

Example

{
  "state": "SUCCESS",
  "payload": {
    "statusDetail": {
      "productType": "Topup",
      "statusCode": "TOPUP_SUCCESS"
    },
    "currency": "SAR"
  }
}

404

Unknown or cross-tenant order.

application/json

The envelope every /api/v1 ERROR response uses. state carries the machine-readable error code (see the Errors guide).

object

state

required

string

payload

required

Always null on an error response.

object

details

object

Examples

notFound

{
  "state": "NOT_FOUND_ESIM_ORDER",
  "payload": null,
  "details": {}
}

429

Too many requests — see the Rate limits guide. Retry after the Retry-After header (seconds).

application/json

The envelope every /api/v1 ERROR response uses. state carries the machine-readable error code (see the Errors guide).

object

state

required

string

payload

required

Always null on an error response.

object

details

object

Example

{
  "state": "NOT_FOUND_ORDER",
  "payload": null
}

Headers

Retry-After

integer

Seconds to wait before retrying.